VIRCAM Pipeline 2.3.12
Functions
casu_fits

These are methods for manipulating the casu_fits object. More...

Functions

casu_fits * casu_fits_load (cpl_frame *frame, cpl_type type, int nexten)
 
void casu_fits_unload_im (casu_fits *in)
 
casu_fits * casu_fits_duplicate (casu_fits *in)
 
void casu_fits_replace_image (casu_fits *in, cpl_image *image)
 
casu_fits ** casu_fits_load_list (cpl_frameset *f, cpl_type type, int exten)
 
void casu_fits_delete (casu_fits *p)
 
void casu_fits_delete_list (casu_fits **p, int n)
 
cpl_image * casu_fits_get_image (casu_fits *p)
 
int casu_fits_get_nexten (casu_fits *p)
 
cpl_propertylist * casu_fits_get_phu (casu_fits *p)
 
cpl_propertylist * casu_fits_get_ehu (casu_fits *p)
 
char * casu_fits_get_extname (casu_fits *p)
 
char * casu_fits_get_filename (casu_fits *p)
 
char * casu_fits_get_fullname (casu_fits *p)
 
int casu_fits_get_status (casu_fits *p)
 
int casu_fits_set_error (casu_fits *p, int status)
 
void casu_fits_set_status (casu_fits *p, int status)
 
void casu_fits_set_filename (casu_fits *p, char *fname)
 
casu_fits * casu_fits_wrap (cpl_image *im, casu_fits *model, cpl_propertylist *phu, cpl_propertylist *ehu)
 
void casu_fits_unwrap (casu_fits *p)
 

Detailed Description

These are methods for manipulating the casu_fits object.

Author
Jim Lewis, CASU

Function Documentation

◆ casu_fits_delete()

void casu_fits_delete ( casu_fits *  p)
Name:
casu_fits_delete
Purpose:
Free all the workspace associated with a casu_fits object
Description:
Free all the workspace associated with a casu_fits object
Language:
C
Parameters
pThe input casu_fits object
Author
Jim Lewis, CASU

Definition at line 364 of file casu_fits.c.

Referenced by casu_fits_delete_list(), casu_imcore(), casu_mask_load(), casu_opm(), casu_overexp(), casu_pawsky_mask(), and vircam_mosaic().

◆ casu_fits_delete_list()

void casu_fits_delete_list ( casu_fits **  p,
int  n 
)
Name:
casu_fits_delete_list
Purpose:
Free all the workspace associated with a list of casu_fits objects
Description:
Free all the workspace associated with a list of casu_fits objects
Language:
C
Parameters
pThe input list of casu_fits objects
nThe number of casu_fits objects in the above array
Author
Jim Lewis, CASU

Definition at line 401 of file casu_fits.c.

References casu_fits_delete().

Referenced by casu_fits_load_list().

◆ casu_fits_duplicate()

casu_fits * casu_fits_duplicate ( casu_fits *  in)
Name:
casu_fits_duplicate
Purpose:
Copy a casu_fits structure into another one.
Description:
An input casu_fits structure is duplcated and returned
Language:
C
Parameters
inThe input casu_fits object
Returns
The output casu_fits object.
Author
Jim Lewis, CASU

Definition at line 225 of file casu_fits.c.

References casu_fits_get_ehu(), and casu_fits_get_phu().

Referenced by casu_imcore(), casu_imstack(), casu_nebuliser(), and casu_opm().

◆ casu_fits_get_ehu()

cpl_propertylist * casu_fits_get_ehu ( casu_fits *  p)
Name:
casu_fits_get_ehu
Purpose:
Get the propertylist for the extension header for a given casu_fits image.
Description:
Get the propertylist for the extension header for a given casu_fits image. This is the extension that is relevant of the image. This should only need to be read once and then can be used to add things to the primary header.
Language:
C
Parameters
pThe input casu_fits object
Returns
The propertylist representing the extension header of the input image (NULL if there is an error).
Author
Jim Lewis, CASU

Definition at line 576 of file casu_fits.c.

