tireData.generate

Create tireData objects with synthetic data

Since R2025a

Syntax

obj = tireData.generate(type,Name=Value)

Description

This function requires Extended Tire Features for Vehicle Dynamics Blockset.

obj = tireData.generate(type,Name=Value) creates a tireData object array with synthetic data in the form specified by type using one or more Name=Value arguments. All tireData channels that are available as optional Name=Value arguments assign set point conditions. In the output tireData objects, channels that are not assigned using a Name=Value argument remain empty.

Examples

Create tireData Objects with Synthetic Data

You can create tireData objects with synthetic data using the tireData.generate function, available in ramp, sine, or steady-state shapes.

Synthesizing Ramp-Shape Data

To generate synthetic data in the shape of a ramp, you must specify "Ramp" as the type input argument and set the direction, initialValue, and finalValue name-value arguments. Additionally, define set point conditions. For this example, set these tireData object channels:

• Fz

• kappa

• gamma

• Vx

• Ip

td_ramp=tireData.generate("Ramp", Direction="alpha", ...
    initialValue=-0.15, finalValue=0.15, ...
    Fz=[1000,2000,3000], ...
    kappa=0, ...
    gamma=[-0.15,0,0.15], ...
    Vx=[10,15,20], ...
    IP=[220000,260000]);

The generated tireData objects with synthetic data include a combination of all the input set point conditions.

summaryTable(td_ramp,VariableNames=["Fz","IP","gamma","kappa","Vx"])

ans=54×5 table
     Fz       IP       gamma    kappa    Vx
    ____    _______    _____    _____    __

    1000    2.2e+05    -0.15      0      10
    1000    2.2e+05    -0.15      0      15
    1000    2.2e+05    -0.15      0      20
    1000    2.2e+05        0      0      10
    1000    2.2e+05        0      0      15
    1000    2.2e+05        0      0      20
    1000    2.2e+05     0.15      0      10
    1000    2.2e+05     0.15      0      15
    1000    2.2e+05     0.15      0      20
    1000    2.6e+05    -0.15      0      10
    1000    2.6e+05    -0.15      0      15
    1000    2.6e+05    -0.15      0      20
    1000    2.6e+05        0      0      10
    1000    2.6e+05        0      0      15
    1000    2.6e+05        0      0      20
    1000    2.6e+05     0.15      0      10
      ⋮

The alpha channel is identical for each tireData object.

plot(td_ramp(1), DataVariableNames=["alpha"]);

Synthesizing Sine-Shape Data

To generate synthetic data in the shape of a sine wave, you must specify "Sine" as the type input argument and set the direction, amp, and bias name-value arguments. Additionally, define set point conditions. For this example, set these tireData object channels:

• Fz

• kappa

• gamma

• Vx

• Ip

td_sine=tireData.generate("Sine", Direction="alpha", ...
    amp=0.15, bias=0.1, ...
    Fz=[1000,2000,3000], ...
    kappa=0, ...
    gamma=[-0.15,0,0.15], ...
    Vx=[10,15,20], ...
    IP=[220000,260000]);

The generated tireData objects with synthetic data include a combination of all the input set point conditions.

summaryTable(td_sine,VariableNames=["Fz","IP","gamma","kappa","Vx"])

ans=54×5 table
     Fz       IP       gamma    kappa    Vx
    ____    _______    _____    _____    __

    1000    2.2e+05    -0.15      0      10
    1000    2.2e+05    -0.15      0      15
    1000    2.2e+05    -0.15      0      20
    1000    2.2e+05        0      0      10
    1000    2.2e+05        0      0      15
    1000    2.2e+05        0      0      20
    1000    2.2e+05     0.15      0      10
    1000    2.2e+05     0.15      0      15
    1000    2.2e+05     0.15      0      20
    1000    2.6e+05    -0.15      0      10
    1000    2.6e+05    -0.15      0      15
    1000    2.6e+05    -0.15      0      20
    1000    2.6e+05        0      0      10
    1000    2.6e+05        0      0      15
    1000    2.6e+05        0      0      20
    1000    2.6e+05     0.15      0      10
      ⋮

