Orfeo Toolbox  4.0
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | Friends | List of all members
itk::ImageRegion< VImageDimension > Class Template Reference

An image region represents a structured region of data. More...

#include <itkImageRegion.h>

+ Inheritance diagram for itk::ImageRegion< VImageDimension >:
+ Collaboration diagram for itk::ImageRegion< VImageDimension >:

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
 
enum  RegionType {
  ITK_UNSTRUCTURED_REGION,
  ITK_STRUCTURED_REGION
}
 
typedef ImageRegion Self
 
typedef Size
< itkGetStaticConstMacro(ImageDimension) > 
SizeType
 
typedef SizeType::SizeValueType SizeValueType
 
typedef ImageRegion
< itkGetStaticConstMacro(SliceDimension) > 
SliceRegion
 
typedef Region Superclass
 

Public Member Functions

 ImageRegion ()
 
 ImageRegion (const Self &region)
 
 ImageRegion (const IndexType &index, const SizeType &size)
 
 ImageRegion (const SizeType &size)
 
virtual ~ImageRegion ()
 
void ComputeOffsetTable (OffsetTableType offsetTable) const
 
bool Crop (const Self &region)
 
const IndexTypeGetIndex () const
 
IndexValueType GetIndex (unsigned int i) const
 
IndexTypeGetModifiableIndex ()
 
SizeTypeGetModifiableSize ()
 
virtual const char * GetNameOfClass () const
 
SizeValueType GetNumberOfPixels () const
 
virtual Superclass::RegionType GetRegionType () const
 
const SizeTypeGetSize () const
 
SizeValueType GetSize (unsigned int i) const
 
IndexType GetUpperIndex () const
 
bool IsInside (const IndexType &index) const
 
