Detailed Description

template<unsigned int VImageDimension>
class itk::ImageRegion< VImageDimension >

An image region represents a structured region of data.

ImageRegion is an class that represents some structured portion or piece of an Image. The ImageRegion 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.)

See Also: Region; Index; Size; MeshRegion

Wiki Examples:

All Examples

An object which holds the index (start) and size of a region of an image

Determine if one region is fully inside another region

Determine if a pixel is inside of a region

Determine the overlap of two regions

Definition at line 69 of file itkImageRegion.h.

Public Types
typedef Index < itkGetStaticConstMacro(ImageDimension) >	IndexType

typedef IndexValueType	IndexValueArrayType [ImageDimension]

typedef IndexType::IndexValueType	IndexValueType

typedef OffsetValueType	OffsetTableType [ImageDimension+1]

typedef IndexType::OffsetType	OffsetType

typedef OffsetType::OffsetValueType	OffsetValueType

typedef ImageRegion	Self

typedef Size < itkGetStaticConstMacro(ImageDimension) >	SizeType

typedef SizeType::SizeValueType	SizeValueType

typedef ImageRegion < itkGetStaticConstMacro(SliceDimension) >	SliceRegion

typedef Region	Superclass

Public Types inherited from itk::Region
enum	RegionType { ITK_UNSTRUCTURED_REGION, ITK_STRUCTURED_REGION }

typedef Region	Self

Public Member Functions
void	ComputeOffsetTable (OffsetTableType offsetTable) const

const IndexType &	GetIndex () const

virtual const char *	GetNameOfClass () const

virtual Superclass::RegionType	GetRegionType () const

const SizeType &	GetSize () const

IndexType	GetUpperIndex () const

	ImageRegion ()

	ImageRegion (const Self &region)

	ImageRegion (const IndexType &index, const SizeType &size)

	ImageRegion (const SizeType &size)

bool	operator!= (const Self &region) const

void	operator= (const Self &region)

bool	operator== (const Self &region) const

void	SetIndex (const IndexType &index)

void	SetSize (const SizeType &size)

void	SetUpperIndex (const IndexType &idx)

virtual	~ImageRegion ()


void	SetSize (unsigned long i, SizeValueType sze)

SizeValueType	GetSize (unsigned long i) const


void	SetIndex (unsigned long i, IndexValueType sze)

IndexValueType	GetIndex (unsigned long i) const


bool	IsInside (const IndexType &index) const

Public Member Functions inherited from itk::Region
virtual void	Print (std::ostream &os, Indent indent=0) const

	Region ()

virtual	~Region ()

Static Public Member Functions
static unsigned int	GetImageDimension ()

Static Public Attributes
static const unsigned int	ImageDimension = VImageDimension

static const unsigned int	SliceDimension = ( ImageDimension - ( ImageDimension > 1 ) )

IndexType	m_Index

SizeType	m_Size

class	ImageBase< VImageDimension >

template<typename TCoordRepType >
bool	IsInside (const ContinuousIndex< TCoordRepType, VImageDimension > &index) const

bool	IsInside (const Self &region) const

SizeValueType	GetNumberOfPixels () const

void	PadByRadius (OffsetValueType radius)

void	PadByRadius (const IndexValueArrayType radius)

void	PadByRadius (const SizeType &radius)

bool	ShrinkByRadius (OffsetValueType radius)

bool	ShrinkByRadius (const IndexValueArrayType radius)

bool	ShrinkByRadius (const SizeType &radius)

bool	Crop (const Self &region)

SliceRegion	Slice (const unsigned long dim) const

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

Additional Inherited Members
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