InputsPrepSamplingFft

class ansys.dpf.core.operators.mapping.prep_sampling_fft.InputsPrepSamplingFft(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to prep_sampling_fft operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mapping.prep_sampling_fft()
>>> my_time_freq_support = dpf.TimeFreqSupport()
>>> op.inputs.time_freq_support.connect(my_time_freq_support)
>>> my_cutoff_frequency = float()
>>> op.inputs.cutoff_frequency.connect(my_cutoff_frequency)
>>> my_number_sampling_point = int()
>>> op.inputs.number_sampling_point.connect(my_number_sampling_point)

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.
cutoff_frequency	Allows to connect cutoff_frequency input to the operator.
number_sampling_point	Allows to connect number_sampling_point input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.mapping.prep_sampling_fft import InputsPrepSamplingFft

Property detail

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

Initial time domain TimeFreqSupport.

Returns:

An Input instance for this pin.

Return type:

input

Examples

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

property InputsPrepSamplingFft.cutoff_frequency: ansys.dpf.core.inputs.Input[float]

Allows to connect cutoff_frequency input to the operator.

Cutoff Frequency. In this case, number of points is calculated computing (time_range * cutoff_freq * 2) and taking the next power of 2 (optimum for fft calculation).

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mapping.prep_sampling_fft()
>>> op.inputs.cutoff_frequency.connect(my_cutoff_frequency)
>>> # or
>>> op.inputs.cutoff_frequency(my_cutoff_frequency)

property InputsPrepSamplingFft.number_sampling_point: ansys.dpf.core.inputs.Input[int]

Allows to connect number_sampling_point input to the operator.

For number of sampling point (calculation with cutoff_frequency is ignored).

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.mapping.prep_sampling_fft()
>>> op.inputs.number_sampling_point.connect(my_number_sampling_point)
>>> # or
>>> op.inputs.number_sampling_point(my_number_sampling_point)

Method detail

InputsPrepSamplingFft.__str__()

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

InputsPrepSamplingFft.__call__(inpt)

InputsPrepSamplingFft.__getitem__(item) → Input