Table Of Contents

Decimate (Single-shot) (G Dataflow)

Last Modified: March 15, 2017

Decimates an input sequence according to a specific decimating factor and averaging method.

connector_pane_image
datatype_icon

signal

Input sequence.

The number of elements in signal must be greater than or equal to decimating factor.

This input accepts the following data types:

  • Waveform
  • Waveform in complex double-precision, floating-point numbers
  • 1D array of waveforms
  • 1D array of waveforms in complex double-precision, floating-point numbers
  • 1D array of double-precision, floating-point numbers
  • 2D array of double-precision, floating-point numbers
  • 1D array of complex double-precision, floating-point numbers
  • 2D array of complex double-precision, floating-point numbers
datatype_icon

decimating factor

The factor by which this node decimates the input sequence. decimating factor must be greater than zero. If decimating factor is greater than the number of elements in signal or less than or equal to zero, this node sets decimated signal to an empty array and returns an error.

Default: 1

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

averaging

A Boolean that determines the method this node uses to handle the data points in the input sequence.

True Each output point in decimated signal is the mean of the decimating factor input points.
False Keeps every decimating factor point from signal.

Default: False

datatype_icon

decimated signal

Decimated sequence of the input sequence.

This output can return the following data types:

  • Waveform
  • Waveform in complex double-precision, floating-point numbers
  • 1D array of waveforms
  • 1D array of waveforms in complex double-precision, floating-point numbers
  • 1D array of double-precision, floating-point numbers
  • 2D array of double-precision, floating-point numbers
  • 1D array of complex double-precision, floating-point numbers
  • 2D array of complex 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 Single-Shot Decimation

If Y represents the output sequence decimated signal, this node obtains the elements of the sequence Y using the following equation:

If averaging? is False, Y i = x i * m

If averaging? is True, Y i = 1 m k = 0 m 1 x i * m + k

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

size = n m ,

where

  • x is signal
  • n is the number of elements in signal
  • m is decimating factor
  • size is the number of elements in the output sequence decimated signal
  • . gives the largest integer less than or equal to the number

Where This Node Can Run:

Desktop OS: Windows

FPGA: This product does not support FPGA devices


Recently Viewed Topics