Orfeo Toolbox  4.2
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::ImageIORegion Class Reference

An ImageIORegion represents a structured region of data. More...

#include <itkImageIORegion.h>

+ Inheritance diagram for itk::ImageIORegion:
+ Collaboration diagram for itk::ImageIORegion:

Public Types

typedef std::vector
< IndexValueType
IndexType
 
typedef ::itk::IndexValueType IndexValueType
 
typedef ::itk::OffsetValueType OffsetValueType
 
typedef Superclass::RegionType RegionType
 
typedef ImageIORegion Self
 
typedef std::vector
< SizeValueType
SizeType
 
typedef ::itk::SizeValueType SizeValueType
 
typedef Region Superclass
 

Public Member Functions

 ImageIORegion (unsigned int dimension)
 
 ImageIORegion ()
 
 ImageIORegion (const Self &region)
 
virtual ~ImageIORegion ()
 
unsigned int GetImageDimension () const
 
const IndexTypeGetIndex () const
 
IndexValueType GetIndex (unsigned long i) const
 
IndexTypeGetModifiableIndex ()
 
SizeTypeGetModifiableSize ()
 
virtual const char * GetNameOfClass () const
 
SizeValueType GetNumberOfPixels (void) const
 
unsigned int GetRegionDimension () const
 
virtual RegionType GetRegionType () const ITK_OVERRIDE
 
const SizeTypeGetSize () const
 
SizeValueType GetSize (unsigned long i) const
 
bool IsInside (const IndexType &index) const
 
bool IsInside (const Self &region) const
 
bool operator!= (const Self &region) const
 
void operator= (const Self &region)
 
bool operator== (const Self &region) const
 
virtual void Print (std::ostream &os, Indent indent=0) const
 
void SetIndex (const IndexType &index)
 
void SetIndex (const unsigned long i, IndexValueType idx)
 
void SetSize (const SizeType &size)
 
void SetSize (const unsigned long i, SizeValueType size)
 

Protected Member Functions

virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const ITK_OVERRIDE
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 

Private Attributes

unsigned int m_ImageDimension
 
IndexType m_Index
 
SizeType m_Size
 

Detailed Description

An ImageIORegion represents a structured region of data.

ImageIORegion is an class that represents some structured portion or piece of an Image. The ImageIORegion is represented with an index and a size in each of the n-dimensions of the image. (The index is the corner of the image, the size is the lengths of the image in each of the topological directions.) ImageIORegion is not templated over dimension, but uses dynamic arrays instead.

The first pixel of an image always have a Zero index. Therefore the index values of ImageIORegion may not directly correspond to those of ImageRegion. When translation between the two is performed one much consider the largest possible region who has a non-zero starting index for the image.

See Also
Region
ImageRegion
Index
Size
MeshRegion

Definition at line 52 of file itkImageIORegion.h.

Member Typedef Documentation

Index typedef support. An index is used to access pixel values.

Definition at line 66 of file itkImageIORegion.h.

Definition at line 62 of file itkImageIORegion.h.

Definition at line 63 of file itkImageIORegion.h.

Region type taken from the superclass

Definition at line 72 of file itkImageIORegion.h.

Standard class typedefs.

Definition at line 56 of file itkImageIORegion.h.

Size typedef support. A size is used to define region bounds.

Definition at line 69 of file itkImageIORegion.h.

these types correspond to those of itk::Size, itk::Offset and itk::Index

Definition at line 61 of file itkImageIORegion.h.

Definition at line 57 of file itkImageIORegion.h.

Constructor & Destructor Documentation

itk::ImageIORegion::ImageIORegion ( unsigned int  dimension)

Constructor. ImageIORegion is a lightweight object that is not reference counted, so the constructor is public.

Definition at line 38 of file itkImageIORegion.cxx.

itk::ImageIORegion::ImageIORegion ( )

Constructor. ImageIORegion is a lightweight object that is not reference counted, so the constructor is public. Default dimension is 2.

Definition at line 24 of file itkImageIORegion.cxx.

itk::ImageIORegion::~ImageIORegion ( )
virtual

Destructor. ImageIORegion is a lightweight object that is not reference counted, so the destructor is public.

Definition at line 34 of file itkImageIORegion.cxx.

itk::ImageIORegion::ImageIORegion ( const Self region)

Copy constructor. ImageIORegion is a lightweight object that is not reference counted, so the copy constructor is public.

Definition at line 48 of file itkImageIORegion.cxx.

References m_ImageDimension, m_Index, and m_Size.

Member Function Documentation

