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:

List of all members.

Public Types

typedef std::vector
< IndexValueType > IndexType

typedef ptrdiff_t IndexValueType

Public Member Functions

unsigned int GetImageDimension () const

const IndexType & GetIndex () const

virtual const char * GetNameOfClass () const

SizeValueType GetNumberOfPixels (void) const

unsigned int GetRegionDimension () const

virtual RegionType GetRegionType () const

const SizeType & GetSize () const

ImageIORegion (const Self &region)

ImageIORegion ()

ImageIORegion (unsigned int dimension)

bool IsInside (const Self &region) const

bool IsInside (const IndexType &index) 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 SetSize (const SizeType &size)

virtual ~ImageIORegion ()

IndexValueType GetIndex (unsigned long i) const

SizeValueType GetSize (unsigned long i) const

void SetIndex (const unsigned long i, IndexValueType idx)

void SetSize (const unsigned long i, SizeValueType size)

Protected Member Functions

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

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

virtual void PrintTrailer (std::ostream &os, Indent indent) 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.

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:

Definition at line 53 of file itkImageIORegion.h.

Member Typedef Documentation

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

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

Definition at line 67 of file itkImageIORegion.h.

typedef ptrdiff_t itk::ImageIORegion::IndexValueType

Definition at line 62 of file itkImageIORegion.h.

typedef ptrdiff_t itk::ImageIORegion::OffsetValueType

Definition at line 63 of file itkImageIORegion.h.

typedef Superclass::RegionType itk::ImageIORegion::RegionType

Region type taken from the superclass

Reimplemented from itk::Region.

Definition at line 73 of file itkImageIORegion.h.

typedef ImageIORegion itk::ImageIORegion::Self

Standard class typedefs.

Reimplemented from itk::Region.

Definition at line 57 of file itkImageIORegion.h.

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

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

Definition at line 70 of file itkImageIORegion.h.

typedef vcl_size_t itk::ImageIORegion::SizeValueType

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

Definition at line 61 of file itkImageIORegion.h.

typedef Region itk::ImageIORegion::Superclass

Definition at line 58 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.

itk::ImageIORegion::ImageIORegion ( )

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

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

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

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

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

Member Function Documentation

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

Dimension of the image available at run time.

Referenced by itk::ImageIORegionAdaptor< VDimension >::Convert().

IndexValueType itk::ImageIORegion::GetIndex ( 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.

const IndexType& itk::ImageIORegion::GetIndex ( ) const

Get index defining the corner of the region.

Referenced by itk::ImageIORegionAdaptor< VDimension >::Convert().

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

Standard part of all itk objects.

Reimplemented from itk::Region.

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

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

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.

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

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

Implements itk::Region.

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.

const SizeType& itk::ImageIORegion::GetSize ( ) const

Get the size of the region.

Referenced by itk::ImageIORegionAdaptor< VDimension >::Convert().

bool itk::ImageIORegion::IsInside ( const Self & region ) const

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

bool itk::ImageIORegion::IsInside ( const IndexType & index ) const

Test if an index is inside

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

Compare two regions.

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

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

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

Compare two regions.

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

Print the region.

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

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

Reimplemented from itk::Region.

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

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.

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

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.

void itk::ImageIORegion::SetIndex ( const IndexType & index )

Set the index defining the corner of the region.

Referenced by itk::ImageIORegionAdaptor< VDimension >::Convert().

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

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.

void itk::ImageIORegion::SetSize ( const SizeType & size )

Set the size of the region. This plus the index determines the rectangular shape, or extent, of the region.

Referenced by itk::ImageIORegionAdaptor< VDimension >::Convert().

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

itkImageIORegion.h


Public Types
typedef std::vector < IndexValueType >	IndexType
typedef ptrdiff_t	IndexValueType
Public Member Functions
unsigned int	GetImageDimension () const
const IndexType &	GetIndex () const
virtual const char *	GetNameOfClass () const
SizeValueType	GetNumberOfPixels (void) const
unsigned int	GetRegionDimension () const
virtual RegionType	GetRegionType () const
const SizeType &	GetSize () const
	ImageIORegion (const Self &region)
	ImageIORegion ()
	ImageIORegion (unsigned int dimension)
bool	IsInside (const Self &region) const
bool	IsInside (const IndexType &index) 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	SetSize (const SizeType &size)
virtual	~ImageIORegion ()

IndexValueType	GetIndex (unsigned long i) const
SizeValueType	GetSize (unsigned long i) const
void	SetIndex (const unsigned long i, IndexValueType idx)
void	SetSize (const unsigned long i, SizeValueType size)
Protected Member Functions
virtual void	PrintSelf (std::ostream &os, Indent indent) const

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