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:

Examples:: SphinxExamples/src/Core/Common/CreateAImageRegion/Code.cxx, SphinxExamples/src/Core/Common/IsPixelInsideRegion/Code.cxx, SphinxExamples/src/ImageCompareCommand.cxx, WikiExamples/Curves/ContourMeanDistanceImageFilter.cxx, WikiExamples/EdgesAndGradients/SobelEdgeDetectionImageFilter.cxx, WikiExamples/Functions/MedianImageFunction.cxx, WikiExamples/ImageProcessing/ApproximateSignedDistanceMapImageFilter.cxx, WikiExamples/ImageProcessing/ImageFilterOnARegion.cxx, WikiExamples/ImageProcessing/MultiplyByConstantImageFilter.cxx, WikiExamples/ImageProcessing/ObjectByObjectLabelMapFilter.cxx, WikiExamples/ImageProcessing/RGBToLuminanceImageFilter.cxx, WikiExamples/ImageProcessing/SignedDanielssonDistanceMapImageFilter.cxx, WikiExamples/ImageProcessing/SignedMaurerDistanceMapImageFilter.cxx, WikiExamples/ImageProcessing/ZeroCrossingImageFilter.cxx, WikiExamples/Images/ConvertPixelBuffer.cxx, WikiExamples/Images/ImageRegion.cxx, WikiExamples/Images/MaskNeighborhoodOperatorImageFilter.cxx, WikiExamples/Images/MirrorPadImageFilter.cxx, WikiExamples/Morphology/BinaryMorphologicalClosingImageFilter.cxx, WikiExamples/Morphology/BinaryMorphologicalOpeningImageFilter.cxx, WikiExamples/Segmentation/ContourExtractor2DImageFilter.cxx, WikiExamples/Segmentation/SimpleContourExtractorImageFilter.cxx, WikiExamples/Segmentation/WatershedImageFilter.cxx, WikiExamples/SimpleOperations/ParaviewColormap.cxx, WikiExamples/SimpleOperations/PixelInsideRegion.cxx, WikiExamples/SimpleOperations/RequestedRegion.cxx, WikiExamples/SimpleOperations/ScalarToRGBColormapImageFilter.cxx, WikiExamples/SpectralAnalysis/ForwardFFTImageFilter.cxx, WikiExamples/SpectralAnalysis/InverseFFTImageFilter.cxx, WikiExamples/SpectralAnalysis/VnlFFTRealToComplexConjugateImageFilter.cxx, WikiExamples/Statistics/HistogramToImageFilterGrayscale.cxx, WikiExamples/Statistics/HistogramToImageFilterRGB.cxx, WikiExamples/Statistics/HistogramToImageFilterVectorImage.cxx, WikiExamples/VectorImages/VectorNeighborhoodIterator.cxx, and WikiExamples/VectorImages/VectorResampleImageFilter.cxx.

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

virtual const char *	GetNameOfClass () const

virtual Superclass::RegionType	GetRegionType () const override

IndexType	GetUpperIndex () const

	ImageRegion ()

	ImageRegion (const Self &region)

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

	ImageRegion (const SizeType &size)

void	operator= (const Self &region)

void	SetIndex (const IndexType &index)

void	SetSize (const SizeType &size)

void	SetUpperIndex (const IndexType &idx)

virtual	~ImageRegion ()


const IndexType &	GetIndex () const

IndexType &	GetModifiableIndex ()


const SizeType &	GetSize () const

SizeType &	GetModifiableSize ()


void	SetSize (unsigned int i, SizeValueType sze)

SizeValueType	GetSize (unsigned int i) const


void	SetIndex (unsigned int i, IndexValueType sze)

IndexValueType	GetIndex (unsigned int i) const


bool	operator== (const Self &region) const


bool	operator!= (const Self &region) const


bool	IsInside (const IndexType &index) const

Public Member Functions inherited from itk::Region
	itkTypeMacroNoParent (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 int dim) const

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

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