template<typename TCoordRepType >
bool IsInside (const ContinuousIndex< TCoordRepType, VImageDimension > &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 PadByRadius (OffsetValueType radius)
 
void PadByRadius (const IndexValueArrayType radius)
 
void PadByRadius (const SizeType &radius)
 
virtual void Print (std::ostream &os, Indent indent=0) const
 
void SetIndex (const IndexType &index)
 
void SetIndex (unsigned int i, IndexValueType sze)
 
void SetSize (const SizeType &size)
 
void SetSize (unsigned int i, SizeValueType sze)
 
void SetUpperIndex (const IndexType &idx)
 
bool ShrinkByRadius (OffsetValueType radius)
 
bool ShrinkByRadius (const IndexValueArrayType radius)
 
bool ShrinkByRadius (const SizeType &radius)
 
SliceRegion Slice (const unsigned int dim) const
 

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

Protected Member Functions

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

Private Attributes

IndexType m_Index
 
SizeType m_Size
 

Friends

class ImageBase< 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

{Images/ImageRegion,An object which holds the index (start) and size of a region of an image} {SimpleOperations/RegionIntersection,Determine if one region is fully inside another region} {SimpleOperations/PixelInsideRegion,Determine if a pixel is inside of a region} {SimpleOperations/RegionOverlap,Determine the overlap of two regions}

Definition at line 69 of file itkImageRegion.h.

Member Typedef Documentation

template<unsigned int VImageDimension>
typedef Index< itkGetStaticConstMacro(ImageDimension) > itk::ImageRegion< VImageDimension >::IndexType

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

Definition at line 92 of file itkImageRegion.h.

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

Definition at line 94 of file itkImageRegion.h.

template<unsigned int VImageDimension>
typedef IndexType::IndexValueType itk::ImageRegion< VImageDimension >::IndexValueType

Definition at line 93 of file itkImageRegion.h.

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

Definition at line 97 of file itkImageRegion.h.

template<unsigned int VImageDimension>
typedef IndexType::OffsetType itk::ImageRegion< VImageDimension >::OffsetType

Definition at line 95 of file itkImageRegion.h.

template<unsigned int VImageDimension>
typedef OffsetType::OffsetValueType itk::ImageRegion< VImageDimension >::OffsetValueType

Definition at line 96 of file itkImageRegion.h.

template<unsigned int VImageDimension>
typedef ImageRegion itk::ImageRegion< VImageDimension >::Self

Standard class typedefs.

Definition at line 73 of file itkImageRegion.h.

template<unsigned int VImageDimension>
typedef Size< itkGetStaticConstMacro(ImageDimension) > itk::ImageRegion< VImageDimension >::SizeType

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

Definition at line 100 of file itkImageRegion.h.

template<unsigned int VImageDimension>
typedef SizeType::SizeValueType itk::ImageRegion< VImageDimension >::SizeValueType

Definition at line 101 of file itkImageRegion.h.

template<unsigned int VImageDimension>
typedef ImageRegion< itkGetStaticConstMacro(SliceDimension) > itk::ImageRegion< VImageDimension >::SliceRegion

Slice region typedef. SliceRegion is one dimension less than Self.

Definition at line 104 of file itkImageRegion.h.

template<unsigned int VImageDimension>
typedef Region itk::ImageRegion< VImageDimension >::Superclass

Definition at line 74 of file itkImageRegion.h.

Member Enumeration Documentation

enum itk::Region::RegionType
inherited

Enums used to describe the extent types.

Enumerator
ITK_UNSTRUCTURED_REGION 
ITK_STRUCTURED_REGION 

Definition at line 71 of file itkRegion.h.

Constructor & Destructor Documentation

template<unsigned int VImageDimension>
itk::ImageRegion< VImageDimension >::ImageRegion ( )

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

Instantiate object.

Definition at line 40 of file itkImageRegion.hxx.

template<unsigned int VImageDimension>
itk::ImageRegion< VImageDimension >::~ImageRegion ( )
virtual

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

Destructor for the ImageRegion class.

Definition at line 51 of file itkImageRegion.hxx.

template<unsigned int VImageDimension>
itk::ImageRegion< VImageDimension >::ImageRegion ( const Self region)
inline

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

Definition at line 120 of file itkImageRegion.h.

template<unsigned int VImageDimension>
itk::ImageRegion< VImageDimension >::ImageRegion ( const IndexType index,
const SizeType size 
)
inline

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

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

Definition at line 82 of file itkImageRegion.hxx.

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.

Definition at line 220 of file itkImageRegion.hxx.

References itk::ImageRegion< VImageDimension >::GetIndex(), and itk::ImageRegion< VImageDimension >::GetSize().

Referenced by otb::ImageRegionAdaptativeSplitter< VImageDimension >::EstimateSplitMap(), itk::ConstantBoundaryCondition< TInputImage, TOutputImage >::GetInputRequestedRegion(), otb::StreamingShrinkImageRegionSplitter::GetSplit(), and otb::ImageRegionSquareTileSplitter< VImageDimension >::GetSplit().

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

Dimension of the image available at run time.

Definition at line 88 of file itkImageRegion.h.

template<unsigned int VImageDimension>
const IndexType& itk::ImageRegion< VImageDimension >::GetIndex ( void  ) const
inline

Get index defining the corner of the region.

Definition at line 143 of file itkImageRegion.h.

Referenced by itk::SpatialObject< TMesh::PointDimension >::ComputeIndex(), itk::ImageBase< TImage::ImageDimension >::ComputeIndex(), itk::SpatialObject< TMesh::PointDimension >::ComputeOffset(), otb::Functor::ShapeAttributesLabelObjectFunctor< TLabelObject, TLabelImage >::ComputePerimeter(), itk::ImageIORegionAdaptor< VDimension >::Convert(), itk::ImageRegion< VImageDimension >::Crop(), itk::ImageToImageFilterDetail::ExtractImageFilterCopyRegion(), itk::MaskFeaturePointSelectionFilter< TImage, TMask, TFeatures >::GenerateData(), itk::PeriodicBoundaryCondition< TInputImage, TOutputImage >::GetInputRequestedRegion(), itk::ZeroFluxNeumannBoundaryCondition< TInputImage, TOutputImage >::GetInputRequestedRegion(), itk::ImageRegionSplitterBase::GetNumberOfSplits(), otb::ImageRegionTileMapSplitter< VImageDimension >::GetNumberOfSplits(), itk::PeriodicBoundaryCondition< TInputImage, TOutputImage >::GetPixel(), itk::ZeroFluxNeumannBoundaryCondition< TInputImage, TOutputImage >::GetPixel(), otb::StreamingShrinkImageRegionSplitter::GetSplit(), itk::ImageRegionMultidimensionalSplitter< VImageDimension >::GetSplit(), otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >::GetSplit(), itk::ImageRegionSplitter< VImageDimension >::GetSplit(), otb::ImageRegionSquareTileSplitter< VImageDimension >::GetSplit(), otb::ImageRegionTileMapSplitter< VImageDimension >::GetSplit(), itk::ImageRegionSplitter< 2 >::GetSplitInternal(), itk::ImageToImageFilterDetail::ImageToImageFilterDefaultCopyRegion(), otb::RemoteSensingRegion< typename VertexType::CoordRepType >::RemoteSensingRegion(), otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetOutputParametersFromImage(), otb::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::SetOutputParametersFromImage(), itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::SetOutputParametersFromImage(), itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::SetOutputParametersFromImage(), and itk::N4BiasFieldCorrectionImageFilter< TInputImage, TMaskImage, TOutputImage >::UpdateBiasFieldEstimate().

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

Definition at line 166 of file itkImageRegion.h.

template<unsigned int VImageDimension>
IndexType& itk::ImageRegion< VImageDimension >::GetModifiableIndex ( )
inline

Definition at line 144 of file itkImageRegion.h.

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

template<unsigned int VImageDimension>
SizeType& itk::ImageRegion< VImageDimension >::GetModifiableSize ( )
inline

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

Reimplemented from itk::Region.

template<unsigned int VImageDimension>
ImageRegion< VImageDimension >::SizeValueType itk::ImageRegion< VImageDimension >::GetNumberOfPixels ( void  ) const
template<unsigned int VImageDimension>
virtual Superclass::RegionType itk::ImageRegion< VImageDimension >::GetRegionType ( ) const
inlinevirtual

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

Implements itk::Region.

Definition at line 107 of file itkImageRegion.h.

template<unsigned int VImageDimension>
const SizeType& itk::ImageRegion< VImageDimension >::GetSize ( void  ) const
inline

Get the size of the region.

Definition at line 152 of file itkImageRegion.h.

Referenced by itk::DiffusionTensor3DReconstructionImageFilter< TReferenceImagePixelType, TGradientImagePixelType, TTensorPixelType, TMaskImageType >::BeforeThreadedGenerateData(), itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::CollapsePhiLattice(), itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::CollapsePhiLattice(), itk::ImageSpatialObject< TDimension, TPixelType >::ComputeLocalBoundingBox(), otb::Functor::ShapeAttributesLabelObjectFunctor< TLabelObject, TLabelImage >::ComputePerimeter(), itk::ImageRegionMultidimensionalSplitter< VImageDimension >::ComputeSplits(), itk::ImageIORegionAdaptor< VDimension >::Convert(), itk::ImageRegion< VImageDimension >::Crop(), itk::ImageToImageFilterDetail::ExtractImageFilterCopyRegion(), itk::GaussianExponentialDiffeomorphicTransform< TScalar, NDimensions >::GaussianSmoothConstantVelocityField(), itk::GaussianSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >::GaussianSmoothDisplacementField(), itk::MaskFeaturePointSelectionFilter< TImage, TMask, TFeatures >::GenerateData(), itk::ImageSeriesWriter< TInputImage, TOutputImage >::GenerateNumericFileNames(), itk::PeriodicBoundaryCondition< TInputImage, TOutputImage >::GetInputRequestedRegion(), itk::ZeroFluxNeumannBoundaryCondition< TInputImage, TOutputImage >::GetInputRequestedRegion(), otb::StreamingShrinkImageRegionSplitter::GetNumberOfSplits(), itk::ImageRegionSplitterBase::GetNumberOfSplits(), otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >::GetNumberOfSplits(), itk::ImageRegionSplitter< VImageDimension >::GetNumberOfSplits(), otb::ImageRegionSquareTileSplitter< VImageDimension >::GetNumberOfSplits(), otb::ImageRegionTileMapSplitter< VImageDimension >::GetNumberOfSplits(), itk::PeriodicBoundaryCondition< TInputImage, TOutputImage >::GetPixel(), itk::ZeroFluxNeumannBoundaryCondition< TInputImage, TOutputImage >::GetPixel(), itk::ImageRegionMultidimensionalSplitter< VImageDimension >::GetSplit(), otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >::GetSplit(), itk::ImageRegionSplitter< VImageDimension >::GetSplit(), otb::ImageRegionTileMapSplitter< VImageDimension >::GetSplit(), itk::ImageRegionSplitter< 2 >::GetSplitInternal(), itk::ImageToImageFilterDetail::ImageToImageFilterDefaultCopyRegion(), itk::DeformableSimplexMesh3DFilter< TInputMesh, TOutputMesh >::Initialize(), itk::ImageSpatialObject< TDimension, TPixelType >::IsInside(), otb::RemoteSensingRegion< typename VertexType::CoordRepType >::RemoteSensingRegion(), otb::VectorDataToLabelImageFilter< TVectorData, TOutputImage >::SetOutputParametersFromImage(), otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetOutputParametersFromImage(), otb::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::SetOutputParametersFromImage(), itk::WarpImageFilter< TInputImage, TOutputImage, TDisplacementField >::SetOutputParametersFromImage(), itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::SetOutputParametersFromImage(), itk::PhasedArray3DSpecialCoordinatesImage< TPixel >::TransformContinuousIndexToPhysicalPoint(), itk::PhasedArray3DSpecialCoordinatesImage< TPixel >::TransformIndexToPhysicalPoint(), itk::PhasedArray3DSpecialCoordinatesImage< TPixel >::TransformPhysicalPointToContinuousIndex(), itk::PhasedArray3DSpecialCoordinatesImage< TPixel >::TransformPhysicalPointToIndex(), itk::N4BiasFieldCorrectionImageFilter< TInputImage, TMaskImage, TOutputImage >::UpdateBiasFieldEstimate(), and itk::ImageSeriesWriter< TInputImage, TOutputImage >::WriteFiles().

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

Definition at line 159 of file itkImageRegion.h.

template<unsigned int VImageDimension>
ImageRegion< VImageDimension >::IndexType itk::ImageRegion< VImageDimension >::GetUpperIndex ( ) const

Get index defining the upper corner of the region.

Definition at line 57 of file itkImageRegion.hxx.

template<unsigned int VImageDimension>
bool itk::ImageRegion< VImageDimension >::IsInside ( const IndexType index) const
inline
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 220 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 251 of file itkImageRegion.h.

template<unsigned int VImageDimension>
bool itk::ImageRegion< VImageDimension >::operator!= ( const Self region) const
inline

Compare two regions.

Definition at line 189 of file itkImageRegion.h.

template<unsigned int VImageDimension>
void itk::ImageRegion< VImageDimension >::operator= ( const Self region)
inline

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

Definition at line 135 of file itkImageRegion.h.

template<unsigned int VImageDimension>
bool itk::ImageRegion< VImageDimension >::operator== ( const Self region) const
inline

Compare two regions.

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

Definition at line 124 of file itkImageRegion.hxx.

template<unsigned int VImageDimension>
void itk::ImageRegion< VImageDimension >::PadByRadius ( const IndexValueArrayType  radius)

Definition at line 151 of file itkImageRegion.hxx.

template<unsigned int VImageDimension>
void itk::ImageRegion< VImageDimension >::PadByRadius ( const SizeType radius)

Definition at line 139 of file itkImageRegion.hxx.

void itk::Region::Print ( std::ostream &  os,
Indent  indent = 0 
) const
virtualinherited
void itk::Region::PrintHeader ( std::ostream &  os,
Indent  indent 
) const
protectedvirtualinherited

Definition at line 43 of file itkRegion.cxx.

template<unsigned int VImageDimension>
void itk::ImageRegion< VImageDimension >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

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.

Definition at line 112 of file itkImageRegion.hxx.

void itk::Region::PrintTrailer ( std::ostream &  os,
Indent  indent 
) const
protectedvirtualinherited

Definition at line 50 of file itkRegion.cxx.

template<unsigned int VImageDimension>
void itk::ImageRegion< VImageDimension >::SetIndex ( const IndexType index)
inline

Set the index defining the corner of the region.

Definition at line 139 of file itkImageRegion.h.

Referenced by itk::BSplineBaseTransform< TScalar, NDimensions, VSplineOrder >::ComputeJacobianFromBSplineWeightsWithRespectToPosition(), itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::ComputeJacobianWithRespectToParameters(), itk::BSplineDeformableTransform< TScalar, NDimensions, VSplineOrder >::ComputeJacobianWithRespectToParameters(), itk::ImageIORegionAdaptor< VDimension >::Convert(), otb::ImageRegionAdaptativeSplitter< VImageDimension >::EstimateSplitMap(), itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >::EvaluateAtContinuousIndex(), itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex(), itk::ImageToImageFilterDetail::ExtractImageFilterCopyRegion(), itk::MaskFeaturePointSelectionFilter< TImage, TMask, TFeatures >::GenerateData(), otb::Rectangle< TValue >::GetBoundingRegion(), otb::RemoteSensingRegion< typename VertexType::CoordRepType >::GetImageRegion(), itk::ConstantBoundaryCondition< TInputImage, TOutputImage >::GetInputRequestedRegion(), otb::StreamingShrinkImageRegionSplitter::GetSplit(), itk::ImageRegionMultidimensionalSplitter< VImageDimension >::GetSplit(), otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >::GetSplit(), itk::ImageRegionSplitter< VImageDimension >::GetSplit(), otb::ImageRegionSquareTileSplitter< VImageDimension >::GetSplit(), otb::ImageRegionTileMapSplitter< VImageDimension >::GetSplit(), itk::ImageToImageFilterDetail::ImageToImageFilterDefaultCopyRegion(), itk::BlockMatchingImageFilter< TFixedImage, TMovingImage, TFeatures, TDisplacements, TSimilarities >::ThreadedGenerateData(), itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::TransformPoint(), itk::BSplineDeformableTransform< TScalar, NDimensions, VSplineOrder >::TransformPoint(), and itk::ImageSeriesWriter< TInputImage, TOutputImage >::WriteFiles().

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

Definition at line 148 of file itkImageRegion.h.

Referenced by itk::BSplineBaseTransform< TScalar, NDimensions, VSplineOrder >::ComputeJacobianFromBSplineWeightsWithRespectToPosition(), itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::ComputeJacobianWithRespectToParameters(), itk::BSplineDeformableTransform< TScalar, NDimensions, VSplineOrder >::ComputeJacobianWithRespectToParameters(), itk::ImageIORegionAdaptor< VDimension >::Convert(), otb::ImageRegionAdaptativeSplitter< VImageDimension >::EstimateSplitMap(), itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >::EvaluateAtContinuousIndex(), itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex(), itk::ImageToImageFilterDetail::ExtractImageFilterCopyRegion(), itk::MaskFeaturePointSelectionFilter< TImage, TMask, TFeatures >::GenerateData(), otb::Rectangle< TValue >::GetBoundingRegion(), otb::RemoteSensingRegion< typename VertexType::CoordRepType >::GetImageRegion(), itk::ConstantBoundaryCondition< TInputImage, TOutputImage >::GetInputRequestedRegion(), otb::StreamingShrinkImageRegionSplitter::GetSplit(), itk::ImageRegionMultidimensionalSplitter< VImageDimension >::GetSplit(), otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >::GetSplit(), itk::ImageRegionSplitter< VImageDimension >::GetSplit(), otb::ImageRegionSquareTileSplitter< VImageDimension >::GetSplit(), otb::ImageRegionTileMapSplitter< VImageDimension >::GetSplit(), itk::ImageToImageFilterDetail::ImageToImageFilterDefaultCopyRegion(), itk::BSplineDeformableTransform< TScalar, NDimensions, VSplineOrder >::SetCoefficientImageInformationFromFixedParameters(), itk::ImageBase< TImage::ImageDimension >::SetRegions(), itk::BlockMatchingImageFilter< TFixedImage, TMovingImage, TFeatures, TDisplacements, TSimilarities >::ThreadedGenerateData(), itk::BSplineTransform< TScalar, NDimensions, VSplineOrder >::TransformPoint(), itk::BSplineDeformableTransform< TScalar, NDimensions, VSplineOrder >::TransformPoint(), and itk::ImageSeriesWriter< TInputImage, TOutputImage >::WriteFiles().

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

Definition at line 71 of file itkImageRegion.hxx.

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.

Definition at line 163 of file itkImageRegion.hxx.

template<unsigned int VImageDimension>
bool itk::ImageRegion< VImageDimension >::ShrinkByRadius ( const IndexValueArrayType  radius)

Definition at line 199 of file itkImageRegion.hxx.

template<unsigned int VImageDimension>
bool itk::ImageRegion< VImageDimension >::ShrinkByRadius ( const SizeType radius)

Definition at line 178 of file itkImageRegion.hxx.

template<unsigned int VImageDimension>
ImageRegion< 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.

Definition at line 282 of file itkImageRegion.hxx.

References itk::Size< VDimension >::Fill(), and itk::Index< VIndexDimension >::Fill().

Friends And Related Function Documentation

template<unsigned int VImageDimension>
friend class ImageBase< VImageDimension >
friend

Friends of ImageRegion

Definition at line 318 of file itkImageRegion.h.

Member Data Documentation

template<unsigned int VImageDimension>
const unsigned int itk::ImageRegion< VImageDimension >::ImageDimension = VImageDimension
static

Dimension of the image available at compile time.

Definition at line 80 of file itkImageRegion.h.

Referenced by itk::ImageRegion< OutputImageType::ImageDimension >::GetImageDimension(), and itk::ImageRegion< OutputImageType::ImageDimension >::IsInside().

template<unsigned int VImageDimension>
IndexType itk::ImageRegion< VImageDimension >::m_Index
private
template<unsigned int VImageDimension>
SizeType itk::ImageRegion< VImageDimension >::m_Size
private
template<unsigned int VImageDimension>
const 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 85 of file itkImageRegion.h.


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

Generated at Sat Mar 8 2014 17:11:47 for Orfeo Toolbox with doxygen 1.8.3.1