Referenced by casu_darkcor(), casu_defringe(), casu_fits_duplicate(), casu_fits_wrap(), casu_flatcor(), casu_gaincor(), casu_imcombine(), casu_imcore(), casu_imdither(), casu_imstack(), casu_nditcor(), casu_nebuliser(), casu_pawsky_mask(), casu_pawsky_mask_pre(), casu_pawsky_minus(), casu_photcal_extinct(), casu_simplesky_mask(), imcore_conf(), imcore_opm(), vircam_destripe(), vircam_illum(), vircam_interleave(), vircam_jmp_catalogue(), vircam_jmp_dither_offsets(), vircam_jmp_illum(), vircam_jmp_interleave(), vircam_jmp_matched_stds(), vircam_jmp_save_catalogue(), vircam_jmp_save_illum(), vircam_jmp_save_offsky(), vircam_jmp_save_simple(), vircam_jmp_save_simple_offsets(), vircam_jmp_save_stack(), vircam_jmp_save_super(), vircam_jmp_skycor(), vircam_jmp_wcsfit(), vircam_lincor(), and vircam_mosaic().

◆ casu_fits_get_extname()

char * casu_fits_get_extname ( casu_fits *  p)
Name:
casu_fits_get_extname
Purpose:
Get the extension name for a give casu_fits object
Description:
Get the extension name for a given casu_fits object.
Language:
C
Parameters
pThe input casu_fits object
Returns
The pointer to the extension name in the casu_fits structure – not a copy! (NULL if there is an error).
Author
Jim Lewis, CASU

Definition at line 613 of file casu_fits.c.

◆ casu_fits_get_filename()

char * casu_fits_get_filename ( casu_fits *  p)
Name:
casu_fits_get_filename
Purpose:
Get the filename from which the current casu_fits object originated
Description:
Get the filename from which the current casu_fits object originated. If this is null, then the image didn't originate in an FITS file.
Language:
C
Parameters
pThe input casu_fits object
Returns
The name of the file from which this image originated. This is not a copy of the name, so be careful not to modify the string.
Author
Jim Lewis, CASU

Definition at line 646 of file casu_fits.c.

Referenced by casu_imcombine(), casu_imcore(), casu_pawsky_mask_pre(), casu_pawsky_minus(), casu_prov(), and vircam_jmp_ustep_seq().

◆ casu_fits_get_fullname()

char * casu_fits_get_fullname ( casu_fits *  p)
Name:
casu_fits_get_fullname
Purpose:
Get the fullname of the FITS extension from which the current casu_fits object originated
Description:
Get the fullname of the FITS extension from which the current casu_fits object originated. If this is null, then the image didn't originate in an FITS file.
Language:
C
Parameters
pThe input casu_fits object
Returns
The fullname name of the file from which this image originated
Author
Jim Lewis, CASU

Definition at line 680 of file casu_fits.c.

Referenced by casu_darkcor(), casu_defringe(), casu_flatcor(), casu_imcore(), casu_imdither(), casu_imstack(), casu_photcal_extinct(), casu_prov(), vircam_illum(), vircam_jmp_interleave(), vircam_jmp_skycor(), and vircam_lincor().

◆ casu_fits_get_image()

cpl_image * casu_fits_get_image ( casu_fits *  p)
Name:
casu_fits_get_image
Purpose:
Get the CPL image from the casu_fits object
Description:
Return the CPL image from the input casu_fits object. This image is suitable for use in all cpl_image routines.
Language:
C
Parameters
pThe input casu_fits object
Returns
The cpl_image object. NULL if there was an error.
Author
Jim Lewis, CASU

Definition at line 436 of file casu_fits.c.

Referenced by casu_darkcor(), casu_defringe(), casu_dummy_image(), casu_flatcor(), casu_gaincor(), casu_genbpm(), casu_imcombine(), casu_imdither(), casu_imstack(), casu_inpaint(), casu_mask_load(), casu_nditcor(), casu_nebuliser(), casu_opm(), casu_overexp(), casu_pawsky_mask(), casu_pawsky_mask_pre(), casu_pawsky_minus(), casu_simplesky_mask(), imcore_conf(), imcore_opm(), vircam_destripe(), vircam_genbpm(), vircam_grout(), vircam_illum(), vircam_interleave(), vircam_jmp_bpm2conf(), vircam_jmp_interleave(), vircam_jmp_save_offsky(), vircam_jmp_save_simple(), vircam_jmp_save_simple_offsets(), vircam_jmp_save_stack(), vircam_jmp_save_super(), vircam_jmp_skycor(), vircam_lincor(), and vircam_tilesky().

◆ casu_fits_get_nexten()

int casu_fits_get_nexten ( casu_fits *  p)
Name:
casu_fits_get_nexten
Purpose:
Get the FITS extension number for the current image in a casu_fits object
Description:
Get the FITS extension number for the current image in a casu_fits object
Language:
C
Parameters
pThe input casu_fits object
Returns
The extension number (-1 in case of error)
Author
Jim Lewis, CASU

