Macros
#define	RECIPE_ID "xsh_mdark"

#define	RECIPE_AUTHOR "P.Goldoni, L.Guglielmi, R. Haigron, F. Royer, D. Bramich, A. Modigliani"

#define	RECIPE_CONTACT "amodigli@eso.org"

Functions
static int	xsh_mdark_create (cpl_plugin *plugin)
	Setup the recipe options.

static int	xsh_mdark_exec (cpl_plugin *plugin)
	Execute the plugin instance given by the interface.

static int	xsh_mdark_destroy (cpl_plugin *plugin)
	Destroy what has been created by the 'create' function.

static void	xsh_mdark (cpl_parameterlist parameters, cpl_frameset frameset)
	Interpret the command line options and execute the data processing.

int	cpl_plugin_get_info (cpl_pluginlist *list)
	Build the list of available plugins, for this module.

static cpl_error_code	xsh_params_set_defaults (cpl_parameterlist pars, xsh_instrument inst)

static cpl_frame *	xsh_get_master_dark_nir_via_noise (cpl_imagelist dataList, cpl_frame medFrame, cpl_parameterlist parameters, xsh_clipping_param noise_clipping, xsh_instrument instrument, cpl_frame *noisyFrame)

static cpl_frame *	xsh_get_master_dark_opt (cpl_frame medFrame, cpl_frame master_bias, cpl_parameterlist parameters, cpl_frame crh_frm, cpl_frame bp_map_noise_frm, xsh_instrument instrument, const int pre_overscan_corr)

static cpl_frame *	xsh_get_crh_frame (cpl_image crh_ima, xsh_instrument instrument)

Variables
static char	xsh_mdark_description_short []

static char	xsh_mdark_description []

Detailed Description

This recipe calculates the master dark frame See man-page for details.

Macro Definition Documentation

◆ RECIPE_AUTHOR

#define RECIPE_AUTHOR "P.Goldoni, L.Guglielmi, R. Haigron, F. Royer, D. Bramich, A. Modigliani"

Definition at line 72 of file xsh_mdark.c.

◆ RECIPE_CONTACT

#define RECIPE_CONTACT "amodigli@eso.org"

Definition at line 73 of file xsh_mdark.c.

◆ RECIPE_ID

#define RECIPE_ID "xsh_mdark"

Definition at line 71 of file xsh_mdark.c.

Function Documentation

◆ cpl_plugin_get_info()

int cpl_plugin_get_info ( cpl_pluginlist * list )

Build the list of available plugins, for this module.

Parameters

list	the plugin list

Returns: 0 if everything is ok, -1 otherwise

Create the recipe instance and make it available to the application using the interface. This function is exported.

Definition at line 128 of file xsh_mdark.c.

References RECIPE_AUTHOR, RECIPE_CONTACT, RECIPE_ID, xsh_get_license(), xsh_mdark_create(), xsh_mdark_description, xsh_mdark_description_short, xsh_mdark_destroy(), and xsh_mdark_exec().

◆ xsh_get_crh_frame()

static cpl_frame * xsh_get_crh_frame	(	cpl_image *	crh_ima,
		xsh_instrument *	instrument
	)

static

Definition at line 440 of file xsh_mdark.c.

References instrument, xsh_add_temporary_file(), XSH_CRH_MAP, xsh_frame_product(), XSH_FREE, XSH_GET_TAG_FROM_ARM, xsh_instrument_arm_tostring(), and XSH_PREFIX.

Referenced by xsh_mdark().

◆ xsh_get_master_dark_nir_via_noise()

static cpl_frame * xsh_get_master_dark_nir_via_noise	(	cpl_imagelist *	dataList,
		cpl_frame *	medFrame,
		cpl_parameterlist *	parameters,
		xsh_clipping_param *	noise_clipping,
		xsh_instrument *	instrument,
		cpl_frame **	noisyFrame
	)

static

Definition at line 342 of file xsh_mdark.c.

References check, xsh_clipping_param::diff, xsh_clipping_param::frac, instrument, llx, lly, xsh_clipping_param::niter, QFLAG_HOT_PIXEL, xsh_clipping_param::sigma, urx, ury, xsh_add_temporary_file(), XSH_BP_MAP_NP, xsh_bpmap_mask_bad_pixel(), xsh_compute_noise_map(), xsh_free_image(), xsh_free_mask(), xsh_free_propertylist(), XSH_GET_TAG_FROM_ARM, xsh_image_search_bad_pixels_via_noise(), xsh_msg_dbg_low, and xsh_pfits_set_pcatg().

Referenced by xsh_mdark().

◆ xsh_get_master_dark_opt()

static cpl_frame * xsh_get_master_dark_opt	(	cpl_frame *	medFrame,
		cpl_frame *	master_bias,
		cpl_parameterlist *	parameters,
		cpl_frame *	crh_frm,
		cpl_frame *	bp_map_noise_frm,
		xsh_instrument *	instrument,
		const int	pre_overscan_corr
	)

static

Definition at line 415 of file xsh_mdark.c.

References check, check_msg, instrument, xsh_create_master_dark(), xsh_free_frame(), xsh_msg, and xsh_subtract_bias().

Referenced by xsh_mdark().

◆ xsh_mdark()

static void xsh_mdark	(	cpl_parameterlist *	parameters,
		cpl_frameset *	frameset
	)

static

Interpret the command line options and execute the data processing.

Parameters

parameters	the parameters list
frameset	the frames list

