InputsExtractTimeFreq

class ansys.dpf.core.operators.utility.extract_time_freq.InputsExtractTimeFreq(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to extract_time_freq operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.extract_time_freq()
>>> my_time_freq_support = dpf.TimeFreqSupport()
>>> op.inputs.time_freq_support.connect(my_time_freq_support)
>>> my_time_scoping = dpf.Scoping()
>>> op.inputs.time_scoping.connect(my_time_scoping)
>>> my_real_or_complex = bool()
>>> op.inputs.real_or_complex.connect(my_real_or_complex)
>>> my_rpm_scoping = int()
>>> op.inputs.rpm_scoping.connect(my_rpm_scoping)

Overview

Methods

connect

Connect any input (an entity or an operator output) to any input pin of this operator.

Properties

time_freq_support	Allows to connect time_freq_support input to the operator.
time_scoping	Allows to connect time_scoping input to the operator.
real_or_complex	Allows to connect real_or_complex input to the operator.
rpm_scoping	Allows to connect rpm_scoping input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.utility.extract_time_freq import InputsExtractTimeFreq

Property detail

property InputsExtractTimeFreq.time_freq_support: ansys.dpf.core.inputs.Input[ansys.dpf.core.time_freq_support.TimeFreqSupport]

Allows to connect time_freq_support input to the operator.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.extract_time_freq()
>>> op.inputs.time_freq_support.connect(my_time_freq_support)
>>> # or
>>> op.inputs.time_freq_support(my_time_freq_support)

property InputsExtractTimeFreq.time_scoping: ansys.dpf.core.inputs.Input[ansys.dpf.core.scoping.Scoping]

Allows to connect time_scoping input to the operator.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.extract_time_freq()
>>> op.inputs.time_scoping.connect(my_time_scoping)
>>> # or
>>> op.inputs.time_scoping(my_time_scoping)

property InputsExtractTimeFreq.real_or_complex: ansys.dpf.core.inputs.Input[bool]

Allows to connect real_or_complex input to the operator.

False for real only (default). True for complex output.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.extract_time_freq()
>>> op.inputs.real_or_complex.connect(my_real_or_complex)
>>> # or
>>> op.inputs.real_or_complex(my_real_or_complex)

property InputsExtractTimeFreq.rpm_scoping: ansys.dpf.core.inputs.Input[int]

Allows to connect rpm_scoping input to the operator.

Optional scoping for RPM/load case selection.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.extract_time_freq()
>>> op.inputs.rpm_scoping.connect(my_rpm_scoping)
>>> # or
>>> op.inputs.rpm_scoping(my_rpm_scoping)

Method detail

InputsExtractTimeFreq.__str__()

InputsExtractTimeFreq.connect(inpt)

Connect any input (an entity or an operator output) to any input pin of this operator.

Searches for the input type corresponding to the output.

Deprecated since version Deprecated: in favor of explicit output-to-input connections.

InputsExtractTimeFreq.__call__(inpt)

InputsExtractTimeFreq.__getitem__(item) → Input