VIRCAM Pipeline  1.3.4
Functions

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

Functions

vir_tfits * vircam_tfits_load (cpl_frame *table, int nexten)
 
vir_tfits * vircam_tfits_extract (vir_tfits *in)
 
vir_tfits * vircam_tfits_duplicate (vir_tfits *in)
 
vir_tfits ** vircam_tfits_load_list (cpl_frameset *f, int exten)
 
void vircam_tfits_delete (vir_tfits *p)
 
void vircam_tfits_delete_list (vir_tfits **p, int n)
 
cpl_table * vircam_tfits_get_table (vir_tfits *p)
 
int vircam_tfits_get_nexten (vir_tfits *p)
 
cpl_propertylist * vircam_tfits_get_phu (vir_tfits *p)
 
cpl_propertylist * vircam_tfits_get_ehu (vir_tfits *p)
 
char * vircam_tfits_get_filename (vir_tfits *p)
 
char * vircam_tfits_get_fullname (vir_tfits *p)
 
int vircam_tfits_get_status (vir_tfits *p)
 
int vircam_tfits_set_error (vir_tfits *p, int status)
 
void vircam_tfits_set_filename (vir_tfits *p, char *fname)
 
vir_tfits * vircam_tfits_wrap (cpl_table *tab, vir_tfits *model, cpl_propertylist *phu, cpl_propertylist *ehu)
 

Detailed Description

These are methods for manipulating the vircam_tfits object.

Author
Jim Lewis, CASU

Function Documentation

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

Definition at line 292 of file vircam_tfits.c.

Referenced by vircam_tfits_delete_list().

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

Definition at line 329 of file vircam_tfits.c.

References vircam_tfits_delete().

Referenced by vircam_tfits_load_list().

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

Definition at line 196 of file vircam_tfits.c.

References vircam_tfits_get_ehu(), and vircam_tfits_get_phu().

Referenced by vircam_grout().

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

Definition at line 152 of file vircam_tfits.c.

References vircam_tfits_get_filename(), vircam_tfits_get_nexten(), and vircam_tfits_get_table().

cpl_propertylist* vircam_tfits_get_ehu ( vir_tfits *  p)
Name:
vircam_tfits_get_ehu
Purpose:
Get the propertylist for the extension header for a given vir_tfits image.
Description:
Get the propertylist for the extension header for a given vir_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 vir_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 vircam_tfits.c.

Referenced by classify(), vircam_grout(), vircam_imcore(), vircam_jmp_illum(), vircam_jmp_photcal(), vircam_jmp_save_catalogue(), vircam_jmp_save_illum(), vircam_jmp_wcsfit(), vircam_tfits_duplicate(), vircam_tfits_load(), and vircam_tfits_wrap().

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

Definition at line 510 of file vircam_tfits.c.

Referenced by vircam_lincor(), and vircam_tfits_extract().

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

Definition at line 544 of file vircam_tfits.c.

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

Definition at line 397 of file vircam_tfits.c.

Referenced by vircam_tfits_extract().

cpl_propertylist* vircam_tfits_get_phu ( vir_tfits *  p)
Name:
vircam_tfits_get_phu
Purpose:
Get the propertylist for the primary header for a given vir_tfits image.
Description:
Get the propertylist for the primary header for a given vir_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 vir_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 vircam_tfits.c.

Referenced by vircam_jmp_save_catalogue(), vircam_jmp_save_illum(), vircam_tfits_duplicate(), and vircam_tfits_wrap().

int vircam_tfits_get_status ( vir_tfits *  p)
Name:
vircam_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 vir_tfits object
Returns
The error status
Author
Jim Lewis, CASU

Definition at line 575 of file vircam_tfits.c.

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

Definition at line 364 of file vircam_tfits.c.

Referenced by classify(), vircam_genlincur(), vircam_grout(), vircam_imcore(), vircam_imstack(), vircam_jmp_dither_offsets(), vircam_jmp_illum(), vircam_jmp_matched_stds(), vircam_jmp_save_catalogue(), vircam_jmp_save_illum(), vircam_jmp_wcsfit(), vircam_lincor(), and vircam_tfits_extract().

vir_tfits* vircam_tfits_load ( cpl_frame *  table,
int  nexten 
)
Name:
vircam_tfits_load
Purpose:
Load an input table into a vircam_tfits object
Description:
A table from an input cpl_frame is loaded into a vircam_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 vircam_tfits object.
Author
Jim Lewis, CASU

Definition at line 78 of file vircam_tfits.c.

References vircam_tfits_get_ehu().

Referenced by vircam_tfits_load_list().

vir_tfits** vircam_tfits_load_list ( cpl_frameset *  f,
int  exten 
)
Name:
vircam_tfits_load_list
Purpose:
Load a input tables into a vircam_tfits object array
Description:
Tables from an input cpl_frameset are loaded into a list of vircam_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 vircam_tfits object list.
Author
Jim Lewis, CASU

Definition at line 247 of file vircam_tfits.c.

References vircam_tfits_delete_list(), and vircam_tfits_load().

int vircam_tfits_set_error ( vir_tfits *  p,
int  status 
)
Name:
vircam_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 vir_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 vircam_tfits.c.

void vircam_tfits_set_filename ( vir_tfits *  p,
char *  fname 
)
Name:
vircam_tfits_set_filename
Purpose:
Set the file name associated with a vir_tfits structure
Description:
Set the file name associated with a vir_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 vir_tfits object
fnameThe input file name.
Returns
Nothing
Author
Jim Lewis, CASU

Definition at line 661 of file vircam_tfits.c.

vir_tfits* vircam_tfits_wrap ( cpl_table *  tab,
vir_tfits *  model,
cpl_propertylist *  phu,
cpl_propertylist *  ehu 
)
Name:
vircam_tfits_wrap
Purpose:
Wrap an table in a vir_tfits wrapper
Description:
The input table is inserted into a vir_tfits wrapper. A model vir_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 vir_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 vir_tfits structure.
Author
Jim Lewis, CASU

Definition at line 703 of file vircam_tfits.c.

References vircam_tfits_get_ehu(), and vircam_tfits_get_phu().

Referenced by imcore_conf(), and vircam_jmp_illum().