itk::ImageIORegion Class Reference

#include <itkImageIORegion.h>

Inheritance diagram for itk::ImageIORegion:

[legend]Collaboration diagram for itk::ImageIORegion:

[legend]List of all members.

---

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

Public Types
typedef std::vector< long >	IndexType
enum	RegionType {   ITK_UNSTRUCTURED_REGION,   ITK_STRUCTURED_REGION }
typedef ImageIORegion	Self
typedef std::vector< long >	SizeType
typedef Region	Superclass
Public Member Functions
unsigned int	GetImageDimension () const
long	GetIndex (unsigned long i) const
const IndexType &	GetIndex () const
virtual const char *	GetNameOfClass () const
unsigned long	GetNumberOfPixels () 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 *unsigned int	GetRegionDimension () const
virtual Superclass::RegionType	GetRegionType () 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 *long	GetSize (unsigned long i) const
const SizeType &	GetSize () const
	ImageIORegion (const Self &region)
Constructor ImageIORegion is a lightweight object that is not reference so the constructor is public Default dimension is *	ImageIORegion ()
Constructor ImageIORegion is a lightweight object that is not reference so the constructor is public *	ImageIORegion (unsigned int dimension)
Test if an index is inside *bool	IsInside (const IndexType &index) const
Compare two regions *bool	operator!= (const Self &region) const
void	operator= (const Self &region)
Compare two regions *bool	operator== (const Self &region) const
virtual void	Print (std::ostream &os, Indent indent=0) const
void	SetIndex (const unsigned long i, long idx)
void	SetIndex (const IndexType &index)
void	SetSize (const unsigned long i, long size)
void	SetSize (const SizeType &size)
virtual	~ImageIORegion ()
Public Attributes
Constructor ImageIORegion is a lightweight object that is not reference *	counted
Constructor ImageIORegion is a lightweight object that is not reference *	counted
Protected Member Functions
virtual void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
Methods invoked by virtual 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.*/virtual void PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const

---

Member Typedef Documentation

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

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

typedef ImageIORegion itk::ImageIORegion::Self

Standard class typedefs. Reimplemented from itk::Region. Definition at line 48 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 76 of file itkImageIORegion.h.

typedef Region itk::ImageIORegion::Superclass

Definition at line 49 of file itkImageIORegion.h.

---

Member Enumeration Documentation

enum itk::Region::RegionType [inherited]

Enums used to describe the extent types. Enumeration values: ITK_UNSTRUCTURED_REGION  ITK_STRUCTURED_REGION  Definition at line 63 of file itkRegion.h.

---

Constructor & Destructor Documentation

Constructor ImageIORegion is a lightweight object that is not reference so the constructor is public* itk::ImageIORegion::ImageIORegion (  unsigned int  dimension  )  [inline]

Definition at line 84 of file itkImageIORegion.h. References itk::Functor::m_Index, and itk::m_Size.

Constructor ImageIORegion is a lightweight object that is not reference so the constructor is public Default dimension is* itk::ImageIORegion::ImageIORegion (   )  [inline]

Definition at line 96 of file itkImageIORegion.h. References itk::Functor::m_Index, and itk::m_Size.

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 108 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 112 of file itkImageIORegion.h. References m_ImageDimension, m_Index, itk::Functor::m_Index, m_Size, and itk::m_Size.

---

Member Function Documentation

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

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

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

Definition at line 150 of file itkImageIORegion.h. References itk::Functor::m_Index.

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

Get index defining the corner of the region. Definition at line 133 of file itkImageIORegion.h. References itk::Functor::m_Index.

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

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

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

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

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* unsigned int itk::ImageIORegion::GetRegionDimension (   )  const [inline]

Definition at line 61 of file itkImageIORegion.h. References itk::m_Size.

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

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* long itk::ImageIORegion::GetSize (  unsigned long  i  )  const [inline]

Definition at line 148 of file itkImageIORegion.h. References itk::m_Size.

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

Get the size of the region. Definition at line 142 of file itkImageIORegion.h. References itk::m_Size.

Test if an index is inside* bool itk::ImageIORegion::IsInside (  const IndexType &  index  )  const [inline]

Definition at line 184 of file itkImageIORegion.h. References itk::Functor::m_Index, and itk::m_Size.

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

Definition at line 172 of file itkImageIORegion.h. References m_ImageDimension, m_Index, itk::Functor::m_Index, m_Size, and itk::m_Size.

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 121 of file itkImageIORegion.h. References m_ImageDimension, m_Index, itk::Functor::m_Index, m_Size, and itk::m_Size.

Compare two regions* bool itk::ImageIORegion::operator== (  const Self &  region  )  const [inline]

Definition at line 160 of file itkImageIORegion.h. References m_ImageDimension, m_Index, itk::Functor::m_Index, m_Size, and itk::m_Size.

virtual void itk::Region::Print (  std::ostream &  os, Indent  indent = 0 )  const [virtual, inherited]

Print the region.

virtual void itk::ImageIORegion::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

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.

virtual void itk::Region::PrintTrailer (  std::ostream &  os, Indent  indent )  const [protected, virtual, inherited]

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

Definition at line 154 of file itkImageIORegion.h. References itk::Functor::m_Index.

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

Set the index defining the corner of the region. Definition at line 129 of file itkImageIORegion.h. References itk::Functor::m_Index.

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

Definition at line 152 of file itkImageIORegion.h. References itk::m_Size.

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 138 of file itkImageIORegion.h. References itk::m_Size.

---

Member Data Documentation

Constructor ImageIORegion is a lightweight object that is not reference* itk::ImageIORegion::counted

Definition at line 95 of file itkImageIORegion.h.

Constructor ImageIORegion is a lightweight object that is not reference* itk::ImageIORegion::counted

Definition at line 83 of file itkImageIORegion.h.

Methods invoked by virtual 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. */ virtual void PrintSelf(std voi itk::Region::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

---

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

• itkImageIORegion.h

---