Utilities relating to MASTER_DARKs

Functions
master_dark *	en_master_dark_create (const hdrl_image *dark, const cpl_mask *hot_bpm, const char *filename, const cpl_propertylist *plist)
	Create a new master_dark struct and initialise the contents.
void	en_master_dark_delete (master_dark *target)
	Delete a 'master_dark' struct.
master_dark *	en_master_dark_load_from_frameset (const cpl_frameset *frameset, const char *tag, cpl_frameset *used)
	Load a 'master_dark' struct from a frameset.
master_dark *	en_master_dark_test (const cpl_size nx, const cpl_size ny, const double dit, const int ndit, const char *mode)
	Create a test master_dark struct.

Detailed Description

Function Documentation

en_master_dark_create()

master_dark * en_master_dark_create	(	const hdrl_image *	dark,
		const cpl_mask *	hot_bpm,
		const char *	filename,
		const cpl_propertylist *	plist
	)

Create a new master_dark struct and initialise the contents.

Parameters

dark	The hdrl_image containing the dark
hot_bpm	The cpl_image containing the hot-pixel bpm
filename	The name of the associated file, or NULL
plist	The associated property list

Returns

The new master_dark struct

The function returns a pointer to a master_dark structure that is populated with copies of the given items.

The object and its contents are deleted by a call to en_master_dark_delete.

Definition at line 66 of file eris_nix_master_dark.c.

References hdrl_image_duplicate().

Referenced by en_master_dark_load_from_frameset(), and en_master_dark_test().

en_master_dark_delete()

void en_master_dark_delete

(

master_dark *

target

)

Delete a 'master_dark' struct.

Parameters

target

The master_dark struct to be deleted

The function deletes a master_dark struct and its contents. If the pointer is NULL then no action is taken but no error set.

Definition at line 106 of file eris_nix_master_dark.c.

References hdrl_image_delete().

Referenced by en_master_dark_load_from_frameset(), en_master_dark_test(), and eris_nix_scired_cal_det().

en_master_dark_load_from_frameset()

master_dark * en_master_dark_load_from_frameset	(	const cpl_frameset *	frameset,
		const char *	tag,
		cpl_frameset *	used
	)

Load a 'master_dark' struct from a frameset.

Parameters

frameset	The list of input frames
tag	The frame tag to look for
used	The list of raw/calibration frames used for this product

Returns

Pointer to the master_dark struct

The function loads a master_dark struct from a frameset.

Definition at line 130 of file eris_nix_master_dark.c.

References en_master_dark_create(), en_master_dark_delete(), enu_himage_load_from_fits(), enu_mef_extension_list_delete(), enu_mef_extension_list_get_mask(), and hdrl_image_delete().

Referenced by eris_nix_scired_cal_det().

en_master_dark_test()

master_dark * en_master_dark_test	(	const cpl_size	nx,
		const cpl_size	ny,
		const double	dit,
		const int	ndit,
		const char *	mode
	)

Create a test master_dark struct.

Parameters

nx	x dimension of detector
ny	y dimension of detector
dit	The DIT of the dark
ndit	The NDIT of the dark
mode	The detector read mode for the dark

Returns

The new master_dark struct

The function returns a pointer to a dummy master_dark structure for use in simple tests.

The object and its contents are deleted by a call to en_master_dark_delete.

Definition at line 203 of file eris_nix_master_dark.c.

References en_master_dark_create(), en_master_dark_delete(), hdrl_image_create(), hdrl_image_delete(), hdrl_image_get_mean(), hdrl_image_get_median(), and hdrl_image_get_stdev().