itk::ImageRegion< VImageDimension > Class Template Reference

#include <itkImageRegion.h>

Inheritance diagram for itk::ImageRegion< VImageDimension >:

Collaboration diagram for itk::ImageRegion< VImageDimension >:

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

Examples:

SphinxExamples/src/Core/Common/CreateAnImageRegion/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/DanielssonDistanceMapImageFilter.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/ImageToHistogramFilterGrayscale.cxx, WikiExamples/Statistics/ImageToHistogramFilterRGB.cxx, WikiExamples/Statistics/ImageToHistogramFilterVectorImage.cxx, WikiExamples/VectorImages/VectorNeighborhoodIterator.cxx, and WikiExamples/VectorImages/VectorResampleImageFilter.cxx.

Definition at line 69 of file itkImageRegion.h.

Public Types
using	IndexType = Index< Self::ImageDimension >
typedef IndexValueType	IndexValueArrayType [ImageDimension]
using	IndexValueType = typename IndexType::IndexValueType
typedef OffsetValueType	OffsetTableType [ImageDimension+1]
using	OffsetType = typename IndexType::OffsetType
using	OffsetValueType = typename OffsetType::OffsetValueType
using	Self = ImageRegion
using	SizeType = Size< Self::ImageDimension >
using	SizeValueType = typename SizeType::SizeValueType
using	SliceRegion = ImageRegion< Self::SliceDimension >
using	Superclass = Region
Public Types inherited from itk::Region
enum	RegionType {   ITK_UNSTRUCTURED_REGION,   ITK_STRUCTURED_REGION }
using	Self = Region

Public Member Functions
void	ComputeOffsetTable (OffsetTableType offsetTable) const
virtual const char *	GetNameOfClass () const
Superclass::RegionType	GetRegionType () const override
IndexType	GetUpperIndex () const
	ImageRegion () noexcept=default
	ImageRegion (const Self &) noexcept=default
	ImageRegion (const IndexType &index, const SizeType &size) noexcept
	ImageRegion (const SizeType &size) noexcept
bool	operator!= (const Self &region) const noexcept
Self &	operator= (const Self &) noexcept=default
bool	operator== (const Self &region) const noexcept
void	SetIndex (const IndexType &index)
void	SetSize (const SizeType &size)
void	SetUpperIndex (const IndexType &idx)
	~ImageRegion () override=default
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	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 ()=default
virtual	~Region ()=default

Static Public Member Functions
static unsigned int	GetImageDimension ()

Static Public Attributes
static constexpr unsigned int	ImageDimension = VImageDimension
static constexpr unsigned int	SliceDimension = ImageDimension - ( ImageDimension > 1 )
IndexType	m_Index = {{0}}
SizeType	m_Size = {{0}}
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
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

Member Typedef Documentation

template<unsigned int VImageDimension>

using itk::ImageRegion< VImageDimension >::IndexType = Index< Self::ImageDimension >

Index type alias support An index is used to access pixel values.

Definition at line 91 of file itkImageRegion.h.

template<unsigned int VImageDimension>

typedef IndexValueType itk::ImageRegion< VImageDimension >::IndexValueArrayType[ImageDimension]

Definition at line 95 of file itkImageRegion.h.

template<unsigned int VImageDimension>

using itk::ImageRegion< VImageDimension >::IndexValueType = typename IndexType::IndexValueType

Definition at line 92 of file itkImageRegion.h.

template<unsigned int VImageDimension>

typedef OffsetValueType itk::ImageRegion< VImageDimension >::OffsetTableType[ImageDimension+1]

Definition at line 96 of file itkImageRegion.h.

template<unsigned int VImageDimension>

using itk::ImageRegion< VImageDimension >::OffsetType = typename IndexType::OffsetType

Definition at line 93 of file itkImageRegion.h.

template<unsigned int VImageDimension>

using itk::ImageRegion< VImageDimension >::OffsetValueType = typename OffsetType::OffsetValueType

Definition at line 94 of file itkImageRegion.h.

template<unsigned int VImageDimension>

using itk::ImageRegion< VImageDimension >::Self = ImageRegion

Standard class type aliases.

