IIINSTRUMENT Pipeline Reference Manual 4.5.1
Functions
FITS header protected access

Functions

double visir_pfits_get_airmass_start (const cpl_propertylist *self)
 The airmass start.
 
double visir_pfits_get_airmass_end (const cpl_propertylist *self)
 The airmass end.
 
double visir_pfits_get_alpha (const cpl_propertylist *self)
 The alpha angle.
 
const char * visir_pfits_get_arcfile (const cpl_propertylist *self)
 The arcfile

 
const char * visir_pfits_get_chopnod_dir (const cpl_propertylist *self)
 The chopping direction.
 
double visir_pfits_get_chop_throw (const cpl_propertylist *self)
 The chopping throw.
 
double visir_pfits_get_chop_freq (const cpl_propertylist *self)
 The chopping frequency.
 
double visir_pfits_get_chop_stat (const cpl_propertylist *self)
 The chopping status.
 
double visir_pfits_get_chop_posang (const cpl_propertylist *self)
 The chopping position angle in rad.
 
double visir_pfits_get_chop_pthrow (const cpl_propertylist *self)
 The chopping throw in pixels.
 
int visir_pfits_get_chop_ncycles (const cpl_propertylist *self)
 The number of chopping cycles.
 
double visir_pfits_get_ada_posang (const cpl_propertylist *self)
 The adapter position angle in rad.
 
double visir_pfits_get_cumoffsetx (const cpl_propertylist *self)
 The cumulative offset in X.
 
double visir_pfits_get_cumoffsety (const cpl_propertylist *self)
 The cumulative offset in Y.
 
const char * visir_pfits_get_date_obs (const cpl_propertylist *self)
 The date of observation.
 
double visir_pfits_get_delta (const cpl_propertylist *self)
 The DELTA keyword in a VISIR header.
 
double visir_pfits_get_dec (const cpl_propertylist *self)
 The DEC.
 
double visir_pfits_get_dit (const cpl_propertylist *self)
 The DIT.
 
int visir_pfits_get_navrg (const cpl_propertylist *self)
 The NAVRG.
 
int visir_pfits_get_expno (const cpl_propertylist *self)
 The number of the current exposition.
 
const char * visir_pfits_get_filter (const cpl_propertylist *self)
 The filter.
 
double visir_pfits_get_focus (const cpl_propertylist *self)
 The focus.
 
double visir_pfits_get_exptime (const cpl_propertylist *self)
 The exposure time.
 
const char * visir_pfits_get_frame_type (const cpl_propertylist *self)
 The frame type.
 
const char * visir_pfits_get_det_name (const cpl_propertylist *self)
 The detector name.
 
const char * visir_pfits_get_grat1_name (const cpl_propertylist *self)
 The name of grating 1.
 
const char * visir_pfits_get_insmode (const cpl_propertylist *self)
 The mode.
 
const char * visir_pfits_get_instrument (const cpl_propertylist *self)
 The instrument.
 
double visir_pfits_get_mjdobs (const cpl_propertylist *self)
 The MJD-OBS.
 
const char * visir_pfits_get_mode (const cpl_propertylist *self)
 The mode name.
 
double visir_pfits_get_monoc_pos (const cpl_propertylist *self)
 The INS.MONOC1.POS.
 
int visir_pfits_get_ndit (const cpl_propertylist *self)
 The NDIT keyword.
 
int visir_pfits_get_naxis1 (const cpl_propertylist *self)
 The NAXIS1 key.
 
int visir_pfits_get_naxis2 (const cpl_propertylist *self)
 The NAXIS2 key.
 
int visir_pfits_get_naxis3 (const cpl_propertylist *self)
 The NAXIS3 key.
 
int visir_pfits_get_win_nx (const cpl_propertylist *self)
 The WIN NX key.
 
int visir_pfits_get_win_ny (const cpl_propertylist *self)
 The WIN NY key.
 
int visir_pfits_get_start_x (const cpl_propertylist *self)
 The WIN STRX key.
 
int visir_pfits_get_start_y (const cpl_propertylist *self)
 The WIN STRY key.
 
int visir_pfits_get_numbexp (const cpl_propertylist *self)
 The number of exposures.
 
int visir_pfits_get_obs_id (const cpl_propertylist *self)
 The OBS ID.
 
const char * visir_pfits_get_nodpos (const cpl_propertylist *self)
 The nodding position.
 
