Filter#

Filter commands are used to create real-time filters of output request data.

Create filters#

In Mdb#

class FilterModel(name: str, description: str = '', stefanBoltzmann: float | None = None, absoluteZero: float | None = None, waveFormulation: SymbolicConstantType = 'NOT_SET', modelType: SymbolicConstantType = 'STANDARD_EXPLICIT', universalGas: float | None = None, copyConstraints: BooleanType = 1, copyConnectors: BooleanType = 1, copyInteractions: BooleanType = 1)[source]#

Abaqus creates a Model object named Model-1 when a session is started.

Notes

This object can be accessed by:

mdb.models[name]

Methods

`ButterworthFilter`(name, cutoffFrequency[, ...])	This method creates a ButterworthFilter object.
`Chebyshev1Filter`(name, cutoffFrequency[, ...])	This method creates a Chebyshev1Filter object.
`Chebyshev2Filter`(name, cutoffFrequency[, ...])	This method creates a Chebyshev2Filter object.
`OperatorFilter`(name, cutoffFrequency[, ...])	This method creates an OperatorFilter object.

ButterworthFilter(name: str, cutoffFrequency: float, order: int = 2, operation: SymbolicConstantType = 'NONE', halt: BooleanType = 0, limit: float | None = None, invariant: SymbolicConstantType = 'NONE') → ButterworthFilter[source]#

This method creates a ButterworthFilter object.

Parameters:

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.
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.

Returns:

A ButterworthFilter object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].ButterworthFilter
session.odbs[name].ButterworthFilter

Chebyshev1Filter(name: str, cutoffFrequency: float, rippleFactor: float = 0, order: int = 2, operation: SymbolicConstantType = 'NONE', halt: BooleanType = 0, limit: float | None = None, invariant: SymbolicConstantType = 'NONE') → Chebyshev1Filter[source]#

This method creates a Chebyshev1Filter object.

Parameters:

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.
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.

Returns:

A Chebyshev1Filter object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

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

Chebyshev2Filter(name: str, cutoffFrequency: float, rippleFactor: float = 0, order: int = 2, operation: SymbolicConstantType = 'NONE', halt: BooleanType = 0, limit: float | None = None, invariant: SymbolicConstantType = 'NONE') → Chebyshev2Filter[source]#

This method creates a Chebyshev2Filter object.

Parameters:

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.
rippleFactor: A Float specifying the amount of allowable ripple in the filter. Possible values are non-negative numbers less than 1. The default value is 0.025.
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.

Returns:

A Chebyshev2Filter object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].Chebyshev2Filter
session.odbs[name].Chebyshev2Filter

OperatorFilter(name: str, cutoffFrequency: float, order: int = 2, operation: SymbolicConstantType = 'NONE', halt: BooleanType = 0, limit: float | None = None, invariant: SymbolicConstantType = 'NONE') → OperatorFilter[source]#

This method creates an OperatorFilter object.

Parameters:

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.
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.

Returns:

An OperatorFilter object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].OperatorFilter
session.odbs[name].OperatorFilter

In Odb#

class FilterOdb(name: str, analysisTitle: str = '', description: str = '', path: str = '')[source]#

The Odb object is the in-memory representation of an output database (ODB) file.

Notes

This object can be accessed by:

import odbAccess
session.odbs[name]

Methods

`ButterworthFilter`(name, cutoffFrequency[, ...])	This method creates a ButterworthFilter object.
`Chebyshev1Filter`(name, cutoffFrequency[, ...])	This method creates a Chebyshev1Filter object.
`Chebyshev2Filter`(name, cutoffFrequency[, ...])	This method creates a Chebyshev2Filter object.
`OperatorFilter`(name, cutoffFrequency[, ...])	This method creates an OperatorFilter object.

This method creates a ButterworthFilter object.

Parameters:

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.
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.

Returns:

A ButterworthFilter object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].ButterworthFilter
session.odbs[name].ButterworthFilter

This method creates a Chebyshev1Filter object.

Parameters:

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.
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.

Returns:

A Chebyshev1Filter object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

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

This method creates a Chebyshev2Filter object.

Parameters:

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.
rippleFactor: A Float specifying the amount of allowable ripple in the filter. Possible values are non-negative numbers less than 1. The default value is 0.025.
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.