The alpha channel is identical for each tireData object.

plot(td_sine(1), DataVariableNames=["alpha"]);

Synthesizing Steady-State Data

To generate steady-state synthetic data, you must specify "Steady-State" as the type input argument. Additionally, define set point conditions. For this example set these tireData object channels:

• Fz

• kappa

• gamma

• Vx

• Ip

td_steadyState=tireData.generate("Steady-State", ...
    Fz=[1000,2000,3000], ...
    kappa=0, ...
    gamma=[-0.15,0,0.15], ...
    Vx=[10,15,20], ...
    IP=[220000,260000]);

The generated tireData objects with synthetic data include a combination of all the input set point conditions.

summaryTable(td_steadyState,VariableNames=["Fz","IP","gamma","kappa","Vx"])

ans=54×5 table
     Fz       IP       gamma    kappa    Vx
    ____    _______    _____    _____    __

    1000    2.2e+05    -0.15      0      10
    1000    2.2e+05    -0.15      0      15
    1000    2.2e+05    -0.15      0      20
    1000    2.2e+05        0      0      10
    1000    2.2e+05        0      0      15
    1000    2.2e+05        0      0      20
    1000    2.2e+05     0.15      0      10
    1000    2.2e+05     0.15      0      15
    1000    2.2e+05     0.15      0      20
    1000    2.6e+05    -0.15      0      10
    1000    2.6e+05    -0.15      0      15
    1000    2.6e+05    -0.15      0      20
    1000    2.6e+05        0      0      10
    1000    2.6e+05        0      0      15
    1000    2.6e+05        0      0      20
    1000    2.6e+05     0.15      0      10
      ⋮

The "Steady-State" option generates constant data for the combination of all the optional tireData channel name-value arguments.

plot(td_steadyState(1), DataVariableNames="Fz");

Input Arguments

type — Shape of data to generate

"Sine | "Ramp" | "Steady-State"

Shape of data to generate, specified as "Sine", "Ramp", or "Steady-State".

Example: type="Sine"

Data Types: string

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Example: tireData.generate("Steady-State",Fz=[1000,2000,3000],kappa=0,gamma=[-0.15,0,0.15],Vx=[10,15,20],IP=[220000,260000]);

direction — Tire data channel for shape application

string scalar

Tire data channel for shape application, specified as a string scalar. String value must be a time-independent property of the tireData object. See tireData Properties.

Note

You must specify the direction argument when type="Sine" or type="Ramp".

Example: direction="alpha"

Data Types: string

amp — Amplitude of sine wave

real positive scalar

Amplitude of the sine wave, specified as a real positive scalar.

Note

You must specify the amp argument when type="Sine".

Example: amp=0.15

Data Types: double

bias — Constant value added to sine wave

scalar

Constant value added to the sine wave, specified as a scalar.

Note

You must specify the bias argument when type="Sine".

Example: bias=0.1

Data Types: double

initialValue — Ramp initial value

scalar

Ramp initial value, specified as a scalar.

Note

You must specify the initialValue argument when type="Ramp".

Example: initialValue=-0.15

Data Types: double

finalValue — Ramp final value

scalar

Ramp final value, specified as a scalar.

Note

You must specify the finalValue argument when type="Ramp".

Example: finalValue=0.15

Data Types: double

IP — Inflation pressure set points

column vector

Inflation pressure set points, specified as a column vector.

Data Types: double

alpha — Slip angle set points

column vector

Slip angle set points, specified as a column vector.

Data Types: double

gamma — Inclination angle set points

column vector

Inclination angle set points, specified as a column vector.

Data Types: double

kappa — Longitudinal slip set points

column vector

Longitudinal slip set points, specified as a column vector.

Data Types: double

V — Total velocity set points

column vector

Total velocity set points, specified as a column vector.

Data Types: double

