Skip to main content

math:sweeping phase

Version: 0.0.0

Description​

Shifts the phase of a real and an imaginary field (in 0 and 1) of a given angle (in 3) of a unit (in 4). The resulting field is computed as field_out = real_field*cos(angle) - imaginary_field*sin(angle).

Inputs​

InputNameExpected type(s)Description
Pin 0
Required
real_fieldfield, fields_containerfield or fields container with only one field is expected
Pin 1
Required
imaginary_fieldfield, fields_containerfield or fields container with only one field is expected
Pin 2
Required
angledouble
Pin 3unit_namestringString Unit. Supported values: "deg" or "rad". Default: "rad".
Pin 4
Required
abs_valuebool
Pin 5
Required
imaginary_part_nullboolIf the imaginary part field is empty and this pin is true, then the imaginary part is supposed to be 0 (default is false).

Outputs​

OutputNameExpected type(s)Description
Pin 0fieldfield

Configurations​

NameExpected type(s)Default valueDescription
mutexboolfalseIf this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads.

Scripting​

Category: math

Plugin: core

Scripting name: None

Full name: None

Internal name: sweeping_phase

License: None

Changelog​

  • Version 0.0.0: Initial release.