FITS - FITS handles input and output of FITS files. [Supporting Modules]

Data Structures
struct	fits2d
struct	fits3d
struct	location
struct	MultiDimFits
Functions
fits2d	readfits (char *filename)
MultiDimFits	openMultiDimFitsRead (char *filename)
void	openMultiDimFitsWrite (char *filename, MultiDimFits *fileInfoPtr, FITSParameters headerParameters)
fits2d	readNextPlane (MultiDimFits fileInfo, WhichPlane whichPlane)
void	writeNextPlane (MultiDimFits fileInfo, WhichPlane whichPlane, fits2d data)
int	closeMultiDimFits (MultiDimFits fileInfo)
int	writefits (char *filename, fits3d data)
int	writefits2dWithLambdaSwitch (char *filename, fits2d data, Float lambda, int useLambda)
int	writefits2d (char *filename, fits2d data)
int	writefits2dWithLambda (char *filename, fits2d data, Float lambda)

---

Function Documentation

int closeMultiDimFits

(

MultiDimFits

fileInfo

)

Close 3D FITS file

Parameters:

[in]

fileInfo

Object containing FITS file info, such as file ptr, dimensions, etc.

MultiDimFits openMultiDimFitsRead

(

char *

filename

)

Open a FITS file for reading; return file info in object containing fitsfile *fptr; current location x, y, z

Parameters:

[in]

filename

Name of the file to open for reading.

Returns:

MultiDimFits object with fitsfile *fptr; current location x, y, z

void openMultiDimFitsWrite	(	char *	filename,
		MultiDimFits *	fileInfoPtr,
		FITSParameters	headerParameters
	)

Open a 3D FITS file for writing; Write the header information including the lambda value used in data calculations. Returns file info in object containing: fitsfile *fptr; current location x, y, z

Parameters:

[in]	filename	Name of the file to open for writing.
[in,out]	fileInfoPtr	Object containing information about FITS file.
[in]	headerParameters	List of parameter names, values and comments to write in FITS header.

fits2d readfits

(

char *

filename

)

Read a 2D or 1D FITS file.

Parameters:

[in]

filename

Name of FITS file to open and read.

fits2d readNextPlane	(	MultiDimFits	fileInfo,
		WhichPlane	whichPlane
	)

Read the next plane of a 3D FITS file.

Parameters:

[in]	fileInfo	Object containing FITS file info, such as file ptr, dimensions, etc.
[in]	whichPlane	Which plane (z-dimension) for the xy-plane to write.

Returns:

A fits2d object containing the data of the xy-plane for the plane specified.

int writefits	(	char *	filename,
		fits3d	data
	)

Write complex data to a file using FITS format

Parameters:

[in]	filename	Name of output file
[in]	data	Array of complex data in a fits3d object

Returns:

FITS file status.

int writefits2d	(	char *	filename,
		fits2d	data
	)

Write real data to a file using FITS format

Parameters:

[in]	filename	Name of output file
[in]	data	Array of real data in a fits2d object

Returns:

FITS file status.

int writefits2dWithLambda	(	char *	filename,
		fits2d	data,
		Float	lambda
	)

Write real data to a file using FITS format

Parameters:

[in]	filename	Name of output file
[in]	data	Array of real data in a fits2d object
[in]	lambda	Value of lambda parameter used during inversion calculation for this data.

Returns:

FITS file status.

int writefits2dWithLambdaSwitch	(	char *	filename,
		fits2d	data,
		Float	lambda,
		int	useLambda
	)

Write real data to a file using FITS format

Parameters:

[in]	filename	Name of output file
[in]	data	Array of real data in a fits2d object
[in]	lambda	Value of lambda parameter used during inversion calculation for this data.
[in]	useLambda	True, if writing lambda parameter in FITS header.

Returns:

FITS file status.

void writeNextPlane	(	MultiDimFits	fileInfo,
		WhichPlane	whichPlane,
		fits2d	data
	)

Write the next plane of a 3D FITS file.

Parameters:

[in]	fileInfo	Object containing FITS file info, such as file ptr, dimensions, etc.
[in]	whichPlane	Which plane (z-dimension) for the xy-plane to write.
[in]	data	A fits2d object containing the data of an xy-plane.