double visir_pfits_get_pixscale (const cpl_propertylist *self)
 The pixel scale.
 
double visir_pfits_get_pixspace (const cpl_propertylist *self)
 The pixel spacing.
 
double visir_pfits_get_ra (const cpl_propertylist *self)
 The RA.
 
double visir_pfits_get_slitwidth (const cpl_propertylist *self)
 The slit width in Arcseconds.
 
const char * visir_pfits_get_starname (const cpl_propertylist *self)
 The std star name.
 
const char * visir_pfits_get_resol (const cpl_propertylist *self)
 The spectral resolution.
 
double visir_pfits_get_temp (const cpl_propertylist *self)
 The telescope (M1) temperature [Celcius].
 
double visir_pfits_get_volt1dcta9 (const cpl_propertylist *self)
 The VOLT1.DCTA9.
 
double visir_pfits_get_volt1dctb9 (const cpl_propertylist *self)
 The VOLT1.DCTB9.
 
double visir_pfits_get_volt2dcta9 (const cpl_propertylist *self)
 The VOLT2.DCTA9.
 
double visir_pfits_get_volt2dctb9 (const cpl_propertylist *self)
 The VOLT2.DCTB9.
 
double visir_pfits_get_wlen (const cpl_propertylist *self)
 The central wavelength.
 
double visir_pfits_get_img_weight (const cpl_propertylist *self)
 The relative weight of the image compared to the other images.
 
int visir_pfits_get_nbeams (const cpl_propertylist *self)
 The number of input beams.
 

Detailed Description

Function Documentation

◆ visir_pfits_get_ada_posang()

double visir_pfits_get_ada_posang ( const cpl_propertylist *  self)

The adapter position angle in rad.

Parameters
selfproperty list to read from
Returns
Chopping position angle in rad

Definition at line 249 of file visir_pfits.c.

◆ visir_pfits_get_airmass_end()

double visir_pfits_get_airmass_end ( const cpl_propertylist *  self)

The airmass end.

Parameters
selfproperty list to read from
Returns
the requested value

Definition at line 103 of file visir_pfits.c.

◆ visir_pfits_get_airmass_start()

double visir_pfits_get_airmass_start ( const cpl_propertylist *  self)

The airmass start.

Parameters
selfproperty list to read from
Returns
the requested value

Definition at line 91 of file visir_pfits.c.

◆ visir_pfits_get_alpha()

double visir_pfits_get_alpha ( const cpl_propertylist *  self)

The alpha angle.

Parameters
selfproperty list to read from
Returns
the requested value

Definition at line 115 of file visir_pfits.c.

◆ visir_pfits_get_arcfile()

const char * visir_pfits_get_arcfile ( const cpl_propertylist *  self)

The arcfile

Parameters
selfproperty list to read from
Returns
pointer to statically allocated character string

Definition at line 127 of file visir_pfits.c.

◆ visir_pfits_get_chop_freq()

double visir_pfits_get_chop_freq ( const cpl_propertylist *  self)

The chopping frequency.

Parameters
selfproperty list to read from
Returns
chopping frequency

Definition at line 170 of file visir_pfits.c.

◆ visir_pfits_get_chop_ncycles()

int visir_pfits_get_chop_ncycles ( const cpl_propertylist *  self)

The number of chopping cycles.

Parameters
selfproperty list to read from
Returns
the requested value

Definition at line 237 of file visir_pfits.c.

Referenced by visir_load_cube2_split(), and visir_load_imagelist().

◆ visir_pfits_get_chop_posang()

double visir_pfits_get_chop_posang ( const cpl_propertylist *  self)

The chopping position angle in rad.

Parameters
selfproperty list to read from
Returns
Chopping position angle in rad

Definition at line 205 of file visir_pfits.c.

Referenced by visir_img_collapse_beam().

◆ visir_pfits_get_chop_pthrow()

double visir_pfits_get_chop_pthrow ( const cpl_propertylist *  self)

The chopping throw in pixels.

Parameters
selfproperty list to read from
Returns
Chopping throw in pixels

Definition at line 222 of file visir_pfits.c.

References visir_pfits_get_chop_throw(), and visir_pfits_get_pixscale().

◆ visir_pfits_get_chop_stat()

double visir_pfits_get_chop_stat ( const cpl_propertylist *  self)

The chopping status.

Parameters
selfproperty list to read from
Returns
chopping status

Definition at line 187 of file visir_pfits.c.

◆ visir_pfits_get_chop_throw()

double visir_pfits_get_chop_throw ( const cpl_propertylist *  self)

The chopping throw.

Parameters
selfproperty list to read from
Returns
Chopping throw

Definition at line 152 of file visir_pfits.c.

Referenced by visir_img_collapse_beam(), and visir_pfits_get_chop_pthrow().

◆ visir_pfits_get_chopnod_dir()

const char * visir_pfits_get_chopnod_dir ( const cpl_propertylist *  self)

The chopping direction.

Parameters
selfproperty list to read from
Returns
pointer to statically allocated character string

Definition at line 139 of file visir_pfits.c.

Referenced by visir_img_collapse_beam().

◆ visir_pfits_get_cumoffsetx()

double visir_pfits_get_cumoffsetx ( const cpl_propertylist *  self)

The cumulative offset in X.

Parameters
selfproperty list to read from
Returns
the requested value

Definition at line 265 of file visir_pfits.c.

◆ visir_pfits_get_cumoffsety()

double visir_pfits_get_cumoffsety ( const cpl_propertylist *  self)

The cumulative offset in Y.

Parameters
selfproperty list to read from
Returns
the requested value

Definition at line 277 of file visir_pfits.c.

◆ visir_pfits_get_date_obs()

const char * visir_pfits_get_date_obs ( const cpl_propertylist *  self)

The date of observation.

Parameters
selfproperty list to read from
Returns
pointer to statically allocated character string

Definition at line 289 of file visir_pfits.c.

◆ visir_pfits_get_dec()

double visir_pfits_get_dec ( const cpl_propertylist *  self)

The DEC.

Parameters
selfproperty list to read from
Returns
the requested value

Definition at line 313 of file visir_pfits.c.

Referenced by visir_spc_phot_sensit().

◆ visir_pfits_get_delta()

double visir_pfits_get_delta ( const cpl_propertylist *  self)

The DELTA keyword in a VISIR header.

Parameters
selfproperty list to read from
Returns
the requested value

Definition at line 301 of file visir_pfits.c.

◆ visir_pfits_get_det_name()

const char * visir_pfits_get_det_name ( const cpl_propertylist *  self)

The detector name.

Parameters
selfproperty list to read from
Returns
pointer to statically allocated character string

Definition at line 447 of file visir_pfits.c.

◆ visir_pfits_get_dit()

double visir_pfits_get_dit ( const cpl_propertylist *  self)

The DIT.

Parameters
selfproperty list to read from
Returns
the requested value

Definition at line 325 of file visir_pfits.c.

Referenced by visir_inputs_combine().

◆ visir_pfits_get_expno()

int visir_pfits_get_expno ( const cpl_propertylist *  self)

The number of the current exposition.

Parameters
selfproperty list to read from
Returns
the requested value

Definition at line 353 of file visir_pfits.c.

◆ visir_pfits_get_exptime()

double visir_pfits_get_exptime ( const cpl_propertylist *  self)

The exposure time.

Parameters
selfproperty list to read from
Returns
the requested value

Definition at line 422 of file visir_pfits.c.

◆ visir_pfits_get_filter()

const char * visir_pfits_get_filter ( const cpl_propertylist *  self)

The filter.

Parameters
selfproperty list to read from
Returns
pointer to statically allocated character string or NULL

Definition at line 365 of file visir_pfits.c.

References visir_pfits_get_insmode().

◆ visir_pfits_get_focus()

double visir_pfits_get_focus ( const cpl_propertylist *  self)

The focus.

Parameters
selfproperty list to read from
Returns
the requested value

Definition at line 410 of file visir_pfits.c.

◆ visir_pfits_get_frame_type()

const char * visir_pfits_get_frame_type ( const cpl_propertylist *  self)

The frame type.

Parameters
selfproperty list to read from
Returns
pointer to statically allocated character string

Definition at line 434 of file visir_pfits.c.

◆ visir_pfits_get_grat1_name()

const char * visir_pfits_get_grat1_name ( const cpl_propertylist *  self)

The name of grating 1.

Parameters
selfproperty list to read from
Returns
pointer to statically allocated character string

Definition at line 462 of file visir_pfits.c.

◆ visir_pfits_get_img_weight()

double visir_pfits_get_img_weight ( const cpl_propertylist *  self)

The relative weight of the image compared to the other images.

Parameters
selfproperty list to read from
Returns
the requested value

e.g. center image in parallel mode has double weight

Definition at line 913 of file visir_pfits.c.

◆ visir_pfits_get_insmode()

const char * visir_pfits_get_insmode ( const cpl_propertylist *  self)

The mode.

Parameters
selfproperty list to read from
Returns
pointer to statically allocated character string

Definition at line 474 of file visir_pfits.c.

Referenced by visir_pfits_get_filter().

◆ visir_pfits_get_instrument()

const char * visir_pfits_get_instrument ( const cpl_propertylist *  self)

The instrument.

Parameters
selfproperty list to read from
Returns
pointer to statically allocated character string

Definition at line 487 of file visir_pfits.c.

◆ visir_pfits_get_mjdobs()

double visir_pfits_get_mjdobs ( const cpl_propertylist *  self)

The MJD-OBS.

Parameters
selfproperty list to read from
Returns
the requested value

Definition at line 499 of file visir_pfits.c.

◆ visir_pfits_get_mode()

const char * visir_pfits_get_mode ( const cpl_propertylist *  self)

The mode name.

Parameters
selfproperty list to read from
Returns
pointer to statically allocated character string

Definition at line 511 of file visir_pfits.c.

◆ visir_pfits_get_monoc_pos()

double visir_pfits_get_monoc_pos ( const cpl_propertylist *  self)

The INS.MONOC1.POS.

Parameters
selfproperty list to read from
Returns
the requested value

Definition at line 523 of file visir_pfits.c.

◆ visir_pfits_get_navrg()

int visir_pfits_get_navrg ( const cpl_propertylist *  self)

The NAVRG.

Parameters
selfproperty list to read from
Returns
the requested value

Definition at line 339 of file visir_pfits.c.

◆ visir_pfits_get_naxis1()

int visir_pfits_get_naxis1 ( const cpl_propertylist *  self)

The NAXIS1 key.

Parameters
selfproperty list to read from
Returns
the requested value

Definition at line 546 of file visir_pfits.c.

◆ visir_pfits_get_naxis2()

int visir_pfits_get_naxis2 ( const cpl_propertylist *  self)

The NAXIS2 key.

Parameters
selfproperty list to read from
Returns
the requested value

Definition at line 561 of file visir_pfits.c.

◆ visir_pfits_get_naxis3()

int visir_pfits_get_naxis3 ( const cpl_propertylist *  self)

The NAXIS3 key.

Parameters
selfproperty list to read from
Returns
the requested value

Definition at line 576 of file visir_pfits.c.

Referenced by visir_imagelist_load_last(), visir_load_cube2_split(), and visir_load_imagelist().

◆ visir_pfits_get_nbeams()

int visir_pfits_get_nbeams ( const cpl_propertylist *  self)

The number of input beams.

Parameters
selfproperty list to read from
Returns
the requested value

with chop-nodding 4, only nodding 2

Definition at line 932 of file visir_pfits.c.

◆ visir_pfits_get_ndit()

int visir_pfits_get_ndit ( const cpl_propertylist *  self)

The NDIT keyword.

Parameters
selfproperty list to read from
Returns
the requested value

Definition at line 535 of file visir_pfits.c.

◆ visir_pfits_get_nodpos()

const char * visir_pfits_get_nodpos ( const cpl_propertylist *  self)

The nodding position.

Parameters
selfproperty list to read from
Returns
pointer to statically allocated character string

Definition at line 699 of file visir_pfits.c.

Referenced by visir_inputs_combine().

◆ visir_pfits_get_numbexp()

int visir_pfits_get_numbexp ( const cpl_propertylist *  self)

The number of exposures.

Parameters
selfproperty list to read from
Returns
the requested value

Definition at line 675 of file visir_pfits.c.

◆ visir_pfits_get_obs_id()

int visir_pfits_get_obs_id ( const cpl_propertylist *  self)

The OBS ID.

Parameters
selfproperty list to read from
Returns
the requested value

Definition at line 687 of file visir_pfits.c.

◆ visir_pfits_get_pixscale()

double visir_pfits_get_pixscale ( const cpl_propertylist *  self)

The pixel scale.