Definition at line 73 of file itkImageRegion.h.

template<unsigned int VImageDimension>

using itk::ImageRegion< VImageDimension >::SizeType = Size< Self::ImageDimension >

Size type alias support A size is used to define region bounds.

Definition at line 99 of file itkImageRegion.h.

template<unsigned int VImageDimension>

using itk::ImageRegion< VImageDimension >::SizeValueType = typename SizeType::SizeValueType

Definition at line 100 of file itkImageRegion.h.

template<unsigned int VImageDimension>

using itk::ImageRegion< VImageDimension >::SliceRegion = ImageRegion< Self::SliceDimension >

Slice region type alias. SliceRegion is one dimension less than Self.

Definition at line 103 of file itkImageRegion.h.

template<unsigned int VImageDimension>

using itk::ImageRegion< VImageDimension >::Superclass = Region

Definition at line 74 of file itkImageRegion.h.

Constructor & Destructor Documentation

template<unsigned int VImageDimension>

itk::ImageRegion< VImageDimension >::ImageRegion ( )

defaultnoexcept

Constructor. ImageRegion is a lightweight object that is not reference counted, so the constructor is public. Its two data members are filled with zeros (using C++11 default member initializers).

template<unsigned int VImageDimension>

itk::ImageRegion< VImageDimension >::~ImageRegion ( )

overridedefault

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

template<unsigned int VImageDimension>

itk::ImageRegion< VImageDimension >::ImageRegion ( const Self &  )

defaultnoexcept

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

template<unsigned int VImageDimension>

itk::ImageRegion< VImageDimension >::ImageRegion ( const IndexType &  index, const SizeType &  size  )

inlinenoexcept

Constructor that takes an index and size. ImageRegion is a lightweight object that is not reference counted, so this constructor is public.

Definition at line 124 of file itkImageRegion.h.

template<unsigned int VImageDimension>

itk::ImageRegion< VImageDimension >::ImageRegion ( const SizeType &  size )

inlinenoexcept

Constructor that takes a size and assumes an index of zeros. ImageRegion is lightweight object that is not reference counted so this constructor is public.

Definition at line 136 of file itkImageRegion.h.

Member Function Documentation

template<unsigned int VImageDimension>

void itk::ImageRegion< VImageDimension >::ComputeOffsetTable

(

OffsetTableType

offsetTable

)

const

Compute an offset table based on the Size.

template<unsigned int VImageDimension>

bool itk::ImageRegion< VImageDimension >::Crop

(

const Self &

region

)

Crop a region by another region. If this region is outside of the crop, this method returns false and does not modify the region. Otherwise, this method returns true and the region is modified to reflect the crop.

Examples:

SphinxExamples/src/Core/Common/ImageRegionOverlap/Code.cxx, and WikiExamples/SimpleOperations/RegionOverlap.cxx.

template<unsigned int VImageDimension>

static unsigned int itk::ImageRegion< VImageDimension >::GetImageDimension ( )

inlinestatic

Dimension of the image available at run time.

Definition at line 87 of file itkImageRegion.h.

template<unsigned int VImageDimension>

const IndexType& itk::ImageRegion< VImageDimension >::GetIndex ( ) const

inline

Get index defining the corner of the region.

Examples:

Examples/Iterators/ImageLinearIteratorWithIndex2.cxx, and Examples/Iterators/ImageSliceIteratorWithIndex.cxx.

Definition at line 152 of file itkImageRegion.h.

Referenced by itk::ImageIORegionAdaptor< VDimension >::Convert(), itk::ImageToImageFilterDetail::ExtractImageFilterCopyRegion(), itk::ImageRegionSplitterBase::GetNumberOfSplits(), itk::ImageToImageFilterDetail::ImageToImageFilterDefaultCopyRegion(), itk::MultiThreaderBase::ParallelizeImageRegion(), and itk::MultiThreaderBase::ParallelizeImageRegionRestrictDirection().

template<unsigned int VImageDimension>

IndexValueType itk::ImageRegion< VImageDimension >::GetIndex ( unsigned int  i ) const

inline

Convenience methods to get and set the index of the particular dimension i.

Definition at line 178 of file itkImageRegion.h.

template<unsigned int VImageDimension>

IndexType& itk::ImageRegion< VImageDimension >::GetModifiableIndex ( )

inline

Get index defining the corner of the region.

Definition at line 153 of file itkImageRegion.h.

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

template<unsigned int VImageDimension>

SizeType& itk::ImageRegion< VImageDimension >::GetModifiableSize ( )

inline

Get the size of the region.

Definition at line 163 of file itkImageRegion.h.

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

template<unsigned int VImageDimension>

virtual const char* itk::ImageRegion< VImageDimension >::GetNameOfClass ( ) const

virtual

Standard part of all itk objects.

template<unsigned int VImageDimension>

SizeValueType itk::ImageRegion< VImageDimension >::GetNumberOfPixels

(

)

const

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

Examples:

Examples/RegistrationITKv3/DeformableRegistration15.cxx, Examples/RegistrationITKv3/ImageRegistration2.cxx, Examples/RegistrationITKv4/DeformableRegistration15.cxx, Examples/RegistrationITKv4/ImageRegistration2.cxx, SphinxExamples/src/Registration/Common/PerformMultiModalityRegistrationWithMutualInformation/Code.cxx, WikiExamples/Registration/MutualInformation.cxx, WikiExamples/Registration/MutualInformationAffine.cxx, and WikiExamples/Registration/WatchRegistration.cxx.

template<unsigned int VImageDimension>

Superclass::RegionType itk::ImageRegion< VImageDimension >::GetRegionType ( ) const

inlineoverridevirtual

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

Implements itk::Region.

Definition at line 106 of file itkImageRegion.h.

template<unsigned int VImageDimension>

const SizeType& itk::ImageRegion< VImageDimension >::GetSize ( ) const

inline

Get the size of the region.

Definition at line 162 of file itkImageRegion.h.

Referenced by itk::ImageIORegionAdaptor< VDimension >::Convert(), itk::ImageToImageFilterDetail::ExtractImageFilterCopyRegion(), itk::ImageRegionSplitterBase::GetNumberOfSplits(), itk::ImageToImageFilterDetail::ImageToImageFilterDefaultCopyRegion(), itk::MultiThreaderBase::ParallelizeImageRegion(), itk::MultiThreaderBase::ParallelizeImageRegionRestrictDirection(), itk::ScanlineFilterCommon< TInputImage, TOutputImage >::SetupLineOffsets(), itk::PhasedArray3DSpecialCoordinatesImage< TPixel >::TransformContinuousIndexToPhysicalPoint(), itk::PhasedArray3DSpecialCoordinatesImage< TPixel >::TransformIndexToPhysicalPoint(), itk::PhasedArray3DSpecialCoordinatesImage< TPixel >::TransformPhysicalPointToContinuousIndex(), and itk::PhasedArray3DSpecialCoordinatesImage< TPixel >::TransformPhysicalPointToIndex().

template<unsigned int VImageDimension>

SizeValueType itk::ImageRegion< VImageDimension >::GetSize ( unsigned int  i ) const

inline

Convenience methods to get and set the size of the particular dimension i.

Definition at line 170 of file itkImageRegion.h.

template<unsigned int VImageDimension>

IndexType itk::ImageRegion< VImageDimension >::GetUpperIndex

(

)

const

Get index defining the upper corner of the region.

template<unsigned int VImageDimension>

bool itk::ImageRegion< VImageDimension >::IsInside ( const IndexType &  index ) const

inline

Test if an index is inside

Definition at line 207 of file itkImageRegion.h.

Referenced by itk::PhasedArray3DSpecialCoordinatesImage< TPixel >::TransformPhysicalPointToContinuousIndex(), and itk::PhasedArray3DSpecialCoordinatesImage< TPixel >::TransformPhysicalPointToIndex().

template<unsigned int VImageDimension>

template<typename TCoordRepType >

bool itk::ImageRegion< VImageDimension >::IsInside ( const ContinuousIndex< TCoordRepType, VImageDimension > &  index ) const

inline

