/home/amodigli/releases/xsh/1.2.10/pso/xsh.26608/xshp/xsh/xsh_utils_efficiency.c File Reference

#include <string.h>
#include <math.h>
#include <cpl.h>
#include <xsh_irplib_utils.h>
#include <xsh_pfits.h>
#include <xsh_msg.h>
#include <xsh_dfs.h>
#include <xsh_error.h>
#include <xsh_utils_table.h>
#include <xsh_utils_wrappers.h>
#include "xsh_utils_efficiency.h"
#include <xsh_star_index.h>

Go to the source code of this file.

Defines

#define PRO_STD_STAR_SPECTRA   "STD_STAR_SPECTRA"

Functions



static int xsh_column_to_double (cpl_table *ptable, const char *column)
static double * xsh_create_column_double (cpl_table *tbl, const char *col_name, int nrow)
static cpl_error_code xsh_get_std_obs_values (cpl_propertylist *plist, double *exptime, double *airmass, double *dRA, double *dDEC)
 get STD star observation exptime, airmass, RA, DEC
void xsh_load_ref_table (cpl_frameset *frames, double dRA, double dDEC, double EPSILON, xsh_instrument *instrument, cpl_table **pptable)
 load reference table
cpl_error_code xsh_parse_catalog_std_stars (cpl_frame *cat, double dRA, double dDEC, double EPSILON, cpl_table **pptable)
 parse referece std stars catalog
cpl_frame * xsh_utils_efficiency (cpl_frameset *frames, double dGain, double dEpsilon, double aimprim, xsh_instrument *inst, const char *col_name_atm_wave, const char *col_name_atm_abs, const char *col_name_ref_wave, const char *col_name_ref_flux, const char *col_name_ref_bin, const char *col_name_obj_wave, const char *col_name_obj_flux)
 Compute efficiency.
cpl_table * xsh_utils_efficiency_internal (cpl_table *tbl_obj_spectrum, cpl_table *tbl_atmext, cpl_table *tbl_ref, double exptime, double airmass, double aimprim, double gain, int biny, double src2ref_wave_sampling, const char *col_name_atm_wave, const char *col_name_atm_abs, const char *col_name_ref_wave, const char *col_name_ref_flux, const char *col_name_ref_bin, const char *col_name_obj_wave, const char *col_name_obj_flux, int *ntot, int *nclip)
 Compute efficiency.
void xsh_frame_sci_get_ra_dec_airmass (cpl_frame *frm_sci, double *ra, double *dec, double *airmass)
 get RA, DEC, airmass (mean) of a frame
static void xsh_frame_sci_get_gain_airmass_exptime_naxis1_biny (cpl_frame *frm_sci, xsh_instrument *instrument, double *gain, double *airmass, double *exptime, int *naxis1, int *biny)
cpl_frame * xsh_catalog_extract_spectrum_frame (cpl_frame *frm_cat, cpl_frame *frm_sci)
 extract spectrum
cpl_frame * xsh_efficiency_compute (cpl_frame *frm_sci, cpl_frame *frm_cat, cpl_frame *frm_atmext, xsh_instrument *instrument)
 computes efficiency

Variables

static const char COL_NAME_WAVELENGTH [] = "WAVELENGTH"
static const char COL_NAME_WAVELENGTH_C [] = "WAVELENGTH"
static const char COL_NAME_WAVE_ATMDISP [] = "LAMBDA"
static const char COL_NAME_ABS_ATMDISP [] = "LA_SILLA"
static const char COL_NAME_REF [] = "REF"
static const char COL_NAME_COR [] = "COR"
static const char COL_NAME_SRC_COR [] = "SRC_COR"
static const char COL_NAME_WAVE_OBJ [] = "WAVELENGTH"
static const char COL_NAME_INT_OBJ [] = "INT_OBJ"
static const char COL_NAME_ORD_OBJ [] = "ORD"
static const char COL_NAME_WAVE_REF [] = "LAMBDA"
static const char COL_NAME_FLUX_REF [] = "FLUX"
static const char COL_NAME_BINWIDTH_REF [] = "BIN_WIDTH"
static const char COL_NAME_EPHOT [] = "EPHOT"
static const char COL_NAME_EXT [] = "EXT"
static const char COL_NAME_SRC_EFF [] = "EFF"
static const char PAR_NAME_DIT [] = "ESO DET DIT"
static const double UVES_flux_factor = 1.e16
static char FRM_EXTCOEFF_TAB [] = XSH_EXTCOEFF_TAB

Define Documentation

#define PRO_STD_STAR_SPECTRA   "STD_STAR_SPECTRA"

Definition at line 45 of file xsh_utils_efficiency.c.


Function Documentation

cpl_frame* xsh_catalog_extract_spectrum_frame ( cpl_frame *  frm_cat,
cpl_frame *  frm_sci 
)
static int xsh_column_to_double ( cpl_table *  ptable,
const char *  column 
) [static]

Definition at line 374 of file xsh_utils_efficiency.c.

References check, and xsh_msg.

Referenced by xsh_utils_efficiency_internal().

static double * xsh_create_column_double ( cpl_table *  tbl,
const char *  col_name,
int  nrow 
) [static]

Definition at line 216 of file xsh_utils_efficiency.c.

References check.

Referenced by xsh_utils_efficiency_internal().

cpl_frame* xsh_efficiency_compute ( cpl_frame *  frm_sci,
cpl_frame *  frm_cat,
cpl_frame *  frm_atmext,
xsh_instrument instrument 
)
static void xsh_frame_sci_get_gain_airmass_exptime_naxis1_biny ( cpl_frame *  frm_sci,
xsh_instrument instrument,
double *  gain,
double *  airmass,
double *  exptime,
int *  naxis1,
int *  biny 
) [static]
void xsh_frame_sci_get_ra_dec_airmass ( cpl_frame *  frm_sci,
double *  ra,
double *  dec,
double *  airmass 
)

get RA, DEC, airmass (mean) of a frame

Parameters:
frm_sci input frame
ra right ascension
dec declination
airmass airmass (mean)
Returns:
void

Definition at line 660 of file xsh_utils_efficiency.c.

References check, xsh_free_propertylist(), xsh_pfits_get_airm_mean(), xsh_pfits_get_dec(), and xsh_pfits_get_ra().

Referenced by xsh_catalog_extract_spectrum_frame(), xsh_compute_response(), xsh_compute_response_ord(), and xsh_efficiency_compute().

cpl_error_code xsh_get_std_obs_values ( cpl_propertylist *  plist,
double *  exptime,
double *  airmass,
double *  dRA,
double *  dDEC 
) [static]

get STD star observation exptime, airmass, RA, DEC

Parameters:
plist (input) property list
exptime (output) exposure time
airmass (output) airmass (average of start and end)
dRA (output) Right Ascension
dDEC (output) Declination
Returns:
CPL error code

Definition at line 241 of file xsh_utils_efficiency.c.

References xsh_pfits_get_airm_mean(), xsh_pfits_get_dec(), xsh_pfits_get_exptime(), and xsh_pfits_get_ra().

Referenced by xsh_utils_efficiency().

void xsh_load_ref_table ( cpl_frameset *  frames,
double  dRA,
double  dDEC,
double  EPSILON,
xsh_instrument instrument,
cpl_table **  pptable 
)

load reference table

Parameters:
frames input frames list
dRA Right Ascension
dDEC Declination
EPSILON tolerance to find ref spectra on catalog on (ra,dec)
instrument xsh instrument
pptable pointer to new table
Returns:
Interpolated data points

Definition at line 104 of file xsh_utils_efficiency.c.

References check, star_index_get(), star_index_load(), xsh_find_frame_with_tag(), XSH_FLUX_STD_CAT, XSH_FLUX_STD_TAB, and xsh_msg.

Referenced by xsh_utils_efficiency().

cpl_error_code xsh_parse_catalog_std_stars ( cpl_frame *  cat,
double  dRA,
double  dDEC,
double  EPSILON,
cpl_table **  pptable 
)

parse referece std stars catalog

Parameters:
cat input frame catalog
dRA Right Ascension
dDEC Declination
EPSILON tolerance to find ref spectra on catalog on (ra,dec)
pptable pointer to new table
Returns:
cpl error code. The table will contain interpolated data points

Definition at line 177 of file xsh_utils_efficiency.c.

References check, star_index_delete(), star_index_get(), star_index_load(), XSH_ASSURE_NOT_NULL_MSG, and xsh_msg.

Referenced by xsh_catalog_extract_spectrum_frame(), xsh_compute_response(), xsh_compute_response_ord(), and xsh_efficiency_compute().

cpl_frame* xsh_utils_efficiency ( cpl_frameset *  frames,
double  dGain,
double  dEpsilon,
double  aimprim,
xsh_instrument inst,
const char *  col_name_atm_wave,
const char *  col_name_atm_abs,
const char *  col_name_ref_wave,
const char *  col_name_ref_flux,
const char *  col_name_ref_bin,
const char *  col_name_obj_wave,
const char *  col_name_obj_flux 
)

Compute efficiency.

Parameters:
frames input frameset
dGain detector's gain value
dEpsilon tolerance to find ref spectra on catalog on (ra,dec)
aimprim airmass
inst instrument (arm) setting
col_name_atm_wave atmospheric extinction table wave column name
col_name_atm_abs atmospheric extinction table absorption column name
col_name_ref_wave reference flux std table wave column name
col_name_ref_flux reference flux std table flux column name
col_name_ref_bin reference flux std table sampling bin value
col_name_obj_wave observed std table wave column name
col_name_obj_flux observed std table flux column name
Returns:
frame with computed efficiency

Definition at line 278 of file xsh_utils_efficiency.c.

References check, exptime, FRM_EXTCOEFF_TAB, xsh_find_frame_with_tag(), xsh_frame_product(), xsh_free_propertylist(), xsh_free_table(), xsh_get_std_obs_values(), xsh_instrument_arm_tostring(), xsh_load_ref_table(), XSH_STD_FLUX_SLIT_STARE_ORDER1D, and xsh_utils_efficiency_internal().

cpl_table* xsh_utils_efficiency_internal ( cpl_table *  tbl_obj_spectrum,
cpl_table *  tbl_atmext,
cpl_table *  tbl_ref,
double  exptime,
double  airmass,
double  aimprim,
double  gain,
int  biny,
double  src2ref_wave_sampling,
const char *  col_name_atm_wave,
const char *  col_name_atm_abs,
const char *  col_name_ref_wave,
const char *  col_name_ref_flux,
const char *  col_name_ref_bin,
const char *  col_name_obj_wave,
const char *  col_name_obj_flux,
int *  ntot,
int *  nclip 
)

Compute efficiency.

Parameters:
tbl_obj_spectrum input object spectrum
tbl_atmext input atmospheric extinction table
tbl_ref input reference flux STD table
exptime input exposure time
airmass input observed frame airmass
aimprim input airmass corrective factor
gain input gain
biny bin on Y (spatial) direction
src2ref_wave_sampling input cnversion factor to pass from src 2 ref units
col_name_atm_wave atmospheric extinction table wave column name
col_name_atm_abs atmospheric extinction table absorption column name
col_name_ref_wave reference flux std table wave column name
col_name_ref_flux reference flux std table flux column name
col_name_ref_bin reference flux std table bin value
col_name_obj_wave observed std table wave column name
col_name_obj_flux observed std table flux column name
Returns:
table with computed efficiency

Definition at line 413 of file xsh_utils_efficiency.c.

References check, COL_NAME_COR, COL_NAME_EPHOT, COL_NAME_EXT, COL_NAME_ORD_OBJ, COL_NAME_REF, COL_NAME_SRC_COR, COL_NAME_SRC_EFF, irplib_isinf(), kappa, TEL_AREA, xsh_column_to_double(), xsh_create_column_double(), xsh_free_table(), xsh_msg_dbg_medium, and xsh_table_interpolate().

Referenced by xsh_efficiency_compute(), and xsh_utils_efficiency().


Variable Documentation

const char COL_NAME_ABS_ATMDISP[] = "LA_SILLA" [static]

Definition at line 49 of file xsh_utils_efficiency.c.

Referenced by xsh_efficiency_compute().

const char COL_NAME_BINWIDTH_REF[] = "BIN_WIDTH" [static]
const char COL_NAME_COR[] = "COR" [static]

Definition at line 52 of file xsh_utils_efficiency.c.

Referenced by xsh_utils_efficiency_internal().

const char COL_NAME_EPHOT[] = "EPHOT" [static]

Definition at line 61 of file xsh_utils_efficiency.c.

Referenced by xsh_utils_efficiency_internal().

const char COL_NAME_EXT[] = "EXT" [static]

Definition at line 62 of file xsh_utils_efficiency.c.

Referenced by xsh_utils_efficiency_internal().

const char COL_NAME_FLUX_REF[] = "FLUX" [static]
const char COL_NAME_INT_OBJ[] = "INT_OBJ" [static]

Definition at line 56 of file xsh_utils_efficiency.c.

Referenced by xsh_efficiency_compute().

const char COL_NAME_ORD_OBJ[] = "ORD" [static]

Definition at line 57 of file xsh_utils_efficiency.c.

Referenced by xsh_efficiency_compute(), and xsh_utils_efficiency_internal().

const char COL_NAME_REF[] = "REF" [static]

Definition at line 51 of file xsh_utils_efficiency.c.

Referenced by xsh_utils_efficiency_internal().

const char COL_NAME_SRC_COR[] = "SRC_COR" [static]

Definition at line 53 of file xsh_utils_efficiency.c.

Referenced by xsh_utils_efficiency_internal().

const char COL_NAME_SRC_EFF[] = "EFF" [static]

Definition at line 63 of file xsh_utils_efficiency.c.

Referenced by xsh_utils_efficiency_internal().

const char COL_NAME_WAVE_ATMDISP[] = "LAMBDA" [static]

Definition at line 48 of file xsh_utils_efficiency.c.

Referenced by xsh_efficiency_compute().

const char COL_NAME_WAVE_OBJ[] = "WAVELENGTH" [static]

Definition at line 55 of file xsh_utils_efficiency.c.

Referenced by xsh_efficiency_compute().

const char COL_NAME_WAVE_REF[] = "LAMBDA" [static]
const char COL_NAME_WAVELENGTH[] = "WAVELENGTH" [static]

Definition at line 46 of file xsh_utils_efficiency.c.

const char COL_NAME_WAVELENGTH_C[] = "WAVELENGTH" [static]

Definition at line 47 of file xsh_utils_efficiency.c.

char FRM_EXTCOEFF_TAB[] = XSH_EXTCOEFF_TAB [static]

Definition at line 67 of file xsh_utils_efficiency.c.

Referenced by xsh_utils_efficiency().

const char PAR_NAME_DIT[] = "ESO DET DIT" [static]

Definition at line 64 of file xsh_utils_efficiency.c.

const double UVES_flux_factor = 1.e16 [static]

Definition at line 65 of file xsh_utils_efficiency.c.


Generated on 9 Mar 2011 for X-shooter Pipeline Reference Manual by  doxygen 1.6.1