Admin Production ni-theme
Current Publication

CxDecimate

LabWindows/CVI

CxDecimate

Advanced Analysis Library Only

AnalysisLibErrType CxDecimate (NIComplexNumber inputArray[], ssize_t numberOfElements, ssize_t decimatingFactor, int averaging, NIComplexNumber decimatedArray[]);

Purpose

Decimates the input sequence inputArray.

This function decimates the input sequence inputArray as follows:

where k=0,1,2...D-1,i = 0, 1, 2 ... size-1,

size = truncation(n/D) is the size of the output sequence.

Parameters

Input
Name Type Description
inputArray NIComplexNumber [] The input sequence. If decimatedArray is NULL, inputArray is overwritten by the output sequence.
numberOfElements ssize_t The length of inputArray.
decimatingFactor ssize_t The decimating factor. decimatingFactor must be greater than 0 and less than numberOfElements.
averaging int Specify a nonzero value or ENABLE_OPTION or select On in the function panel to use averaging in decimating the inputArray.

Specify 0 or DISABLE_OPTION or select Off in the function panel to disable averaging. This is the default value.
Output
Name Type Description
decimatedArray NIComplexNumber [] The decimated sequence.

Return Value

Name Type Description
status AnalysisLibErrType A value that specifies the type of error that occurred. Refer to analysis.h for definitions of these constants.

Additional Information

Library: Advanced Analysis Library

Include file: analysis.h

LabWindows/CVI compatibility: LabWindows/CVI 8.1 and later