#include <itkImageIORegion.h>

Inheritance diagram for itk::ImageIORegion:

Collaboration diagram for itk::ImageIORegion:

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

Examples:: Examples/IO/VisibleHumanPasteWrite.cxx.

Definition at line 52 of file itkImageIORegion.h.

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 Types inherited from itk::Region
enum	RegionType { ITK_UNSTRUCTURED_REGION, ITK_STRUCTURED_REGION }

typedef Region	Self

Public Member Functions
unsigned int	GetImageDimension () const

IndexValueType	GetIndex (unsigned long i) const

virtual const char *	GetNameOfClass () const

SizeValueType	GetNumberOfPixels () const

unsigned int	GetRegionDimension () const

virtual RegionType	GetRegionType () const override

SizeValueType	GetSize (unsigned long i) const

	ImageIORegion (unsigned int dimension)

	ImageIORegion ()

	ImageIORegion (const Self &region)

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

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)

virtual	~ImageIORegion () override


const IndexType &	GetIndex () const

IndexType &	GetModifiableIndex ()


const SizeType &	GetSize () const

SizeType &	GetModifiableSize ()

Public Member Functions inherited from itk::Region
	itkTypeMacroNoParent (Region)

virtual void	Print (std::ostream &os, Indent indent=0) const

	Region ()

virtual	~Region ()

Protected Member Functions
virtual void	PrintSelf (std::ostream &os, Indent indent) const override

Protected Member Functions inherited from itk::Region
virtual void	PrintHeader (std::ostream &os, Indent indent) const

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

Private Attributes
unsigned int	m_ImageDimension

IndexType	m_Index

SizeType	m_Size

Member Typedef Documentation

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

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

Definition at line 66 of file itkImageIORegion.h.

typedef ::itk::IndexValueType itk::ImageIORegion::IndexValueType

Definition at line 62 of file itkImageIORegion.h.

typedef ::itk::OffsetValueType itk::ImageIORegion::OffsetValueType

Definition at line 63 of file itkImageIORegion.h.

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

Region type taken from the superclass

Definition at line 72 of file itkImageIORegion.h.

typedef ImageIORegion itk::ImageIORegion::Self

Standard class typedefs.

Definition at line 56 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 69 of file itkImageIORegion.h.

typedef ::itk::SizeValueType 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 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.

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 ( )

overridevirtual

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(), itk::ImageRegionSplitterBase::GetNumberOfSplits(), and itk::ImageRegionSplitterBase::GetSplit().

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

Get index defining the corner of the region.

Referenced by itk::ImageIORegionAdaptor< VDimension >::Convert(), and itk::ImageRegionSplitterBase::GetNumberOfSplits().

IndexValueType itk::ImageIORegion::GetIndex ( unsigned long i ) const

IndexType& itk::ImageIORegion::GetModifiableIndex ( )

Get index defining the corner of the region.

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

SizeType& itk::ImageIORegion::GetModifiableSize ( )

Get the size of the region.

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

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

virtual

Standard part of all itk objects.

SizeValueType 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

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

overridevirtual

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

Implements itk::Region.

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

Get the size of the region.

Referenced by itk::ImageIORegionAdaptor< VDimension >::Convert(), and itk::ImageRegionSplitterBase::GetNumberOfSplits().

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.

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

Test if an index is inside

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

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

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::ImageIORegion::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

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.

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

Set the index defining the corner of the region.