idresampOptions

Option set for idresamp

Since R2023a

Description

Use an idresampOptions object to specify options when using the idresamp function. You can specify options such as the filter order and input-channel intersample behavior.

Creation

Syntax

opt = idresampOptions

opt = idresampOptions(Name,Value)

Description

opt = idresampOptions creates the default option set for idresamp. To modify the properties of this option set for your specific application, use dot notation.

opt = idresampOptions(Name,Value) creates an option set with properties specified using one or more name-value arguments. For example, opt = idresampOptions('InputInterSample','foh') sets the InputInterSample option to 'foh'.

Properties

FilterOrder — Filter order

8 (default) | integer

Filter order used for decimation and interpolation, specified as a positive integer.

Tolerance — Tolerance of rational approximation

[] (default) | numeric value

Tolerance of rational approximation, specified as a numeric value. When you set Tolerance to [], the software uses a tolerance of 1e-6.

The software uses this option only when the second input argument of idresamp is a scalar R.

InputInterSample — Input-channel intersample behavior

'auto' | 'zoh' | 'foh' | 'bl'

Input-channel intersample behavior for transformations between discrete time and continuous time, specified as 'auto', 'zoh','foh', or 'bl'.

The definitions of the three behavior values are as follows:

• 'zoh' — Zero-order hold maintains a piecewise-constant input signal between samples.

• 'foh' — First-order hold maintains a piecewise-linear input signal between samples.

• 'bl' — Band-limited behavior specifies that the continuous-time input signal has zero power above the Nyquist frequency.

iddata objects have a similar property, data.InterSample, that contains the same behavior value options. When the InputInterSample value is 'auto' and the estimation data is in an iddata object data, the software uses the data.InterSample value. When the estimation data is instead contained in a timetable or a matrix pair, with the 'auto' option, the software uses 'zoh'.

The software applies the same option value to all channels and all experiments.

Version History

Introduced in R2023a

R2023a: idresampOptions provides option set for idresamp

idresampOptions provides options for the idresamp function, which was updated in R2023a to incorporate the functionality of resample and to accept data in the form of timetables and matrices in addition to iddata objects.