Table Of Contents

Check for Included Angle (G Dataflow)

Version:
    Last Modified: March 15, 2017

    Checks whether one or multiple input angles are within the counterclockwise range.

    connector_pane_image
    datatype_icon

    angle units

    Units of the input and output angles.

    Name Value Description
    radian in, radian out 0 The units of input and output angles are both radian.
    radian in, degree out 1 The unit of input angles is radian. The unit of output angles is degree.
    degree in, degree out 2 The units of input and output angles are both degree.
    degree in, radian out 3 The unit of input angles is degree. The unit of output angles is radian.

    Default: radian in, radian out

    datatype_icon

    angle in

    Angle that this node checks.

    This input accepts the following data types:

    • Double-precision, floating-point number
    • 1D array of double-precision, floating-point numbers

    This input converts angles into [0, 360] or [0, 2pi] if you enter angles out of this range. You must specify the same number of elements in angle in, start angle, and end angle. Otherwise, this node returns an error.

    datatype_icon

    start angle

    Angle at the beginning of the range.

    This input accepts the following data types:

    • Double-precision, floating-point number
    • 1D array of double-precision, floating-point numbers

    The range continues in the counterclockwise direction. This input converts angles into [0, 360] or [0, 2pi] if you enter angles out of this range. You must specify the same number of elements in angle in, start angle, and end angle. Otherwise, this node returns an error.

    datatype_icon

    end angle

    Angle at the end of the range.

    This input accepts the following data types:

    • Double-precision, floating-point number
    • 1D array of double-precision, floating-point numbers

    This input converts angles into [0, 360] or [0, 2pi] if you enter angles out of this range. end angle must have the same unit as start angle. You must specify the same number of elements in angle in, start angle, and end angle. Otherwise, this node returns an error.

    datatype_icon

    output angle range

    Range of the output angle.

    Name Value Description
    none 0 The range is [-Inf , Inf].
    -180 to 180 (-pi to pi) 1 The range is [-180, 180] in degrees or [-pi, pi] in radians.
    0 to 360 (0 to 2pi) 2 The range is [0, 360] in degrees or [0, 2pi] in radians.

    Default: -180 to 180 (-pi to pi)

    datatype_icon

    error in

    Error conditions that occur before this node runs.

    The node responds to this input according to standard error behavior.

    Standard Error Behavior

    Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

    error in does not contain an error error in contains an error
    If no error occurred before the node runs, the node begins execution normally.

    If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

    If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

    Default: No error

    datatype_icon

    coerce angle

    A Boolean that specifies whether to coerce angle in to the nearest angle in the range between start angle and end angle when angle in is out of the range. This input does nothing when angle in is in the range.

    True angle out returns the nearest angle in the range between start angle and end angle.
    False angle out returns the same value as angle in.

    Default: False

    datatype_icon

    angle out

    Output angle.

    This output can return the following data types:

    • Double-precision, floating-point number
    • 1D array of double-precision, floating-point numbers

    If in range? is True or if in range? and coerce angle are both False, this output returns the input angle. If in range? is False and coerce angle is True, this output returns the nearest angle of the input angle in the range between start angle and end angle.

    datatype_icon

    in range?

    A Boolean that indicates whether the input angle is in the range between start angle and end angle.

    True The input angle is in the range.
    False The input angle is not in the range.

    This output can return the following data types:

    • Boolean
    • 1D array of Booleans
    datatype_icon

    error out

    Error information.

    The node produces this output according to standard error behavior.

    Standard Error Behavior

    Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

    error in does not contain an error error in contains an error
    If no error occurred before the node runs, the node begins execution normally.

    If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

    If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

    Angles in Range and out of Range

    The following figures demonstrate the input angle in range and out of the range from the start angle to the end angle, respectively.

    Where This Node Can Run:

    Desktop OS: Windows

    FPGA: This product does not support FPGA devices


    Recently Viewed Topics