scale_by_field class

Namespace: Ans.DataProcessing.operators.math

Summary

DEPRECATED, PLEASE USE SCALE. Scales a field (in 0) by a scalar field (in 1). If one field's scoping has an 'overall' location, then this field's values are applied on the other field entirely.

available inputs: fieldA (Field, FieldsContainer), fieldB (Field, FieldsContainer)

available outputs: field (Field)

Example

op = scale_by_field()

op = scale_by_field(fieldA=my_fieldA,fieldB=my_fieldB)

Class Information

Property	Value
Namespace	Ans.DataProcessing.operators.math
Assembly	Ans_Dpf_Native_dll_cs
Base Class	Ans.DataProcessing.internal_objects.BaseOperator

Inputs

fieldA

field or fields container with only one field is expected

Type: LinkableInput

fieldB

field or fields container with only one field is expected

Type: LinkableInput

Outputs

field

Type: LinkableOutput

Constructors

Constructor

scale_by_field()

Constructor

scale_by_field(fieldA, fieldB, config)

Parameters:

• fieldA (object)
• fieldB (object)
• config (OperatorConfig)

Constructor

scale_by_field(config)

Parameters:

• config (OperatorConfig)

Methods

Properties

inputs

Type: InputSpec

# Get or set the property
value = obj.inputs
obj.inputs = new_value

outputs

Type: OutputSpec

# Get or set the property
value = obj.outputs
obj.outputs = new_value

defaultConfig

Type: Config

# Get the property (read-only)
value = obj.defaultConfig