VIRCAM Pipeline  2.3.12
Functions
casu_tfits

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

Functions

casu_tfits * casu_tfits_load (cpl_frame *table, int nexten)
 
casu_tfits * casu_tfits_extract (casu_tfits *in)
 
casu_tfits * casu_tfits_duplicate (casu_tfits *in)
 
casu_tfits ** casu_tfits_load_list (cpl_frameset *f, int exten)
 
void casu_tfits_delete (casu_tfits *p)
 
void casu_tfits_delete_list (casu_tfits **p, int n)
 
cpl_table * casu_tfits_get_table (casu_tfits *p)
 
int casu_tfits_get_nexten (casu_tfits *p)
 
cpl_propertylist * casu_tfits_get_phu (casu_tfits *p)
 
cpl_propertylist * casu_tfits_get_ehu (casu_tfits *p)
 
char * casu_tfits_get_filename (casu_tfits *p)
 
char * casu_tfits_get_fullname (casu_tfits *p)
 
int casu_tfits_get_status (casu_tfits *p)
 
int casu_tfits_set_error (casu_tfits *p, int status)
 
void casu_tfits_set_status (casu_tfits *p, int status)
 
void casu_tfits_set_filename (casu_tfits *p, char *fname)
 
casu_tfits * casu_tfits_wrap (cpl_table *tab, casu_tfits *model, cpl_propertylist *phu, cpl_propertylist *ehu)
 

Detailed Description

These are methods for manipulating the casu_tfits object.

Author
Jim Lewis, CASU

Function Documentation

◆ casu_tfits_delete()

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

Definition at line 292 of file casu_tfits.c.

Referenced by casu_tfits_delete_list(), and vircam_jmp_photcal().

◆ casu_tfits_delete_list()

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

Definition at line 329 of file casu_tfits.c.

References casu_tfits_delete().

Referenced by casu_tfits_load_list().

◆ casu_tfits_duplicate()

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

Definition at line 196 of file casu_tfits.c.

References casu_tfits_get_ehu(), and casu_tfits_get_phu().

Referenced by vircam_grout().

◆ casu_tfits_extract()

casu_tfits* casu_tfits_extract ( casu_tfits *  in)
Name:
casu_tfits_extract
Purpose:
Extract selected rows from a casu_tfits table
Description:
A casu_tfits structure is passed in containing a table that has had some rows selected. A new casu_tfits table is returned with only the selected rows.
Language:
C
Parameters
inThe input casu_tfits object
Returns
The output casu_tfits object.
Author
Jim Lewis, CASU

Definition at line 152 of file casu_tfits.c.

References casu_tfits_get_filename(), casu_tfits_get_nexten(), and casu_tfits_get_table().

◆ casu_tfits_get_ehu()

cpl_propertylist* casu_tfits_get_ehu ( casu_tfits *  p)
Name:
casu_tfits_get_ehu
Purpose:
Get the propertylist for the extension header for a given casu_tfits image.
Description:
Get the propertylist for the extension header for a given casu_tfits 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_tfits object
Returns
The propertylist represeting the extension header of the input table (NULL if there is an error).
Author
Jim Lewis, CASU

Definition at line 473 of file casu_tfits.c.

Referenced by casu_imcore(), casu_photcal_extinct(), casu_tfits_duplicate(), casu_tfits_load(), casu_tfits_wrap(), imcore_classify(), vircam_grout(), vircam_jmp_illum(), vircam_jmp_save_catalogue(), vircam_jmp_save_illum(), and vircam_jmp_wcsfit().

◆ casu_tfits_get_filename()

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

Definition at line 510 of file casu_tfits.c.

Referenced by casu_tfits_extract(), and vircam_lincor().

◆ casu_tfits_get_fullname()

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

Definition at line 544 of file casu_tfits.c.

◆ casu_tfits_get_nexten()

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

Definition at line 397 of file casu_tfits.c.

Referenced by casu_tfits_extract().

◆ casu_tfits_get_phu()

cpl_propertylist* casu_tfits_get_phu ( casu_tfits *  p)
Name:
casu_tfits_get_phu
Purpose:
Get the propertylist for the primary header for a given casu_tfits image.
Description:
Get the propertylist for the primary header for a given casu_tfits 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_tfits object
Returns
The propertylist represeting the primary header of the input table (NULL if there is an error).
Author
Jim Lewis, CASU

