Cube resampling related functions

Functions
cpl_error_code	eris_ifu_resample_save_cube (hdrl_resample_result *aCube, const char *procatg, const char *recipe, const char *filename, const cpl_parameterlist *parlist, cpl_frameset *frameset, cpl_boolean gen_phase3)
	save an cube (imagelist, product of pixel resampling) on a FITS file with proper FITS header
cpl_error_code	eris_ifu_cube_collapse_mean_and_save (const char *pro_catg, cpl_frameset *frameset, const cpl_parameterlist *parlist, const char *recipe_name, cpl_boolean apply_flat, cpl_boolean is_pupil)
	-------------------------------------------------------------------------—‍/
cpl_error_code	eris_ifu_combine (cubeType obj_type, cpl_frameset *frameset, const cpl_parameterlist *parlist, const char *recipe_name, const char *pipefile_prefix)
	This function resample input cubes using HDRL.
cpl_error_code	eris_ifu_resample_trim_edge (hdrl_image *himg, int edge_trim)
	Duplicate a 2D header from a 3D header.
cpl_error_code	eris_ifu_combine_pbp (cpl_frameset *frameset, const cpl_parameterlist *parlist, const char *input_cube_pro_catg, const char *filenameSpec, float *offsetx, float *offsety, const char *offunit, const char *recipe_name, const char *pipefile_prefix)
	This function resample input cubes plane by plane using HDRL.

Detailed Description

TBD

Function Documentation

eris_ifu_combine()

cpl_error_code eris_ifu_combine	(	cubeType	obj_type,
		cpl_frameset *	frameset,
		const cpl_parameterlist *	parlist,
		const char *	recipe_name,
		const char *	pipefile_prefix
	)

This function resample input cubes using HDRL.

Parameters

obj_type	input object type
frameset	input set of frames
parlist	input recipe parameters
recipe_name	recipe name
pipefile_prefix	product filename prefix

Returns

cpl_error_code

Definition at line 1968 of file eris_ifu_resample.c.

References eris_check_error_code(), eris_ifu_extract_frameset(), eris_ifu_free_propertylist(), eris_ifu_free_string(), eris_ifu_resample_save_cube(), eris_ifu_save_image(), hdrl_image_delete(), hdrl_image_get_error(), hdrl_image_get_image(), hdrl_image_get_mask(), hdrl_imagelist_collapse_mean(), hdrl_parameter_delete(), hdrl_resample_compute(), and hdrl_resample_result_delete().

eris_ifu_combine_pbp()

cpl_error_code eris_ifu_combine_pbp	(	cpl_frameset *	frameset,
		const cpl_parameterlist *	parlist,
		const char *	input_cube_pro_catg,
		const char *	filenameSpec,
		float *	offsetx,
		float *	offsety,
		const char *	offunit,
		const char *	recipe_name,
		const char *	pipefile_prefix
	)

This function resample input cubes plane by plane using HDRL.

Parameters

frameset	input set of frames
parlist	input recipe parameters
input_cube_pro_catg	type of products to be combined
filenameSpec	product filename suffix
offsetx	user defined X offsets
offsety	user defined Y offsets
offunit	user defined offset unit [pix/arcsec]
recipe_name	recipe name
pipefile_prefix	product filename prefix

Returns

cpl_error_code

Definition at line 2265 of file eris_ifu_resample.c.

References eris_check_error_code(), eris_ifu_extract_frameset(), eris_ifu_free_string(), eris_ifu_resample_save_cube(), eris_ifu_resample_trim_edge(), eris_ifu_save_deq_image(), eris_ifu_save_image_phase3(), eris_pfits_get_dit(), eris_pfits_get_ndit(), hdrl_image_create(), hdrl_image_delete(), hdrl_image_duplicate(), hdrl_image_get_error(), hdrl_image_get_image(), hdrl_image_get_mask(), hdrl_image_get_median(), hdrl_image_reject_from_mask(), hdrl_image_sub_scalar(), hdrl_imagelist_collapse_mean(), hdrl_imagelist_delete(), hdrl_imagelist_get_const(), hdrl_imagelist_new(), hdrl_imagelist_set(), hdrl_parameter_delete(), hdrl_resample_compute(), hdrl_resample_image_to_table(), and hdrl_resample_result_delete().

eris_ifu_cube_collapse_mean_and_save()

cpl_error_code eris_ifu_cube_collapse_mean_and_save	(	const char *	pro_catg,
		cpl_frameset *	frameset,
		const cpl_parameterlist *	parlist,
		const char *	recipe_name,
		cpl_boolean	apply_flat,
		cpl_boolean	is_pupil
	)

-------------------------------------------------------------------------—‍/

‍** ‍**

This function mean-collapse and save a cube along wavelength (Z) azis

Parameters

pro_catg	cube product category
frameset	input set of frames
parlist	input recipe parameters
recipe_name	recipe name
apply_flat	do flat field
is_pupil	is a pupil frame

Returns

cpl_error_code

Definition at line 1587 of file eris_ifu_resample.c.

References eris_check_error_code(), eris_ifu_free_propertylist(), eris_ifu_resample_trim_edge(), eris_ifu_save_deq_image(), eris_ifu_save_image_phase3(), eris_pfits_get_dit(), eris_pfits_get_ndit(), eris_pfits_put_qc(), eris_qclog_add_double_f(), eris_qclog_init(), hdrl_image_create(), hdrl_image_delete(), hdrl_image_get_error(), hdrl_image_get_image(), hdrl_image_get_mask(), hdrl_image_get_size_x(), hdrl_image_get_size_y(), hdrl_image_reject_from_mask(), hdrl_imagelist_collapse_mean(), hdrl_imagelist_create(), and hdrl_imagelist_delete().

eris_ifu_resample_save_cube()

cpl_error_code eris_ifu_resample_save_cube	(	hdrl_resample_result *	aCube,
		const char *	procatg,
		const char *	recipe,
		const char *	filename,
		const cpl_parameterlist *	parlist,
		cpl_frameset *	frameset,
		cpl_boolean	gen_phase3
	)

save an cube (imagelist, product of pixel resampling) on a FITS file with proper FITS header

Parameters

aCube	cube to save
procatg	FITS product category
recipe	recipe name
filename	product filename
parlist	input recipe parameters
frameset	product set of frames

Returns

cpl_error_code

Definition at line 776 of file eris_ifu_resample.c.

References eris_check_error_code(), eris_ifu_free_propertylist(), eris_ifu_heades_add_hduclass_common(), eris_ifu_heades_add_hduclass_data(), eris_ifu_heades_add_hduclass_errs(), eris_ifu_heades_add_hduclass_qual(), and eris_ifu_split3_hdrl_imagelist().

Referenced by eris_ifu_combine(), and eris_ifu_combine_pbp().

eris_ifu_resample_trim_edge()

cpl_error_code eris_ifu_resample_trim_edge	(	hdrl_image *	himg,
		int	edge_trim
	)

Duplicate a 2D header from a 3D header.

Parameters

himg	hdrl_image to be trimmed
edge_trim	Number of pixels to be trimmed

Returns

cpl_error_code

Definition at line 2200 of file eris_ifu_resample.c.

References eris_check_error_code(), hdrl_image_get_size_x(), hdrl_image_get_size_y(), and hdrl_image_reject().

Referenced by eris_ifu_combine_pbp(), and eris_ifu_cube_collapse_mean_and_save().