X-shooter Pipeline Reference Manual 3.8.15
Functions
Merge the orders (xsh_merge_ord)

Functions

static void xsh_merge_point (double flux_a, double weight_a, double flux_b, double weight_b, double *flux_res, double *err_res)
 Compute flux and error associated to each merged spectrum point.
 
static cpl_frame * xsh_merge_ord_with_tag (cpl_frame *rec_frame, xsh_instrument *instrument, int merge_par, const char *tag)
 Merge the orders.
 
cpl_frame * xsh_merge_ord (cpl_frame *rec_frame, xsh_instrument *instrument, int merge_par, const char *rec_prefix)
 Merge orders of the rectified frame using merge parameters.
 
cpl_frame * xsh_merge_ord_slitlet (cpl_frame *rec_frame, xsh_instrument *instrument, int merge_par, int slitlet, const char *rec_prefix)
 Merge orders of the rectified frame using merge parameters.
 
static void xsh_frame_set_shift_ref (cpl_frame *rec_frame, cpl_frame *shift_frame)
 
cpl_frameset * xsh_merge_ord_ifu (cpl_frameset *rec_frameset, xsh_instrument *instrument, int merge_par, const char *rec_prefix)
 Merge orders of the rectified frame using merge parameters.
 

Detailed Description

Function ...

Function Documentation

◆ xsh_frame_set_shift_ref()

static void xsh_frame_set_shift_ref ( cpl_frame *  rec_frame,
cpl_frame *  shift_frame 
)
static

◆ xsh_merge_ord()

cpl_frame * xsh_merge_ord ( cpl_frame *  rec_frame,
xsh_instrument instrument,
int  merge_par,
const char *  rec_prefix 
)

Merge orders of the rectified frame using merge parameters.

Parameters
[in]rec_frameRectified frame
[in]instrumentPointer to instrument description structure
[in]merge_parMerge parameters
[in]rec_prefixPrefix (string value recipe related) used for product filenames and tags
Returns
The merged spectrum

Definition at line 418 of file xsh_merge_ord.c.

References CENTER_SLIT, check, instrument, xsh_merge_ord_slitlet(), and xsh_msg.

Referenced by analyse_localization(), xsh_absorp(), xsh_flux_calibrate1D(), xsh_flux_calibrate2D(), xsh_localize_obj(), xsh_respon_slit_nod(), xsh_respon_slit_offset(), xsh_respon_slit_stare(), xsh_scired_slit_nod(), xsh_scired_slit_offset(), xsh_scired_slit_stare(), and xsh_util_apply_response().

◆ xsh_merge_ord_ifu()

cpl_frameset * xsh_merge_ord_ifu ( cpl_frameset *  rec_frameset,
xsh_instrument instrument,
int  merge_par,
const char *  rec_prefix 
)

Merge orders of the rectified frame using merge parameters.

Parameters
[in]rec_framesetRectified frameset
[in]instrumentPointer to instrument description structure
[in]merge_parMerge parameters
[in]rec_prefixPrefix (string value recipe related) used for product filenames and tags
Returns
The merged spectrum

Definition at line 575 of file xsh_merge_ord.c.

References check, instrument, LOWER_IFU_SLITLET, SlitletName, UPPER_IFU_SLITLET, XSH_ASSURE_NOT_NULL, xsh_frame_set_shift_ref(), xsh_frameset_drl_frames(), xsh_free_frameset(), xsh_merge_ord_slitlet(), and xsh_msg.

Referenced by xsh_geom_ifu(), xsh_scired_ifu_offset(), and xsh_scired_ifu_stare().

◆ xsh_merge_ord_slitlet()

cpl_frame * xsh_merge_ord_slitlet ( cpl_frame *  rec_frame,
xsh_instrument instrument,
int  merge_par,
int  slitlet,
const char *  rec_prefix 
)

Merge orders of the rectified frame using merge parameters.

Parameters
[in]rec_frameRectified frame
[in]instrumentPointer to instrument description structure
[in]merge_parMerge parameters
[in]slitletslitlet id (used for IFU)
[in]rec_prefixPrefix (string value recipe related) used for product filenames and tags
Returns
The merged spectrum

Definition at line 447 of file xsh_merge_ord.c.

