IIINSTRUMENT Pipeline Reference Manual  6.2.2
Functions
Miscellaneous Utilities

Functions

const char * isaac_get_license (void)
 Get the pipeline copyright and license. More...
 
cpl_bivector * isaac_get_offsets (const cpl_frameset *fset)
 Get the offsets from a set of frames. More...
 
isaac_band isaac_get_bbfilter (const char *f)
 Get the broad band filter. More...
 
isaac_band isaac_get_associated_filter (const char *f)
 Get the broad band filter. More...
 
const char * isaac_std_band_name (isaac_band band)
 Return a band name. More...
 
cpl_image * isaac_oddeven_correct (const cpl_image *in)
 Correct the odd/even in an image. More...
 
cpl_frameset * isaac_extract_frameset (const cpl_frameset *self, const char *tag)
 Extract the frames with the given tag from a frameset. More...
 
const char * isaac_extract_filename (const cpl_frameset *self, const char *tag)
 Extract the filename of the first frame of the given tag. More...
 

Detailed Description

Function Documentation

◆ isaac_extract_filename()

const char* isaac_extract_filename ( const cpl_frameset *  self,
const char *  tag 
)

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

Parameters
selfA frameset
tagThe tag of the requested file
Returns
Pointer to the file, or NULL when not found
Note
The pointer is only valid as long as the frame exists

Definition at line 397 of file isaac_utils.c.

◆ isaac_extract_frameset()

cpl_frameset* isaac_extract_frameset ( const cpl_frameset *  self,
const char *  tag 
)

Extract the frames with the given tag from a frameset.

Parameters
selfA frameset
tagThe tag of the requested frames
Returns
The newly created frameset or NULL when none found, or on error

The returned frameset must be de allocated with cpl_frameset_delete()

Definition at line 356 of file isaac_utils.c.

◆ isaac_get_associated_filter()

isaac_band isaac_get_associated_filter ( const char *  f)

Get the broad band filter.

Parameters
fthe filter name
Returns
the broadband filter id

Definition at line 195 of file isaac_utils.c.

◆ isaac_get_bbfilter()

isaac_band isaac_get_bbfilter ( const char *  f)

Get the broad band filter.

Parameters
fthe filter name
Returns
the broadband filter id

Definition at line 144 of file isaac_utils.c.

◆ isaac_get_license()

const char* isaac_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 62 of file isaac_utils.c.

◆ isaac_get_offsets()

cpl_bivector* isaac_get_offsets ( const 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 92 of file isaac_utils.c.

References isaac_pfits_get_cumoffsetx(), and isaac_pfits_get_cumoffsety().

◆ isaac_oddeven_correct()

cpl_image* isaac_oddeven_correct ( const cpl_image *  in)

Correct the odd/even in an image.

Parameters
inthe inpute image
Returns
the corrected image or NULL on error case

Definition at line 275 of file isaac_utils.c.

◆ isaac_std_band_name()

const char* isaac_std_band_name ( isaac_band  band)

Return a band name.

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

Definition at line 243 of file isaac_utils.c.