Getlocalpeakpower - JDS Uniphase SWS15100 User Manual

getLocalPeakPower

Description The getlocalPeakPower function retrieves the power of the largest peak that is
contained in the pPowData power array, within a specified wavelength range.
Call the function after obtaining pPowData array through a call to the
getILTrace function. The refpeak parameter must be specified by the caller.
C prototype int getLocalPeakPower( double *pLamData, double *pPowData, unsigned
short dataSize, double dStartWave, double dStopWave, unsigned short
refpeak, unsigned short *peakIndex, double *pPowPeak, double *pLamPeak );
VB prototype Declare Function getLocalPeakPower Lib "SWS15100" (ByRef pLamData As
Double, ByRef pPowData As Double, ByVal dataSize%, ByVal dStartWave As
Double, Byval dStopWave As Double, ByVal refPeak%, ByRef PeakIndex%,
ByRef pPowPeak As Double, ByRef pLamPeak As Double) As Long
Input double *pLamData:
The pLamData array stores wavelength points of the trace.
double *pPowData:
The pPowData array stores IL power level (dB scale) points. Each point from
the pPowData array has a corresponding point in the pLamData array.
unsigned short dataSize:
This is the size of arrays pLamData and pPowData allocated by the user. This
is the size of the acquired trace retrieved by the user using the function
getDataSize.
double dStartWave:
Specifies the wavelength at which to start processing.
double dStopWave:
Specifies the wavelength at which to stop processing.
Output unsigned short refpeak:
This is an integer set of values:
{MAX_PEAK_REF = 0(find maximum peaks),
MIN_PEAK_REF = 1(find minimum peaks)}
unsigned short *peakIndex
This is the position of the peak in the pPowData array.
double *pPowPeak:
This is the power of the peak, the maximum power of the pPowData array,
within the wavelength range specified.
double *pLamPeak:
This is the wavelength of the peak that corresponds to the pPowPeak value.
Return Value When there is no error, the function returns zero.
When there is an error, the return value contains the error number.
Artisan Technology Group - Quality Instrumentation ... Guaranteed | (888) 88-SOURCE | www.artisantg.com
Programming Guide – 145