Parameters
selfproperty list to read from
Returns
on success double pixel scale, -1. on failure

Definition at line 711 of file visir_pfits.c.

Referenced by visir_img_collapse_beam(), and visir_pfits_get_chop_pthrow().

◆ visir_pfits_get_pixspace()

double visir_pfits_get_pixspace ( const cpl_propertylist *  self)

The pixel spacing.

Parameters
selfproperty list to read from
Returns
the requested value

Definition at line 727 of file visir_pfits.c.

◆ visir_pfits_get_ra()

double visir_pfits_get_ra ( const cpl_propertylist *  self)

The RA.

Parameters
selfproperty list to read from
Returns
the requested value

Definition at line 742 of file visir_pfits.c.

Referenced by visir_spc_phot_sensit().

◆ visir_pfits_get_resol()

const char * visir_pfits_get_resol ( const cpl_propertylist *  self)

The spectral resolution.

Parameters
selfproperty list to read from
Returns
pointer to statically allocated character string

Definition at line 820 of file visir_pfits.c.

◆ visir_pfits_get_slitwidth()

double visir_pfits_get_slitwidth ( const cpl_propertylist *  self)

The slit width in Arcseconds.

Parameters
selfproperty list to read from
Returns
the requested value

Definition at line 754 of file visir_pfits.c.

◆ visir_pfits_get_starname()

const char * visir_pfits_get_starname ( const cpl_propertylist *  self)

The std star name.

Parameters
selfproperty list to read from
Returns
pointer to statically allocated character string

Definition at line 808 of file visir_pfits.c.

Referenced by visir_spc_phot_sensit().

◆ visir_pfits_get_start_x()

int visir_pfits_get_start_x ( const cpl_propertylist *  self)

The WIN STRX key.

Parameters
selfproperty list to read from
Returns
the requested value or -1 if not present

Definition at line 633 of file visir_pfits.c.

◆ visir_pfits_get_start_y()

int visir_pfits_get_start_y ( const cpl_propertylist *  self)

The WIN STRY key.

Parameters
selfproperty list to read from
Returns
the requested value or -1 if not present

Definition at line 654 of file visir_pfits.c.

◆ visir_pfits_get_temp()

double visir_pfits_get_temp ( const cpl_propertylist *  self)

The telescope (M1) temperature [Celcius].

Parameters
selfproperty list to read from
Returns
the requested value

Definition at line 835 of file visir_pfits.c.

◆ visir_pfits_get_volt1dcta9()

double visir_pfits_get_volt1dcta9 ( const cpl_propertylist *  self)

The VOLT1.DCTA9.

Parameters
selfproperty list to read from
Returns
the requested value

Definition at line 847 of file visir_pfits.c.

◆ visir_pfits_get_volt1dctb9()

double visir_pfits_get_volt1dctb9 ( const cpl_propertylist *  self)

The VOLT1.DCTB9.

Parameters
selfproperty list to read from
Returns
the requested value

Definition at line 859 of file visir_pfits.c.

◆ visir_pfits_get_volt2dcta9()

double visir_pfits_get_volt2dcta9 ( const cpl_propertylist *  self)

The VOLT2.DCTA9.

Parameters
selfproperty list to read from
Returns
the requested value

Definition at line 871 of file visir_pfits.c.

◆ visir_pfits_get_volt2dctb9()

double visir_pfits_get_volt2dctb9 ( const cpl_propertylist *  self)

The VOLT2.DCTB9.

Parameters
selfproperty list to read from
Returns
the requested value

Definition at line 883 of file visir_pfits.c.

◆ visir_pfits_get_win_nx()

int visir_pfits_get_win_nx ( const cpl_propertylist *  self)

The WIN NX key.

Parameters
selfproperty list to read from
Returns
the requested value or -1 if not present

Definition at line 591 of file visir_pfits.c.

◆ visir_pfits_get_win_ny()

int visir_pfits_get_win_ny ( const cpl_propertylist *  self)

The WIN NY key.

Parameters
selfproperty list to read from
Returns
the requested value or -1 if not present

Definition at line 612 of file visir_pfits.c.

◆ visir_pfits_get_wlen()

double visir_pfits_get_wlen ( const cpl_propertylist *  self)

The central wavelength.

Parameters
selfproperty list to read from
Returns
the requested value

Definition at line 895 of file visir_pfits.c.