DESCRIPTION
This class implements the interface presented in DfcImageInfoInterface.h

ImageInfo contains all the information about an Image EXCEPT the actual image data itself. It presents a good way of allowing objects, such as a Frame, to accesss only relevant information about an Image.
The user shouldn't be concerned with creating istances of this class, just obtaining and using them.

To find out how to obtain the data part of the Image, see the Image class.

EXAMPLES

    for (int image = 0; image < myFrame.getNumImages(); image++)
  {
    DfcImageInfo currentImage = myFrame.getImageInfo(image);
    cout << currentImage.getName() << endl;
  } 

    try
  {
    DfcImageInfo myInfoObj = myFrame.getImageInfo("someName");
  }
  catch(DfcDoesntExistExc exc)
  {
    cerr << "Frame doesn't contain an ImageInfo object of that name\n";
  }
  

DESIGN NOTES
Previously the ImageInfo class was the base class for an Image hierarchy so that downcasting from the ImageInfo class to, say DfcImage<float> would then yield the methods necessary to access the image data. ImageInfo has been seperated for three reasons:
1 - As pointed out in the first design review the semantics of such a hierarchy are questionable.
2 - It is desired that, regardless of whatever format the data is stored in, it should be possible to load the data into memory as any type. This means delaying the actual creation of an Image instance until the user specifies what type each pixel is to be represented as. This necessitates splitting the ImageInfo class from the Image hierarchy.
3 - The requirement for fast access to Image headers only.

The class "ActualImageInfo" is the actual object that is stored in both DfcFrame and associated with DfcImageBase. The derived class "DfcImageInfo" is a proxy object which manipualtes one of these objects. The proxy is provided to prevent the user from deleting the ActualImageInfo object.

Arguments

Arguments

Arguments

Returns
An indication of the type of data the image is composed of. This may be vectors, or it may be scalar pixels.

Returns
The number of axes in the Image, will be 1, 2, 3 or 4.

Returns
A reference to a DfcKeywordStructure instance. This is the top level structure associated with this Image. An iterator can be obtained from this Structure.

Preconditions
0 <= whichAxis < getNumAxes();

Returns
A reference to the requested axis. Note that it is a reference - do NOT delete it.

Exceptions

• DfcBoundsExc - whichAxis is not a valid axis.

Arguments

Returns
A reference to the requested axis.

Exceptions

• DfcDoesntExist - whichAxis is not a valid axis.

Arguments

Returns
Boolean indication of whether the saving of the data was succesful or not.

Exceptions

• DfcReadOnlyExc - the class cannot be read back because it has been opened as a read only class.

Arguments

Returns
Boolean indicating whether the data was succesfully read or not.

Exceptions

• DfcMemoryExc - while trying to create the sub-objects to hold the data locally, not enough memory was available.
• DfcAlreadyOpenExc - the object is already opened somewhere else.

Arguments

Returns
Boolean indicating whether the data was succesfully read or not.

Exceptions

• DfcMemoryExc - while trying to create the sub-objects to hold the data locally, not enough memory was available.
• DfcAlreadyOpenExc - the object is already open for update somewhere else.

Arguments

Returns
Reference (constant) to a RWString.

Arguments

Returns
A pointer to the copy of this object. Responsibility for memory management transfers to the invoker of the method.

Exceptions

• DfcAlreadyOpenExc - if an attempt is made to clone an object that is already update, this exception results.
• DfcMemoryExc - there isn't enough memory on the local machine to perform the clone operation.

Returns
Reference to this object to allow chaining together of assignment statements.

Exceptions

• DfcAlreadyOpenExc - if an attempt is made to assign from an object that is already update, this exception results.
• DfcMemoryExc - there isn't enough memory on the local machine to perform the copying.

Arguments

Returns
Reference to this object to allow chaining together of assignment statements.

Exceptions

• DfcAlreadyOpenExc - if an attempt is made to assign from an object that is already update, this exception results.
• DfcMemoryExc - there isn't enough memory on the local machine to perform the copying.

Arguments