Table Of Contents

Measures of Spread (Moment about Mean) (G Dataflow)

Version:
    Last Modified: March 15, 2017

    Computes the moment about the mean of a sequence using a specific order.

    connector_pane_image
    datatype_icon

    reset

    A Boolean that specifies whether to reset the internal state of the node.

    True Resets the internal state of the node.
    False Does not reset the internal state of the node.

    This input is available only if you wire a double-precision, floating-point number to x.

    Default: False

    datatype_icon

    x

    The input sequence.

    If x is empty, moment is NaN.

    This input accepts a double-precision, floating-point number or a 1D array of double-precision, floating-point numbers.

    datatype_icon

    order

    Order of the calculated moment about mean.

    order must be greater than 0. If order is less than or equal to 0, the node sets moment to NaN and returns an error.

    Default: 2

    datatype_icon

    sample length

    Length of each set of data.

    The node performs computation for each set of data. sample length must be greater than zero.

    This input is available only if you wire a double-precision floating-point number to x.

    Default: 100

    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

    moment

    Moment about the mean of the input sequence calculated using the specified order.

    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 Computing the Moment about the Mean of a Sequence

    The node computes the mth-order moment using the following equation.

    σ x m = 1 n i = 0 n 1 ( x i μ ) m

    where σ x m is the mth-order moment, and n is the number of elements in the input sequence x.

    Where This Node Can Run:

    Desktop OS: Windows

    FPGA: This product does not support FPGA devices


    Recently Viewed Topics