Extract objects (xsh_extract)
[DRL Functions]

Functions

static cpl_frame * xsh_extract_with_tag (cpl_frame *rec_frame, cpl_frame *loc_frame, xsh_instrument *instrument, xsh_extract_param *extract_par, const char *tag, cpl_frame **res_frame_ext)
 Simple 1D extraction of point source like object.
static cpl_error_code xsh_extraction_get_slit_minmax (xsh_localization *loc_list, const double lambda, const double slit_0, const double slit_step, const int nslit, int *ylow, int *yup, double *y_frac_up, double *y_frac_low)
cpl_error_code xsh_extract_clean_slice (const float *flux, const float *errs, int *qual, const double *lambda, const int ilambda, xsh_instrument *instrument, const int slit_min, const int slit_max, const int nlambda, const int nslit, const int mask_hsize, double *fluxval, double *errval, int *qualval)
static cpl_frame * xsh_extract_clean_with_tag (cpl_frame *rec_frame, cpl_frame *loc_frame, xsh_instrument *instrument, xsh_extract_param *extract_par, xsh_interpolate_bp_param *ipol_bp_par, const char *tag, cpl_frame **res_frame_ext)
 Simple 1D extraction of point source like object.
cpl_frame * xsh_extract (cpl_frame *rec_frame, cpl_frame *loc_frame, xsh_instrument *instrument, xsh_extract_param *extract_par, cpl_frame **res_frame_ext, const char *rec_prefix)
 simple 1D extraction of point source like object
cpl_frame * xsh_extract_clean (cpl_frame *rec_frame, cpl_frame *loc_frame, xsh_instrument *instrument, xsh_extract_param *extract_par, xsh_interpolate_bp_param *ipol_bp_par, cpl_frame **res_frame_ext, const char *rec_prefix)
 simple 1D extraction of point source like object
cpl_frameset * xsh_extract_ifu (cpl_frameset *rec_frameset, cpl_frameset *loc_frameset, xsh_instrument *instrument, xsh_extract_param *extract_par, const char *rec_prefix)
 Loop on IFU Frames to extract simple 1D (1 per slitlet).
static void fill_img (cpl_image *img, int ilambda, cpl_image *down, cpl_image *cen, cpl_image *up, int up_shift, int cen_shift)
static void make_data_cube (xsh_pre_3d *pre_3d, xsh_pre *pre_down, xsh_pre *pre_cen, xsh_pre *pre_up)
cpl_frame * xsh_format (cpl_frameset *spectrum_frame_set, const char *result_name, xsh_instrument *instrument, const char *rec_prefix)
static int * create_sky_mask (cpl_frame *sky_line_frame, int size, double lambda_min, double lambda_step, xsh_instrument *instrument)
 Create a sky mask from a SKY LINE lIST where flag sky lines are 1.
void xsh_center_cube (cpl_frame *cube_frame, cpl_frame *sky_line_frame, int chunk_size, xsh_instrument *instrument)
 Shift a cube to center object at 0 arcsec.
cpl_frame * xsh_cube (cpl_frameset *merge2d_frameset, xsh_instrument *instrument, const char *rec_prefix)
 Create a cube.

Detailed Description

Function ...


Function Documentation

static int* create_sky_mask ( cpl_frame *  sky_line_frame,
int  size,
double  lambda_min,
double  lambda_step,
xsh_instrument instrument 
) [static]

Create a sky mask from a SKY LINE lIST where flag sky lines are 1.

Parameters:
[in] sky_line_frame A Sky line list
[in] size Size of mask
[in] chunk_size Size of chunk along wavelength direction

Definition at line 311 of file xsh_format.c.

References check, XSH_CALLOC, XSH_FREE, xsh_instrument_arm_tostring(), xsh_instrument_mode_tostring(), xsh_msg, xsh_msg_dbg_low, xsh_resolution_get(), xsh_round_double(), xsh_sort_table_1(), XSH_TABLE_FREE, and XSH_TABLE_LOAD.

Referenced by xsh_center_cube().

static void fill_img ( cpl_image *  img,
int  ilambda,
cpl_image *  down,
cpl_image *  cen,
cpl_image *  up,
int  up_shift,
int  cen_shift 
) [static]

Definition at line 67 of file xsh_format.c.

References check, nx, ny, and xsh_msg_dbg_high.

Referenced by make_data_cube().

static void make_data_cube ( xsh_pre_3d pre_3d,
xsh_pre pre_down,
xsh_pre pre_cen,
xsh_pre pre_up 
) [static]
void xsh_center_cube ( cpl_frame *  cube_frame,
cpl_frame *  sky_line_frame,
int  chunk_size,
xsh_instrument instrument 
)

Shift a cube to center object at 0 arcsec.

Parameters:
[in,out] cube The Data cube
[in] sky lines frame The sky lines table or NULL
[in] chunk_size Size of chunk along wavelength direction

Definition at line 367 of file xsh_format.c.

