Threshold Detector (G Dataflow)

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

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

Default: False

The input sequence.

If the input sequence is less than or equal to the minimum width, this node sets the number of valid peaks to zero and returns an error.

This input accepts the following data types:

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

The level that all valid peaks must equal or exceed for the duration of the minimum width.

This input accepts a double-precision, floating-point number or a 1D array of double-precision, floating-point numbers. This input accepts a 1D array of double-precision, floating-point numbers when signal is a 1D array of waveforms or a 2D array of double-precision, floating-point numbers.

Default: 0

The minimum width, in number of samples, that the input sequence must remain at or above the threshold for the candidate peak to be considered a valid peak. This input must be greater than zero. If this input is less than or equal to zero, this node sets the number of valid peaks to zero and returns an error.

This input accepts a 32-bit signed integer or a 1D array of 32-bit signed integers. This input accepts a 1D array of 32-bit signed integers when signal is a 1D array of waveforms or a 2D array of double-precision, floating-point numbers.

Default: 1

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

Sample period of the time-domain signal in seconds.

Set this input to 1/fs, where fs is the sampling frequency of the time-domain signal.

This input is available only if you wire a 1D array of double-precision, floating-point numbers or a 2D array of double-precision, floating-point numbers to signal.

Default: 1

The mode in which to retrieve the peak location.

This input accepts a ring or a 1D array of rings. This input accepts a 1D array of rings when signal is a 1D array of waveforms or a 2D array of double-precision, floating-point numbers.

This input is available only if you wire one of the following data types to signal:

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

Default: Index

Locations of peaks detected in terms of array index or time in seconds.

This output can return a 1D array of clusters or a 1D array of double-precision, floating-point numbers.

This output is available only if you wire one of the following data types to signal:

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

A Boolean that indicates whether this node detected a peak.

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

The number of valid peaks.

This output can return a 32-bit signed integer or a 1D array of 32-bit signed integers.

This output changes to index if you wire a double-precision, floating-point number to signal.

Beginning index of the most recent peak when detected? is True.

This output changes to count if you wire one of the following data types to signal:

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

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.