ERIS Pipeline Reference Manual 1.9.2
Functions
Miscellaneous Utilities

Functions

cpl_error_code eris_check_error_code (const char *func_id)
 handle CPL errors
 
const char * eris_get_license (void)
 Get the pipeline copyright and license.
 
cpl_frameset * eris_dfs_extract_frames_with_tag (cpl_frameset *input, const char *rtag)
 Extract frames of user given tag.
 
cpl_error_code eris_dfs_extract_raw_frames (cpl_frameset *input, cpl_frameset *raws)
 split input sof in groups: raw and calib
 
cpl_error_code eris_dfs_extract_cal_frames (cpl_frameset *input, cpl_frameset *calibs)
 split input sof in groups: raw and calib
 
cpl_error_code eris_parameters_get_double (const cpl_parameterlist *parlist, const char *pname, double *pvalue)
 get double parameter value if changed by the user
 
cpl_boolean eris_param_has_changed (const cpl_parameter *p)
 verify if a parameter value has been changed (from command line or or rc file by a user)
 
cpl_error_code eris_files_dont_exist (cpl_frameset *frameset)
 Check if all SOF files exist.
 

Detailed Description

Function Documentation

◆ eris_check_error_code()

cpl_error_code eris_check_error_code ( const char *  func_id)

handle CPL errors

Parameters
func_idinput function name
Returns
cpl_error_code
 Example function to handle errors. In case of error this function
 displays the function caller name, the error message, the line of
 code at which the error occurs

Definition at line 56 of file eris_utils.c.

Referenced by enu_basic_calibrate(), enu_basic_calibrate_himage(), enu_bracket_skys(), enu_calc_flat(), enu_calc_maglim(), enu_calc_pixel_coords(), enu_catalogue_compute(), enu_catalogue_limlist(), enu_check_conformance(), enu_check_wcs(), enu_correct_wcs(), enu_debug_limlist_save(), enu_dfs_save_catalogue(), enu_dfs_save_himage(), enu_dfs_save_limage(), enu_dfs_setup_product_header(), enu_flat_save(), enu_get_airmass(), enu_get_det_mode(), enu_get_dit(), enu_get_filter(), enu_get_filter_wavelength(), enu_get_ra_dec(), enu_get_rcore_and_mesh_size(), enu_get_tel_alt(), enu_get_window_info(), enu_himage_load_from_fits(), enu_limlist_load_from_frameset(), enu_load_component(), enu_load_limage_from_frame(), enu_load_mef_components(), enu_located_image_duplicate(), enu_mef_extension_save(), enu_modify_CD_matrix(), enu_normalise_confidence(), enu_opm_limlist(), enu_opm_lss_limlist(), enu_raw_flats_qc(), enu_remove_read_offsets(), enu_sky_backgrounds(), eris_compute_gain(), eris_compute_psf_qc(), eris_dfs_set_groups(), eris_get_cumoffs_dec(), eris_get_cumoffs_ra(), eris_get_mjd_obs(), eris_get_pupil_shift(), eris_ifu_1d_interpolation(), eris_ifu_1d_polynomial_fit(), eris_ifu_add_badpix_border(), eris_ifu_add_std_params(), eris_ifu_append_qc_double(), eris_ifu_append_qc_float(), eris_ifu_append_qc_int(), eris_ifu_bpm_correction(), eris_ifu_calc_bpm(), eris_ifu_calc_centers_collapse_chunk(), eris_ifu_calc_noise_map(), eris_ifu_combine(), eris_ifu_combine_pbp(), eris_ifu_cube_collapse_mean_and_save(), eris_ifu_cube_set_values(), eris_ifu_cube_trim_nans(), eris_ifu_cut_endings(), eris_ifu_dark_get_dqi(), eris_ifu_dark_noise(), eris_ifu_dark_qc(), eris_ifu_dark_static(), eris_ifu_detect_crh(), eris_ifu_detlin_compute_linearity(), eris_ifu_detlin_filter_mask(), eris_ifu_detlin_load_frames(), eris_ifu_dfs_set_groups(), eris_ifu_exposure_column_correction(), eris_ifu_exposure_line_correction(), eris_ifu_extract_frameset(), eris_ifu_extract_mst_frames(), eris_ifu_extract_obj_frames(), eris_ifu_extract_sky_frames(), eris_ifu_fetch_std_param(), eris_ifu_file_exists(), eris_ifu_frame_is_on(), eris_ifu_frame_is_sky(), eris_ifu_free_std_param(), eris_ifu_get_badpix_qc_from_ima(), eris_ifu_get_badpix_qc_from_mask(), eris_ifu_get_band(), eris_ifu_get_band_resolution(), eris_ifu_get_bandString(), eris_ifu_get_callamp_status(), eris_ifu_get_dit(), eris_ifu_get_frameset_by_tag(), eris_ifu_get_hdrlimagelist_by_tag(), eris_ifu_get_instrument(), eris_ifu_get_instrument_frame(), eris_ifu_get_instrumentString(), eris_ifu_get_lampString(), eris_ifu_get_plane_cut_min_max(), eris_ifu_get_preopticsScale(), eris_ifu_get_preopticsScaleString(), eris_ifu_get_spiffi_preoptics_scale(), eris_ifu_get_spiffier_preoptics_scale(), eris_ifu_hdrl_get_imagelist(), eris_ifu_hdrl_image_reject_mask(), eris_ifu_heades_add_hduclass_common(), eris_ifu_heades_add_hduclass_data(), eris_ifu_heades_add_hduclass_errs(), eris_ifu_heades_add_hduclass_qual(), eris_ifu_hima_get_obj_mask(), eris_ifu_idl_values_at_indices(), eris_ifu_idl_where(), eris_ifu_image_collapse(), eris_ifu_image_create_window(), eris_ifu_image_get_mean(), eris_ifu_interpolatedMask_to_maskZero(), eris_ifu_jitter_build_cube(), eris_ifu_jitter_extract(), eris_ifu_jitter_extract_spec_processSof(), eris_ifu_jitter_fetch_params(), eris_ifu_jitter_fill_common_parameterlist(), eris_ifu_jitter_fill_extract_parameterlist(), eris_ifu_jitter_get_instrument_settings(), eris_ifu_jitter_get_objsky_exposures(), eris_ifu_jitter_process_exposures(), eris_ifu_jitter_processSof(), eris_ifu_load_badpixel_mask(), eris_ifu_load_cal_image_file(), eris_ifu_load_cal_image_frame(), eris_ifu_load_deq_hdrl_image(), eris_ifu_load_deq_hdrl_imagelist(), eris_ifu_load_deq_image(), eris_ifu_load_deq_imagelist(), eris_ifu_load_distances(), eris_ifu_load_distortion_polynomials(), eris_ifu_load_distortion_polynomials_old(), eris_ifu_load_exposure_file(), eris_ifu_load_exposure_frame(), eris_ifu_load_exposure_frameset(), eris_ifu_load_slit_positions(), eris_ifu_mask_create_border(), eris_ifu_mask_nans_in_cube(), eris_ifu_mask_nans_in_hdrlimage(), eris_ifu_parameterlist_append_list(), eris_ifu_polyfit_1d(), eris_ifu_quality2bp_mask(), eris_ifu_raw_hdrl_image(), eris_ifu_resample_save_cube(), eris_ifu_resample_trim_edge(), eris_ifu_saturation_detection(), eris_ifu_save_cpl_image_dbg(), eris_ifu_save_cpl_imagelist_dbg(), eris_ifu_save_deq_cube(), eris_ifu_save_deq_image(), eris_ifu_save_hdrl_image_dbg(), eris_ifu_save_hdrl_imagelist_dbg(), eris_ifu_save_image(), eris_ifu_save_image_phase3(), eris_ifu_save_imagelist(), eris_ifu_save_imagelist_dbg(), eris_ifu_save_table(), eris_ifu_sdp_properties_collect(), eris_ifu_sdp_properties_update(), eris_ifu_set_qc_int(), eris_ifu_sky_tweak(), eris_ifu_slitpos_gauss(), eris_ifu_split3_hdrl_imagelist(), eris_ifu_split_hdrl_imagelist(), eris_ifu_stdstar_fill_common_parameterlist(), eris_ifu_warp_polynomial_image(), eris_parlist_config_add_all_recipes(), eris_parlist_config_add_bpm(), eris_parlist_config_add_flat(), eris_pfits_put_qc(), eris_qclog_add_bool(), eris_qclog_add_double(), eris_qclog_add_double_f(), eris_qclog_add_double_format(), eris_qclog_add_int(), eris_qclog_add_string(), eris_qclog_init(), and eris_stdstar_reduction_common().