In case of failure the cpl_error_code is set.

Definition at line 476 of file xsh_mdark.c.

References check, check_msg, crh_clipping, instrument, xsh_pre::qual, RECIPE_ID, xsh_add_product_image(), XSH_ARM_NIR, XSH_ASSURE_NOT_ILLEGAL, xsh_badpixelmap_fill_bp_pattern_holes(), xsh_badpixelmap_image_coadd(), xsh_begin(), xsh_check_load_master_bpmap(), xsh_create_master_dark(), xsh_create_master_dark2(), XSH_DARK, xsh_end(), xsh_find_frame_with_tag(), xsh_frame_head_extract_qc(), xsh_frameset_check_uniform_exptime(), XSH_FREE, xsh_free_frame(), xsh_free_frameset(), xsh_free_image(), xsh_free_imagelist(), xsh_free_propertylist(), xsh_get_crh_frame(), xsh_get_master_dark_nir_via_noise(), xsh_get_master_dark_opt(), xsh_instrument_arm_tostring(), xsh_instrument_free(), xsh_instrument_get_arm(), XSH_MASTER_BIAS, xsh_mdark_description_short, xsh_msg, xsh_parameters_clipping_crh_get(), xsh_parameters_clipping_noise_get(), xsh_parameters_get_int(), xsh_params_set_defaults(), xsh_pre_free(), xsh_pre_load(), xsh_pre_save(), xsh_prepare(), xsh_recipe_params_check(), xsh_remove_crh_multiple(), and xsh_stack_frames_get().

Referenced by xsh_mdark_exec().

◆ xsh_mdark_create()

static int xsh_mdark_create ( cpl_plugin * plugin )

static

Setup the recipe options.

Parameters

plugin the plugin

Returns: 0 if everything is ok

Create the recipe instance and make it available to the application using the interface.

Definition at line 170 of file xsh_mdark.c.

References assure, check, DECODE_BP_FLAG_DEF, RECIPE_ID, xsh_error_dump, xsh_init(), xsh_parameters_clipping_crh_create(), xsh_parameters_clipping_noise_create(), xsh_parameters_decode_bp(), xsh_parameters_fpn_create(), xsh_parameters_generic(), xsh_parameters_new_boolean(), xsh_parameters_new_double(), xsh_parameters_pre_overscan(), xsh_parameters_ref1_create(), xsh_parameters_ron_dark_create(), and xsh_parameters_stack_create().

Referenced by cpl_plugin_get_info().

◆ xsh_mdark_destroy()

static int xsh_mdark_destroy ( cpl_plugin * plugin )

static

Destroy what has been created by the 'create' function.

Parameters

plugin the plugin

Returns: 0 if everything is ok

Definition at line 291 of file xsh_mdark.c.

References assure, xsh_error_reset, and xsh_free_parameterlist().

Referenced by cpl_plugin_get_info().

◆ xsh_mdark_exec()

static int xsh_mdark_exec ( cpl_plugin * plugin )

static

Execute the plugin instance given by the interface.

Parameters

plugin the plugin

Returns: 0 if everything is ok

Definition at line 257 of file xsh_mdark.c.

References assure, xsh_error_dump, xsh_error_reset, and xsh_mdark().

Referenced by cpl_plugin_get_info().

◆ xsh_params_set_defaults()

static cpl_error_code xsh_params_set_defaults	(	cpl_parameterlist *	pars,
		xsh_instrument *	inst
	)

static

Definition at line 319 of file xsh_mdark.c.

References check, RECIPE_ID, XSH_ARM_NIR, xsh_instrument_get_arm(), and xsh_parameters_find().

Referenced by xsh_mdark().

Variable Documentation

◆ xsh_mdark_description

char xsh_mdark_description[]

static

Initial value:

=
"This recipe creates a master dark frame\n\
Input Frames : \n\
  - A set of n RAW frames (Format=RAW, n >=3, Tag = DARK_arm)\n\
  - [UVB,VIS] A master bias frame (Format=PRE, Tag = MASTER_BIAS_arm)\n\
  - [OPTIONAL] A map of non linear bad pixels (Format=QUP, Tag = BP_MAP_NL_arm)\n\
  - [OPTIONAL] A map of reference bad pixels (Format = QUP,RAW, Tag = BP_MAP_RP_arm)\n\
Products : \n\
  - A master dark frame (Format=PRE, PRO.CATG = MASTER_DARK_arm)\n\
    A dark frame, (Format=PRE, PRO.CATG = DARK_arm)\n"

Definition at line 96 of file xsh_mdark.c.

Referenced by cpl_plugin_get_info().

◆ xsh_mdark_description_short

char xsh_mdark_description_short[]

static

Initial value:

=

"Create the master dark frame"

Definition at line 93 of file xsh_mdark.c.

Referenced by cpl_plugin_get_info(), and xsh_mdark().

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ RECIPE_AUTHOR

◆ RECIPE_CONTACT

◆ RECIPE_ID

Function Documentation

◆ cpl_plugin_get_info()

◆ xsh_get_crh_frame()

◆ xsh_get_master_dark_nir_via_noise()

◆ xsh_get_master_dark_opt()

◆ xsh_mdark()

◆ xsh_mdark_create()

◆ xsh_mdark_destroy()

◆ xsh_mdark_exec()

◆ xsh_params_set_defaults()

Variable Documentation

◆ xsh_mdark_description

◆ xsh_mdark_description_short