Fx — Longitudinal force set points

column vector

Longitudinal force set points, specified as a column vector.

Data Types: double

Fy — Lateral force set points

column vector

Lateral force set points, specified as a column vector.

Data Types: double

Fz — Normal force set points

column vector

Normal force set points, specified as a column vector.

Data Types: double

Mx — Overturning moment set points

column vector

Overturning moment set points, specified as a column vector.

Data Types: double

My — Rolling moment set points

column vector

Rolling moment set points, specified as a column vector.

Data Types: double

Mz — Self-aligning moment set points

column vector

Self-aligning moment set points, specified as a column vector.

Data Types: double

Tw — Wheel torque set points

column vector

Wheel torque set points, specified as a column vector.

Data Types: double

phit — Turn slip set points

column vector

Turn slip set points, specified as a column vector.

Data Types: double

phi — Total tire spin set points

column vector

Total tire spin set points, specified as a column vector.

Data Types: double

Vx — Longitudinal velocity set points

column vector

Longitudinal velocity set points, specified as a column vector.

Data Types: double

Vy — Lateral velocity set points

column vector

Lateral velocity set points, specified as a column vector.

Data Types: double

omega — Wheel spin velocity set points

column vector

Wheel spin velocity set points, specified as a column vector.

Data Types: double

psidot — Turn slip velocity set points

column vector

Turn slip velocity set points, specified as a column vector.

Data Types: double

RL — Loaded radius set points

column vector

Loaded radius set points, specified as a column vector.

Data Types: double

Re — Effective radius set points

column vector

Effective radius set points, specified as a column vector.

Data Types: double

Rdyn — Dynamic rolling radius set points

column vector

Dynamic rolling radius set points, specified as a column vector.

Data Types: double

rhoz — Radial deflection set points

column vector

Radial deflection set points, specified as a column vector.

Data Types: double

dist — Travel distance set points

column vector

Travel distance set points, specified as a column vector.

Data Types: double

Ta — Ambient temperature set points

column vector

Ambient temperature set points, specified as a column vector.

Data Types: double

Tsurface — Tread surface temperature set points

column vector

Tread surface temperature set points, specified as a column vector.

Data Types: double

TtreadI — Set points of tread surface temperature (inside shoulder)

column vector

Set points of tread surface temperature (inside shoulder), specified as a column vector.

Data Types: double

TtreadC — Set points of tread surface temperature (center rib)

column vector

Set points of tread surface temperature (center rib), specified as a column vector.

Data Types: double

TtreadO — Set points of tread surface temperature (outside shoulder)

column vector

Set points of tread surface temperature (outside shoulder), specified as a column vector.

Data Types: double

Tsidewall — Sidewall surface temperature set points

column vector

Sidewall surface temperature set points, specified as a column vector.

Data Types: double

Tinnerliner — Innerliner surface temperature set points

column vector

Innerliner surface temperature set points, specified as a column vector.

Data Types: double

Tcavity — Tire cavity air temperature set points

column vector

Tire cavity air temperature set points, specified as a column vector.

Data Types: double

sig_x — Longitudinal relaxation length set points

column vector

Longitudinal relaxation length set points, specified as a column vector.

Data Types: double

sig_y — Lateral relaxation length set points

column vector

Lateral relaxation length set points, specified as a column vector.

Data Types: double

patch_a — Half of contact patch length set points

column vector

Half of contact patch length set points, specified as a column vector.

Data Types: double

patch_b — Half of contact patch width set points

column vector

Half of contact patch width set points, specified as a column vector.

Data Types: double

UserData — Data channel to store user-defined data

column vector

Data channel to store user-defined data, specified as a column vector.

Data Types: double

label — Nonnumeric data

column vector

Nonnumeric data, specified as a column vector.

Data Types: string

Output Arguments

obj — Generated synthetic data

tireData object | array of tireData objects

Generated synthetic data, returned as a tireData object or an array of tireData objects.

Version History

Introduced in R2025a