abstract Template base for all image templates More...
#include <BaseImageTemplate.h>
Public Types | |
| typedef T | Pixel |
| local typedef for Pixel | |
Public Member Functions | |
| virtual double | getElementTypeMaximum () const |
| virtual double | getElementTypeMinimum () const |
| unsigned | getHeight () const |
| double | getValueRangeMaximum () const |
| double | getValueRangeMinimum () const |
| unsigned | getWidth () const |
| bool | isSubImage () const |
| check if image is a sub image | |
| operator const T ** () const | |
| cast operator for constant object | |
| operator T ** () | |
| cast operator | |
| void | operator= (const TBaseImg &o) |
| explicit definition of assignment operator | |
| const Vector< T > & | operator[] (int i) const |
| access operators for data rows (const) | |
| Vector< T > & | operator[] (int i) |
| access operators for data rows (mutable) | |
| void | readFromFile (const char *fileName) |
| void | resize (int width, int height) |
| delegate resize operation to matrix | |
| void | resize (int width, int height, TBaseImg *master, int xOffset, int yOffset) |
| delegate resize operation to matrix to create a subimage | |
| void | setupImageBaseVariables () |
| void | setValueRangeMaximum (double value) |
| void | setValueRangeMinimum (double value) |
| T ** | unsafeRowPointerArray () |
| verbose cast via method call | |
| const T ** | unsafeRowPointerArray () const |
| verbose cast via method call | |
| void | writeToFile (const char *fileName) const |
Protected Member Functions | |
| TBaseImg (int width=0, int height=0) | |
| also works as default constructor | |
| TBaseImg (int width, int height, TBaseImg *master, int xOffset, int yOffset) | |
| subimage constructor | |
Protected Attributes | |
| Matrix< T > | c0 |
| image matrix (raw data) | |
| double | mValueRangeMaximum |
| double | mValueRangeMinimum |
Detailed Description
template<class T>
class puma2::TBaseImg< T >
abstract Template base for all image templates
(detailed descripton forthcomming)
- See also:
- ImageCore
- Date:
- January 2007
Definition at line 32 of file BaseImageTemplate.h.
Member Typedef Documentation
| typedef T puma2::TBaseImg< T >::Pixel |
local typedef for Pixel
Definition at line 48 of file BaseImageTemplate.h.
Constructor & Destructor Documentation
| puma2::TBaseImg< T >::TBaseImg | ( | int | width = 0, |
| int | height = 0 |
||
| ) | [inline, protected] |
also works as default constructor
Definition at line 133 of file BaseImageTemplate.h.
| puma2::TBaseImg< T >::TBaseImg | ( | int | width, |
| int | height, | ||
| TBaseImg< T > * | master, | ||
| int | xOffset, | ||
| int | yOffset | ||
| ) | [inline, protected] |
subimage constructor
Definition at line 137 of file BaseImageTemplate.h.
Member Function Documentation
| virtual double puma2::TBaseImg< T >::getElementTypeMaximum | ( | ) | const [inline, virtual] |
Tell about the maximal value which can be stored by an element (a sample) which is the base type of this image class. (see getElementTypeMaximum().)
Reimplemented in puma2::ColorImageRGBa8, puma2::ColorImageRGB8, puma2::ColorImageUV8, puma2::GrayLevelImage8, puma2::GrayLevelImageFloat, and puma2::GrayLevelImage16.
Definition at line 114 of file BaseImageTemplate.h.
| virtual double puma2::TBaseImg< T >::getElementTypeMinimum | ( | ) | const [inline, virtual] |
Tell about the minimal value which can be stored by an element (a sample) which is the base type of this image class.lementTypeM (This should be some kind of constant, individually set for each subclass, but C++ allows such overloading only for functions, so we have to implement it as a constant function.)
Reimplemented in puma2::ColorImageRGBa8, puma2::ColorImageRGB8, puma2::ColorImageUV8, puma2::GrayLevelImage8, puma2::GrayLevelImageFloat, and puma2::GrayLevelImage16.
Definition at line 107 of file BaseImageTemplate.h.
| unsigned puma2::TBaseImg< T >::getHeight | ( | ) | const [inline] |
Retuns the vertical size of the image.
- Returns:
- Vertical size of the image
Definition at line 39 of file BaseImageTemplate.h.
| double puma2::TBaseImg< T >::getValueRangeMaximum | ( | ) | const [inline] |
get mValueRangeMaximum
Definition at line 125 of file BaseImageTemplate.h.
| double puma2::TBaseImg< T >::getValueRangeMinimum | ( | ) | const [inline] |
get mValueRangeMinimum
Definition at line 123 of file BaseImageTemplate.h.
| unsigned puma2::TBaseImg< T >::getWidth | ( | ) | const [inline] |
Retuns the horizontal size of the image.
- Returns:
- Horizontal size of the image
Definition at line 45 of file BaseImageTemplate.h.
| bool puma2::TBaseImg< T >::isSubImage | ( | ) | const [inline] |
check if image is a sub image
Definition at line 78 of file BaseImageTemplate.h.
| puma2::TBaseImg< T >::operator const T ** | ( | ) | const [inline] |
cast operator for constant object
Definition at line 63 of file BaseImageTemplate.h.
| puma2::TBaseImg< T >::operator T ** | ( | ) | [inline] |
cast operator
Definition at line 61 of file BaseImageTemplate.h.
| void puma2::TBaseImg< T >::operator= | ( | const TBaseImg< T > & | o | ) | [inline] |
explicit definition of assignment operator
Definition at line 57 of file BaseImageTemplate.h.
| const Vector<T>& puma2::TBaseImg< T >::operator[] | ( | int | i | ) | const [inline] |
access operators for data rows (const)
Definition at line 51 of file BaseImageTemplate.h.
| Vector<T>& puma2::TBaseImg< T >::operator[] | ( | int | i | ) | [inline] |
access operators for data rows (mutable)
Definition at line 54 of file BaseImageTemplate.h.
| void puma2::TBaseImg< T >::readFromFile | ( | const char * | fileName | ) | [inline] |
Reimplemented in puma2::ColorImageRGBa8, puma2::ColorImageRGB8, puma2::GrayLevelImage8, and puma2::GrayLevelImageFloat.
Definition at line 80 of file BaseImageTemplate.h.
| void puma2::TBaseImg< T >::resize | ( | int | width, |
| int | height | ||
| ) | [inline] |
delegate resize operation to matrix
Definition at line 70 of file BaseImageTemplate.h.
| void puma2::TBaseImg< T >::resize | ( | int | width, |
| int | height, | ||
| TBaseImg< T > * | master, | ||
| int | xOffset, | ||
| int | yOffset | ||
| ) | [inline] |
delegate resize operation to matrix to create a subimage
Definition at line 73 of file BaseImageTemplate.h.
| void puma2::TBaseImg< T >::setupImageBaseVariables | ( | ) | [inline] |
Definition at line 94 of file BaseImageTemplate.h.
| void puma2::TBaseImg< T >::setValueRangeMaximum | ( | double | value | ) | [inline] |
set mValueRangeMaximum to value
- Parameters:
-
[in] value new maximum
Definition at line 121 of file BaseImageTemplate.h.
| void puma2::TBaseImg< T >::setValueRangeMinimum | ( | double | value | ) | [inline] |
set mValueRangeMinimum to value
- Parameters:
-
[in] value new minimum
Definition at line 118 of file BaseImageTemplate.h.
| T** puma2::TBaseImg< T >::unsafeRowPointerArray | ( | ) | [inline] |
verbose cast via method call
Definition at line 65 of file BaseImageTemplate.h.
| const T** puma2::TBaseImg< T >::unsafeRowPointerArray | ( | ) | const [inline] |
verbose cast via method call
Definition at line 67 of file BaseImageTemplate.h.
| void puma2::TBaseImg< T >::writeToFile | ( | const char * | fileName | ) | const [inline] |
Reimplemented in puma2::ColorImageRGBa8, puma2::ColorImageRGB8, puma2::GrayLevelImage8, and puma2::GrayLevelImageFloat.
Definition at line 87 of file BaseImageTemplate.h.
Member Data Documentation
Matrix<T> puma2::TBaseImg< T >::c0 [protected] |
image matrix (raw data)
Definition at line 125 of file BaseImageTemplate.h.
double puma2::TBaseImg< T >::mValueRangeMaximum [protected] |
Holds the intended maximum value any sample of this image should have. This is not the current minimal value of all samples, but the value according to the range expected, like an 8-bit gray level image usually has an expected range from 0 (mValueRangeMinimum) to 255 (mValueRangeMaximum), whereas a 4-bit image has a range of 0..15, 12-bit has 0..4095 and so on.
Definition at line 156 of file BaseImageTemplate.h.
double puma2::TBaseImg< T >::mValueRangeMinimum [protected] |
Holds the intended minimum value any sample of this image should have. This is not the current minimal value of all samples, but the value according to the range expected, like an 8-bit gray level image usually has an expected range from 0 (mValueRangeMinimum) to 255 (mValueRangeMaximum), whereas a 4-bit image has a range of 0..15, 12-bit has 0..4095 and so on.
Definition at line 147 of file BaseImageTemplate.h.
The documentation for this class was generated from the following file: