# Decimate

Advanced Analysis Library Only

AnalysisLibErrType Decimate (double inputArray[], int numberOfElements, int dFactor, int averaging, double decimatedArray[]);

## Purpose

Decimates the input sequence X by the decimating factor and the averaging. If Y represents the decimated output sequence, Decimate obtains the elements of the sequence Y using the following formula:

where | i = 0, 1, 2, . . ., size — 1
| size = trunc(numberOfElements/dFactor) is the size of the output sequence

## Parameters

Input
Name | Type | Description
inputArray | double-precision array | The input array to decimate.
numberOfElements | integer | Number of elements in the input array.
dFactor | integer | Amount by which to decimate inputArray to form decimatedArray.
averaging | integer | Specifies whether to use averaging in decimating intputArray. Default Value: 0 (averaging off)
Output
Name | Type | Description
decimatedArray | double-precision array | The output array, which is inputArray decimated by the dFactor. The size of this array must be trunc(numberOfElements/dFactor).

## 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.