NACO Pipeline Reference Manual  4.4.0
Functions
STREHL related functions

Functions

cpl_error_code naco_strehl_compute (const cpl_image *self, const cpl_parameterlist *parlist, const char *recipename, double lam, double dlam, double pos_x, double pos_y, double pixscale, double *pstrehl, double *pstrehl_err, double *pstar_bg, double *pstar_peak, double *pstar_flux, double *ppsf_peak, double *ppsf_flux, double *pbg_noise)
 Compute the strehl ratio in an image. More...
 

Detailed Description

TBD

Function Documentation

cpl_error_code naco_strehl_compute ( const cpl_image *  self,
const cpl_parameterlist *  parlist,
const char *  recipename,
double  lam,
double  dlam,
double  pos_x,
double  pos_y,
double  pixscale,
double *  pstrehl,
double *  pstrehl_err,
double *  pstar_bg,
double *  pstar_peak,
double *  pstar_flux,
double *  ppsf_peak,
double *  ppsf_flux,
double *  pbg_noise 
)

Compute the strehl ratio in an image.

Parameters
selfImage with pixel-type float
parlistThe recipe parameter list
recipenameThe recipe name
lamCentral wavelength [micron]
dlamFilter bandwidth [micron]
pos_xObject X-position [pixel]
pos_yObject Y-position [pixel]
pixscaleThe pixel scale (from the header)
pstrehlPointer to the Strehl Error (positive on success)
pstrehl_errPointer to the Strehl Error (non-negative on success)
pstar_bgPointer to the Star Background
pstar_peakPointer to the Star Peak (positive on success)
pstar_fluxPointer to the Star Flux (positive on success)
ppsf_peakPointer to the PSF Peak (positive on success)
ppsf_fluxPointer to the PSF Flux (1 on success)
pbg_noisePointer to the Background Noise
Returns
CPL_ERROR_NONE or the relevant CPL error code on error

Definition at line 80 of file naco_strehl.c.

References IRPLIB_STREHL_BOX_SIZE, IRPLIB_STREHL_M1, IRPLIB_STREHL_M2, and naco_parameterlist_get_double().