Definition at line 497 of file casu_fits.c.

Referenced by casu_imcombine(), imcore_conf(), imcore_opm(), and vircam_jmp_interleave().

◆ casu_fits_get_phu()

cpl_propertylist * casu_fits_get_phu ( casu_fits *  p)
Name:
casu_fits_get_phu
Purpose:
Get the propertylist for the primary header for a given casu_fits image.
Description:
Get the propertylist for the primary header for a given casu_fits image. This should only need to be read once and then can be used to add things to the primary header.
Language:
C
Parameters
pThe input casu_fits object
Returns
The propertylist representing the primary header of the input image (NULL if there is an error).
Author
Jim Lewis, CASU

Definition at line 531 of file casu_fits.c.

Referenced by casu_fits_duplicate(), casu_fits_wrap(), casu_imcombine(), casu_imcore(), casu_imdither(), casu_imstack(), casu_nditcor(), casu_photcal_extinct(), imcore_conf(), vircam_illum(), vircam_interleave(), vircam_jmp_dither_images(), vircam_jmp_dither_offsets(), vircam_jmp_illum(), vircam_jmp_photcal(), vircam_jmp_save_catalogue(), vircam_jmp_save_illum(), vircam_jmp_save_offsky(), vircam_jmp_save_simple(), vircam_jmp_save_simple_offsets(), vircam_jmp_save_stack(), vircam_jmp_save_super(), vircam_jmp_ustep_seq(), and vircam_tilesky().

◆ casu_fits_get_status()

int casu_fits_get_status ( casu_fits *  p)
Name:
casu_fits_get_status
Purpose:
Get the error status of the current object.
Description:
Get the error status of the current object.
Language:
C
Parameters
pThe input casu_fits object
Returns
The error status
Author
Jim Lewis, CASU

Definition at line 711 of file casu_fits.c.

Referenced by casu_pawsky_mask(), casu_pawsky_mask_pre(), casu_pawsky_minus(), casu_photcal_extinct(), casu_simplesky_mask(), vircam_jmp_catalogue(), vircam_jmp_dither_images(), vircam_jmp_dither_offsets(), vircam_jmp_illum(), vircam_jmp_interleave(), vircam_jmp_save_offsky(), vircam_jmp_save_simple(), vircam_jmp_save_simple_offsets(), vircam_jmp_save_stack(), vircam_jmp_save_super(), vircam_jmp_skycor(), and vircam_jmp_ustep_seq().

◆ casu_fits_load()

casu_fits * casu_fits_load ( cpl_frame *  frame,
cpl_type  type,
int  nexten 
)
Name:
casu_fits_load
Purpose:
Load an input image into a casu_fits object
Description:
An image from an input cpl_frame is loaded into a casu_fits object. Only the image for a given extension number is loaded. The rest of the object properties are initialised
Language:
C
Parameters
frameThe input cpl_frame object
typeThe data type for the loaded image
nextenThe image extension that you want to load.
Returns
The output casu_fits object or NULL if there was a problem
Author
Jim Lewis, CASU

Definition at line 80 of file casu_fits.c.

Referenced by casu_fits_load_list(), casu_mask_load(), vircam_grout(), and vircam_mosaic().

◆ casu_fits_load_list()

casu_fits ** casu_fits_load_list ( cpl_frameset *  f,
cpl_type  type,
int  exten 
)
Name:
casu_fits_load_list
Purpose:
Load a list of input images into a casu_fits object array
Description:
Images from an input cpl_frameset are loaded into a list of casu_fits objects. Only the images for a given extension number are loaded. The rest of the object properties are initialised
Language:
C
Parameters
fThe input cpl_frameset object
typeThe data type for the loaded images
extenThe image extension that you want to load.
Returns
The output casu_fits object list or NULL if there was a problem
Author
Jim Lewis, CASU

Definition at line 318 of file casu_fits.c.

References casu_fits_delete_list(), and casu_fits_load().

◆ casu_fits_replace_image()

void casu_fits_replace_image ( casu_fits *  in,
cpl_image *  image 
)
Name:
casu_fits_replace_image
Purpose:
Replace the image in a casu_fits structure with a new one
Description:
The image in an input casu_fits structure is deleted and replaced with a new one. This should be used with caution, but can be useful for subsetting and image as when we trim the overscan regions off.
Language:
C
Parameters
inThe input casu_fits object
imageThe new image
Author
Jim Lewis, CASU

