VIPER REFERENCE MANUAL


NAME
iflSize - defines the size of an image

INHERITS FROM
iflXYZC

HEADER FILE
#include <ifl/iflSize.h>

PUBLIC METHOD SUMMARY

   Constructors
iflSize (  );
iflSize ( int X, int Y, int C=1);
iflSize ( int X, int Y, int Z, int C);
iflSize ( const iflSize& size);

   Operators
operator int (  ) const;

INHERITED PUBLIC METHODS

   Inherited from iflXYZC
iflXYZC& init ( X, T Y, T Z, T C);
inline int operator!= ( const iflXYZC& that) const;
inline iflXYZC operator% ( const iflXYZC& that) const;
inline iflXYZC& operator%= ( const iflXYZC& that);
inline iflXYZC operator& ( const iflXYZC& that) const;
inline iflXYZC& operator&= ( const iflXYZC& that);
inline iflXYZC operator* ( const iflXYZC& that) const;
inline iflXYZC& operator*= ( const iflXYZC& that);
inline iflXYZC operator+ ( const iflXYZC& that) const;
inline iflXYZC& operator+= ( const iflXYZC& that);
inline iflXYZC operator- ( const iflXYZC& that) const;
inline iflXYZC& operator-= ( const iflXYZC& that);
inline iflXYZC operator/ ( const iflXYZC& that) const;
inline iflXYZC& operator/= ( const iflXYZC& that);
inline int operator< ( const iflXYZC& that) const;
inline int operator<= ( const iflXYZC& that) const;
inline iflXYZC& operator= ( const iflXYZC& that);
inline int operator== ( const iflXYZC& that) const;
inline int operator> ( const iflXYZC& that) const;
inline int operator>= ( const iflXYZC& that) const;
T& operator[] ( iflAxis axis);
inline iflXYZC operator| ( const iflXYZC& that) const;
inline iflXYZC& operator|= ( const iflXYZC& that);

CLASS DESCRIPTION
This object is used to describe the size of an image. It is mostly used to group the four values describing the (x, y, z, c) size of an image together in a convenient way. An iflSize object can be declared in the following way:
    // unitialized
    iflSize size;

    // initialized
    iflSize size(X_SIZE, Y_SIZE, Z_SIZE, C_SIZE);
    iflSize size(X_SIZE, Y_SIZE, C_SIZE);
    iflSize size(otherSizeObj);
Several useful operators are provided to extract the total size and to perform direct comparisons between iflSize objects.

METHOD DESCRIPTIONS

   iflSize()
iflSize (  );
iflSize ( int X, int Y, int C=1);
iflSize ( int X, int Y, int Z, int C);
iflSize ( const iflSize& size);

The first version with no arguments constructs an uninitialized iflSize. The second version constructs an iflSize with the size set to (X, Y, C). Note that c and z default to 1. The third version constructs an iflSize with the size set to (X, Y, Z, C). The final version constructs an iflSize whose values are taken from size.

   operator int()
operator int (  ) const;

The integer cast operator returns the product of the dimensions, x*y*z*c.

SEE ALSO
iflXYZC