InputsQuantization#

class ansys.dpf.core.operators.compression.quantization.InputsQuantization(op: ansys.dpf.core.dpf_operator.Operator)#

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to quantization operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.compression.quantization()
>>> my_input_field = dpf.Field()
>>> op.inputs.input_field.connect(my_input_field)
>>> my_threshold = float()
>>> op.inputs.threshold.connect(my_threshold)

Overview#

connect

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

input_field

Allows to connect input_field input to the operator.

threshold

Allows to connect threshold input to the operator.

__str__

__call__

__getitem__

Import detail#

from ansys.dpf.core.operators.compression.quantization import InputsQuantization

Property detail#

property InputsQuantization.input_field: ansys.dpf.core.inputs.Input#

Allows to connect input_field input to the operator.

Field to quantize.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.compression.quantization()
>>> op.inputs.input_field.connect(my_input_field)
>>> # or
>>> op.inputs.input_field(my_input_field)
property InputsQuantization.threshold: ansys.dpf.core.inputs.Input#

Allows to connect threshold input to the operator.

Precision threshold desired. Case double : the threshold is applied on all the input field. Case field with one value : the threshold is applied on all the input field. Case field with “numComp” values : each threhsold is applied to the corresponding component of the input field. Case field with the same number of values than the input field : quantization is performed component-wise.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.compression.quantization()
>>> op.inputs.threshold.connect(my_threshold)
>>> # or
>>> op.inputs.threshold(my_threshold)

Method detail#

InputsQuantization.__str__()#
InputsQuantization.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.

Parameters:

  • inpt (str, int, double, bool, list[int], list[float], Field, FieldsContainer, Scoping, Enum,)

  • ScopingsContainer (E501) – Input of the operator.

  • MeshedRegion (E501) – Input of the operator.

  • MeshesContainer (E501) – Input of the operator.

  • DataSources (E501) – Input of the operator.

  • CyclicSupport (E501) – Input of the operator.

  • Outputs (E501) – Input of the operator.

  • noqa (os.PathLike #) – Input of the operator.

InputsQuantization.__call__(inpt)#
InputsQuantization.__getitem__(item) → Input#