Test if a continuous index is inside the region. We take into account the fact that each voxel has its center at the integer coordinate and extends half way to the next integer coordinate.

Definition at line 230 of file itkImageRegion.h.

template<unsigned int VImageDimension>

bool itk::ImageRegion< VImageDimension >::IsInside ( const Self &  region ) const

inline

Test if a region (the argument) is completely inside of this region. If the region that is passed as argument to this method, has a size of value zero, then it will not be considered to be inside of the current region, even its starting index is inside.

Definition at line 262 of file itkImageRegion.h.

template<unsigned int VImageDimension>

bool itk::ImageRegion< VImageDimension >::operator!= ( const Self &  region ) const

inlinenoexcept

Compare two regions.

Definition at line 200 of file itkImageRegion.h.

template<unsigned int VImageDimension>

Self& itk::ImageRegion< VImageDimension >::operator= ( const Self &  )

defaultnoexcept

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

template<unsigned int VImageDimension>

bool itk::ImageRegion< VImageDimension >::operator== ( const Self &  region ) const

inlinenoexcept

Compare two regions.

Definition at line 193 of file itkImageRegion.h.

template<unsigned int VImageDimension>

void itk::ImageRegion< VImageDimension >::PadByRadius

(

OffsetValueType

radius

)

Pad an image region by the specified radius. Region can be padded uniformly in all dimensions or can be padded by different amounts in each dimension.

template<unsigned int VImageDimension>

void itk::ImageRegion< VImageDimension >::PadByRadius

(

const IndexValueArrayType

radius

)

Friends of ImageRegion

template<unsigned int VImageDimension>

void itk::ImageRegion< VImageDimension >::PadByRadius

(

const SizeType &

radius

)

Friends of ImageRegion

template<unsigned int VImageDimension>

void itk::ImageRegion< VImageDimension >::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.

template<unsigned int VImageDimension>

void itk::ImageRegion< VImageDimension >::SetIndex ( const IndexType &  index )

inline

Set the index defining the corner of the region.

Examples:

Examples/DataRepresentation/Image/Image5.cxx, Examples/IO/VisibleHumanStreamReadWrite.cxx, SphinxExamples/src/Core/Common/ImageRegionOverlap/Code.cxx, SphinxExamples/src/Core/Common/ImportPixelBufferIntoAnImage/Code.cxx, SphinxExamples/src/Filtering/ImageGrid/ExtractRegionOfInterestInOneImage/Code.cxx, SphinxExamples/src/ImageCompareCommand.cxx, and WikiExamples/IO/ImportImageFilter.cxx.

Definition at line 148 of file itkImageRegion.h.

Referenced by itk::BoxMeanCalculatorFunction(), itk::BoxSigmaCalculatorFunction(), itk::ImageIORegionAdaptor< VDimension >::Convert(), itk::ImageToImageFilterDetail::ExtractImageFilterCopyRegion(), itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::GetRegion(), itk::ImageToImageFilterDetail::ImageToImageFilterDefaultCopyRegion(), itk::MultiThreaderBase::ParallelizeImageRegion(), and itk::MultiThreaderBase::ParallelizeImageRegionRestrictDirection().

template<unsigned int VImageDimension>

void itk::ImageRegion< VImageDimension >::SetIndex ( unsigned int  i, IndexValueType  sze  )

inline

Convenience methods to get and set the index of the particular dimension i.

Definition at line 176 of file itkImageRegion.h.

template<unsigned int VImageDimension>

void itk::ImageRegion< VImageDimension >::SetSize ( const SizeType &  size )

inline

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

Examples:

