itk::Size< VDimension > Class Template Reference
[Image Representation Objects]
Represent the size (bounds) of a n-dimensional image. More...
#include <itkSize.h>
Public Types | |
| typedef Size | Self |
| typedef Size< VDimension > | SizeType |
| typedef unsigned long | SizeValueType |
Public Member Functions | |
| void | Fill (SizeValueType value) |
| SizeValueType | GetElement (unsigned long element) const |
| const SizeValueType * | GetSize () const |
| SizeValueType | operator[] (unsigned int dim) const |
| SizeValueType & | operator[] (unsigned int dim) |
| void | SetElement (unsigned long element, SizeValueType val) |
| void | SetSize (const SizeValueType val[VDimension]) |
Static Public Member Functions | |
| static unsigned int | GetSizeDimension (void) |
|
| |
| SizeValueType | m_Size [VDimension] |
| bool | operator!= (const Self &vec) const |
| const Self | operator* (const Self &vec) const |
| const Self & | operator*= (const Self &vec) |
| const Self | operator+ (const Self &vec) const |
| const Self & | operator+= (const Self &vec) |
| const Self | operator- (const Self &vec) const |
| const Self & | operator-= (const Self &vec) |
| bool | operator== (const Self &vec) const |
Detailed Description
template<unsigned int VDimension = 2>
class itk::Size< VDimension >
Represent the size (bounds) of a n-dimensional image.
Size is a class to represent multi-dimensional array bounds, templated over the dimension. Insight assumes that the first element of Size is the fastest moving index.
For the sake of efficiency, Size does not define a default constructor, a copy constructor, or an operator=. We rely on the compiler to provide efficient bitwise copies.
Size is an "aggregate" class. Its data is public (m_Size) allowing for fast and convenient instantiations/assignments.
The following syntax for assigning a size is allowed/suggested: Size<3> size = {256, 256, 20};
- See also:
- Index
Definition at line 46 of file itkSize.h.
Member Typedef Documentation
| typedef unsigned long itk::Size< VDimension >::SizeValueType |
Member Function Documentation
| void itk::Size< VDimension >::Fill | ( | SizeValueType | value | ) | [inline] |
Set one value for the index in all dimensions. Useful for initializing an offset to zero.
Definition at line 184 of file itkSize.h.
Referenced by itk::ImageIORegionAdaptor< VDimension >::Convert(), and itk::ImageRegion< TDimension >::ImageRegion().
| SizeValueType itk::Size< VDimension >::GetElement | ( | unsigned long | element | ) | const [inline] |
Get an element of the Size. gets the value of one of the elements in the size This method is mainly intended to facilitate the access to elements from Tcl and Python where C++ notation is not very convenient.
- Warning:
- No bound checking is performed
- See also:
- GetSize()
- SetElement()
| const SizeValueType* itk::Size< VDimension >::GetSize | ( | void | ) | const [inline] |
| static unsigned int itk::Size< VDimension >::GetSizeDimension | ( | void | ) | [inline, static] |
| SizeValueType itk::Size< VDimension >::operator[] | ( | unsigned int | dim | ) | const [inline] |
| SizeValueType& itk::Size< VDimension >::operator[] | ( | unsigned int | dim | ) | [inline] |
| void itk::Size< VDimension >::SetElement | ( | unsigned long | element, | |
| SizeValueType | val | |||
| ) | [inline] |
Set an element of the Size. sets the value of one of the elements in the Size This method is mainly intended to facilitate the access to elements from Tcl and Python where C++ notation is not very convenient.
- Warning:
- No bound checking is performed.
- See also:
- SetSize()
- GetElement()
| void itk::Size< VDimension >::SetSize | ( | const SizeValueType | val[VDimension] | ) | [inline] |
Set the size. Try to prototype this function so that val has to point to a block of memory that is the appropriate size.
- See also:
- GetSize
Definition at line 161 of file itkSize.h.
Referenced by itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::LabelStatistics::LabelStatistics().
Member Data Documentation
| SizeValueType itk::Size< VDimension >::m_Size[VDimension] |
Size is an "aggregate" class. Its data is public (m_Size) allowing for fast and convenient instantiations/assignments.
The following syntax for assigning a size is allowed/suggested:
Size<3> size = {{256, 256, 20}};
The doubled braces {{ and }} are required to prevent `gcc -Wall' (and perhaps other compilers) from complaining about a partly bracketed initializer.
Definition at line 197 of file itkSize.h.
Referenced by itk::Size< itkGetStaticConstMacro(ImageDimension) >::Fill(), itk::Size< itkGetStaticConstMacro(ImageDimension) >::GetElement(), itk::Size< itkGetStaticConstMacro(ImageDimension) >::GetSize(), itk::Size< itkGetStaticConstMacro(ImageDimension) >::operator!=(), itk::Size< itkGetStaticConstMacro(ImageDimension) >::operator*(), itk::Index< itkGetStaticConstMacro(Dimension)>::operator*(), itk::Size< itkGetStaticConstMacro(ImageDimension) >::operator*=(), itk::Size< itkGetStaticConstMacro(ImageDimension) >::operator+(), itk::Size< itkGetStaticConstMacro(ImageDimension) >::operator+=(), itk::Size< itkGetStaticConstMacro(ImageDimension) >::operator-(), itk::Size< itkGetStaticConstMacro(ImageDimension) >::operator-=(), itk::Size< itkGetStaticConstMacro(ImageDimension) >::operator==(), itk::Size< itkGetStaticConstMacro(ImageDimension) >::operator[](), itk::Size< itkGetStaticConstMacro(ImageDimension) >::SetElement(), itk::Neighborhood< PixelType, itkGetStaticConstMacro(ImageDimension)>::SetRadius(), and itk::Size< itkGetStaticConstMacro(ImageDimension) >::SetSize().
The documentation for this class was generated from the following file:
