Table Of Contents

Clip Array (G Dataflow)

Version:
    Last Modified: March 15, 2017

    Clips the elements of an array to within the bounds of specific upper limit and lower limit.

    connector_pane_image
    datatype_icon

    input array

    Input array to be clipped.

    This input changes to input data point when the data type is a double-precision, floating-point number.

    datatype_icon

    input data point

    Input data point to be clipped.

    This input changes to input array when the data type is a 1D array of double-precision, floating-point numbers.

    datatype_icon

    upper limit

    Greater than or equal to the lower limit. If upper limit is less than lower limit, this node sets the sequence clipped array to an empty array and returns an error.

    Default: 0

    datatype_icon

    lower limit

    Less than or equal to the upper limit.

    Default: 0

    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

    clipped array

    The input array subjected to the upper limit and lower limit.

    This output changes to clipped data point when the input data type is a double-precision, floating-point number.

    datatype_icon

    clipped data point

    The input data point subjected to the upper limit and lower limit.

    This output changes to clipped array when the input data type is a 1D array of double-precision, floating-point numbers.

    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.

    Algorithm for Clipping Arrays

    Let the sequence Y represent the output sequence clipped array. Then the elements of Y are related to the elements of input array by the following equation:

    Y i = { a x i > a x i b x i a b x i < b

    for i = 0, 1, 2, ..., n - 1,

    where

    • x is input array
    • n is the number of elements in input array
    • a is upper limit
    • b is lower limit

    Where This Node Can Run:

    Desktop OS: Windows

    FPGA: This product does not support FPGA devices


    Recently Viewed Topics