Signal operations

Consult Signal contracts, find time-domain and spectral analysis functions, and identify their documented operands.

How to use this family

Time-domain and spectral processing have requirements on the step, form and length of the inputs. When time and samples appear, provide abscissas and measurements in the order of the phenomenon. Read the provider options for sampling frequency, window, reference channel, filters and bands. In a spectrum, distinguish amplitude, phase, power and density. Complex quantities can have separate real and imaginary fields.

Function index

signal.analytic.envelope

Determines an envelope of amplitude or of values, according to the contract.

Signature
signal.analytic.envelope(samples, sample_rate, unused, options)
Arguments
samples sample_rate unused options
Technical descriptors
Show shapes and scopes by argument{name samples shape real_vector source cell,range,column,scalar,option} {name sample_rate shape positive_scalar source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
real_vector;positive_scalar
Unit rule
signal_unit;Hz
Units
signal_unit;Hz
Result fields
vector
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1) , 2. Press Preview fields. The results include amplitude.

Back to the list

signal.analytic.instantaneous_frequency

Estimates the instantaneous frequency from the change of the analytic phase over time.

Signature
signal.analytic.instantaneous_frequency(samples, sample_rate, unused, options)
Arguments
samples sample_rate unused options
Technical descriptors
Show shapes and scopes by argument{name samples shape real_vector source cell,range,column,scalar,option} {name sample_rate shape positive_scalar source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
real_vector;positive_scalar
Unit rule
signal_unit;Hz
Units
signal_unit;Hz
Result fields
vector
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1) , 2. Press Preview fields. The results include frequency_hz.

Back to the list

signal.analytic.phase

Derives the phase of the analytic signal with the stated convention.

Signature
signal.analytic.phase(samples, sample_rate, unused, options)
Arguments
samples sample_rate unused options
Technical descriptors
Show shapes and scopes by argument{name samples shape real_vector source cell,range,column,scalar,option} {name sample_rate shape positive_scalar source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
real_vector;positive_scalar
Unit rule
signal_unit;Hz
Units
signal_unit;Hz
Result fields
vector
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1) , 2. Press Preview fields. The results include phase_rad.

Back to the list

signal.analytic.signal

Returns the complex representation of the analytic signal.

Signature
signal.analytic.signal(samples, sample_rate, unused, options)
Arguments
samples sample_rate unused options
Technical descriptors
Show shapes and scopes by argument{name samples shape real_vector source cell,range,column,scalar,option} {name sample_rate shape positive_scalar source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
real_vector;positive_scalar
Unit rule
signal_unit;Hz
Units
signal_unit;Hz
Result fields
vector
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1) , 2. Press Preview fields. The results include value_real, value_imaginary.

Back to the list

signal.cepstrum.complex

Builds a complex number.

