vircam_fits
[Groups of Support Routines]

---

Detailed Description

These are methods for manipulating the vircam_fits object.

Author:

Jim Lewis, CASU

Functions
vir_fits *	vircam_fits_load (cpl_frame *frame, cpl_type type, int nexten)
vir_fits *	vircam_fits_duplicate (vir_fits *in)
vir_fits **	vircam_fits_load_list (cpl_frameset *f, cpl_type type, int exten)
void	vircam_fits_delete (vir_fits *p)
void	vircam_fits_delete_list (vir_fits **p, int n)
cpl_image *	vircam_fits_get_image (vir_fits *p)
int	vircam_fits_get_nexten (vir_fits *p)
cpl_propertylist *	vircam_fits_get_phu (vir_fits *p)
cpl_propertylist *	vircam_fits_get_ehu (vir_fits *p)
char *	vircam_fits_get_extname (vir_fits *p)
char *	vircam_fits_get_filename (vir_fits *p)
char *	vircam_fits_get_fullname (vir_fits *p)
int	vircam_fits_get_status (vir_fits *p)
int	vircam_fits_set_error (vir_fits *p, int status)
vir_fits *	vircam_fits_wrap (cpl_image *im, vir_fits *model, cpl_propertylist *phu, cpl_propertylist *ehu)

---

Function Documentation

void vircam_fits_delete

(

vir_fits *

p

)

Name:

vircam_fits_delete

Purpose:

Free all the workspace associated with a vircam_fits object

Description:

Free all the workspace associated with a vircam_fits object

Language:

C

Parameters:

p

The input vir_fits object

Author:

Jim Lewis, CASU

Definition at line 262 of file vircam_fits.c.

Referenced by vircam_fits_delete_list(), vircam_imcore(), vircam_mask_load(), and vircam_overexp().

void vircam_fits_delete_list	(	vir_fits **	p,
		int	n
	)

Name:

vircam_fits_delete_list

Purpose:

Free all the workspace associated with a list of vircam_fits objects

Description:

Free all the workspace associated with a list of vircam_fits objects

Language:

C

Parameters:

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

Author:

Jim Lewis, CASU

Definition at line 299 of file vircam_fits.c.

References vircam_fits_delete().

Referenced by vircam_fits_load_list().

vir_fits* vircam_fits_duplicate

(

vir_fits *

in

)

Name:

vircam_fits_duplicate

Purpose:

Copy a vircam_fits structure into another one.

Description:

An input vircam_fits structure is duplcated and returned

Language:

C

Parameters:

in

The input vircam_fits object

Returns:

The output vircam_fits object.

Author:

Jim Lewis, CASU

Definition at line 156 of file vircam_fits.c.

Referenced by vircam_imcore().

cpl_propertylist* vircam_fits_get_ehu

(

vir_fits *

p

)

Name:

vircam_fits_get_ehu

Purpose:

Get the propertylist for the extension header for a given vir_fits image.

Description:

Get the propertylist for the extension header for a given vir_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:

p

The input vir_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 442 of file vircam_fits.c.

Referenced by vircam_darkcor(), vircam_defringe(), vircam_destripe(), vircam_fits_load(), vircam_fits_wrap(), vircam_flatcor(), vircam_gaincor(), vircam_illum(), vircam_imdither(), vircam_interleave(), 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_simple(), vircam_jmp_save_stack(), vircam_jmp_save_super(), vircam_jmp_skycor(), vircam_jmp_wcsfit(), vircam_lincor(), and vircam_photcal().

char* vircam_fits_get_extname

(

vir_fits *

p

)

Name:

vircam_fits_get_extname

Purpose:

Get the extension name for a give vir_fits object

Description:

Get the extension name for a given vir_fits object.

Language:

C

Parameters:

p

The input vir_fits object

Returns:

The pointer to the extension name in the vir_fits structure -- not a copy! (NULL if there is an error).

Author:

Jim Lewis, CASU

Definition at line 479 of file vircam_fits.c.

char* vircam_fits_get_filename

(

vir_fits *

p

)

Name:

vircam_fits_get_filename

Purpose:

Get the filename from which the current vir_fits object originated

Description:

Get the filename from which the current vir_fits object originated. If this is null, then the image didn't originate in an FITS file.

Language:

C

Parameters:

p

The input vir_fits object

Returns:

The name of the file from which this image originated

Author:

Jim Lewis, CASU

Definition at line 511 of file vircam_fits.c.

Referenced by vircam_imcombine(), vircam_imcore(), and vircam_jmp_ustep_seq().

char* vircam_fits_get_fullname

(

vir_fits *

p

)

Name:

vircam_fits_get_fullname

Purpose:

Get the fullname of the FITS extension from which the current vir_fits object originated

Description:

Get the fullname of the FITS extension from which the current vir_fits object originated. If this is null, then the image didn't originate in an FITS file.

Language:

C

Parameters:

p

The input vir_fits object

Returns:

The fullname name of the file from which this image originated

Author:

Jim Lewis, CASU

Definition at line 545 of file vircam_fits.c.

Referenced by vircam_darkcor(), vircam_defringe(), vircam_flatcor(), vircam_illum(), vircam_imcore(), vircam_imdither(), vircam_jmp_interleave(), vircam_lincor(), vircam_mkconf(), vircam_photcal(), and vircam_prov().

cpl_image* vircam_fits_get_image

