itk::ImageIORegion Class Reference

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

#include <itkImageIORegion.h>

Inheritance diagram for itk::ImageIORegion:

[legend]Collaboration diagram for itk::ImageIORegion:

[legend]List of all members.

Public Types
typedef ImageIORegion	Self
typedef Region	Superclass
typedef std::vector< long >	IndexType
typedef std::vector< long >	SizeType
Public Member Functions
virtual const char *	GetClassName () const
unsigned int	GetImageDimension () const
virtual Superclass::RegionType	GetRegionType () const
virtual	~ImageIORegion ()
	ImageIORegion (const Self &region)
void	operator= (const Self &region)
void	SetIndex (const IndexType &index)
const IndexType &	GetIndex () const
void	SetSize (const SizeType &size)
const SizeType &	GetSize () const
unsigned long	GetNumberOfPixels () const
unsigned int	GetRegionDimension () const
	ImageIORegion (unsigned int dimension)
	ImageIORegion ()
long	GetSize (unsigned long i) const
long	GetIndex (unsigned long i) const
void	SetSize (const unsigned long i, long size)
void	SetIndex (const unsigned long i, long idx)
bool	operator== (const Self &region) const
bool	operator!= (const Self &region) const
bool	IsInside (const IndexType &index) const

---

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.

See also:

Region

ImageRegion

Index

Size

MeshRegion

Definition at line 43 of file itkImageIORegion.h.

---

Member Typedef Documentation

typedef std::vector<long> itk::ImageIORegion::IndexType

Index typedef support. An index is used to access pixel values. Definition at line 72 of file itkImageIORegion.h.

typedef ImageIORegion itk::ImageIORegion::Self

Standard class typedefs. Reimplemented from itk::Region. Definition at line 47 of file itkImageIORegion.h.

typedef std::vector<long> itk::ImageIORegion::SizeType

Size typedef support. A size is used to define region bounds. Definition at line 75 of file itkImageIORegion.h.

typedef Region itk::ImageIORegion::Superclass

Definition at line 48 of file itkImageIORegion.h.

---

Constructor & Destructor Documentation

itk::ImageIORegion::ImageIORegion (  unsigned int  dimension  )  [inline]

Constructor. ImageIORegion is a lightweight object that is not reference counted, so the constructor is public. Definition at line 83 of file itkImageIORegion.h.

itk::ImageIORegion::ImageIORegion (   )  [inline]

Constructor. ImageIORegion is a lightweight object that is not reference counted, so the constructor is public. Default dimension is 2. Definition at line 95 of file itkImageIORegion.h.

virtual itk::ImageIORegion::~ImageIORegion (   )  [inline, virtual]

Destructor. ImageIORegion is a lightweight object that is not reference counted, so the destructor is public. Definition at line 107 of file itkImageIORegion.h.

itk::ImageIORegion::ImageIORegion (  const Self &  region  )  [inline]

Copy constructor. ImageIORegion is a lightweight object that is not reference counted, so the copy constructor is public. Definition at line 111 of file itkImageIORegion.h.

---

Member Function Documentation

virtual const char* itk::ImageIORegion::GetClassName (   )  const [virtual]

Standard part of all itk objects. Reimplemented from itk::Region.

unsigned int itk::ImageIORegion::GetImageDimension (   )  const [inline]

Dimension of the image available at run time. Definition at line 54 of file itkImageIORegion.h.

long itk::ImageIORegion::GetIndex (  unsigned long  i  )  const [inline]

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 149 of file itkImageIORegion.h.

const IndexType& itk::ImageIORegion::GetIndex (  void   )  const [inline]

Get index defining the corner of the region. Definition at line 132 of file itkImageIORegion.h.

unsigned long itk::ImageIORegion::GetNumberOfPixels (   )  const

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

unsigned int itk::ImageIORegion::GetRegionDimension (   )  const [inline]

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 60 of file itkImageIORegion.h.

virtual Superclass::RegionType itk::ImageIORegion::GetRegionType (   )  const [inline, virtual]

Return the region type. Images are described with structured regions. Implements itk::Region. Definition at line 78 of file itkImageIORegion.h.

long itk::ImageIORegion::GetSize (  unsigned long  i  )  const [inline]

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.h.

const SizeType& itk::ImageIORegion::GetSize (   )  const [inline]

Get the size of the region. Definition at line 141 of file itkImageIORegion.h.

bool itk::ImageIORegion::IsInside (  const IndexType &  index  )  const [inline]

Test if an index is inside Definition at line 183 of file itkImageIORegion.h.

bool itk::ImageIORegion::operator!= (  const Self &  region  )  const [inline]

Compare two regions. Definition at line 171 of file itkImageIORegion.h.

void itk::ImageIORegion::operator= (  const Self &  region  )  [inline]

operator=. ImageIORegion is a lightweight object that is not reference counted, so operator= is public. Definition at line 120 of file itkImageIORegion.h.

bool itk::ImageIORegion::operator== (  const Self &  region  )  const [inline]

Compare two regions. Definition at line 159 of file itkImageIORegion.h.

void itk::ImageIORegion::SetIndex (  const unsigned long  i, long  idx )  [inline]

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 153 of file itkImageIORegion.h.

void itk::ImageIORegion::SetIndex (  const IndexType &  index  )  [inline]

Set the index defining the corner of the region. Definition at line 128 of file itkImageIORegion.h.

void itk::ImageIORegion::SetSize (  const unsigned long  i, long  size )  [inline]

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 151 of file itkImageIORegion.h.

void itk::ImageIORegion::SetSize (  const SizeType &  size  )  [inline]

Set the size of the region. This plus the index determines the rectangular shape, or extent, of the region. Definition at line 137 of file itkImageIORegion.h.

---

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

• itkImageIORegion.h

---