Definition at line 432 of file casu_tfits.c.

Referenced by casu_tfits_duplicate(), casu_tfits_wrap(), vircam_jmp_save_catalogue(), and vircam_jmp_save_illum().

◆ casu_tfits_get_status()

int casu_tfits_get_status ( casu_tfits *  p)
Name:
casu_tfits_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_tfits object
Returns
The error status
Author
Jim Lewis, CASU

Definition at line 575 of file casu_tfits.c.

◆ casu_tfits_get_table()

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

Definition at line 364 of file casu_tfits.c.

Referenced by casu_imcore(), casu_imstack(), casu_photcal_extinct(), casu_tfits_extract(), imcore_classify(), vircam_genlincur(), vircam_grout(), vircam_jmp_dither_offsets(), vircam_jmp_illum(), vircam_jmp_matched_stds(), vircam_jmp_save_catalogue(), vircam_jmp_save_illum(), vircam_jmp_wcsfit(), and vircam_lincor().

◆ casu_tfits_load()

casu_tfits* casu_tfits_load ( cpl_frame *  table,
int  nexten 
)
Name:
casu_tfits_load
Purpose:
Load an input table into a casu_tfits object
Description:
A table from an input cpl_frame is loaded into a casu_tfits object. Only the table for a given extension number is loaded. The rest of the object properties are initialised
Language:
C
Parameters
tableThe input cpl_frame object
nextenThe image extension that you want to load.
Returns
The output casu_tfits object.
Author
Jim Lewis, CASU

Definition at line 78 of file casu_tfits.c.

References casu_tfits_get_ehu().

Referenced by casu_tfits_load_list().

◆ casu_tfits_load_list()

casu_tfits** casu_tfits_load_list ( cpl_frameset *  f,
int  exten 
)
Name:
casu_tfits_load_list
Purpose:
Load a input tables into a casu_tfits object array
Description:
Tables from an input cpl_frameset are loaded into a list of casu_tfits objects. Only the tables for a given extension number are loaded. The rest of the object properties are initialised
Language:
C
Parameters
fThe input cpl_frameset object
extenThe image extension that you want to load.
Returns
The output casu_tfits object list.
Author
Jim Lewis, CASU

Definition at line 247 of file casu_tfits.c.

References casu_tfits_delete_list(), and casu_tfits_load().

◆ casu_tfits_set_error()

int casu_tfits_set_error ( casu_tfits *  p,
int  status 
)
Name:
casu_tfits_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_tfits object
statusThe input error status
Returns
A flag to say whether the input status was fatal
Author
Jim Lewis, CASU

Definition at line 611 of file casu_tfits.c.

◆ casu_tfits_set_filename()

void casu_tfits_set_filename ( casu_tfits *  p,
char *  fname 
)
Name:
casu_tfits_set_filename
Purpose:
Set the file name associated with a casu_tfits structure
Description:
Set the file name associated with a casu_tfits structure. This is useful if you have wrapped a cpl_table 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_tfits object
fnameThe input file name.
Returns
Nothing
Author
Jim Lewis, CASU

Definition at line 697 of file casu_tfits.c.

◆ casu_tfits_set_status()

void casu_tfits_set_status ( casu_tfits *  p,
int  status 
)
Name:
casu_tfits_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_tfits object
statusThe input error status
Returns
None
Author
Jim Lewis, CASU

Definition at line 659 of file casu_tfits.c.

◆ casu_tfits_wrap()

casu_tfits* casu_tfits_wrap ( cpl_table *  tab,
casu_tfits *  model,
cpl_propertylist *  phu,
cpl_propertylist *  ehu 
)
Name:
casu_tfits_wrap
Purpose:
Wrap an table in a casu_tfits wrapper
Description:
The input table is inserted into a casu_tfits wrapper. A model casu_tfits 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.
Language:
C
Parameters
tabThe input cpl_table
modelThe input casu_tfits model object
phuThe input propertylist for the primary header for the new object.
ehuThe input propertylist for the extension header for the new object.
Returns
The new casu_tfits structure.
Author
Jim Lewis, CASU

Definition at line 739 of file casu_tfits.c.

References casu_tfits_get_ehu(), and casu_tfits_get_phu().

Referenced by imcore_conf(), vircam_jmp_illum(), and vircam_jmp_photcal().