QC Structure Functions

Functions
qc_description *	xsh_get_qc_desc_by_kw (const char *kw)
qc_description *	xsh_get_qc_desc_by_pro_catg (const char *pro_catg)
int	xsh_qc_in_recipe (qc_description *pqc, xsh_instrument *instrument)
qc_description *	xsh_get_qc_desc_by_recipe (const char *recipe, qc_description *prev)
qc_description *	xsh_get_qc_desc_by_function (char *function, qc_description *prev)
int	xsh_is_qc_for_arm (const char *arm, qc_description *pqc)
int	xsh_is_qc_for_pro_catg (const char *pro_catg, qc_description *pqc)
void	xsh_add_qc_crh (xsh_pre *pre, int nbcrh, int nframes)

Detailed Description

Function Documentation

xsh_add_qc_crh()

void xsh_add_qc_crh	(	xsh_pre *	pre,
		int	nbcrh,
		int	nframes
	)

Calculates and set the QC parameters relevant for Cosmic Rays.

Parameters

pre	Pointer to XSH_PRE Structure
nbcrh	Total umber of cosmics found
nframes	Number of frames used to remove cosmics

< Average of cosmics per frame

Definition at line 225 of file xsh_qc_handling.c.

References check, xsh_pre::data_header, xsh_pre::exptime, xsh_pre::nx, xsh_pre::ny, xsh_pre::pszx, xsh_pre::pszy, xsh_pre::qual_header, XSH_ASSURE_NOT_ILLEGAL, XSH_ASSURE_NOT_NULL, xsh_msg_dbg_medium, xsh_pfits_set_qc_crrate(), xsh_pfits_set_qc_ncrh(), and xsh_pfits_set_qc_ncrh_mean().

Referenced by xsh_hdrl_remove_crh_single(), and xsh_remove_crh_single().

xsh_get_qc_desc_by_function()

qc_description * xsh_get_qc_desc_by_function	(	char *	function,
		qc_description *	prev
	)

Definition at line 140 of file xsh_qc_handling.c.

References qc_description::kw_function, qc_description::kw_name, and qc_table.

xsh_get_qc_desc_by_kw()

qc_description * xsh_get_qc_desc_by_kw

(

const char *

kw

)

Definition at line 70 of file xsh_qc_handling.c.

References qc_description::kw_name, and qc_table.

Referenced by xsh_pfits_set_qc(), and xsh_pfits_set_qc_multi().

xsh_get_qc_desc_by_pro_catg()

qc_description * xsh_get_qc_desc_by_pro_catg

(

const char *

pro_catg

)

Definition at line 81 of file xsh_qc_handling.c.

References qc_description::kw_name, qc_description::pro_catg, and qc_table.

xsh_get_qc_desc_by_recipe()

qc_description * xsh_get_qc_desc_by_recipe	(	const char *	recipe,
		qc_description *	prev
	)

Definition at line 118 of file xsh_qc_handling.c.

References qc_description::kw_name, qc_description::kw_recipes, qc_description::kw_recipes_tbw, qc_description::kw_type, and qc_table.

Referenced by main(), and xsh_paf_save().

xsh_is_qc_for_arm()

int xsh_is_qc_for_arm	(	const char *	arm,
		qc_description *	pqc
	)

Check if the ARM is in the list of arms of the QC descriptor. If yes or the list of arms is NULL, returns TRUE (1), returns 0 otherwise. Is used for somw WC parameters that are relevant only for some specific arm(s) such as BP-MAP NOISYPIX (calculated in xsh_mdark).

Parameters

arm	Name of the arm (NIR, UVB, VIS)
pqc	Pointer to QC parameter description

Returns

1 if the arm is in the qc.arms string or qc.arms is null, 0 otherwise

Definition at line 169 of file xsh_qc_handling.c.

References qc_description::arms.

Referenced by xsh_paf_save().

xsh_is_qc_for_pro_catg()

int xsh_is_qc_for_pro_catg	(	const char *	pro_catg,
		qc_description *	pqc
	)

Check if the PRO.CATG is in the list of arms of the QC descriptor. If yes or the list of pro.catg is NULL, returns TRUE (1), returns 0 otherwise.

Parameters

pro_catg	PRO.CATG string
pqc	Pointer to QC parameter description

Returns

1 if the arm is in the qc.pro_catg string or qc.pro_catg is null, 0 otherwise.

Definition at line 186 of file xsh_qc_handling.c.

References qc_description::kw_name, qc_description::pro_catg, and xsh_msg_dbg_high.

Referenced by xsh_paf_save().

xsh_qc_in_recipe()

int xsh_qc_in_recipe	(	qc_description *	pqc,
		xsh_instrument *	instrument
	)

Definition at line 108 of file xsh_qc_handling.c.

References instrument, qc_description::kw_recipes, qc_description::kw_recipes_tbw, and xsh_instrument::recipe_id.

Referenced by xsh_pfits_set_qc(), and xsh_pfits_set_qc_multi().