Returns:

A Chebyshev2Filter object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].Chebyshev2Filter
session.odbs[name].Chebyshev2Filter

This method creates an OperatorFilter object.

Parameters:

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.
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.

Returns:

An OperatorFilter object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].OperatorFilter
session.odbs[name].OperatorFilter

Object features#

Filter#

class Filter[source]#

The Filter object is the abstract base type for other Filter objects. The Filter object has no explicit constructor. The methods and members of the Filter object are common to all objects derived from the Filter.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the repository key. This name ANTIALIASING is reserved for filters generated internally by the program.
cutoffFrequency: float: A Float specifying the attenuation point of the filter. Possible values are non-negative numbers. Order is not available for OperatorFilter.
order: int: 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: SymbolicConstant: A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.
halt: Boolean: A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.
limit: float: 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: SymbolicConstant: A SymbolicConstant specifying the invariant to which filtering is applied. Possible values are NONE, FIRST, and SECOND. The default value is NONE.

ButterworthFilter#

class ButterworthFilter(name: str, cutoffFrequency: float, order: int = 2, operation: SymbolicConstantType = 'NONE', halt: BooleanType = 0, limit: float | None = None, invariant: SymbolicConstantType = 'NONE')[source]#

The ButterworthFilter object defines a Butterworth type filter. The ButterworthFilter object is derived from the Filter object.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

FILTER

Methods

setValues([order, operation, halt, limit, ...])

This method modifies the ButterworthFilter object.

setValues(order: int = 2, operation: SymbolicConstantType = 'NONE', halt: BooleanType = 0, limit: float | None = None, invariant: SymbolicConstantType = 'NONE')[source]#

This method modifies the ButterworthFilter object.

Parameters:

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.

Raises:

RangeError

Chebyshev1Filter#

class Chebyshev1Filter(name: str, cutoffFrequency: float, rippleFactor: float = 0, order: int = 2, operation: SymbolicConstantType = 'NONE', halt: BooleanType = 0, limit: float | None = None, invariant: SymbolicConstantType = 'NONE')[source]#

The Chebyshev1Filter object defines a Chebyshev type 1 filter. The Chebyshev1Filter object is derived from the Filter object.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

FILTER

Methods

setValues([rippleFactor, order, operation, ...])

This method modifies the Chebyshev1Filter object.

setValues(rippleFactor: float = 0, order: int = 2, operation: SymbolicConstantType = 'NONE', halt: BooleanType = 0, limit: float | None = None, invariant: SymbolicConstantType = 'NONE')[source]#

This method modifies the Chebyshev1Filter object.

Parameters:

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.

Raises:

RangeError

Chebyshev2Filter#

class Chebyshev2Filter(name: str, cutoffFrequency: float, rippleFactor: float = 0, order: int = 2, operation: SymbolicConstantType = 'NONE', halt: BooleanType = 0, limit: float | None = None, invariant: SymbolicConstantType = 'NONE')[source]#

The Chebyshev2Filter object defines a Chebyshev type 2 filter. The Chebyshev2Filter object is derived from the Filter object.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

FILTER

Methods

setValues([rippleFactor, order, operation, ...])

This method modifies the Chebyshev2Filter object.

Parameters:

rippleFactor: A Float specifying the amount of allowable ripple in the filter. Possible values are non-negative numbers less than 1. The default value is 0.025.
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.

Raises:

RangeError

OperatorFilter#

class OperatorFilter(name: str, cutoffFrequency: float, order: int = 2, operation: SymbolicConstantType = 'NONE', halt: BooleanType = 0, limit: float | None = None, invariant: SymbolicConstantType = 'NONE')[source]#

The OperatorFilter object defines an operator filter. The OperatorFilter object is derived from the Filter object.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

FILTER

Methods

setValues([order, operation, halt, limit, ...])

This method modifies the OperatorFilter object.

setValues(order: int = 2, operation: SymbolicConstantType = 'NONE', halt: BooleanType = 0, limit: float | None = None, invariant: SymbolicConstantType = 'NONE')[source]#

This method modifies the OperatorFilter object.

Parameters:

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.

Raises:

RangeError