unsigned int itk::ImageIORegion::GetImageDimension ( ) const
const ImageIORegion::IndexType & itk::ImageIORegion::GetIndex ( void  ) const
ImageIORegion::IndexValueType itk::ImageIORegion::GetIndex ( unsigned long  i) const

Definition at line 158 of file itkImageIORegion.cxx.

ImageIORegion::IndexType & itk::ImageIORegion::GetModifiableIndex ( )

Definition at line 88 of file itkImageIORegion.cxx.

Referenced by itk::ImageRegionSplitterBase::GetSplit().

ImageIORegion::SizeType & itk::ImageIORegion::GetModifiableSize ( )

Definition at line 113 of file itkImageIORegion.cxx.

Referenced by itk::ImageRegionSplitterBase::GetSplit().

virtual const char* itk::ImageIORegion::GetNameOfClass ( ) const
virtual

Standard part of all itk objects.

Reimplemented from itk::Region.

ImageIORegion::SizeValueType itk::ImageIORegion::GetNumberOfPixels ( void  ) const

Get the number of pixels contained in this region. This just multiplies the size components.

Definition at line 239 of file itkImageIORegion.cxx.

unsigned int itk::ImageIORegion::GetRegionDimension ( ) const

Dimension of the region to be written. This differs from the the image dimension and is calculated at run-time by examining the size of the image in each coordinate direction.

Definition at line 134 of file itkImageIORegion.cxx.

ImageIORegion::RegionType itk::ImageIORegion::GetRegionType ( ) const
virtual

Return the region type. Images are described with structured regions.

Implements itk::Region.

Definition at line 127 of file itkImageIORegion.cxx.

const ImageIORegion::SizeType & itk::ImageIORegion::GetSize ( void  ) const
ImageIORegion::SizeValueType itk::ImageIORegion::GetSize ( unsigned long  i) const

Convenience methods to get the size of the image in a particular coordinate direction i. Do not try to access image sizes beyond the the ImageDimension.

Definition at line 147 of file itkImageIORegion.cxx.

bool itk::ImageIORegion::IsInside ( const IndexType index) const
bool itk::ImageIORegion::IsInside ( const Self region) const

Test if a region (the argument) is completly inside of this region

Definition at line 214 of file itkImageIORegion.cxx.

References GetIndex(), GetSize(), and m_ImageDimension.

bool itk::ImageIORegion::operator!= ( const Self region) const

Compare two regions.

Definition at line 266 of file itkImageIORegion.cxx.

References m_ImageDimension, m_Index, and m_Size.

void itk::ImageIORegion::operator= ( const Self region)

operator=. ImageIORegion is a lightweight object that is not reference counted, so operator= is public.

Definition at line 57 of file itkImageIORegion.cxx.

References m_ImageDimension, m_Index, and m_Size.

bool itk::ImageIORegion::operator== ( const Self region) const

Compare two regions.

Definition at line 253 of file itkImageIORegion.cxx.

References m_ImageDimension, m_Index, and m_Size.

void itk::Region::Print ( std::ostream &  os,
Indent  indent = 0 
) const
virtualinherited
void itk::Region::PrintHeader ( std::ostream &  os,
Indent  indent 
) const
protectedvirtualinherited

Definition at line 43 of file itkRegion.cxx.

void itk::ImageIORegion::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::Region.

Definition at line 278 of file itkImageIORegion.cxx.

void itk::Region::PrintTrailer ( std::ostream &  os,
Indent  indent 
) const
protectedvirtualinherited

Definition at line 50 of file itkRegion.cxx.

void itk::ImageIORegion::SetIndex ( const IndexType index)
void itk::ImageIORegion::SetIndex ( const unsigned long  i,
IndexValueType  idx 
)

Definition at line 180 of file itkImageIORegion.cxx.

void itk::ImageIORegion::SetSize ( const SizeType size)
void itk::ImageIORegion::SetSize ( const unsigned long  i,
SizeValueType  size 
)

Definition at line 169 of file itkImageIORegion.cxx.

Member Data Documentation

unsigned int itk::ImageIORegion::m_ImageDimension
private

Definition at line 158 of file itkImageIORegion.h.

Referenced by ImageIORegion(), IsInside(), operator!=(), operator=(), and operator==().

IndexType itk::ImageIORegion::m_Index
private

Definition at line 159 of file itkImageIORegion.h.

Referenced by ImageIORegion(), operator!=(), operator=(), and operator==().

SizeType itk::ImageIORegion::m_Size
private

Definition at line 160 of file itkImageIORegion.h.

Referenced by ImageIORegion(), operator!=(), operator=(), and operator==().


The documentation for this class was generated from the following files:

Generated at Sat Aug 30 2014 17:21:25 for Orfeo Toolbox with doxygen 1.8.3.1