FITSdata is a container class that includes a BasicFITSHeader and an Image as data members. It provides a set of methods to perform combined I/O operations on the header and data in a FITS file.
2008 July 09 - Documentation written.
Destructor. Destroys the Header and Image objects it contains. Never call this procedure directly; it is invoked by IDL's Obj_Destroy function.
Structure definition. Specifies the contents of the IDL structure instantiated by the FITSData class. Used by Obj_New; do not invoke directly.
Return Object Header
Returns a reference to its Header object.
Return Object Image
Returns a reference to its Image object.
argument string headerClass
argument string imageClass
Return bool TRUE
Constructor. It creates two objects of class specified by the arguments. Never call this function directly; it is invoked by IDL's Obj_New function.
Calls HeaderClass::is_valid, ImageClass::is_valid
Return long[i] valid
Each OIL class has an is_valid function that performs class-specific tests on its data members. If all members are found to be valid, however validity is defined for that class, this funtion returns 1. Otherwise, a negative number is returned that contains a bitwise combination of all errors detected. In the case of FITSData, a 2D array is returned containing the result of is_valid called for each of the contained objects.
Calls HeaderClass::read, HeaderClass::get_card_image, ImageClass::new_data_array, ImageClass::read, ImageClass::byteswap
Reads a FITS file into the header and image objects. A new data array is created in the Image object, and the routine ensures the data are properly byteswapped from the FITS big-endian standard for the local machine.
argument string dataFile
Calls HeaderClass::set_datafile, ImageClass::set_datafile
Sets the value of the data file the object is linked to.
argument Object Header
Sets the Header data member to a new object reference, destroying the old object first.
argument Object Image
Sets the Image data member to a new object reference, destroying the old object first.
Calls HeaderClass::write, ImageClass::write, ImageClass::byteswap
Writes the header and the image data to the linked file.
obj = Obj_New( 'FITSData', 'BasicFITSHeader', 'Image' )
Obj_Destroy( obj )