X-shooter Pipeline Reference Manual 3.8.15
Functions
Functions for calibrations

Functions

cpl_vector * xsh_irplib_imagelist_get_clean_mean_levels (const cpl_imagelist *iml, const double kappa, const int nclip, const double tolerance)
 find out the character string associated to the DIT keyword in a propertylist
 
static cpl_error_code irplib_imagelist_subtract_values (cpl_imagelist **iml, cpl_vector *values)
 Subtract from input imagelist values specified in input vector.
 
cpl_image * xsh_irplib_mkmaster_mean (cpl_imagelist *images, const double kappa, const int nclip, const double tolerance, const double klow, const double khigh)
 Computes master frame by clean stack mean of the input imagelist.
 
cpl_image * xsh_irplib_mkmaster_median (cpl_imagelist *images, const double kappa, const int nclip, const double tolerance)
 Computes master frame by clean stack median of the input imagelist.
 
cpl_imagelist * xsh_irplib_mkmaster_dark_fill_imagelist (const cpl_imagelist *raw_images, cpl_propertylist **raw_headers, const cpl_image *master_bias, double *mean_exptime)
 

Detailed Description

Function Documentation

◆ irplib_imagelist_subtract_values()

static cpl_error_code irplib_imagelist_subtract_values ( cpl_imagelist **  iml,
cpl_vector *  values 
)
static

Subtract from input imagelist values specified in input vector.

Parameters
imlinput imagelist
valuesvalue to be subtracted
Returns
corrected imagelist

Definition at line 120 of file xsh_irplib_mkmaster.c.

References size.

Referenced by xsh_irplib_mkmaster_mean(), and xsh_irplib_mkmaster_median().

◆ xsh_irplib_imagelist_get_clean_mean_levels()

cpl_vector * xsh_irplib_imagelist_get_clean_mean_levels ( const cpl_imagelist *  iml,
const double  kappa,
const int  nclip,
const double  tolerance 
)

find out the character string associated to the DIT keyword in a propertylist

Parameters
plistpropertylist
Returns
dit value

Computes kappa-sigma clean mean (free bad pixels) for each input image of the input imagelist.

Parameters
imlinput imagelist
kappavalue for kappa-sigma clip
nclipNumber of clipping iterations
tolerancetolerance on range between two successive clip iterations
Returns
vector with computed values for each image of the list

The returned vector must be deallocated.

Definition at line 73 of file xsh_irplib_mkmaster.c.

References kappa, size, tolerance, and xsh_ksigma_clip().

Referenced by xsh_irplib_mkmaster_mean(), xsh_irplib_mkmaster_median(), and xsh_preoverscan_corr().

◆ xsh_irplib_mkmaster_dark_fill_imagelist()

cpl_imagelist * xsh_irplib_mkmaster_dark_fill_imagelist ( const cpl_imagelist *  raw_images,
cpl_propertylist **  raw_headers,
const cpl_image *  master_bias,
double *  mean_exptime 
)

Definition at line 394 of file xsh_irplib_mkmaster.c.

References xsh_pfits_get_exptime().

Referenced by xsh_create_master_dark2().

◆ xsh_irplib_mkmaster_mean()

cpl_image * xsh_irplib_mkmaster_mean ( cpl_imagelist *  images,
const double  kappa,
const int  nclip,
const double  tolerance,
const double  klow,
const double  khigh 
)

Computes master frame by clean stack mean of the input imagelist.

Parameters
imagesinput imagelist
kappavalue for kappa-sigma clip
nclipNumber of clipping iterations
tolerancetolerance on range between two successive clip iterations
klowkappa value applied to kappa sigma clip low pix values
khighkappa value applied to kappa sigma clip low pix values
Returns
master image

The returned image must be deallocated.

Definition at line 318 of file xsh_irplib_mkmaster.c.

References irplib_imagelist_subtract_values(), kappa, tolerance, and xsh_irplib_imagelist_get_clean_mean_levels().

Referenced by xsh_create_master_bias2(), and xsh_create_master_dark2().

◆ xsh_irplib_mkmaster_median()

cpl_image * xsh_irplib_mkmaster_median ( cpl_imagelist *  images,
const double  kappa,
const int  nclip,
const double  tolerance 
)

Computes master frame by clean stack median of the input imagelist.

Parameters
imagesinput imagelist
kappavalue for kappa-sigma clip
nclipNumber of clipping iterations
tolerancetolerance on range between two successive clip iterations
Returns
master image

The returned image must be deallocated.

Definition at line 362 of file xsh_irplib_mkmaster.c.

References irplib_imagelist_subtract_values(), kappa, tolerance, xsh_imagelist_collapse_median_create(), and xsh_irplib_imagelist_get_clean_mean_levels().

Referenced by xsh_create_master_bias2(), and xsh_create_master_dark2().