iflPixel(3) Image Format Library C++ Reference Manual iflPixel(3)NAMEiflPixel - class for pixel abstraction
INHERITS FROM
This is a base class and therefore has no inheritance.
HEADER FILE
#include <ifl/iflCdefs.h>
CLASS DESCRIPTION
This class abstracts the concept of a pixel of image data. It contains
the data type, the number of channels, and a list of component values.
Pixels are used as arguments on an iflConverter constructor.
CLASS MEMBER FUNCTION SUMMARY
Constructor
iflPixel *iflPixelCreate(iflDataType type, int nc, void *data)
iflPixel *iflPixelPixCreate(iflPixel* pix)
Destructor
void iflPixelDelete(iflPixel *pixel)
Initializing
void iflPixelConvert(iflPixel *pixel, iflPixel *pix, iflDataType toType, int nc,
int *chanList)
void iflPixelSet(iflPixel *pixel, iflDataType type, int nc, void *data)
Member access
void *iflPixelGetData(iflPixel *pixel)
iflDataType iflPixelGetDataType(iflPixel *pixel)
double iflPixelGetElem(iflPixel *pixel, int index)
int iflPixelGetNumChans(iflPixel *pixel)
void iflPixelSetElem(iflPixel *pixel, double elemValue, int index)
double iflPixelMin(iflPixel *pixel)
double iflPixelMax(iflPixel *pixel)
FUNCTION DESCRIPTIONSiflPixel()iflPixel *iflPixelCreate(iflDataType type, int nc, void *data)
iflPixel *iflPixelPixCreate(iflPixel* pix)
Page 1
iflPixel(3) Image Format Library C++ Reference Manual iflPixel(3)
The first constructor creates a pixel of data type, type, with nc
channels, and with the component values pointed to by data. The
data values are copied into the iflPixel constructed. The second
constructor copies the attributes and data from the iflPixel
specified by pix.
iflPixelDelete()
void iflPixelDelete(iflPixel *pixel)
convert()
void iflPixelConvert(iflPixel *pixel, iflPixel *pix, iflDataType toType, int nc,
int *chanList)
This function copies the pixel specified by pix, converting to the
new data type, toType. A subset of the channels can be selected by
listing the channels to copy from the source pixel in chanList. The
length of the channel list is given by nc.
getData()
void *iflPixelGetData(iflPixel *pixel)
This function returns a pointer to the pixel component array. This
is identical in function to the (void*) cast operation.
getDataType()
iflDataType iflPixelGetDataType(iflPixel *pixel)
This function returns the data type of the pixel.
getElem()
double iflPixelGetElem(iflPixel *pixel, int index)
This function returns the pixel component selected by index. The
first component is at index zero. This is identical in function to
the [] subscript operation.
getNumChans()
int iflPixelGetNumChans(iflPixel *pixel)
Page 2
iflPixel(3) Image Format Library C++ Reference Manual iflPixel(3)
This function returns the number of channels in the pixel.
min()
double iflPixelMin(iflPixel *pixel)
This function returns the minimum value of the pixel component
array.
max()
double iflPixelMax(iflPixel *pixel)
This function returns the maximum value of the pixel component
array.
set()
void iflPixelSet(iflPixel *pixel, iflDataType type, int nc, void *data)
This function initializes the pixel's data type to type, sets the
channel count to nc, and copies the component values from data.
setElem()
void iflPixelSetElem(iflPixel *pixel, double elemValue, int index)
This function sets the pixel component selected by index. The first
component is at index zero.
SEE ALSO
iflConverter
Page 3