Examples/DataRepresentation/Image/Image1.cxx, Examples/DataRepresentation/Image/Image3.cxx, Examples/DataRepresentation/Image/Image4.cxx, Examples/DataRepresentation/Image/VectorImage.cxx, Examples/Filtering/DigitallyReconstructedRadiograph1.cxx, Examples/IO/ImageReadExtractFilterInsertWrite.cxx, Examples/IO/ImageReadExtractWrite.cxx, Examples/IO/ImageReadRegionOfInterestWrite.cxx, Examples/RegistrationITKv3/ImageRegistration8.cxx, Examples/RegistrationITKv4/ImageRegistration8.cxx, Examples/Segmentation/GibbsPriorImageFilter1.cxx, Examples/Segmentation/HoughTransform2DCirclesImageFilter.cxx, Examples/SpatialObjects/ImageMaskSpatialObject.cxx, Examples/SpatialObjects/ImageSpatialObject.cxx, SphinxExamples/src/Core/Common/CreateAnImage/Code.cxx, SphinxExamples/src/Core/Common/CreateAnImageOfVectors/Code.cxx, SphinxExamples/src/Filtering/FastMarching/CreateDistanceMapFromSeeds/Code.cxx, SphinxExamples/src/Filtering/ImageCompare/CombineTwoImagesWithCheckerBoardPattern/Code.cxx, SphinxExamples/src/Filtering/ImageGrid/ProcessA2DSliceOfA3DImage/Code.cxx, WikiExamples/ImageProcessing/AbsoluteValueDifferenceImageFilter.cxx, WikiExamples/ImageProcessing/AddConstantToImageFilter.cxx, WikiExamples/ImageProcessing/AddPixelAccessor.cxx, WikiExamples/ImageProcessing/AndImageFilter.cxx, WikiExamples/ImageProcessing/BinaryImageToLabelMapFilter.cxx, WikiExamples/ImageProcessing/BinaryImageToShapeLabelMapFilter.cxx, WikiExamples/ImageProcessing/BinaryNotImageFilter.cxx, WikiExamples/ImageProcessing/Compose3DCovariantVectorImageFilter.cxx, WikiExamples/ImageProcessing/ConvolutionImageFilter.cxx, WikiExamples/ImageProcessing/ImageAdaptorExtractVectorComponent.cxx, WikiExamples/ImageProcessing/LabelGeometryImageFilter.cxx, WikiExamples/ImageProcessing/LabelMapOverlayImageFilter.cxx, WikiExamples/ImageProcessing/LabelMapToLabelImageFilter.cxx, WikiExamples/ImageProcessing/LabelOverlayImageFilter.cxx, WikiExamples/ImageProcessing/LabelShapeKeepNObjectsImageFilter.cxx, WikiExamples/ImageProcessing/LabelStatisticsImageFilter.cxx, WikiExamples/ImageProcessing/MaximumImageFilter.cxx, WikiExamples/ImageProcessing/MinimumImageFilter.cxx, WikiExamples/ImageProcessing/NthElementImageAdaptor.cxx, WikiExamples/ImageProcessing/OrImageFilter.cxx, WikiExamples/ImageProcessing/ProcessingNthImageElement.cxx, WikiExamples/ImageProcessing/RegionOfInterestImageFilter.cxx, WikiExamples/ImageProcessing/ShapeOpeningLabelMapFilter.cxx, WikiExamples/ImageProcessing/SquaredDifferenceImageFilter.cxx, WikiExamples/ImageProcessing/SquareImageFilter.cxx, WikiExamples/ImageProcessing/SubtractImageFilter_Constant.cxx, WikiExamples/ImageProcessing/XorImageFilter.cxx, WikiExamples/Inspection/CheckerBoardImageFilter.cxx, WikiExamples/IO/CreateImages.cxx, WikiExamples/Iterators/ConstantBoundaryCondition.cxx, WikiExamples/Iterators/ConstNeighborhoodIterator.cxx, WikiExamples/Iterators/ImageBoundaryFacesCalculator.cxx, WikiExamples/Iterators/ImageRandomConstIteratorWithIndex.cxx, WikiExamples/Iterators/ImageRegionConstIterator.cxx, WikiExamples/Iterators/ImageRegionConstIteratorWithIndex.cxx, WikiExamples/Iterators/ImageRegionIterator.cxx, WikiExamples/Iterators/ImageRegionIteratorWithIndex.cxx, WikiExamples/Iterators/LineConstIterator.cxx, WikiExamples/Iterators/LineIterator.cxx, WikiExamples/Iterators/NeighborhoodIterator.cxx, WikiExamples/Registration/DeformationFieldTransform.cxx, WikiExamples/Registration/LandmarkBasedTransformInitializer.cxx, WikiExamples/Registration/WarpImageFilter.cxx, WikiExamples/Segmentation/LabelMapContourOverlayImageFilter.cxx, WikiExamples/Segmentation/OtsuMultipleThresholdsImageFilter.cxx, WikiExamples/Segmentation/OtsuThresholdImageFilter.cxx, WikiExamples/Smoothing/AntiAliasBinaryImageFilter.cxx, and WikiExamples/VectorImages/VectorImageToImageAdaptor.cxx.

