# Chirp

Advanced Analysis Library Only

AnalysisLibErrType Chirp (int numberOfElements, double amplitude, double beginningFreq, double endingFreq, double chirp[]);

## Purpose

Generates an array that contains a chirp pattern. Chirp generates the output array x according to the following formula:

where |
and where | f1 is the beginning frequency in cycles per sample
| f2 is the ending frequency in cycles per sample

## Parameters

Input
Name | Type | Description
numberOfElements | integer | Number of elements to generate in the chirp signal.
amplitude | double-precision | Amplitude of the resulting chirp signal. Default Value: 1.0.
beginningFreq | double-precision | Beginning frequency of the resulting chirp signal in normalized units of cycles/sample. Default Value: 0.0.
endingFreq | double-precision | Ending frequency of the resulting chirp signal in normalized units of cycles/sample. Default Value: 0.5.
Output
Name | Type | Description
chirp | double-precision array | The generated chirp pattern.

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