DFS related functions

Functions
cpl_error_code	eris_nix_dfs_set_groups (cpl_frameset *set)
	Set the group as RAW or CALIB in a frameset.
cpl_error_code	enu_dfs_save_bpm (const char *procat, cpl_frameset *allframes, const cpl_parameterlist *parlist, const cpl_frameset *usedframes, const master_bpm *mbad_pix_map, const char *recipe, const cpl_propertylist *applist, const char *pipe_id, const char *filename)
	Save a master_bpm as a DFS-compliant pipeline product.
cpl_error_code	enu_dfs_save_catalogue (cpl_frameset *frameset, cpl_frame *image, const cpl_parameterlist *parlist, const cpl_table *catalogue, const cpl_propertylist *tablelist, const char *cat_name, const char *recipe, const char *pipe_id, const char *preface, const char *procat)
	Save a catalogue as DFS product.
cpl_error_code	enu_dfs_save_himage (cpl_frameset *allframes, const cpl_parameterlist *parlist, const cpl_frameset *provenance, const cpl_boolean prov_raw, const hdrl_image *image, const hdrl_imagelist *imagelist, const mef_extension_list *mefs, const char *recipe, const cpl_frame *inherit_frame, const cpl_propertylist *applist, const cpl_propertylist *wcs_plist, const char *pipe_id, const char *filename)
	Save an hdrl_image/imagelist as a DFS-compliant MEF pipeline product.
cpl_error_code	enu_dfs_save_limage (cpl_frameset *allframes, const cpl_parameterlist *parlist, const cpl_frameset *provenance, const cpl_boolean prov_raw, const located_image *limage, const char *recipe, const cpl_frame *inherit, cpl_propertylist *applist, const char *pipe_id, const char *filename)
	Save a located image structure to a MEF.
cpl_error_code	enu_dfs_setup_product_header (cpl_propertylist *header, const cpl_frame *product_frame, const cpl_frameset *framelist, const cpl_parameterlist *parlist, const char *recipe_id, const char *pipe_id, const cpl_frame *inherit, const cpl_frameset *provenance, cpl_boolean prov_raw)
	Add phase3/IDP keywords to a pipeline product propertyist list.

Detailed Description

Function Documentation

enu_dfs_save_bpm()

cpl_error_code enu_dfs_save_bpm	(	const char *	procat,
		cpl_frameset *	allframes,
		const cpl_parameterlist *	parlist,
		const cpl_frameset *	usedframes,
		const master_bpm *	mbad_pix_map,
		const char *	recipe,
		const cpl_propertylist *	applist,
		const char *	pipe_id,
		const char *	filename
	)

Save a master_bpm as a DFS-compliant pipeline product.

Routine to save a master_bpm to a DFS-compliant FITS file. A wrapper for cpl_dfs_save_image.

Parameters

procat	The product CATG
allframes	The list of input frames for the recipe
parlist	The list of input parameters
usedframes	The list of raw/calibration frames used for this product
mbad_pix_map	The master_bpm to be saved
recipe	The recipe name
applist	Propertylist to append to primary header
pipe_id	PACKAGE "/" PACKAGE_VERSION
filename	Filename of created product

Returns

CPL_ERROR_NONE or the relevant CPL error code on error

Definition at line 218 of file eris_nix_dfs.c.

enu_dfs_save_catalogue()

cpl_error_code enu_dfs_save_catalogue	(	cpl_frameset *	frameset,
		cpl_frame *	image,
		const cpl_parameterlist *	parlist,
		const cpl_table *	catalogue,
		const cpl_propertylist *	tablelist,
		const char *	cat_name,
		const char *	recipe,
		const char *	pipe_id,
		const char *	preface,
		const char *	procat
	)

Save a catalogue as DFS product.

Routine to write an hdrl_image data product to a MEF (DFS-compliant) file. Adapted from cpl_dfs_product_save.

Parameters

frameset	The list of input frames for the recipe
image	Frame to which the catalogue refers
parlist	The list of input parameters
catalogue	The catalogue to be saved
tablelist	NULL or optional propertylist to use in table extension
cat_name	The name of the catalogue to be saved
recipe	The recipe name
pipe_id	PACKAGE "/" PACKAGE_VERSION
preface	The catalogue filename will be "<preface>.<raw filename>"
procat	The DFS category of the product

Returns

CPL_ERROR_NONE on success, a CPL error code otherwise

The function saves the table to a DFS-compliant FITS file of name "<preface>.<inherit frame filename>", with keyword DPR.CATG set to the specified value. If the catalogue is NULL no action is taken.

Definition at line 274 of file eris_nix_dfs.c.

References enu_dfs_setup_product_header(), enu_repreface(), and eris_check_error_code().

Referenced by eris_nix_scired_cal_wcs(), and eris_nix_scired_hdrl_stack().

enu_dfs_save_himage()