Signature
signal.cepstrum.complex(signal, bounds, unused, options)
Arguments
signal bounds unused options
Technical descriptors
Show shapes and scopes by argument{name signal shape vector source cell,range,column,scalar,option} {name bounds shape optional_quefrency_bounds source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
vector;optional_quefrency_bounds
Unit rule
samples
Units
samples
Result fields
cepstral_vector quefrency
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(1,0.1,0,0,0,0,0,0) . Press Preview fields. The results include value_real, value_imaginary, quefrency_samples.

Back to the list

signal.cepstrum.inverse

Reconstructs the signal from the complex cepstrum and the required alignment data.

Signature
signal.cepstrum.inverse(signal, bounds, unused, options)
Arguments
signal bounds unused options
Technical descriptors
Show shapes and scopes by argument{name signal shape vector source cell,range,column,scalar,option} {name bounds shape optional_quefrency_bounds source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
vector;optional_quefrency_bounds
Unit rule
samples
Units
samples
Result fields
cepstral_vector quefrency
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(0.1,0.05,0,0,0,0,0,0) . Press Preview fields. The results include value_real, value_imaginary, quefrency_samples.

Back to the list

signal.cepstrum.lifter

Modifies the cepstral coefficients according to the set window.

Signature
signal.cepstrum.lifter(signal, bounds, unused, options)
Arguments
signal bounds unused options
Technical descriptors
Show shapes and scopes by argument{name signal shape vector source cell,range,column,scalar,option} {name bounds shape optional_quefrency_bounds source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
vector;optional_quefrency_bounds
Unit rule
samples
Units
samples
Result fields
cepstral_vector quefrency
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(1,2,3,4,5,6,7,8) , vector(1,2). Press Preview fields. The results include value_real, value_imaginary, mask, quefrency_samples.

Back to the list

signal.cepstrum.real

Selects the real part of the complex result.

Signature
signal.cepstrum.real(signal, bounds, unused, options)
Arguments
signal bounds unused options
Technical descriptors
Show shapes and scopes by argument{name signal shape vector source cell,range,column,scalar,option} {name bounds shape optional_quefrency_bounds source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
vector;optional_quefrency_bounds
Unit rule
samples
Units
samples
Result fields
cepstral_vector quefrency
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(1,0.1,0,0,0,0,0,0) . Press Preview fields. The results include value_real, value_imaginary, quefrency_samples.

Back to the list

signal.convolution.circular

Computes the convolution with periodic extension.

Signature
signal.convolution.circular(x, kernel, unused, options)
Arguments
x kernel unused options
Technical descriptors
Show shapes and scopes by argument{name x shape vectors source cell,range,column,scalar,option} {name kernel shape action-specific source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
vectors
Unit rule
Product of the signal and kernel units.
Units
Product of the signal and kernel units.
Result fields
vector length
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1) , vector(1,2,1). Press Preview fields. The results include value_real, value_imaginary, output_length.

Back to the list

signal.convolution.deconvolve

Estimates the input of the convolution from the result and the kernel.

Signature
signal.convolution.deconvolve(x, kernel, unused, options)
Arguments
x kernel unused options
Technical descriptors
Show shapes and scopes by argument{name x shape vectors source cell,range,column,scalar,option} {name kernel shape action-specific source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
vectors
Unit rule
Product of the signal and kernel units.
Units
Product of the signal and kernel units.
Result fields
vector length
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(1,3,5,3) , vector(1,1). In Options use regularization=0.01. Press Preview fields. The results include value_real, value_imaginary, output_length.

Back to the list

signal.convolution.linear

Computes the linear discrete convolution. Without trimming, the output length equals the sum of the lengths minus one.

Signature
signal.convolution.linear(x, kernel, unused, options)
Arguments
x kernel unused options
Technical descriptors
Show shapes and scopes by argument{name x shape vectors source cell,range,column,scalar,option} {name kernel shape action-specific source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
vectors
Unit rule
Product of the signal and kernel units.
Units
Product of the signal and kernel units.
Result fields
vector length
Provider
math.signal · SIGNAL_API_v1

Example of guided operation. x = B1:B4, kernel = B1:B2, value_real field. The result has five cells.

Back to the list

signal.correlation.auto

Computes the autocorrelation of the series over the lags according to the indicated convention.

Signature
signal.correlation.auto(x, y, unused, options)
Arguments
x y unused options
Technical descriptors
Show shapes and scopes by argument{name x shape vectors source cell,range,column,scalar,option} {name y shape action-specific source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
vectors
Unit rule
lags_samples_or_seconds
Units
lags_samples_or_seconds
Result fields
vector lags delay
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(1,2,3,4,3,2,1) . Press Preview fields. The results include value_real, value_imaginary, lags, delay_samples, n, n_x, n_y, lag_count.

Back to the list

signal.correlation.cross

Cross product of triples.

Signature
signal.correlation.cross(x, y, unused, options)
Arguments
x y unused options
Technical descriptors
Show shapes and scopes by argument{name x shape vectors source cell,range,column,scalar,option} {name y shape action-specific source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
vectors
Unit rule
lags_samples_or_seconds
Units
lags_samples_or_seconds
Result fields
vector lags delay
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1) , vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1). Press Preview fields. The results include value_real, value_imaginary, lags, delay_samples, n, n_x, n_y, lag_count.

Back to the list

signal.correlation.delay

Estimates a time shift according to the criterion of the operation.

Signature
signal.correlation.delay(x, y, unused, options)
Arguments
x y unused options
Technical descriptors
Show shapes and scopes by argument{name x shape vectors source cell,range,column,scalar,option} {name y shape action-specific source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
vectors
Unit rule
lags_samples_or_seconds
Units
lags_samples_or_seconds
Result fields
vector lags delay
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1) , vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1). Press Preview fields. The results include value_real, value_imaginary, lags, delay_samples, n, n_x, n_y, lag_count.

Back to the list

signal.design.bessel

Designs the Bessel filter, suited to cases where the passband phase matters.

Signature
signal.design.bessel(order, cutoff, ripple, options)
Arguments
order cutoff ripple options
Technical descriptors
Show shapes and scopes by argument{name order shape scalar source cell,range,column,scalar,option} {name cutoff shape scalar_or_pair source cell,range,column,scalar,option} {name ripple shape scalar source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
scalar;scalar_or_pair;scalar
Unit rule
cutoff_normalized_or_radians_per_second
Units
cutoff_normalized_or_radians_per_second
Result fields
coefficients poles SOS
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, 4, 0.25, 1. In Options use domain="analog". Press Preview fields. The results include numerator_real, numerator_imaginary, denominator_real, denominator_imaginary, poles_real, poles_imaginary, domain, stable.

Back to the list

signal.design.butterworth

Designs the Butterworth filter, with a monotonic amplitude response.

Signature
signal.design.butterworth(order, cutoff, ripple, options)
Arguments
order cutoff ripple options
Technical descriptors
Show shapes and scopes by argument{name order shape scalar source cell,range,column,scalar,option} {name cutoff shape scalar_or_pair source cell,range,column,scalar,option} {name ripple shape scalar source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
scalar;scalar_or_pair;scalar
Unit rule
cutoff_normalized_or_radians_per_second
Units
cutoff_normalized_or_radians_per_second
Result fields
coefficients poles SOS
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, 4, 0.25, 1. Press Preview fields. The results include numerator_real, numerator_imaginary, denominator_real, denominator_imaginary, poles_real, poles_imaginary, domain, stable.

Back to the list

signal.design.chebyshev1

Designs the Chebyshev type I filter, with ripple in the passband.

Signature
signal.design.chebyshev1(order, cutoff, ripple, options)
Arguments
order cutoff ripple options
Technical descriptors
Show shapes and scopes by argument{name order shape scalar source cell,range,column,scalar,option} {name cutoff shape scalar_or_pair source cell,range,column,scalar,option} {name ripple shape scalar source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
scalar;scalar_or_pair;scalar
Unit rule
cutoff_normalized_or_radians_per_second
Units
cutoff_normalized_or_radians_per_second
Result fields
coefficients poles SOS
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, 4, 0.25, 1. Press Preview fields. The results include numerator_real, numerator_imaginary, denominator_real, denominator_imaginary, poles_real, poles_imaginary, domain, stable.

Back to the list

signal.design.chebyshev2

Designs the Chebyshev type II filter, with ripple in the stopband.

Signature
signal.design.chebyshev2(order, cutoff, ripple, options)
Arguments
order cutoff ripple options
Technical descriptors
Show shapes and scopes by argument{name order shape scalar source cell,range,column,scalar,option} {name cutoff shape scalar_or_pair source cell,range,column,scalar,option} {name ripple shape scalar source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
scalar;scalar_or_pair;scalar
Unit rule
cutoff_normalized_or_radians_per_second
Units
cutoff_normalized_or_radians_per_second
Result fields
coefficients poles SOS
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, 4, 0.25, 35. Press Preview fields. The results include numerator_real, numerator_imaginary, denominator_real, denominator_imaginary, poles_real, poles_imaginary, domain, stable.

Back to the list

signal.design.elliptic

Designs the elliptic filter, with ripple in both bands.

Signature
signal.design.elliptic(order, cutoff, ripple, options)
Arguments
order cutoff ripple options
Technical descriptors
Show shapes and scopes by argument{name order shape scalar source cell,range,column,scalar,option} {name cutoff shape scalar_or_pair source cell,range,column,scalar,option} {name ripple shape scalar source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
scalar;scalar_or_pair;scalar
Unit rule
cutoff_normalized_or_radians_per_second
Units
cutoff_normalized_or_radians_per_second
Result fields
coefficients poles SOS
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, 4, 0.25, 1. Press Preview fields. The results include numerator_real, numerator_imaginary, denominator_real, denominator_imaginary, poles_real, poles_imaginary, domain, stable.

Back to the list

signal.design.estimate_order

Determines the filter order compatible with the declared band specifications.

Signature
signal.design.estimate_order(order, cutoff, ripple, options)
Arguments
order cutoff ripple options
Technical descriptors
Show shapes and scopes by argument{name order shape scalar source cell,range,column,scalar,option} {name cutoff shape scalar_or_pair source cell,range,column,scalar,option} {name ripple shape scalar source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
scalar;scalar_or_pair;scalar
Unit rule
cutoff_normalized_or_radians_per_second
Units
cutoff_normalized_or_radians_per_second
Result fields
coefficients poles SOS
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, 0.2, 0.35, 1. Press Preview fields. The results include order, cutoff.

Back to the list

signal.design.fir_window

Designs an FIR filter with the window method.

Signature
signal.design.fir_window(order, cutoff, ripple, options)
Arguments
order cutoff ripple options
Technical descriptors
Show shapes and scopes by argument{name order shape scalar source cell,range,column,scalar,option} {name cutoff shape scalar_or_pair source cell,range,column,scalar,option} {name ripple shape scalar source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
scalar;scalar_or_pair;scalar
Unit rule
cutoff_normalized_or_radians_per_second
Units
cutoff_normalized_or_radians_per_second
Result fields
coefficients poles SOS
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, 4, 0.25, 1. Press Preview fields. The results include numerator_real, numerator_imaginary, denominator_real, denominator_imaginary, poles_real, poles_imaginary, domain, stable.

Back to the list

signal.events.crossings

Finds crossings of the set level along ordered abscissas.

Signature
signal.events.crossings(time, samples, second_signal, options)
Arguments
time samples second_signal options
Technical descriptors
Show shapes and scopes by argument{name time shape increasing_vector source cell,range,column,scalar,option} {name samples shape real_vectors source cell,range,column,scalar,option} {name second_signal shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
increasing_vector;real_vectors
Unit rule
seconds
Units
seconds
Result fields
crossing_times delay
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(0,0.25,0.5,0.75,1,1.25,1.5,1.75,2,2.25,2.5,2.75,3,3.25,3.5,3.75), vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1), vector(3,2,1,2,3,2,1,2,3,2,1,2,3,2,1,2). In Options use level=2. Press Preview fields. The results include time, count.

Back to the list

signal.events.delay

Estimates a time shift according to the criterion of the operation.

Signature
signal.events.delay(time, samples, second_signal, options)
Arguments
time samples second_signal options
Technical descriptors
Show shapes and scopes by argument{name time shape increasing_vector source cell,range,column,scalar,option} {name samples shape real_vectors source cell,range,column,scalar,option} {name second_signal shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
increasing_vector;real_vectors
Unit rule
seconds
Units
seconds
Result fields
crossing_times delay
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. First bind time and voltage to columns A and B. Enter, in order, A1:A16, B1:B16, B1:B16. In Options use threshold=2.5. Press Preview fields. The results include delay_seconds.

Back to the list

signal.events.period

Estimates the duration of a cycle from the samples or the reference events.

Signature
signal.events.period(time, samples, second_signal, options)
Arguments
time samples second_signal options
Technical descriptors
Show shapes and scopes by argument{name time shape increasing_vector source cell,range,column,scalar,option} {name samples shape real_vectors source cell,range,column,scalar,option} {name second_signal shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
increasing_vector;real_vectors
Unit rule
seconds
Units
seconds
Result fields
crossing_times delay
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. First bind time and voltage to columns A and B. Enter, in order, A1:A16 , B1:B16. In Options use threshold=2.5. Press Preview fields. The results include n, crossing_count, period_count, method, period, frequency_hz, crossing_times.

Back to the list

signal.filter.causal

Applies the filter without using future samples for the current output.

Signature
signal.filter.causal(model, samples, state, options)
Arguments
model samples state options
Technical descriptors
Show shapes and scopes by argument{name model shape struct source cell,range,column,scalar,option} {name samples shape vector source cell,range,column,scalar,option} {name state shape vector source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
struct;vector;vector
Unit rule
preserve_signal_unit
Units
preserve_signal_unit
Result fields
vector state stability
Provider
math.signal · SIGNAL_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Example with the fields in positional order and in a cell. With a zero initial state you get 0.5, 2, 4, 6 and 8.

Back to the list

signal.filter.inspect

Shows the poles, order and stability indicator of the filter model.

Signature
signal.filter.inspect(model, samples, state, options)
Arguments
model samples state options
Technical descriptors
Show shapes and scopes by argument{name model shape struct source cell,range,column,scalar,option} {name samples shape vector source cell,range,column,scalar,option} {name state shape vector source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
struct;vector;vector
Unit rule
preserve_signal_unit
Units
preserve_signal_unit
Result fields
vector state stability
Provider
math.signal · SIGNAL_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Example with synthetic data. Enter, in order, record("numerator",vector(0.25,0.5,0.25),"denominator",1) , vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1). Press Preview fields. The results include poles_real, poles_imaginary, stable, order.

Back to the list

signal.filter.sos

Uses a cascade of second-order sections to represent or apply the filter.

Signature
signal.filter.sos(model, samples, state, options)
Arguments
model samples state options
Technical descriptors
Show shapes and scopes by argument{name model shape struct source cell,range,column,scalar,option} {name samples shape vector source cell,range,column,scalar,option} {name state shape vector source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
struct;vector;vector
Unit rule
preserve_signal_unit
Units
preserve_signal_unit
Result fields
vector state stability
Provider
math.signal · SIGNAL_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Example with synthetic data. Enter, in order, record("sos",matrix(vector(0.25,0.5,0.25,1,0,0),1,6)) , vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1). Press Preview fields. The results include value_real, value_imaginary, state_real, state_imaginary.

Back to the list

signal.filter.zero_phase

Applies the expected filtering to compensate for the phase shift.

Signature
signal.filter.zero_phase(model, samples, state, options)
Arguments
model samples state options
Technical descriptors
Show shapes and scopes by argument{name model shape struct source cell,range,column,scalar,option} {name samples shape vector source cell,range,column,scalar,option} {name state shape vector source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
struct;vector;vector
Unit rule
preserve_signal_unit
Units
preserve_signal_unit
Result fields
vector state stability
Provider
math.signal · SIGNAL_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Example with synthetic data. Enter, in order, record("numerator",vector(0.25,0.5,0.25),"denominator",1) , vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1). Press Preview fields. The results include value_real, value_imaginary.

Back to the list

signal.frequency_metric.bandwidth

Estimates the bandwidth according to the characteristic frequencies and the selected threshold rule.

Signature
signal.frequency_metric.bandwidth(frequency, response, unused, options)
Arguments
frequency response unused options
Technical descriptors
Show shapes and scopes by argument{name frequency shape increasing_vector source cell,range,column,scalar,option} {name response shape complex_vector source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
increasing_vector;complex_vector
Unit rule
Hz;seconds;dB;dimensionless
Units
Hz;seconds;dB;dimensionless
Result fields
metrics
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(1,2,3,4,5) , vector(0.3,0.8,1,0.8,0.3). Press Preview fields. The results include lower_3db_hz, upper_3db_hz, bandwidth_hz, peak_frequency_hz, q.

Back to the list

signal.frequency_metric.gain

Derives the gain from the system response.

Signature
signal.frequency_metric.gain(frequency, response, unused, options)
Arguments
frequency response unused options
Technical descriptors
Show shapes and scopes by argument{name frequency shape increasing_vector source cell,range,column,scalar,option} {name response shape complex_vector source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
increasing_vector;complex_vector
Unit rule
Hz;seconds;dB;dimensionless
Units
Hz;seconds;dB;dimensionless
Result fields
metrics
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(0,0.25,0.5,1,2) , complex(vector(1,0.8,0.5,0.25,0.1),vector(0,-0.3,-0.45,-0.35,-0.2)). Press Preview fields. The results include magnitude, gain_db, phase_rad.

Back to the list

signal.frequency_metric.group_delay

Group delay from the phase as a function of frequency.

Signature
signal.frequency_metric.group_delay(frequency, response, unused, options)
Arguments
frequency response unused options
Technical descriptors
Show shapes and scopes by argument{name frequency shape increasing_vector source cell,range,column,scalar,option} {name response shape complex_vector source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
increasing_vector;complex_vector
Unit rule
Hz;seconds;dB;dimensionless
Units
Hz;seconds;dB;dimensionless
Result fields
metrics
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(0,0.25,0.5,1,2) , complex(vector(1,0.8,0.5,0.25,0.1),vector(0,-0.3,-0.45,-0.35,-0.2)). Press Preview fields. The results include delay_seconds.

Back to the list

signal.frequency_metric.margins

Estimates the stability margins from the frequency response.

Signature
signal.frequency_metric.margins(frequency, response, unused, options)
Arguments
frequency response unused options
Technical descriptors
Show shapes and scopes by argument{name frequency shape increasing_vector source cell,range,column,scalar,option} {name response shape complex_vector source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
increasing_vector;complex_vector
Unit rule
Hz;seconds;dB;dimensionless
Units
Hz;seconds;dB;dimensionless
Result fields
metrics
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(0,0.25,0.5,1,2) , complex(vector(1,0.8,0.5,0.25,0.1),vector(0,-0.3,-0.45,-0.35,-0.2)). Press Preview fields. The results include gain_crossover_hz, phase_margin_deg.

Back to the list

signal.frequency_metric.peak

Derives the peak according to the indicated criterion and interval.

Signature
signal.frequency_metric.peak(frequency, response, unused, options)
Arguments
frequency response unused options
Technical descriptors
Show shapes and scopes by argument{name frequency shape increasing_vector source cell,range,column,scalar,option} {name response shape complex_vector source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
increasing_vector;complex_vector
Unit rule
Hz;seconds;dB;dimensionless
Units
Hz;seconds;dB;dimensionless
Result fields
metrics
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(0,0.25,0.5,1,2) , complex(vector(1,0.8,0.5,0.25,0.1),vector(0,-0.3,-0.45,-0.35,-0.2)). Press Preview fields. The results include peak_frequency_hz, peak_magnitude, peak_db.

Back to the list

signal.frequency_metric.phase_delay

Derives the phase delay from the requested phases and frequencies.

Signature
signal.frequency_metric.phase_delay(frequency, response, unused, options)
Arguments
frequency response unused options
Technical descriptors
Show shapes and scopes by argument{name frequency shape increasing_vector source cell,range,column,scalar,option} {name response shape complex_vector source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
increasing_vector;complex_vector
Unit rule
Hz;seconds;dB;dimensionless
Units
Hz;seconds;dB;dimensionless
Result fields
metrics
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(1,2,3,4,5) , complex(vector(1,1,1,1,1),vector(0,-0.1,-0.2,-0.3,-0.4)). Press Preview fields. The results include delay_seconds.

Back to the list

signal.frequency_metric.q

Computes the quality factor from the ratio between characteristic frequency and bandwidth.

Signature
signal.frequency_metric.q(frequency, response, unused, options)
Arguments
frequency response unused options
Technical descriptors
Show shapes and scopes by argument{name frequency shape increasing_vector source cell,range,column,scalar,option} {name response shape complex_vector source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
increasing_vector;complex_vector
Unit rule
Hz;seconds;dB;dimensionless
Units
Hz;seconds;dB;dimensionless
Result fields
metrics
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(1,2,3,4,5) , vector(0.3,0.8,1,0.8,0.3). Press Preview fields. The results include lower_3db_hz, upper_3db_hz, bandwidth_hz, peak_frequency_hz, q.

Back to the list

signal.frequency_metric.resonance

Finds or characterizes a resonance peak.

Signature
signal.frequency_metric.resonance(frequency, response, unused, options)
Arguments
frequency response unused options
Technical descriptors
Show shapes and scopes by argument{name frequency shape increasing_vector source cell,range,column,scalar,option} {name response shape complex_vector source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
increasing_vector;complex_vector
Unit rule
Hz;seconds;dB;dimensionless
Units
Hz;seconds;dB;dimensionless
Result fields
metrics
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(0,0.25,0.5,1,2) , complex(vector(1,0.8,0.5,0.25,0.1),vector(0,-0.3,-0.45,-0.35,-0.2)). Press Preview fields. The results include peak_frequency_hz, peak_magnitude, peak_db.

Back to the list

signal.generate.am

Generates an amplitude-modulated signal.

Signature
signal.generate.am(time, frequency, modulation, options)
Arguments
time frequency modulation options
Technical descriptors
Show shapes and scopes by argument{name time shape increasing_time_vector source cell,range,column,scalar,option} {name frequency shape scalars_or_frequency_vector source cell,range,column,scalar,option} {name modulation shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
increasing_time_vector;scalars_or_frequency_vector
Unit rule
caller_declared
Units
caller_declared
Result fields
generated_samples time
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(0,0.25,0.5,0.75,1,1.25,1.5,1.75,2,2.25,2.5,2.75,3,3.25,3.5,3.75), 0.5, 0.125. Press Preview fields. The results include value_real, value_imaginary, time.

Back to the list

signal.generate.chirp

Generates a signal whose frequency varies over time.

Signature
signal.generate.chirp(time, frequency, modulation, options)
Arguments
time frequency modulation options
Technical descriptors
Show shapes and scopes by argument{name time shape increasing_time_vector source cell,range,column,scalar,option} {name frequency shape scalars_or_frequency_vector source cell,range,column,scalar,option} {name modulation shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
increasing_time_vector;scalars_or_frequency_vector
Unit rule
caller_declared
Units
caller_declared
Result fields
generated_samples time
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(0,0.25,0.5,0.75,1,1.25,1.5,1.75,2,2.25,2.5,2.75,3,3.25,3.5,3.75), 0.5, 1.5. Press Preview fields. The results include value_real, value_imaginary, time.

Back to the list

signal.generate.colored_noise

Generates noise with the chosen spectral distribution.

Signature
signal.generate.colored_noise(time, frequency, modulation, options)
Arguments
time frequency modulation options
Technical descriptors
Show shapes and scopes by argument{name time shape increasing_time_vector source cell,range,column,scalar,option} {name frequency shape scalars_or_frequency_vector source cell,range,column,scalar,option} {name modulation shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
increasing_time_vector;scalars_or_frequency_vector
Unit rule
caller_declared
Units
caller_declared
Result fields
generated_samples time
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(0,0.25,0.5,0.75,1,1.25,1.5,1.75,2,2.25,2.5,2.75,3,3.25,3.5,3.75), 0.5, 0.125. In Options use seed=31. Press Preview fields. The results include value_real, value_imaginary, time.

Back to the list

signal.generate.fm

Generates a frequency-modulated signal.

Signature
signal.generate.fm(time, frequency, modulation, options)
Arguments
time frequency modulation options
Technical descriptors
Show shapes and scopes by argument{name time shape increasing_time_vector source cell,range,column,scalar,option} {name frequency shape scalars_or_frequency_vector source cell,range,column,scalar,option} {name modulation shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
increasing_time_vector;scalars_or_frequency_vector
Unit rule
caller_declared
Units
caller_declared
Result fields
generated_samples time
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(0,0.25,0.5,0.75,1,1.25,1.5,1.75,2,2.25,2.5,2.75,3,3.25,3.5,3.75), 0.5, 0.125. Press Preview fields. The results include value_real, value_imaginary, time.

Back to the list

signal.generate.impulse

Generates an impulse sample or computes the impulse response of the system indicated by the entry.

Signature
signal.generate.impulse(time, frequency, modulation, options)
Arguments
time frequency modulation options
Technical descriptors
Show shapes and scopes by argument{name time shape increasing_time_vector source cell,range,column,scalar,option} {name frequency shape scalars_or_frequency_vector source cell,range,column,scalar,option} {name modulation shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
increasing_time_vector;scalars_or_frequency_vector
Unit rule
caller_declared
Units
caller_declared
Result fields
generated_samples time
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(0,0.25,0.5,0.75,1,1.25,1.5,1.75,2,2.25,2.5,2.75,3,3.25,3.5,3.75), 0.5, 0.125. Press Preview fields. The results include value_real, value_imaginary, time.

Back to the list

signal.generate.multi_tone

Sums sinusoidal tones at the requested frequencies and amplitudes.

Signature
signal.generate.multi_tone(time, frequency, modulation, options)
Arguments
time frequency modulation options
Technical descriptors
Show shapes and scopes by argument{name time shape increasing_time_vector source cell,range,column,scalar,option} {name frequency shape scalars_or_frequency_vector source cell,range,column,scalar,option} {name modulation shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
increasing_time_vector;scalars_or_frequency_vector
Unit rule
caller_declared
Units
caller_declared
Result fields
generated_samples time
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(0,0.25,0.5,0.75,1,1.25,1.5,1.75,2,2.25,2.5,2.75,3,3.25,3.5,3.75) , vector(0.5,1). Press Preview fields. The results include value_real, value_imaginary, time.

Back to the list

signal.generate.pulse

Describes or generates a pulse according to the selected family.

Signature
signal.generate.pulse(time, frequency, modulation, options)
Arguments
time frequency modulation options
Technical descriptors
Show shapes and scopes by argument{name time shape increasing_time_vector source cell,range,column,scalar,option} {name frequency shape scalars_or_frequency_vector source cell,range,column,scalar,option} {name modulation shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
increasing_time_vector;scalars_or_frequency_vector
Unit rule
caller_declared
Units
caller_declared
Result fields
generated_samples time
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(0,0.25,0.5,0.75,1,1.25,1.5,1.75,2,2.25,2.5,2.75,3,3.25,3.5,3.75), 0.5, 0.125. Press Preview fields. The results include value_real, value_imaginary, time.

Back to the list

signal.generate.sine

Generates a sinusoid on the requested grid.

Signature
signal.generate.sine(time, frequency, modulation, options)
Arguments
time frequency modulation options
Technical descriptors
Show shapes and scopes by argument{name time shape increasing_time_vector source cell,range,column,scalar,option} {name frequency shape scalars_or_frequency_vector source cell,range,column,scalar,option} {name modulation shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
increasing_time_vector;scalars_or_frequency_vector
Unit rule
caller_declared
Units
caller_declared
Result fields
generated_samples time
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(0,0.25,0.5,0.75,1,1.25,1.5,1.75,2,2.25,2.5,2.75,3,3.25,3.5,3.75), 0.5, 0.125. Press Preview fields. The results include value_real, value_imaginary, time.

Back to the list

signal.generate.square

Square.

Signature
signal.generate.square(time, frequency, modulation, options)
Arguments
time frequency modulation options
Technical descriptors
Show shapes and scopes by argument{name time shape increasing_time_vector source cell,range,column,scalar,option} {name frequency shape scalars_or_frequency_vector source cell,range,column,scalar,option} {name modulation shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
increasing_time_vector;scalars_or_frequency_vector
Unit rule
caller_declared
Units
caller_declared
Result fields
generated_samples time
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(0,0.25,0.5,0.75,1,1.25,1.5,1.75,2,2.25,2.5,2.75,3,3.25,3.5,3.75), 0.5, 0.125. Press Preview fields. The results include value_real, value_imaginary, time.

Back to the list

signal.generate.white_noise

Generates white noise with the set parameters and seed, if any.

Signature
signal.generate.white_noise(time, frequency, modulation, options)
Arguments
time frequency modulation options
Technical descriptors
Show shapes and scopes by argument{name time shape increasing_time_vector source cell,range,column,scalar,option} {name frequency shape scalars_or_frequency_vector source cell,range,column,scalar,option} {name modulation shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
increasing_time_vector;scalars_or_frequency_vector
Unit rule
caller_declared
Units
caller_declared
Result fields
generated_samples time
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(0,0.25,0.5,0.75,1,1.25,1.5,1.75,2,2.25,2.5,2.75,3,3.25,3.5,3.75), 0.5, 0.125. In Options use seed=31. Press Preview fields. The results include value_real, value_imaginary, time.

Back to the list

signal.lti.foh

Discretizes the model using first-order interpolation between samples.

Signature
signal.lti.foh(model, unused, unused, options)
Arguments
model unused unused options
Technical descriptors
Show shapes and scopes by argument{name model shape TF_ZPK_or_SS_struct source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
TF_ZPK_or_SS_struct
Unit rule
explicit_sample_period_seconds
Units
explicit_sample_period_seconds
Result fields
coefficients state_matrices poles
Provider
math.signal · SIGNAL_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Example with synthetic data. Enter, in order, record("kind","tf","numerator",1,"denominator",vector(1,1)) . In Options use sample_period=0.1. Press Preview fields. The results include numerator_real, numerator_imaginary, denominator_real, denominator_imaginary, sample_period.

Back to the list

signal.lti.inspect

Shows poles, zeros, stability and, if available, the DC response value for the LTI system.

Signature
signal.lti.inspect(model, unused, unused, options)
Arguments
model unused unused options
Technical descriptors
Show shapes and scopes by argument{name model shape TF_ZPK_or_SS_struct source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
TF_ZPK_or_SS_struct
Unit rule
explicit_sample_period_seconds
Units
explicit_sample_period_seconds
Result fields
coefficients state_matrices poles
Provider
math.signal · SIGNAL_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Example with synthetic data. Enter, in order, record("kind","tf","numerator",1,"denominator",vector(1,1)) . Press Preview fields. The results include poles_real, poles_imaginary, zeros_real, zeros_imaginary, stable, dc_gain_defined, dc_gain_real, dc_gain_imaginary.

Back to the list

signal.lti.matched

Uses pole and zero matching between the indicated domains.

Signature
signal.lti.matched(model, unused, unused, options)
Arguments
model unused unused options
Technical descriptors
Show shapes and scopes by argument{name model shape TF_ZPK_or_SS_struct source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
TF_ZPK_or_SS_struct
Unit rule
explicit_sample_period_seconds
Units
explicit_sample_period_seconds
Result fields
coefficients state_matrices poles
Provider
math.signal · SIGNAL_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Example with synthetic data. Enter, in order, record("kind","tf","numerator",1,"denominator",vector(1,1)) . In Options use sample_period=0.1. Press Preview fields. The results include numerator_real, numerator_imaginary, denominator_real, denominator_imaginary, sample_period.

Back to the list

signal.lti.prewarp

Prewarps the frequency distortion of the bilinear transformation at the declared value.

Signature
signal.lti.prewarp(model, unused, unused, options)
Arguments
model unused unused options
Technical descriptors
Show shapes and scopes by argument{name model shape TF_ZPK_or_SS_struct source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
TF_ZPK_or_SS_struct
Unit rule
explicit_sample_period_seconds
Units
explicit_sample_period_seconds
Result fields
coefficients state_matrices poles
Provider
math.signal · SIGNAL_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Example with synthetic data. Enter, in order, record("kind","tf","numerator",1,"denominator",vector(1,1)) . In Options use sample_period=0.1 prewarp_hz=0.5. Press Preview fields. The results include numerator_real, numerator_imaginary, denominator_real, denominator_imaginary, sample_period.

Back to the list

signal.lti.ss

Represents a system in state space.

Signature
signal.lti.ss(model, unused, unused, options)
Arguments
model unused unused options
Technical descriptors
Show shapes and scopes by argument{name model shape TF_ZPK_or_SS_struct source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
TF_ZPK_or_SS_struct
Unit rule
explicit_sample_period_seconds
Units
explicit_sample_period_seconds
Result fields
coefficients state_matrices poles
Provider
math.signal · SIGNAL_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Example with synthetic data. Enter, in order, record("kind","tf","numerator",1,"denominator",vector(1,1)) . Press Preview fields. The results include A_real, A_imaginary, B_real, B_imaginary, C_real, C_imaginary, D_real, D_imaginary.

Back to the list

signal.lti.tf

Represents a system through its transfer function.

Signature
signal.lti.tf(model, unused, unused, options)
Arguments
model unused unused options
Technical descriptors
Show shapes and scopes by argument{name model shape TF_ZPK_or_SS_struct source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
TF_ZPK_or_SS_struct
Unit rule
explicit_sample_period_seconds
Units
explicit_sample_period_seconds
Result fields
coefficients state_matrices poles
Provider
math.signal · SIGNAL_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Example with synthetic data. Enter, in order, record("kind","tf","numerator",1,"denominator",vector(1,1)) . Press Preview fields. The results include numerator_real, numerator_imaginary, denominator_real, denominator_imaginary.

Back to the list

signal.lti.tustin

Discretizes the model with the bilinear transformation.

Signature
signal.lti.tustin(model, unused, unused, options)
Arguments
model unused unused options
Technical descriptors
Show shapes and scopes by argument{name model shape TF_ZPK_or_SS_struct source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
TF_ZPK_or_SS_struct
Unit rule
explicit_sample_period_seconds
Units
explicit_sample_period_seconds
Result fields
coefficients state_matrices poles
Provider
math.signal · SIGNAL_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Example with synthetic data. Enter, in order, record("kind","tf","numerator",1,"denominator",vector(1,1)) . In Options use sample_period=0.1. Press Preview fields. The results include numerator_real, numerator_imaginary, denominator_real, denominator_imaginary, sample_period.

Back to the list

signal.lti.zoh

Discretizes the model holding the input constant between samples.

Signature
signal.lti.zoh(model, unused, unused, options)
Arguments
model unused unused options
Technical descriptors
Show shapes and scopes by argument{name model shape TF_ZPK_or_SS_struct source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
TF_ZPK_or_SS_struct
Unit rule
explicit_sample_period_seconds
Units
explicit_sample_period_seconds
Result fields
coefficients state_matrices poles
Provider
math.signal · SIGNAL_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Example with synthetic data. Enter, in order, record("kind","tf","numerator",1,"denominator",vector(1,1)) . In Options use sample_period=0.1. Press Preview fields. The results include numerator_real, numerator_imaginary, denominator_real, denominator_imaginary, sample_period.

Back to the list

signal.lti.zpk

Represents a system with zeros, poles and gain.

Signature
signal.lti.zpk(model, unused, unused, options)
Arguments
model unused unused options
Technical descriptors
Show shapes and scopes by argument{name model shape TF_ZPK_or_SS_struct source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
TF_ZPK_or_SS_struct
Unit rule
explicit_sample_period_seconds
Units
explicit_sample_period_seconds
Result fields
coefficients state_matrices poles
Provider
math.signal · SIGNAL_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Example with synthetic data. Enter, in order, record("kind","tf","numerator",1,"denominator",vector(1,1)) . Press Preview fields. The results include zeros_real, zeros_imaginary, poles_real, poles_imaginary, gain_real, gain_imaginary.

Back to the list

signal.multirate.decimate

Reduces the sampling frequency by the indicated integer factor.

Signature
signal.multirate.decimate(samples, up_factor, down_factor, options)
Arguments
samples up_factor down_factor options
Technical descriptors
Show shapes and scopes by argument{name samples shape vector source cell,range,column,scalar,option} {name up_factor shape integers source cell,range,column,scalar,option} {name down_factor shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
vector;integers
Unit rule
preserve_signal_unit
Units
preserve_signal_unit
Result fields
vector time sample_rate
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(0,1,2,3,4,5,6,7,0,1,2,3,4,5,6,7,0,1,2,3,4,5,6,7,0,1,2,3,4,5,6,7) , 2. In Options use sample_rate=8. Press Preview fields. The results include value_real, value_imaginary, up_factor, down_factor, output_sample_rate, time.

Back to the list

signal.multirate.interpolate

Interpolated evaluation at the requested points.

Signature
signal.multirate.interpolate(samples, up_factor, down_factor, options)
Arguments
samples up_factor down_factor options
Technical descriptors
Show shapes and scopes by argument{name samples shape vector source cell,range,column,scalar,option} {name up_factor shape integers source cell,range,column,scalar,option} {name down_factor shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
vector;integers
Unit rule
preserve_signal_unit
Units
preserve_signal_unit
Result fields
vector time sample_rate
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1), 2, 2. Press Preview fields. The results include value_real, value_imaginary, up_factor, down_factor.

Back to the list

signal.multirate.rational

Resamples by a rational frequency ratio.

Signature
signal.multirate.rational(samples, up_factor, down_factor, options)
Arguments
samples up_factor down_factor options
Technical descriptors
Show shapes and scopes by argument{name samples shape vector source cell,range,column,scalar,option} {name up_factor shape integers source cell,range,column,scalar,option} {name down_factor shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
vector;integers
Unit rule
preserve_signal_unit
Units
preserve_signal_unit
Result fields
vector time sample_rate
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1), 2, 2. Press Preview fields. The results include value_real, value_imaginary, up_factor, down_factor.

Back to the list

signal.quality.basic

Returns basic statistics on the signal, including samples and amplitudes.

Signature
signal.quality.basic(samples, noise, sample_rate, options)
Arguments
samples noise sample_rate options
Technical descriptors
Show shapes and scopes by argument{name samples shape vectors source cell,range,column,scalar,option} {name noise shape positive_scalar source cell,range,column,scalar,option} {name sample_rate shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
vectors;positive_scalar
Unit rule
signal_unit;dB;bits
Units
signal_unit;dB;bits
Result fields
metrics
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1), vector(0.1,-0.1,0.15,-0.2,0.1,-0.1,0.15,-0.2,0.1,-0.1,0.15,-0.2,0.1,-0.1,0.15,-0.2), 4. Press Preview fields. The results include n, rms, peak, peak_to_peak, crest_factor, dc_real, dc_imaginary, input_kind.

Back to the list

signal.quality.harmonics

Measures the harmonic components at the fundamental frequency and its multiples.

Signature
signal.quality.harmonics(samples, noise, sample_rate, options)
Arguments
samples noise sample_rate options
Technical descriptors
Show shapes and scopes by argument{name samples shape vectors source cell,range,column,scalar,option} {name noise shape positive_scalar source cell,range,column,scalar,option} {name sample_rate shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
vectors;positive_scalar
Unit rule
signal_unit;dB;bits
Units
signal_unit;dB;bits
Result fields
metrics
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1), empty(), 4. In Options use fundamental_hz=1. Press Preview fields. The results include n, sample_rate, fundamental_hz, fundamental_bin, harmonic_orders, method, normalization, fundamental_power.

Back to the list

signal.quality.snr

Estimates the signal-to-noise ratio according to the chosen regions and normalization.

Signature
signal.quality.snr(samples, noise, sample_rate, options)
Arguments
samples noise sample_rate options
Technical descriptors
Show shapes and scopes by argument{name samples shape vectors source cell,range,column,scalar,option} {name noise shape positive_scalar source cell,range,column,scalar,option} {name sample_rate shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
vectors;positive_scalar
Unit rule
signal_unit;dB;bits
Units
signal_unit;dB;bits
Result fields
metrics
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1), vector(0.1,-0.1,0.15,-0.2,0.1,-0.1,0.15,-0.2,0.1,-0.1,0.15,-0.2,0.1,-0.1,0.15,-0.2), 4. Press Preview fields. The results include n, snr_db, signal_energy, noise_energy, signal_zero, noise_zero, method.

Back to the list

signal.quality.spectrum

Computes a representation of the frequency content.

Signature
signal.quality.spectrum(samples, noise, sample_rate, options)
Arguments
samples noise sample_rate options
Technical descriptors
Show shapes and scopes by argument{name samples shape vectors source cell,range,column,scalar,option} {name noise shape positive_scalar source cell,range,column,scalar,option} {name sample_rate shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
vectors;positive_scalar
Unit rule
signal_unit;dB;bits
Units
signal_unit;dB;bits
Result fields
metrics
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1), empty(), 4. In Options use fundamental_hz=1. Press Preview fields. The results include n, sample_rate, fundamental_hz, fundamental_bin, harmonic_orders, method, normalization, fundamental_power.

Back to the list

signal.response.evaluate

Evaluates the transfer function at the specified points of the complex plane.

Signature
signal.response.evaluate(model, axis, input, options)
Arguments
model axis input options
Technical descriptors
Show shapes and scopes by argument{name model shape model source cell,range,column,scalar,option} {name axis shape vector source cell,range,column,scalar,option} {name input shape optional_vector_or_matrix source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
model;vector;optional_vector_or_matrix
Unit rule
Hz_or_seconds
Units
Hz_or_seconds
Result fields
vector_or_frequency_by_output_by_input
Provider
math.signal · SIGNAL_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Example with synthetic data. Enter, in order, record("kind","tf","numerator",1,"denominator",vector(1,1)) , vector(0,0.25,0.5,1,2). Press Preview fields. The results include value_real, value_imaginary.

Back to the list

signal.response.frequency

Evaluates the transfer function response on the frequency grid in hertz.

Signature
signal.response.frequency(model, axis, input, options)
Arguments
model axis input options
Technical descriptors
Show shapes and scopes by argument{name model shape model source cell,range,column,scalar,option} {name axis shape vector source cell,range,column,scalar,option} {name input shape optional_vector_or_matrix source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
model;vector;optional_vector_or_matrix
Unit rule
Hz_or_seconds
Units
Hz_or_seconds
Result fields
vector_or_frequency_by_output_by_input
Provider
math.signal · SIGNAL_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Example with synthetic data. Enter, in order, record("kind","tf","numerator",1,"denominator",vector(1,1)) , vector(0,0.25,0.5,1,2). Press Preview fields. The results include value_real, value_imaginary, magnitude, phase_rad, frequency_hz, group_delay_seconds.

Back to the list

signal.response.impulse

Generates an impulse sample or computes the impulse response of the system indicated by the entry.

Signature
signal.response.impulse(model, axis, input, options)
Arguments
model axis input options
Technical descriptors
Show shapes and scopes by argument{name model shape model source cell,range,column,scalar,option} {name axis shape vector source cell,range,column,scalar,option} {name input shape optional_vector_or_matrix source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
model;vector;optional_vector_or_matrix
Unit rule
Hz_or_seconds
Units
Hz_or_seconds
Result fields
vector_or_frequency_by_output_by_input
Provider
math.signal · SIGNAL_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Example with synthetic data. Enter, in order, record("kind","tf","numerator",1,"denominator",vector(1,1)) , vector(0,0.25,0.5,0.75,1,1.25,1.5,1.75,2,2.25,2.5,2.75,3,3.25,3.5,3.75). Press Preview fields. The results include value_real, value_imaginary, time.

Back to the list

signal.response.input

Computes the time response of the system to the sampled input you provide.

Signature
signal.response.input(model, axis, input, options)
Arguments
model axis input options
Technical descriptors
Show shapes and scopes by argument{name model shape model source cell,range,column,scalar,option} {name axis shape vector source cell,range,column,scalar,option} {name input shape optional_vector_or_matrix source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
model;vector;optional_vector_or_matrix
Unit rule
Hz_or_seconds
Units
Hz_or_seconds
Result fields
vector_or_frequency_by_output_by_input
Provider
math.signal · SIGNAL_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

In-cell example for a first-order system with constant input.

Back to the list

signal.response.step

Computes the time response of the system to a step input.

Signature
signal.response.step(model, axis, input, options)
Arguments
model axis input options
Technical descriptors
Show shapes and scopes by argument{name model shape model source cell,range,column,scalar,option} {name axis shape vector source cell,range,column,scalar,option} {name input shape optional_vector_or_matrix source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
model;vector;optional_vector_or_matrix
Unit rule
Hz_or_seconds
Units
Hz_or_seconds
Result fields
vector_or_frequency_by_output_by_input
Provider
math.signal · SIGNAL_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Example with synthetic data. Enter, in order, record("kind","tf","numerator",1,"denominator",vector(1,1)) , vector(0,0.25,0.5,0.75,1,1.25,1.5,1.75,2,2.25,2.5,2.75,3,3.25,3.5,3.75). Press Preview fields. The results include value_real, value_imaginary, time.

Back to the list

signal.spectral.asd

Computes the amplitude spectral density, as the square root of the power density.

Signature
signal.spectral.asd(samples, second_signal, sample_rate, options)
Arguments
samples second_signal sample_rate options
Technical descriptors
Show shapes and scopes by argument{name samples shape vectors source cell,range,column,scalar,option} {name second_signal shape positive_scalar source cell,range,column,scalar,option} {name sample_rate shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
vectors;positive_scalar
Unit rule
Hz;signal_squared_per_Hz
Units
Hz;signal_squared_per_Hz
Result fields
frequency_vector PSD_ASD_or_FRF
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1), empty(), 4. Press Preview fields. The results include n, sample_rate, fft_length, bin_count, window_length, overlap_samples, window_count, used_sample_count.

Back to the list

signal.spectral.coherence

Estimates the coherence between two aligned signals as a function of frequency.

Signature
signal.spectral.coherence(samples, second_signal, sample_rate, options)
Arguments
samples second_signal sample_rate options
Technical descriptors
Show shapes and scopes by argument{name samples shape vectors source cell,range,column,scalar,option} {name second_signal shape positive_scalar source cell,range,column,scalar,option} {name sample_rate shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
vectors;positive_scalar
Unit rule
Hz;signal_squared_per_Hz
Units
Hz;signal_squared_per_Hz
Result fields
frequency_vector PSD_ASD_or_FRF
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1), vector(3,2,1,2,3,2,1,2,3,2,1,2,3,2,1,2), 4. Press Preview fields. The results include n, sample_rate, fft_length, bin_count, window_length, overlap_samples, window_count, used_sample_count.

Back to the list

signal.spectral.cross_psd

Estimates the cross spectral density between two signals.

Signature
signal.spectral.cross_psd(samples, second_signal, sample_rate, options)
Arguments
samples second_signal sample_rate options
Technical descriptors
Show shapes and scopes by argument{name samples shape vectors source cell,range,column,scalar,option} {name second_signal shape positive_scalar source cell,range,column,scalar,option} {name sample_rate shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
vectors;positive_scalar
Unit rule
Hz;signal_squared_per_Hz
Units
Hz;signal_squared_per_Hz
Result fields
frequency_vector PSD_ASD_or_FRF
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1), vector(3,2,1,2,3,2,1,2,3,2,1,2,3,2,1,2), 4. Press Preview fields. The results include n, sample_rate, fft_length, bin_count, window_length, overlap_samples, window_count, used_sample_count.

Back to the list

signal.spectral.frf_h1

Estimates the H1 frequency response function from the input and output spectra.

Signature
signal.spectral.frf_h1(samples, second_signal, sample_rate, options)
Arguments
samples second_signal sample_rate options
Technical descriptors
Show shapes and scopes by argument{name samples shape vectors source cell,range,column,scalar,option} {name second_signal shape positive_scalar source cell,range,column,scalar,option} {name sample_rate shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
vectors;positive_scalar
Unit rule
Hz;signal_squared_per_Hz
Units
Hz;signal_squared_per_Hz
Result fields
frequency_vector PSD_ASD_or_FRF
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1), vector(3,2,1,2,3,2,1,2,3,2,1,2,3,2,1,2), 4. Press Preview fields. The results include n, sample_rate, fft_length, bin_count, window_length, overlap_samples, window_count, used_sample_count.

Back to the list

signal.spectral.frf_h2

Estimates the H2 frequency response function with the corresponding spectral normalization.

Signature
signal.spectral.frf_h2(samples, second_signal, sample_rate, options)
Arguments
samples second_signal sample_rate options
Technical descriptors
Show shapes and scopes by argument{name samples shape vectors source cell,range,column,scalar,option} {name second_signal shape positive_scalar source cell,range,column,scalar,option} {name sample_rate shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
vectors;positive_scalar
Unit rule
Hz;signal_squared_per_Hz
Units
Hz;signal_squared_per_Hz
Result fields
frequency_vector PSD_ASD_or_FRF
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1), vector(3,2,1,2,3,2,1,2,3,2,1,2,3,2,1,2), 4. Press Preview fields. The results include n, sample_rate, fft_length, bin_count, window_length, overlap_samples, window_count, used_sample_count.

Back to the list

signal.spectral.periodogram

Estimates the power spectral density from a transform of the segment.

Signature
signal.spectral.periodogram(samples, second_signal, sample_rate, options)
Arguments
samples second_signal sample_rate options
Technical descriptors
Show shapes and scopes by argument{name samples shape vectors source cell,range,column,scalar,option} {name second_signal shape positive_scalar source cell,range,column,scalar,option} {name sample_rate shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
vectors;positive_scalar
Unit rule
Hz;signal_squared_per_Hz
Units
Hz;signal_squared_per_Hz
Result fields
frequency_vector PSD_ASD_or_FRF
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1), empty(), 4. Press Preview fields. The results include n, sample_rate, fft_length, bin_count, window_length, overlap_samples, window_count, used_sample_count.

Back to the list

signal.spectral.welch

Estimates the average spectral density over windowed, overlapping segments.

Signature
signal.spectral.welch(samples, second_signal, sample_rate, options)
Arguments
samples second_signal sample_rate options
Technical descriptors
Show shapes and scopes by argument{name samples shape vectors source cell,range,column,scalar,option} {name second_signal shape positive_scalar source cell,range,column,scalar,option} {name sample_rate shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
vectors;positive_scalar
Unit rule
Hz;signal_squared_per_Hz
Units
Hz;signal_squared_per_Hz
Result fields
frequency_vector PSD_ASD_or_FRF
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1), empty(), 4. Press Preview fields. The results include n, sample_rate, fft_length, bin_count, window_length, overlap_samples, window_count, used_sample_count.

Back to the list

signal.spectral.window_metrics

Describes the window properties, including the equivalent response when exposed.

Signature
signal.spectral.window_metrics(samples, second_signal, sample_rate, options)
Arguments
samples second_signal sample_rate options
Technical descriptors
Show shapes and scopes by argument{name samples shape vectors source cell,range,column,scalar,option} {name second_signal shape positive_scalar source cell,range,column,scalar,option} {name sample_rate shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
vectors;positive_scalar
Unit rule
Hz;signal_squared_per_Hz
Units
Hz;signal_squared_per_Hz
Result fields
frequency_vector PSD_ASD_or_FRF
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(0,0.25,0.75,1,0.75,0.25,0), empty(), 4. Press Preview fields. The results include n, sample_rate, coherent_gain, power_gain, equivalent_noise_bandwidth_hz, method.

Back to the list

signal.stft.forward

Computes the short-time transform with the requested window and hop size.

Signature
signal.stft.forward(samples_or_STFT, window, hop, options)
Arguments
samples_or_STFT window hop options
Technical descriptors
Show shapes and scopes by argument{name samples_or_STFT shape vector_or_matrix source cell,range,column,scalar,option} {name window shape vector source cell,range,column,scalar,option} {name hop shape integer source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
vector_or_matrix;vector;integer
Unit rule
sample_bins_or_Hz_seconds
Units
sample_bins_or_Hz_seconds
Result fields
matrix axes reconstruction
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1), vector(0.25,1,1,0.25), 2. In Options use sample_rate=4. Press Preview fields. The results include value_real, value_imaginary, sample_positions, frequency_bins, pad_left, pad_right, original_length, time_seconds.

Back to the list

signal.stft.inverse

Reconstructs the series from the STFT columns using a consistent window and hop. Every retained sample must be covered.

Signature
signal.stft.inverse(samples_or_STFT, window, hop, options)
Arguments
samples_or_STFT window hop options
Technical descriptors
Show shapes and scopes by argument{name samples_or_STFT shape vector_or_matrix source cell,range,column,scalar,option} {name window shape vector source cell,range,column,scalar,option} {name hop shape integer source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
vector_or_matrix;vector;integer
Unit rule
sample_bins_or_Hz_seconds
Units
sample_bins_or_Hz_seconds
Result fields
matrix axes reconstruction
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, matrix(vector(4,8,0,0,0,0,0,0),4,2), vector(1,1,1,1), 2. Press Preview fields. The results include value_real, value_imaginary, minimum_overlap_weight, maximum_overlap_weight.

Back to the list

signal.time_metric.pulse

Describes or generates a pulse according to the selected family.

Signature
signal.time_metric.pulse(time, samples, unused, options)
Arguments
time samples unused options
Technical descriptors
Show shapes and scopes by argument{name time shape increasing_vector source cell,range,column,scalar,option} {name samples shape real_vector source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
increasing_vector;real_vector
Unit rule
seconds;signal_per_second
Units
seconds;signal_per_second
Result fields
metrics
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. First bind time and voltage to columns A and B. Enter, in order, A1:A16 , B1:B16. In Options use threshold=2.5. Press Preview fields. The results include n, crossing_count, period_count, method, width_count, period_seconds, frequency_hz, pulse_width_seconds.

Back to the list

signal.time_metric.slew

Measures the rate of change over time in the requested interval.

Signature
signal.time_metric.slew(time, samples, unused, options)
Arguments
time samples unused options
Technical descriptors
Show shapes and scopes by argument{name time shape increasing_vector source cell,range,column,scalar,option} {name samples shape real_vector source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
increasing_vector;real_vector
Unit rule
seconds;signal_per_second
Units
seconds;signal_per_second
Result fields
metrics
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(0,0.25,0.5,0.75,1,1.25,1.5,1.75,2,2.25,2.5,2.75,3,3.25,3.5,3.75) , vector(0,0,0,0,0.2,0.4,0.6,0.8,0.95,1,1,1,1,1,1,1). Press Preview fields. The results include maximum_slew_per_second, minimum_slew_per_second.

Back to the list

signal.time_metric.step

Estimates the step transient properties from abscissas and measured values.

Signature
signal.time_metric.step(time, samples, unused, options)
Arguments
time samples unused options
Technical descriptors
Show shapes and scopes by argument{name time shape increasing_vector source cell,range,column,scalar,option} {name samples shape real_vector source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
increasing_vector;real_vector
Unit rule
seconds;signal_per_second
Units
seconds;signal_per_second
Result fields
metrics
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(0,0.25,0.5,0.75,1,1.25,1.5,1.75,2,2.25,2.5,2.75,3,3.25,3.5,3.75) , vector(0,0,0,0,0.2,0.4,0.6,0.8,0.95,1,1,1,1,1,1,1). Press Preview fields. The results include rise_time_seconds, lower_crossing_seconds, upper_crossing_seconds, settling_time_seconds, overshoot_fraction, peak_time_seconds, steady_state_value, undershoot_fraction.

Back to the list

signal.wavelet.cwt

Computes the continuous wavelet transform on the requested scales.

Signature
signal.wavelet.cwt(signal_or_coefficients, scales_or_details, unused, options)
Arguments
signal_or_coefficients scales_or_details unused options
Technical descriptors
Show shapes and scopes by argument{name signal_or_coefficients shape vector source cell,range,column,scalar,option} {name scales_or_details shape vector source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
vector;vector
Unit rule
explicit_sample_rate
Units
explicit_sample_rate
Result fields
coefficients scalogram_axes
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1) , vector(1,2,3). In Options use wavelet="morlet" sample_rate=4. Press Preview fields. The results include coefficients_real, coefficients_imaginary, power, scales, time_seconds, wavelet.

Contract values

morlet
In Options, use wavelet=”morlet” for the oscillating Gaussian window, with complex coefficients.
mexican_hat
In Options, use wavelet=”mexican_hat” for the second derivative of the Gaussian, with real coefficients for real inputs.

Back to the list

signal.wavelet.dwt

Decomposes the signal into discrete wavelet coefficients.

Signature
signal.wavelet.dwt(signal_or_coefficients, scales_or_details, unused, options)
Arguments
signal_or_coefficients scales_or_details unused options
Technical descriptors
Show shapes and scopes by argument{name signal_or_coefficients shape vector source cell,range,column,scalar,option} {name scales_or_details shape vector source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
vector;vector
Unit rule
explicit_sample_rate
Units
explicit_sample_rate
Result fields
coefficients scalogram_axes
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1) . In Options use wavelet="haar". Press Preview fields. The results include approximation_real, approximation_imaginary, detail_real, detail_imaginary, wavelet, boundary.

Contract values

haar
In Options use wavelet="haar" for the Haar basis, the default of the DWT.
db1
In Options use wavelet="db1" for the order-1 Daubechies basis, equivalent to Haar.
db2
In Options use wavelet="db2" for the four-coefficient Daubechies filter.
sym2
In Options use wavelet="sym2". This implementation uses the same coefficients as db2.

Back to the list

signal.wavelet.inverse_dwt

Reconstructs the signal from the discrete wavelet coefficients and the associated configuration.

Signature
signal.wavelet.inverse_dwt(signal_or_coefficients, scales_or_details, unused, options)
Arguments
signal_or_coefficients scales_or_details unused options
Technical descriptors
Show shapes and scopes by argument{name signal_or_coefficients shape vector source cell,range,column,scalar,option} {name scales_or_details shape vector source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
vector;vector
Unit rule
explicit_sample_rate
Units
explicit_sample_rate
Result fields
coefficients scalogram_axes
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, vector(1,2) , vector(0.5,0.25). In Options use wavelet="haar". Press Preview fields. The results include value_real, value_imaginary, wavelet.

Back to the list

signal.wavelet.scalogram

Represents the intensity of the wavelet coefficients over time and scale.

Signature
signal.wavelet.scalogram(signal_or_coefficients, scales_or_details, unused, options)
Arguments
signal_or_coefficients scales_or_details unused options
Technical descriptors
Show shapes and scopes by argument{name signal_or_coefficients shape vector source cell,range,column,scalar,option} {name scales_or_details shape vector source cell,range,column,scalar,option} {name unused shape action-specific source cell,range,column,scalar,option} {name options shape action-specific source cell,range,column,scalar,option}
Input shape
vector;vector
Unit rule
explicit_sample_rate
Units
explicit_sample_rate
Result fields
coefficients scalogram_axes
Provider
math.signal · SIGNAL_API_v1

Example with synthetic data. Enter, in order, matrix(vector(1,2,3,4,5,6),2,3) , vector(1,2). In Options use sample_rate=4. Press Preview fields. The results include power, scales, time_seconds.

Back to the list