References check, instrument, XSH_ASSURE_NOT_NULL, XSH_COMBINED_OFFSET_2D_SLIT, XSH_FLUX_MERGE1D, XSH_FLUX_MERGE2D, XSH_FLUX_MOXT1D, XSH_FLUX_ORDER1D, XSH_FLUX_ORDER2D, XSH_FLUX_OXT1D, xsh_free_propertylist(), XSH_GET_TAG_FROM_ARM, XSH_GET_TAG_FROM_SLITLET, XSH_MERGE1D, XSH_MERGE2D, XSH_MERGE_EXT1D, xsh_merge_ord_with_tag(), XSH_MERGE_OXT1D, xsh_msg_error, XSH_NORM_MERGE1D, XSH_NORM_MERGE2D, XSH_NORM_ORDER1D, XSH_NORM_ORDER2D, XSH_ORDER1D, XSH_ORDER2D, XSH_ORDER_EXT1D, XSH_ORDER_OXT1D, and xsh_pfits_get_pcatg().

Referenced by main(), xsh_merge_ord(), and xsh_merge_ord_ifu().

◆ xsh_merge_ord_with_tag()

static cpl_frame * xsh_merge_ord_with_tag ( cpl_frame *  rec_frame,
xsh_instrument instrument,
int  merge_par,
const char *  tag 
)
static

Merge the orders.

Parameters
[in]rec_frameRectified frame (1D or 2D)
[in]instrumentInstrument pointer
[in]merge_parParameters for merge the orders
[in]tagThe spectrum tag
Returns
A spectrum (1D or 2D)

Definition at line 148 of file xsh_merge_ord.c.

References check, xsh_instrument::decode_bp, xsh_spectrum::errs_header, xsh_spectrum::flux_header, xsh_rec_list::header, instrument, lambda_step, n, xsh_rec_list::size, xsh_spectrum::size, slit_step, XSH_ASSURE_NOT_NULL, XSH_CALLOC, XSH_COMBINED_OFFSET_2D_IFU, XSH_COMBINED_OFFSET_2D_SLIT, XSH_FREE, xsh_free_propertylist(), XSH_MERGE2D, xsh_merge_point(), xsh_msg_dbg_high, xsh_msg_dbg_medium, xsh_msg_warning, XSH_ORDER2D, xsh_pfits_get_bunit(), xsh_pfits_get_naxis(), xsh_pfits_get_pcatg(), xsh_pfits_get_rectify_bin_lambda(), xsh_pfits_get_rectify_bin_space(), xsh_pfits_get_rectify_lambda_max(), xsh_pfits_get_rectify_lambda_min(), xsh_pfits_get_rectify_space_max(), xsh_pfits_get_rectify_space_min(), xsh_pfits_set_bunit(), xsh_rec_list_free(), xsh_rec_list_get_data1(), xsh_rec_list_get_errs1(), xsh_rec_list_get_lambda(), xsh_rec_list_get_nlambda(), xsh_rec_list_get_nslit(), xsh_rec_list_get_qual1(), xsh_rec_list_load(), xsh_rec_list_load_eso(), xsh_rec_list_load_eso_1d(), xsh_round_double(), xsh_spectrum_1D_create(), xsh_spectrum_2D_create(), xsh_spectrum_free(), xsh_spectrum_get_errs(), xsh_spectrum_get_flux(), xsh_spectrum_get_qual(), xsh_spectrum_get_size_lambda(), xsh_spectrum_get_size_slit(), xsh_spectrum_save(), and xsh_stringcat_any().

Referenced by xsh_merge_ord_slitlet().

◆ xsh_merge_point()

static void xsh_merge_point ( double  flux_a,
double  weight_a,
double  flux_b,
double  weight_b,
double *  flux_res,
double *  err_res 
)
static

Compute flux and error associated to each merged spectrum point.

Parameters
[in]flux_aInput flux from a contribute
[in]err_aError associated to flux_a
[in]weight_aWeight associated to flux_a
[in]flux_bInput flux from b contribute
[in]err_bError associated to flux_b
[in]weight_bWeight associated to flux_b
[out]flux_resInput flux from merged contributes
[out]err_resError associated to flux_res
Returns
void (

Definition at line 93 of file xsh_merge_ord.c.

References XSH_ASSURE_NOT_NULL.

Referenced by xsh_merge_ord_with_tag().