◆ eris_dfs_extract_cal_frames()

cpl_error_code eris_dfs_extract_cal_frames ( cpl_frameset *  input,
cpl_frameset *  calibs 
)

split input sof in groups: raw and calib

Parameters
inputthe input set of files
calibsthe calibration input set of files
Returns
cpl error code

Definition at line 287 of file eris_utils.c.

◆ eris_dfs_extract_frames_with_tag()

cpl_frameset * eris_dfs_extract_frames_with_tag ( cpl_frameset *  input,
const char *  rtag 
)

Extract frames of user given tag.

Parameters
inputthe input set of files
rtagthe frame tag to be selected
Returns
cpl_frameset with frames of user given tag

Definition at line 227 of file eris_utils.c.

◆ eris_dfs_extract_raw_frames()

cpl_error_code eris_dfs_extract_raw_frames ( cpl_frameset *  input,
cpl_frameset *  raws 
)

split input sof in groups: raw and calib

Parameters
inputthe input set of files
rawsthe raws file of the input set of files
Returns
cpl error code

Definition at line 260 of file eris_utils.c.

◆ eris_files_dont_exist()

cpl_error_code eris_files_dont_exist ( cpl_frameset *  frameset)

Check if all SOF files exist.

Parameters
framesetThe input set-of-frames
Returns
1 if not all files exist, 0 if they all exist.

Definition at line 867 of file eris_utils.c.

Referenced by eris_nix_scired_cal_det(), eris_nix_scired_cal_phot(), eris_nix_scired_cal_wcs(), eris_nix_scired_hdrl_stack(), and eris_nix_scired_skysub().

◆ eris_get_license()

const char * eris_get_license ( void  )

Get the pipeline copyright and license.

Returns
The copyright and license string

The function returns a pointer to the statically allocated license string. This string should not be modified using the returned pointer.

Definition at line 138 of file eris_utils.c.

◆ eris_param_has_changed()

cpl_boolean eris_param_has_changed ( const cpl_parameter *  p)

verify if a parameter value has been changed (from command line or or rc file by a user)

Parameters
pparameter
Returns
CPL_TRUE if parameter has changes, else CPL_FALSE

Definition at line 809 of file eris_utils.c.

Referenced by eris_parameters_get_double().

◆ eris_parameters_get_double()

cpl_error_code eris_parameters_get_double ( const cpl_parameterlist *  parlist,
const char *  pname,
double *  pvalue 
)

get double parameter value if changed by the user

Parameters
parlistlist of input recipe parameters
pnamerecipe parameter name
pvaluerecipe parameter value
Returns
cpl_error_code

Definition at line 765 of file eris_utils.c.

References eris_param_has_changed().

Referenced by eris_compute_psf_qc().