Admin Production ni-theme
Current Publication

GaussModSinePattern

LabWindows/CVI

GaussModSinePattern

Advanced Analysis Library Only

AnalysisLibErrType GaussModSinePattern (ssize_t numberOfElements, double amplitude, double delay, double samplingInterval, double centerFrequency, double bandwidth, double attenuation, double gaussianModSinPattern[]);

Purpose

Generates an array containing a Gaussian modulated sinusoidal pulse.

This function obtains the element of the output array using the following formula:

where

Parameters

Input
Name Type Description
numberOfElements ssize_t The number of elements to generate.
amplitude double Peak amplitude of the pattern.
delay double Shifts the peak of the pattern.
samplingInterval double The sampling interval, which must be positive.
centerFrequency double The center frequency in Hertz, which must be positive.
bandwidth double The bandwidth normalized to centerFrequency, which must be positive. The bandwidth*centerFrequency is the bandwidth corresponding to -attenuation dB in the power spectrum.
attenuation double The attenuation in dB at the bandwidth point, which must be positive.
Output
Name Type Description
gaussianModSinPattern double [] The generated Gaussian modulated sinusoidal 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.

Additional Information

Library: Advanced Analysis Library

Include file: analysis.h

LabWindows/CVI compatibility: LabWindows/CVI 8.1 and later