References check, create_sky_mask(), xsh_pre_3d::data_header, sigma, XSH_ASSURE_NOT_NULL, xsh_error_reset, XSH_FREE, xsh_free_vector(), xsh_image_3d_get_data(), xsh_image_3d_get_size_x(), xsh_image_3d_get_size_y(), xsh_image_3d_get_size_z(), XSH_MALLOC, xsh_msg, xsh_pfits_get_cdelt2(), xsh_pfits_get_cdelt3(), xsh_pfits_get_crval2(), xsh_pfits_get_crval3(), xsh_pre_3d_free(), xsh_pre_3d_get_data(), xsh_pre_3d_load(), xsh_unwrap_vector(), and y.

Referenced by main().

cpl_frame* xsh_cube ( cpl_frameset *  merge2d_frameset,
xsh_instrument instrument,
const char *  rec_prefix 
)
cpl_frame* xsh_extract ( cpl_frame *  rec_frame,
cpl_frame *  loc_frame,
xsh_instrument instrument,
xsh_extract_param extract_par,
cpl_frame **  res_frame_ext,
const char *  rec_prefix 
)

simple 1D extraction of point source like object

Parameters:
[in] rec_frame Rectified frame (from xsh_rectify)
[in] loc_frame Localization table
[in] instrument Instrument pointer
[in] extract_par Parameters for object extraction
[out] res_frame_ext extracted frame in ESO format
[in] rec_prefix recipe prefix (for PRO.CATG definition)
Returns:
a rectified frame

Definition at line 716 of file xsh_extract.c.

References check, xsh_add_temporary_file(), xsh_extract_with_tag(), XSH_GET_TAG_FROM_ARM, and XSH_ORDER1D.

Referenced by xsh_absorp().

cpl_frame* xsh_extract_clean ( cpl_frame *  rec_frame,
cpl_frame *  loc_frame,
xsh_instrument instrument,
xsh_extract_param extract_par,
xsh_interpolate_bp_param ipol_bp_par,
cpl_frame **  res_frame_ext,
const char *  rec_prefix 
)

simple 1D extraction of point source like object

Parameters:
[in] rec_frame Rectified frame (from xsh_rectify)
[in] loc_frame Localization table
[in] instrument Instrument pointer
[in] extract_par Parameters for object extraction
[in] ipol_bp_par Parameters for bad pixel interpolation during extraction
[out] res_frame_ext extracted frame in ESO format
[in] rec_prefix recipe prefix (for PRO.CATG definition)
Returns:
a rectified frame

Definition at line 744 of file xsh_extract.c.

References check, xsh_add_temporary_file(), xsh_extract_clean_with_tag(), XSH_GET_TAG_FROM_ARM, and XSH_ORDER1D.

Referenced by xsh_respon_slit_nod(), xsh_respon_slit_offset(), xsh_respon_slit_stare(), xsh_scired_slit_nod(), xsh_scired_slit_offset(), and xsh_scired_slit_stare().

cpl_error_code xsh_extract_clean_slice ( const float *  flux,
const float *  errs,
int *  qual,
const double *  lambda,
const int  ilambda,
xsh_instrument instrument,
const int  slit_min,
const int  slit_max,
const int  nlambda,
const int  nslit,
const int  mask_hsize,
double *  fluxval,
double *  errval,
int *  qualval 
)
static cpl_frame* xsh_extract_clean_with_tag ( cpl_frame *  rec_frame,
cpl_frame *  loc_frame,
xsh_instrument instrument,
xsh_extract_param extract_par,
xsh_interpolate_bp_param ipol_bp_par,
const char *  tag,
cpl_frame **  res_frame_ext 
) [static]
cpl_frameset* xsh_extract_ifu ( cpl_frameset *  rec_frameset,
cpl_frameset *  loc_frameset,
xsh_instrument instrument,
xsh_extract_param extract_par,
const char *  rec_prefix 
)

Loop on IFU Frames to extract simple 1D (1 per slitlet).

Parameters:
[in] rec_frameset Rectified frameset (from xsh_rectify_ifu)
[in] loc_frameset Localization table frameset (xsh_localize_ifu)
[in] instrument Instrument pointer
[in] extract_par Parameters for object extraction
[in] rec_prefix recipe prefix (to define PRO.CATG value)
Returns:
a rectified frame

Definition at line 776 of file xsh_extract.c.

References CENTER_IFU_SLITLET, check, LOWER_IFU_SLITLET, SlitletName, UPPER_IFU_SLITLET, XSH_ASSURE_NOT_NULL, xsh_extract_with_tag(), XSH_GET_TAG_FROM_ARM, xsh_msg, and xsh_msg_dbg_medium.

static cpl_frame* xsh_extract_with_tag ( cpl_frame *  rec_frame,
cpl_frame *  loc_frame,
xsh_instrument instrument,
xsh_extract_param extract_par,
const char *  tag,
cpl_frame **  res_frame_ext 
) [static]
static cpl_error_code xsh_extraction_get_slit_minmax ( xsh_localization loc_list,
const double  lambda,
const double  slit_0,
const double  slit_step,
const int  nslit,
int *  ylow,
int *  yup,
double *  y_frac_up,
double *  y_frac_low 
) [static]
cpl_frame* xsh_format ( cpl_frameset *  spectrum_frame_set,
const char *  result_name,
xsh_instrument instrument,
const char *  rec_prefix 
)

Generated on 13 Mar 2013 for X-shooter Pipeline Reference Manual by  doxygen 1.6.1