You are here: NI Home > Support > Product Reference > Manuals > LabVIEW 8.6 Advanced Signal Processing Toolkit Help

Owning Palette: Statistical Analysis VIs

Installed With: Advanced Signal Processing Toolkit

Computes the entropy of an input univariate or multivariate (vector) time series. Wire data to the Xt input to determine the polymorphic instance to use or manually select the instance.

Details  Example

Use the pull-down menu to select an instance of this VI.

Select an instance TSA Entropy (waveform)TSA Entropy (array)TSA Vector Entropy (waveform)TSA Vector Entropy (array)

TSA Entropy (waveform)

	Xt specifies the input univariate time series.
	method specifies the method to use in computing the entropy of the input time series. Options include Shannon (default), Threshold, Sure, Norm, and Energy. Refer to the Details section for more information about each method.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	reference value specifies the associated parameter for the methods Threshold, Sure, and Norm. For the Threshold and Sure methods, the reference value must be greater than 0. For the Norm method, the reference value must be greater than 1.
	entropy returns the entropy of the input time series.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

TSA Entropy (array)

	Xt specifies the input univariate time series.
	method specifies the method to use in computing the entropy of the input time series. Options include Shannon (default), Threshold, Sure, Norm, and Energy. Refer to the Details section for more information about each method.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	reference value specifies the associated parameter for the methods Threshold, Sure, and Norm. For the Threshold and Sure methods, the reference value must be greater than 0. For the Norm method, the reference value must be greater than 1.
	entropy returns the entropy of the input time series.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

TSA Vector Entropy (waveform)

	Xt specifies the input multivariate (vector) time series.
	method specifies the method to use in computing the entropy of the input time series. Options include Shannon (default), Threshold, Sure, Norm, and Energy. Refer to the Details section for more information about each method.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	reference value specifies the associated parameter for the methods Threshold, Sure, and Norm. For the Threshold and Sure methods, the reference value must be greater than 0. For the Norm method, the reference value must be greater than 1.
	entropy returns the vector entropy of the input multivariate (vector) time series.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

TSA Vector Entropy (array)

	Xt specifies the input multivariate (vector) time series. Each column of the 2D array represents a vector at certain time.
	method specifies the method to use in computing the entropy of the input time series. Options include Shannon (default), Threshold, Sure, Norm, and Energy. Refer to the Details section for more information about each method.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	reference value specifies the associated parameter for the methods Threshold, Sure, and Norm. For the Threshold and Sure methods, the reference value must be greater than 0. For the Norm method, the reference value must be greater than 1.
	entropy returns the vector entropy of the input multivariate (vector) time series.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

TSA Entropy Details

This VI computes the Shannon entropy according to the following equation:

When X_t²(i)=0, let log(X_t²(i))=0. n is the number of samples of the input time series.

This VI computes the Threshold entropy according to the following equation:

where t(i)=1 if abs(X_t(i))>p and 0 elsewhere. n is the number of samples of the input time series, and p is reference value.

This VI computes the Sure entropy according to the following equation:

where m(i)=1 if abs(X_t(i))>p and 0 elsewhere, n(i)=1 if abs(X_t(i))≥p and 0 elsewhere

n is number of samples of the input time series, and p is reference value.

This VI computes the Norm entropy according to the following equation:

where n is the number of samples of the input time series. p is reference value.

This VI computes the Energy entropy according to the following equation:

When X_t²(i)=0, let log(X_t²(i))=0. n is the number of samples of the input time series.

Example

Refer to the Series Statistical Analysis VI in the labview\examples\Time Series Analysis\TSAGettingStarted.llb for an example of using the TSA Entropy VI.