Definition at line 158 of file itkImageRegion.h.

Referenced by itk::BoxMeanCalculatorFunction(), itk::BoxSigmaCalculatorFunction(), itk::ImageIORegionAdaptor< VDimension >::Convert(), itk::ImageToImageFilterDetail::ExtractImageFilterCopyRegion(), itk::ImageToImageFilterDetail::ImageToImageFilterDefaultCopyRegion(), itk::MultiThreaderBase::ParallelizeImageRegion(), itk::MultiThreaderBase::ParallelizeImageRegionRestrictDirection(), and itk::ImageBase< TImage::ImageDimension >::SetRegions().

template<unsigned int VImageDimension>

void itk::ImageRegion< VImageDimension >::SetSize ( unsigned int  i, SizeValueType  sze  )

inline

Convenience methods to get and set the size of the particular dimension i.

Definition at line 168 of file itkImageRegion.h.

template<unsigned int VImageDimension>

void itk::ImageRegion< VImageDimension >::SetUpperIndex

(

const IndexType &

idx

)

Modify the Size of the ImageRegion so that the provided index will be the upper corner index.

template<unsigned int VImageDimension>

bool itk::ImageRegion< VImageDimension >::ShrinkByRadius

(

OffsetValueType

radius

)

Shrink an image region by the specified radius. The region can be shrunk uniformly in all dimension or can be shink by different amounts in each direction. If the shink operation fails because the radius is too large, this method returns false.

template<unsigned int VImageDimension>

bool itk::ImageRegion< VImageDimension >::ShrinkByRadius

(

const IndexValueArrayType

radius

)

Friends of ImageRegion

template<unsigned int VImageDimension>

bool itk::ImageRegion< VImageDimension >::ShrinkByRadius

(

const SizeType &

radius

)

Friends of ImageRegion

template<unsigned int VImageDimension>

SliceRegion itk::ImageRegion< VImageDimension >::Slice

(

const unsigned int

dim

)

const

Slice a region, producing a region that is one dimension lower than the current region. Parameter "dim" specifies which dimension to remove.

Referenced by itk::RLEImage< TPixel, VImageDimension, CounterType >::SetBufferedRegion(), itk::RLEImage< TPixel, VImageDimension, CounterType >::SetLargestPossibleRegion(), and itk::RLEImage< TPixel, VImageDimension, CounterType >::SetRequestedRegion().

Friends And Related Function Documentation

template<unsigned int VImageDimension>

friend class ImageBase< VImageDimension >

friend

Friends of ImageRegion

Definition at line 329 of file itkImageRegion.h.

Member Data Documentation

template<unsigned int VImageDimension>

constexpr unsigned int itk::ImageRegion< VImageDimension >::ImageDimension = VImageDimension

static

Dimension of the image available at compile time.

Definition at line 80 of file itkImageRegion.h.

template<unsigned int VImageDimension>

IndexType itk::ImageRegion< VImageDimension >::m_Index = {{0}}

private

Friends of ImageRegion

Definition at line 325 of file itkImageRegion.h.

template<unsigned int VImageDimension>

SizeType itk::ImageRegion< VImageDimension >::m_Size = {{0}}

private

Friends of ImageRegion

Definition at line 326 of file itkImageRegion.h.

template<unsigned int VImageDimension>

constexpr unsigned int itk::ImageRegion< VImageDimension >::SliceDimension = ImageDimension - ( ImageDimension > 1 )

static

Dimension one lower than the image unless the image is one dimensional in which case the SliceDimension is also one dimensional.

Definition at line 84 of file itkImageRegion.h.

---

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

• itkImageRegion.h