Definition at line 279 of file casu_fits.c.

◆ casu_fits_set_error()

int casu_fits_set_error ( casu_fits *  p,
int  status 
)
Name:
casu_fits_set_error
Purpose:
Set the error status and message for an object
Description:
The input status is checked to see if there has been a problem with the current object. If there has been, then the status is stored away and any error message from the cpl_error system is copied down.
Language:
C
Parameters
pThe input casu_fits object
statusThe input error status
Returns
A flag to say whether the input status was fatal.
Author
Jim Lewis, CASU

Definition at line 747 of file casu_fits.c.

Referenced by vircam_jmp_catalogue(), vircam_jmp_dither_images(), vircam_jmp_dither_offsets(), vircam_jmp_interleave(), and vircam_jmp_ustep_seq().

◆ casu_fits_set_filename()

void casu_fits_set_filename ( casu_fits *  p,
char *  fname 
)
Name:
casu_fits_set_filename
Purpose:
Set the file name associated with a casu_fits structure
Description:
Set the file name associated with a casu_fits structure. This is useful if you have wrapped a cpl_image in a structure and you don't have a physical file to refer to. The name can be used to define an output file name if you ultimately decide to write this out. If a name already exists, it will be overwritten
Language:
C
Parameters
pThe input casu_fits object
fnameThe input file name.
Returns
Nothing
Author
Jim Lewis, CASU

Definition at line 839 of file casu_fits.c.

◆ casu_fits_set_status()

void casu_fits_set_status ( casu_fits *  p,
int  status 
)
Name:
casu_fits_set_status
Purpose:
Set the error status
Description:
The input status is checked to see if there has been a problem with the current object. If there has been, then the status is stored.
Language:
C
Parameters
pThe input casu_fits object
statusThe input error status
Returns
None
Author
Jim Lewis, CASU

Definition at line 801 of file casu_fits.c.

Referenced by casu_pawsky_mask(), casu_pawsky_mask_pre(), casu_pawsky_minus(), and casu_simplesky_mask().

◆ casu_fits_unload_im()

void casu_fits_unload_im ( casu_fits *  in)
Name:
casu_fits_unload_im
Purpose:
Unload the image from a casu_fits structure
Description:
The image is unloaded from a casu_fits structure. This might be done as a means of saving memory on large images.
Language:
C
Parameters
inThe input casu_fits object
Author
Jim Lewis, CASU

Definition at line 200 of file casu_fits.c.

Referenced by casu_imstack().

◆ casu_fits_unwrap()

void casu_fits_unwrap ( casu_fits *  p)
Name:
casu_fits_unwrap
Purpose:
Get rid of the casu_fits structure but leave the image
Description:
The input casu_fits structure is deallocated leaving the image behind Make sure you have a reference to the original image when using this routine so that it can be deleted explicitly later
Language:
C
Parameters
pThe input casu_fits
Author
Jim Lewis, CASU

Definition at line 945 of file casu_fits.c.

◆ casu_fits_wrap()

casu_fits * casu_fits_wrap ( cpl_image *  im,
casu_fits *  model,
cpl_propertylist *  phu,
cpl_propertylist *  ehu 
)
Name:
casu_fits_wrap
Purpose:
Wrap an image in a casu_fits wrapper
Description:
The input image is inserted into a casu_fits wrapper. A model casu_fits object may be provided to give the new object headers. If the phu and ehu parameters are not null then they will be used as the propertylists for the new object. If not, then an attempt will be made to copy the propertylists from the model. If the model and the propertylists are both NULL, then empty propertylists are given
Language:
C
Parameters
imThe input cpl_image
modelThe input casu_fits model object
phuThe input propertylist for the extension header for the new object.
ehuThe input propertylist for the extension header for the new object.
Returns
The new casu_fits structure.
Author
Jim Lewis, CASU

Definition at line 883 of file casu_fits.c.

References casu_fits_get_ehu(), and casu_fits_get_phu().

Referenced by casu_mask_wrap_bpm(), casu_pawsky_mask(), casu_pawsky_mask_pre(), casu_pawsky_minus(), casu_simplesky_mask(), vircam_jmp_dither_images(), vircam_jmp_interleave(), vircam_jmp_skycor(), vircam_mosaic(), and vircam_tilesky().