ERIS Pipeline Reference Manual 1.9.2
Functions
ERIS NIX science data reduction related functions

Functions

cpl_error_code eris_nix_scired_cal_det (cpl_frameset *frameset, const cpl_parameterlist *parlist, const char *recipe_name, const char *context)
 This function removes the detector signature from science frames.
 
cpl_error_code eris_nix_scired_skysub (cpl_frameset *frameset, const cpl_parameterlist *parlist, const char *recipe_name, const char *context)
 This recipe estimates and subtracts the sky background from a set of science frames.
 
cpl_error_code eris_nix_scired_cal_wcs (cpl_frameset *frameset, const cpl_parameterlist *parlist, const char *recipe_name, const char *context)
 This recipe calibrates the astrometry of ERIS/NIX frames.
 
cpl_error_code eris_nix_scired_cal_phot (cpl_frameset *frameset, const cpl_parameterlist *parlist, const char *recipe_name, const char *context)
 This recipe calibrates the photometry of ERIS/NIX frames.
 
cpl_error_code eris_nix_scired_hdrl_stack (cpl_frameset *frameset, const cpl_parameterlist *parlist, const char *recipe_name, const char *context)
 This rebin and stack a set of calibrated ERIS/NIX jitter frames.
 

Detailed Description

TBD

Function Documentation

◆ eris_nix_scired_cal_det()

cpl_error_code eris_nix_scired_cal_det ( cpl_frameset *  frameset,
const cpl_parameterlist *  parlist,
const char *  recipe_name,
const char *  context 
)

This function removes the detector signature from science frames.

Parameters
framesetthe frames list
parlistthe parameters list
recipe_namename of recipe
contextrecipe context (eris)

This comprises dark subtraction, linearization, flat-fielding, and association with the master bad-pixel mask.

Returns
CPL_ERROR_NONE iff OK

Definition at line 581 of file eris_nix_scired.c.

References en_master_bpm_delete(), en_master_dark_delete(), en_master_dark_load_from_frameset(), enu_basic_calibrate(), enu_load_limage_from_frame(), enu_located_image_delete(), eris_files_dont_exist(), and eris_nix_dfs_set_groups().

◆ eris_nix_scired_cal_phot()

cpl_error_code eris_nix_scired_cal_phot ( cpl_frameset *  frameset,
const cpl_parameterlist *  parlist,
const char *  recipe_name,
const char *  context 
)

This recipe calibrates the photometry of ERIS/NIX frames.

Parameters
framesetthe frames list
parlistthe parameters list
recipe_namename of recipe
contextrecipe context (eris)
      This recipe calibrates the photometry of ERIS/NIX frames.
Returns
CPL_ERROR_NONE iff OK

Definition at line 3584 of file eris_nix_scired.c.

References enu_limlist_load_from_frameset(), enu_located_imagelist_delete(), eris_files_dont_exist(), and eris_nix_dfs_set_groups().

◆ eris_nix_scired_cal_wcs()

cpl_error_code eris_nix_scired_cal_wcs ( cpl_frameset *  frameset,
const cpl_parameterlist *  parlist,
const char *  recipe_name,
const char *  context 
)

This recipe calibrates the astrometry of ERIS/NIX frames.

Parameters
framesetthe frames list
parlistthe parameters list
recipe_namename of recipe
contextrecipe context (eris)

This comprises dark subtraction, linearization, flat-fielding, and association with the master bad-pixel mask.

Returns
CPL_ERROR_NONE iff OK

Definition at line 1709 of file eris_nix_scired.c.

References enu_calc_pixel_coords(), enu_catalogue_compute(), enu_catalogue_limlist(), enu_dfs_save_catalogue(), enu_dfs_save_limage(), enu_get_ra_dec(), enu_get_rcore_and_mesh_size(), enu_limlist_load_from_frameset(), enu_located_imagelist_delete(), enu_repreface(), eris_files_dont_exist(), eris_nix_dfs_set_groups(), hdrl_catalogue_parameter_create(), hdrl_image_get_size_x(), hdrl_image_get_size_y(), hdrl_image_reject_from_mask(), and hdrl_parameter_delete().

◆ eris_nix_scired_hdrl_stack()

cpl_error_code eris_nix_scired_hdrl_stack ( cpl_frameset *  frameset,
const cpl_parameterlist *  parlist,
const char *  recipe_name,
const char *  context 
)

◆ eris_nix_scired_skysub()

cpl_error_code eris_nix_scired_skysub ( cpl_frameset *  frameset,
const cpl_parameterlist *  parlist,
const char *  recipe_name,
const char *  context 
)

This recipe estimates and subtracts the sky background from a set of science frames.

Parameters
framesetthe frames list
parlistthe parameters list
recipe_namename of recipe
contextrecipe context (eris)

This comprises dark subtraction, linearization, flat-fielding, and association with the master bad-pixel mask.

Returns
CPL_ERROR_NONE iff OK

Definition at line 1064 of file eris_nix_scired.c.

References enu_debug_limlist_save(), enu_dfs_save_limage(), enu_get_ra_dec(), enu_limlist_load_from_frameset(), enu_located_imagelist_delete(), enu_repreface(), enu_sky_subtract_limlist(), eris_files_dont_exist(), and eris_nix_dfs_set_groups().