(

vir_fits *

p

)

Name:

vircam_fits_get_image

Purpose:

Get the CPL image from the vir_fits object

Description:

Return the CPL image from the input vir_fits object. This image is suitable for use in all cpl_image routines.

Language:

C

Parameters:

p

The input vir_fits object

Returns:

The cpl_image object. NULL if there was an error.

Author:

Jim Lewis, CASU

Definition at line 334 of file vircam_fits.c.

Referenced by vircam_backmap(), vircam_darkcor(), vircam_defringe(), vircam_destripe(), vircam_dummy_image(), vircam_flatcor(), vircam_gaincor(), vircam_genbpm(), vircam_illum(), vircam_imcombine(), vircam_imdither(), vircam_interleave(), vircam_jmp_bpm2conf(), vircam_jmp_interleave(), vircam_jmp_save_simple(), vircam_jmp_save_stack(), vircam_jmp_save_super(), vircam_jmp_skycor(), vircam_lincor(), vircam_mask_load(), and vircam_overexp().

int vircam_fits_get_nexten

(

vir_fits *

p

)

Name:

vircam_fits_get_nexten

Purpose:

Get the FITS extension number for the current image in a vir_fits object

Description:

Get the FITS extension number for the current image in a vir_fits object

Language:

C

Parameters:

p

The input vir_fits object

Returns:

The extension number (-1 in case of error)

Author:

Jim Lewis, CASU

Definition at line 367 of file vircam_fits.c.

Referenced by vircam_imcombine().

cpl_propertylist* vircam_fits_get_phu

(

vir_fits *

p

)

Name:

vircam_fits_get_phu

Purpose:

Get the propertylist for the primary header for a given vir_fits image.

Description:

Get the propertylist for the primary header for a given vir_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:

p

The input vir_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 401 of file vircam_fits.c.

Referenced by vircam_fits_wrap(), vircam_illum(), vircam_imcombine(), vircam_imcore(), vircam_imdither(), vircam_interleave(), vircam_jmp_dither_offsets(), vircam_jmp_illum(), vircam_jmp_photcal(), vircam_jmp_save_simple(), vircam_jmp_save_stack(), vircam_jmp_save_super(), vircam_jmp_ustep_seq(), and vircam_photcal().

int vircam_fits_get_status

(

vir_fits *

p

)

Name:

vircam_fits_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_fits object

Returns:

The error status

Author:

Jim Lewis, CASU

Definition at line 576 of file vircam_fits.c.

Referenced by vircam_jmp_catalogue(), vircam_jmp_dither_images(), vircam_jmp_dither_offsets(), vircam_jmp_illum(), vircam_jmp_interleave(), vircam_jmp_save_simple(), vircam_jmp_save_stack(), vircam_jmp_save_super(), vircam_jmp_skycor(), and vircam_jmp_ustep_seq().

vir_fits* vircam_fits_load	(	cpl_frame *	frame,
		cpl_type	type,
		int	nexten
	)

Name:

vircam_fits_load

Purpose:

Load an input image into a vircam_fits object

Description:

An image from an input cpl_frame is loaded into a vircam_fits object. Only the image for a given extension number is loaded. The rest of the object properties are initialised

Language:

C

Parameters:

	frame	The input cpl_frame object
	type	The data type for the loaded image
	nexten	The image extension that you want to load.

Returns:

The output vircam_fits object.

Author:

Jim Lewis, CASU

Definition at line 80 of file vircam_fits.c.

References vircam_fits_get_ehu().

Referenced by vircam_fits_load_list(), and vircam_mask_load().

vir_fits** vircam_fits_load_list	(	cpl_frameset *	f,
		cpl_type	type,
		int	exten
	)

Name:

vircam_fits_load_list

Purpose:

Load an input images into a vircam_fits object array

Description:

Images from an input cpl_frameset are loaded into a list of vircam_fits objects. Only the images for a given extension number are loaded. The rest of the object properties are initialised

Language:

C

Parameters:

	f	The input cpl_frameset object
	type	The data type for the loaded images
	exten	The image extension that you want to load.

Returns:

The output vircam_fits object list.

Author:

Jim Lewis, CASU

Definition at line 216 of file vircam_fits.c.

References vircam_fits_delete_list(), and vircam_fits_load().

int vircam_fits_set_error	(	vir_fits *	p,
		int	status
	)

Name:

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

	p	The input vir_fits object
	status	The input error status

Returns:

A flag to say whether the input status was fatal.

Author:

Jim Lewis, CASU

Definition at line 613 of file vircam_fits.c.

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

vir_fits* vircam_fits_wrap	(	cpl_image *	im,
		vir_fits *	model,
		cpl_propertylist *	phu,
		cpl_propertylist *	ehu
	)

Name:

vircam_fits_wrap

Purpose:

Wrap an image in a vir_fits wrapper

Description:

The input image is inserted into a vir_fits wrapper. A model vir_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.

Language:

C

Parameters:

	im	The input cpl_image
	model	The input vir_fits model object
	phu	The input propertylist for the extension header for the new object.
	ehu	The input propertylist for the extension header for the new object.

Returns:

The new vir_fits structure.

Author:

Jim Lewis, CASU

Definition at line 673 of file vircam_fits.c.

References vircam_fits_get_ehu(), and vircam_fits_get_phu().

Referenced by vircam_jmp_dither_images(), and vircam_jmp_interleave().

---