MXARGBImage Class Reference

This class represents a 2D array of rgb values. The data is written to the data file using the H5Image protocol. This means that some extra attributes are written to the dataset in addition to the data. If this is NOT what you want then use the generic MXA2DArray class instead. More...

Inherits MXAArrayTemplate< uint8 >.

Inheritance diagram for MXARGBImage:

Inheritance graph
[legend]
Collaboration diagram for MXARGBImage:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual ~MXARGBImage ()
virtual int32 getNumberOfDimensions ()
virtual void getDimensions (uint64 *dims)
 Copies the values of the dimensions into the supplied pointer.
uint8 * getPixelPointer (int32 x, int32 y)
virtual int32 getWidth ()
virtual int32 getHeight ()
virtual int32 resize (uint64 size)
 Reseizes the internal array.
int32 resizeArray (int32 width, int32 height)
 Resizes the data array to the specified width and height.
virtual std::string valueToString (char delimiter= ' ')
 Serializes the value(s) of the array to a string using the delimiter The character to use to separate the values - Default is a single space.

Static Public Member Functions

static IMXAArray::Pointer CreateRGBImageArray (int32 width, int32 height)
static MXARGBImageNew (int32 width, int32 height)

Protected Member Functions

 MXARGBImage (int32 width, int32 height)

Private Member Functions

 MXARGBImage (const MXARGBImage &)
void operator= (const MXARGBImage &)

Private Attributes

int32 _width
int32 _height

Detailed Description

This class represents a 2D array of rgb values. The data is written to the data file using the H5Image protocol. This means that some extra attributes are written to the dataset in addition to the data. If this is NOT what you want then use the generic MXA2DArray class instead.

Author:
mjackson
Date:
Jan 9, 2008
Version:
Revision
1.2


Constructor & Destructor Documentation

MXARGBImage::~MXARGBImage (  )  [virtual]

MXARGBImage::MXARGBImage ( int32  width,
int32  height 
) [protected]

MXARGBImage::MXARGBImage ( const MXARGBImage  )  [private]


Member Function Documentation

IMXAArray::Pointer MXARGBImage::CreateRGBImageArray ( int32  width,
int32  height 
) [static]

MXARGBImage * MXARGBImage::New ( int32  width,
int32  height 
) [static]

int32 MXARGBImage::getNumberOfDimensions (  )  [virtual]

Returns the number of dimensions the data has.

Reimplemented from MXAArrayTemplate< uint8 >.

virtual void MXARGBImage::getDimensions ( uint64 *  dims  )  [inline, virtual]

Copies the values of the dimensions into the supplied pointer.

Parameters:
dims Pointer to store the dimension values into

Reimplemented from MXAArrayTemplate< uint8 >.

uint8 * MXARGBImage::getPixelPointer ( int32  x,
int32  y 
)

virtual int32 MXARGBImage::getWidth (  )  [inline, virtual]

virtual int32 MXARGBImage::getHeight (  )  [inline, virtual]

int32 MXARGBImage::resize ( uint64  size  )  [virtual]

Reseizes the internal array.

Parameters:
size The new size of the internal array
Returns:
1 on success, 0 on failure

Reimplemented from MXAArrayTemplate< uint8 >.

int32 MXARGBImage::resizeArray ( int32  width,
int32  height 
)

Resizes the data array to the specified width and height.

Parameters:
width The new width of the array
height The new height of the array
Returns:
1 on success and Zero (0) on failure

std::string MXARGBImage::valueToString ( char  delimiter = ' '  )  [virtual]

Serializes the value(s) of the array to a string using the delimiter The character to use to separate the values - Default is a single space.

Reimplemented from MXAArrayTemplate< uint8 >.

void MXARGBImage::operator= ( const MXARGBImage  )  [private]


Member Data Documentation

int32 MXARGBImage::_width [private]

int32 MXARGBImage::_height [private]


The documentation for this class was generated from the following files:
Generated on Tue Nov 17 18:43:15 2009 for MXADataModel by  doxygen 1.5.2