IIINSTRUMENT Pipeline Reference Manual  1.5.13
Functions
Miscellaneous Utilities

Functions

const char * sofi_get_license (void)
 Get the pipeline copyright and license. More...
 
int sofi_correct_crosstalk_list (cpl_imagelist *ilist)
 Remove the Cross-talk effect from an image list. More...
 
int sofi_correct_crosstalk (cpl_image *ima)
 Remove the Cross-talk effect. More...
 
cpl_bivector * sofi_get_offsets (cpl_frameset *fset)
 Get the offsets from a set of frames. More...
 
sofi_band sofi_get_bbfilter (char *f)
 Get the broad band filter. More...
 
const char * sofi_std_band_name (sofi_band band)
 Return a band name. More...
 
cpl_frameset * sofi_extract_frameset (const cpl_frameset *in, const char *tag)
 Extract the frames with the given tag from a frameset. More...
 
const char * sofi_extract_filename (const cpl_frameset *in, const char *tag)
 Extract the filename ffor the first frame of the given tag. More...
 
int sofi_detlin_correct (cpl_imagelist *ilist, const char *detlin_a, const char *detlin_b, const char *detlin_c)
 Apply the detector linearity correction. More...
 

Detailed Description

Function Documentation

◆ sofi_correct_crosstalk()

int sofi_correct_crosstalk ( cpl_image *  ima)

Remove the Cross-talk effect.

Parameters
imathe input image
Returns
The corrected image or NULL in error case Input image must be FLOAT

Definition at line 124 of file sofi_utils.c.

Referenced by sofi_correct_crosstalk_list().

◆ sofi_correct_crosstalk_list()

int sofi_correct_crosstalk_list ( cpl_imagelist *  ilist)

Remove the Cross-talk effect from an image list.

Parameters
ilistthe input image list
Returns
int 0 if ok, -1 otherwise Input image list must be FLOAT

Definition at line 91 of file sofi_utils.c.

References sofi_correct_crosstalk().

◆ sofi_detlin_correct()

int sofi_detlin_correct ( cpl_imagelist *  ilist,
const char *  detlin_a,
const char *  detlin_b,
const char *  detlin_c 
)

Apply the detector linearity correction.

Parameters
ilistthe input image list
detlin_athe a coeffs
detlin_bthe b coeffs
detlin_cthe c coeffs
Returns
0 if everything is ok, -1 otherwise

Definition at line 363 of file sofi_utils.c.

◆ sofi_extract_filename()

const char* sofi_extract_filename ( const cpl_frameset *  in,
const char *  tag 
)

Extract the filename ffor the first frame of the given tag.

Parameters
inA non-empty frameset
tagThe tag of the requested file
Returns
Pointer to the file

Definition at line 342 of file sofi_utils.c.

◆ sofi_extract_frameset()

cpl_frameset* sofi_extract_frameset ( const cpl_frameset *  in,
const char *  tag 
)

Extract the frames with the given tag from a frameset.

Parameters
inA non-empty frameset
tagThe tag of the requested frames
Returns
The newly created frameset or NULL on error

The returned frameset must be de allocated with cpl_frameset_delete()

Definition at line 298 of file sofi_utils.c.

◆ sofi_get_bbfilter()

sofi_band sofi_get_bbfilter ( char *  f)

Get the broad band filter.

Parameters
fthe filter name
Returns
the broadband filter id

Definition at line 233 of file sofi_utils.c.

◆ sofi_get_license()

const char* sofi_get_license ( void  )

Get the pipeline copyright and license.

Returns
The copyright and license string

The function returns a pointer to the statically allocated license string. This string should not be modified using the returned pointer.

Definition at line 60 of file sofi_utils.c.

◆ sofi_get_offsets()

cpl_bivector* sofi_get_offsets ( cpl_frameset *  fset)

Get the offsets from a set of frames.

Parameters
fsetthe set of frames
Returns
The offsets in a bivector or NULL in error case

Definition at line 181 of file sofi_utils.c.

References sofi_pfits_get_cumoffsetx(), and sofi_pfits_get_cumoffsety().

◆ sofi_std_band_name()

const char* sofi_std_band_name ( sofi_band  band)

Return a band name.

Parameters
banda BB
Returns
1 pointer to a static band name.

Definition at line 266 of file sofi_utils.c.