22.3 Chebyshev1Filter object

The Chebyshev1Filter object defines a Chebyshev type 1 filter.

The Chebyshev1Filter object is derived from the Filter object.

Access
import filter
mdb.models[name].filters[name]
import odbFilter
session.odbs[name].filters[name]


22.3.1 Chebyshev1Filter(...)

This method creates a Chebyshev1Filter object.

Path
mdb.models[name].Chebyshev1Filter
session.odbs[name].Chebyshev1Filter

Required arguments

name

A String specifying the repository key. This name ANTIALIASING is reserved for filters generated internally by the program.

cutoffFrequency

A Float specifying the attenuation point of the filter. Possible values are non-negative numbers. Order is not available for OperatorFilter.

Optional arguments

rippleFactor

A Float specifying the amount of allowable ripple in the filter. Possible values are non-negative numbers. The default value is 0.225.

order

An Int specifying the highest power of the filter transfer function. Possible values are non-negative numbers less than or equal to 20. Order is not available for OperatorFilter. The default value is 2.

operation

A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.

halt

A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.

limit

None or a Float specifying the threshold limit, an upper or lower bound for output values depending on the operation, or a bound for stopping the analysis when Halt is used. The default value is None.

invariant

A SymbolicConstant specifying the invariant to which filtering is applied. Possible values are NONE, FIRST, and SECOND. The default value is NONE.

Return value

A Chebyshev1Filter object.

Exceptions

InvalidNameError and RangeError.


22.3.2 setValues(...)

This method modifies the Chebyshev1Filter object.

Required arguments

None.

Optional arguments

The optional arguments to setValues are the same as the arguments to the Chebyshev1Filter method, except for the name argument.

Return value

None

Exceptions

RangeError.


22.3.3  Members

The Chebyshev1Filter object has members with the same names and descriptions as the arguments to the Chebyshev1Filter method.


22.3.4  Corresponding analysis keywords

*FILTER