Ramp Pattern by Samples

Generates a signal containing a ramp pattern of samples.

1378

Inputs/Outputs

datatype_icon

type

Type of ramp to generate.

Linear 0 Uses the linear type.
Logarithmic 1 Uses the logarithmic type.

Default value: Linear

datatype_icon

start

First value of the ramp.

This node does not impose conditions on the relationship between start and end. Therefore, this node can generate ramp-up and ramp-down patterns.

Default value: 0

datatype_icon

end

Final value of the ramp.

This node does not impose conditions on the relationship between start and end. Therefore, this node can generate ramp-up and ramp-down patterns.

Default value: 1

datatype_icon

exclude end

A Boolean that determines whether to use the final value of the ramp to generate the ramp pattern.

True Ignores the final value of the ramp when generating the ramp pattern.
False Uses the final value of the ramp when generating the ramp pattern.

Default value: False

datatype_icon

error in

Error conditions that occur before this node runs.

The node responds to this input according to standard error behavior.

Standard Error Behavior

Default value: No error

datatype_icon

dt

Sampling rate in samples per second.

This input is available only if you configure this node to return a waveform.

Default value: 0.1

datatype_icon

samples

Number of samples in the pattern.

samples must be greater than 0. Otherwise, this node returns an error.

Default value: 128

datatype_icon

t0

Timestamp of the output signal.

If this input is unwired, this node uses the current time as the timestamp of the output signal.

This input is available only if you configure this node to return a waveform.

datatype_icon

ramp pattern

Output ramp pattern.

This output can return a waveform or an array of double-precision, floating-point numbers.

datatype_icon

error out

Error information.

The node produces this output according to standard error behavior.

Standard Error Behavior

Algorithm for Generating the Linear Ramp Pattern

Let the sequence X represent ramp pattern. If type is Linear, the node generates the pattern according to the following equation:

x i = x 0 + i Δ x x i = x 0 + i Δ x

for i = 0, 1, 2, …, n - 1

where

  • x 0 is start
  • n is the number of samples
  • Δ x = ( end − start ) m
    ,
    m=n
    if exclude end? is True. Otherwise,
    m=n−1
    .

Algorithm for Generating the Logarithmic Ramp Pattern

Let the sequence X represent ramp pattern. If type is Logarithmic, the node generates the pattern according to the following equation:

x i = exp [ ln ⁡ ( x 0 ) + i Δ x ] ⁡ x i = exp [ ln ⁡ ( x 0 ) + i Δ x ] ⁡

for i = 0, 1, 2, …, n - 1

where

  • x 0 is the start
  • n is the number of samples
  • Δ x = [ ln ( end ) − ln ( start ) ] m
    ,
    m=n
    if exclude end? is True. Otherwise,
    m=n−1
    .
  • start and end must be greater than 0.