cpl_error_code enu_dfs_save_himage	(	cpl_frameset *	allframes,
		const cpl_parameterlist *	parlist,
		const cpl_frameset *	provenance,
		const cpl_boolean	prov_raw,
		const hdrl_image *	image,
		const hdrl_imagelist *	imagelist,
		const mef_extension_list *	mefs,
		const char *	recipe,
		const cpl_frame *	inherit_frame,
		const cpl_propertylist *	applist,
		const cpl_propertylist *	wcs_plist,
		const char *	pipe_id,
		const char *	filename
	)

Save an hdrl_image/imagelist as a DFS-compliant MEF pipeline product.

Routine to write an hdrl_image or hdrl_imagelist data product to a MEF (DFS-compliant) file. Adapted from cpl_dfs_product_save.

Parameters

allframes	The list of input frames for the recipe
parlist	The list of input parameters
usedframes	The raw/calibration frames used for this product
provenance	The frames that contributed directly to this product
prov_raw	CPL_TRUE for raw data filenames, CPL_FALSE for actual names
image	The image to be saved or...
imagelist	...the imagelist to be saved
mefs	List of extension components associated with the image
recipe	The recipe name
inherit	See cpl_dfs_setup_product_header.
applist	Propertyies to add to primary header, w. PRO.CATG
wcs_list	Properties defining image wcs
pipe_id	PACKAGE "/" PACKAGE_VERSION
filename	Filename of created product

Returns

CPL_ERROR_NONE or the relevant CPL error code on error

Definition at line 423 of file eris_nix_dfs.c.

References enu_dfs_setup_product_header(), enu_mef_extension_save(), eris_check_error_code(), hdrl_image_get_error_const(), hdrl_image_get_image_const(), hdrl_image_get_mask(), hdrl_imagelist_get(), and hdrl_imagelist_get_size().

Referenced by enlu_trace_save(), enu_dfs_save_limage(), and enu_flat_save().

enu_dfs_save_limage()

cpl_error_code enu_dfs_save_limage	(	cpl_frameset *	allframes,
		const cpl_parameterlist *	parlist,
		const cpl_frameset *	provenance,
		const cpl_boolean	prov_raw,
		const located_image *	limage,
		const char *	recipe,
		const cpl_frame *	inherit,
		cpl_propertylist *	applist,
		const char *	pipe_id,
		const char *	filename
	)

Save a located image structure to a MEF.

Parameters

allframes	The list of input frames for the recipe
parlist	The list of input parameters
provenance	The frames that contribute directly to this product
prov_raw	CPL_TRUE for raw data filenames, CPL_FALSE for actual names
limage	The locate image to save
recipe	The recipe name
inherit	The frame to inherit header info from
applist	The propertylist to be added to the primary header
pipe_id	PACKAGE "/" PACKAGE_VERSION
filename	The name of the pipeline

Returns

CPL_ERROR_NONE if all goes well, otherwise an error code

Definition at line 909 of file eris_nix_dfs.c.

References enu_dfs_save_himage(), enu_mef_extension_list_delete(), enu_mef_extension_list_new(), enu_mef_new_image(), eris_check_error_code(), hdrl_image_get_error(), and hdrl_image_get_image().

Referenced by enu_debug_limlist_save(), eris_nix_scired_cal_wcs(), eris_nix_scired_hdrl_stack(), and eris_nix_scired_skysub().

enu_dfs_setup_product_header()

cpl_error_code enu_dfs_setup_product_header	(	cpl_propertylist *	header,
		const cpl_frame *	product_frame,
		const cpl_frameset *	framelist,
		const cpl_parameterlist *	parlist,
		const char *	recipe_id,
		const char *	pipe_id,
		const cpl_frame *	inherit,
		const cpl_frameset *	provenance,
		cpl_boolean	prov_raw
	)

Add phase3/IDP keywords to a pipeline product propertyist list.

Parameters

header	The required propertylist
product_frame	Frame containing the productFilename of created product
framelist	The list of input frames for the recipe
parlist	The list of input parameters
recipe_id	The recipe name
pipe_id	PACKAGE "/" PACKAGE_VERSION
inherit	The frame to inherit header info from
provenance	The frames that contribute directly to this product
prov_raw	CPL_TRUE for raw data filenames, CPL_FALSE for actual names

Returns

CPL_ERROR_NONE if all goes well, otherwise an error code

Definition at line 1038 of file eris_nix_dfs.c.

References enu_get_filter(), and eris_check_error_code().

Referenced by enu_dfs_save_catalogue(), and enu_dfs_save_himage().

eris_nix_dfs_set_groups()

cpl_error_code eris_nix_dfs_set_groups

(

cpl_frameset *

set

)

Set the group as RAW or CALIB in a frameset.

Parameters

set	the input frameset

Returns

CPL_ERROR_NONE iff OK

Definition at line 58 of file eris_nix_dfs.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().