CalculateEnvelope

ID: legacy/7.x/CalculateEnvelope


Deprecated: Replaced by array-based NumPy trace step template.

Generates the upper and lower bound signals for the envelope.

Signals

LowerBound

The signal for the lower bound of the envelope.

  • Direction: OUT

  • Optional: True

Signal

The signal for which the envelope will be calculated.

  • Direction: IN

  • Optional: False

UpperBound

The signal for the upper bound of the envelope.

  • Direction: OUT

  • Optional: True

Parameters

deltaT

The distance in time between an envelope border and the signal. The final width of the envelope will be two times deltaT. Note: DeltaT should be greater than or equal to the half of the period of the signal.

  • Direction: IN

  • Type: FLOAT

emitEverySample

If set, then the lower and upper bound signals get a sample for every sample in the input signal. If not set (recommended because it saves memory) the lower and upper bound signals only get samples where the value has changed.

  • Direction: IN

  • Type: BOOLEAN

minusDeltaY

The distance in height between the lower bound of the envelope and the signal.

  • Direction: IN

  • Type: FLOAT

plusDeltaY

The distance in height between the upper bound of the envelope and the signal.

  • Direction: IN

  • Type: FLOAT