VIRCAM Pipeline: vircam

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:

p

The input vir_tfits object

Author:: Jim Lewis, CASU

Definition at line 245 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:

	p	The input list of vir_tfits objects
	n	The number of vir_tfits objects in the above array

Author:: Jim Lewis, CASU

Definition at line 282 of file vircam_tfits.c.

References vircam_tfits_delete().

Referenced by vircam_tfits_load_list().

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:

in

The 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:

p

The 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 426 of file vircam_tfits.c.

Referenced by vircam_jmp_illum(), vircam_jmp_photcal(), vircam_jmp_save_catalogue(), vircam_jmp_save_illum(), vircam_jmp_wcsfit(), 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:

p

The input vir_tfits object

Returns:: The name of the file from which this table originated

Author:: Jim Lewis, CASU

Definition at line 463 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:

p

The input vir_tfits object

Returns:: The fullname name of the file from which this image originated

Author:: Jim Lewis, CASU

Definition at line 497 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:

p

The input vir_tfit object

Returns:: The extension number (-1 in case of error)

Author:: Jim Lewis, CASU

Definition at line 350 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:

p

The 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 385 of file vircam_tfits.c.

Referenced by vircam_jmp_save_catalogue(), vircam_jmp_save_illum(), 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:

p

The input vir_tfits object

Returns:: The error status

Author:: Jim Lewis, CASU

Definition at line 528 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:

p

The input vir_tfits object

Returns:: The cpl_image object. NULL if there was an error.

Author:: Jim Lewis, CASU

Definition at line 317 of file vircam_tfits.c.

Referenced by vircam_genlincur(), vircam_imcore(), 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:

	table	The input cpl_frame object
	nexten	The 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:

	f	The input cpl_frameset object
	exten	The image extension that you want to load.

Returns:: The output vircam_tfits object list.

Author:: Jim Lewis, CASU

Definition at line 200 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:

	p	The input vir_tfits object
	status	The input error status

Returns:: A flag to say whether the input status was fatal

Author:: Jim Lewis, CASU

Definition at line 564 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:

	tab	The input cpl_table
	model	The input vir_tfits model object
	phu	The input propertylist for the primary header for the new object.
	ehu	The input propertylist for the extension header for the new object.

Returns:: The new vir_tfits structure.

Author:: Jim Lewis, CASU

Definition at line 618 of file vircam_tfits.c.

References vircam_tfits_get_ehu(), and vircam_tfits_get_phu().

Referenced by vircam_jmp_illum().


Functions
vir_tfits *	vircam_tfits_load (cpl_frame *table, int nexten)
vir_tfits *	vircam_tfits_extract (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)
vir_tfits *	vircam_tfits_wrap (cpl_table tab, vir_tfits model, cpl_propertylist phu, cpl_propertylist ehu)

vircam_tfits
[Groups of Support Routines]

Detailed Description

Functions

Function Documentation

vircam_tfits [Groups of Support Routines]

Detailed Description

Functions

Function Documentation

vircam_tfits
[Groups of Support Routines]