![]() |
Orfeo Toolbox
3.16
|
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 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 ®ion) | |
| ImageRegion (const IndexType &index, const SizeType &size) | |
| ImageRegion (const SizeType &size) | |
| virtual | ~ImageRegion () |
| bool | Crop (const Self ®ion) |
| const IndexType & | GetIndex () const |
| IndexValueType | GetIndex (unsigned long i) const |
| virtual const char * | GetNameOfClass () const |
| SizeValueType | GetNumberOfPixels () const |
| virtual Superclass::RegionType | GetRegionType () const |
| const SizeType & | GetSize () const |
| SizeValueType | GetSize (unsigned long i) const |
| bool | IsInside (const IndexType &index) const |
| template<typename TCoordRepType > | |
| bool | IsInside (const ContinuousIndex< TCoordRepType, VImageDimension > &index) const |
| bool | IsInside (const Self ®ion) const |
| bool | operator!= (const Self ®ion) const |
| void | operator= (const Self ®ion) |
| bool | operator== (const Self ®ion) const |
| void | PadByRadius (IndexValueType 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 long i, IndexValueType sze) |
| void | SetSize (const SizeType &size) |
| void | SetSize (unsigned long i, SizeValueType sze) |
| SliceRegion | Slice (const unsigned long 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 > |
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.)
Definition at line 55 of file itkImageRegion.h.
| typedef Index< itkGetStaticConstMacro( ImageDimension) > itk::ImageRegion< VImageDimension >::IndexType |
Index typedef support. An index is used to access pixel values.
Definition at line 78 of file itkImageRegion.h.
| typedef IndexValueType itk::ImageRegion< VImageDimension >::IndexValueArrayType[ImageDimension] |
Definition at line 80 of file itkImageRegion.h.
| typedef IndexType::IndexValueType itk::ImageRegion< VImageDimension >::IndexValueType |
Definition at line 79 of file itkImageRegion.h.
| typedef IndexType::OffsetType itk::ImageRegion< VImageDimension >::OffsetType |
Definition at line 81 of file itkImageRegion.h.
| typedef OffsetType::OffsetValueType itk::ImageRegion< VImageDimension >::OffsetValueType |
Definition at line 82 of file itkImageRegion.h.
| typedef ImageRegion itk::ImageRegion< VImageDimension >::Self |
Standard class typedefs.
Reimplemented from itk::Region.
Definition at line 59 of file itkImageRegion.h.
| typedef Size< itkGetStaticConstMacro( ImageDimension ) > itk::ImageRegion< VImageDimension >::SizeType |
Size typedef support. A size is used to define region bounds.
Definition at line 85 of file itkImageRegion.h.
| typedef SizeType::SizeValueType itk::ImageRegion< VImageDimension >::SizeValueType |
Definition at line 86 of file itkImageRegion.h.
| typedef ImageRegion<itkGetStaticConstMacro(SliceDimension)> itk::ImageRegion< VImageDimension >::SliceRegion |
Slice region typedef. SliceRegion is one dimension less than Self.
Definition at line 89 of file itkImageRegion.h.
| typedef Region itk::ImageRegion< VImageDimension >::Superclass |
Definition at line 60 of file itkImageRegion.h.
|
inherited |
Enums used to describe the extent types.
Reimplemented in itk::ImageIORegion.
Definition at line 63 of file itkRegion.h.
| 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 33 of file itkImageRegion.txx.
|
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 44 of file itkImageRegion.txx.
|
inline |
Copy constructor. ImageRegion is a lightweight object that is not reference counted, so the copy constructor is public.
Definition at line 105 of file itkImageRegion.h.
|
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 109 of file itkImageRegion.h.
|
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 115 of file itkImageRegion.h.
| 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 118 of file itkImageRegion.txx.
References itk::ImageRegion< VImageDimension >::GetIndex(), and itk::ImageRegion< VImageDimension >::GetSize().
Referenced by otb::ImageRegionAdaptativeSplitter< VImageDimension >::EstimateSplitMap(), otb::StreamingShrinkImageRegionSplitter::GetSplit(), otb::ImageRegionSquareTileSplitter< VImageDimension >::GetSplit(), otb::ZoomableImageWidget< TPixel >::resize(), otb::FullResolutionImageWidget< TPixel >::resize(), and otb::FullResolutionImageWidget< TPixel >::SetUpperLeftCorner().
|
inlinestatic |
Dimension of the image available at run time.
Definition at line 74 of file itkImageRegion.h.
|
inline |
Get index defining the corner of the region.
Definition at line 128 of file itkImageRegion.h.
Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::ComputeIndex(), itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::ComputeOffset(), otb::ImageAlternateViewer< TPixel >::ComputeRequestedRegion(), itk::ImageIORegionAdaptor< VDimension >::Convert(), otb::ImageAlternateViewer< TPixel >::CreateAdditionalBuffer(), itk::ImageRegion< VImageDimension >::Crop(), otb::VectorDataEditionModel::DeleteSelectedGeometriesInROI(), otb::ImageAlternateViewer< TPixel >::Draw(), otb::ImageAlternateViewer< TPixel >::DrawRegionBoundary(), itk::ImageToImageFilterDetail::ExtractImageFilterCopyRegion(), otb::ImageWidgetBase< TPixel >::GetBufferIndex(), otb::ImageRegionTileMapSplitter< VImageDimension >::GetNumberOfSplits(), otb::ImageWidgetBase< TPixel >::GetRevertedBufferIndex(), 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(), otb::ImageAlternateViewer< TPixel >::IncrementalOpenGlBufferUpdate(), otb::RemoteSensingRegion< typename VertexType::CoordRepType >::RemoteSensingRegion(), otb::RegionGlComponent::Render(), otb::VerticalAsymptoteCurve::Render(), otb::HistogramCurve< THistogram >::Render(), otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetOutputParametersFromImage(), itk::WarpImageFilter< TInputImage, TOutputImage, TDeformationField >::SetOutputParametersFromImage(), itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetOutputParametersFromImage(), otb::FullResolutionImageWidget< TPixel >::UpdateOpenGlBufferedRegionRequested(), and otb::Curves2DWidget::UpdateSpaceToScreenTransform().
|
inline |
Definition at line 149 of file itkImageRegion.h.
|
virtual |
Standard part of all itk objects.
Reimplemented from itk::Region.
| ImageRegion< VImageDimension >::SizeValueType itk::ImageRegion< VImageDimension >::GetNumberOfPixels | ( | ) | const |
Get the number of pixels contained in this region. This just multiplies the size components.
Definition at line 51 of file itkImageRegion.txx.
Referenced by otb::PipelineMemoryPrintCalculator::EvaluateDataObjectPrint(), itk::HistogramToImageFilter< THistogram, TFunction >::GenerateData(), otb::StreamingShrinkImageRegionSplitter::GetNumberOfSplits(), and otb::ImageRegionSquareTileSplitter< VImageDimension >::GetNumberOfSplits().
|
inlinevirtual |
Return the region type. Images are described with structured regions.
Implements itk::Region.
Definition at line 92 of file itkImageRegion.h.
|
inline |
Get the size of the region.
Definition at line 137 of file itkImageRegion.h.
Referenced by itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::CollapsePhiLattice(), itk::fem::FEMRegistrationFilter< TMovingImage, TFixedImage >::ComputeJacobian(), itk::ImageSpatialObject< TDimension, TPixelType >::ComputeLocalBoundingBox(), otb::ImageAlternateViewer< TPixel >::ComputeRequestedRegion(), itk::ImageIORegionAdaptor< VDimension >::Convert(), otb::ImageAlternateViewer< TPixel >::CreateAdditionalBuffer(), itk::ImageRegion< VImageDimension >::Crop(), otb::VectorDataEditionModel::DeleteSelectedGeometriesInROI(), otb::ViewerViewGUI::DisplayPreviewWidget(), otb::ImageAlternateViewer< TPixel >::Draw(), otb::ImageAlternateViewer< TPixel >::DrawRegionBoundary(), itk::fem::FEMRegistrationFilter< TMovingImage, TFixedImage >::ExpandVectorField(), itk::ImageToImageFilterDetail::ExtractImageFilterCopyRegion(), itk::ImageSeriesWriter< TInputImage, TOutputImage >::GenerateNumericFileNames(), otb::ImageWidgetBase< TPixel >::GetBufferIndex(), itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::GetFixedParameters(), otb::StreamingShrinkImageRegionSplitter::GetNumberOfSplits(), itk::ImageRegionMultidimensionalSplitter< VImageDimension >::GetNumberOfSplits(), otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >::GetNumberOfSplits(), itk::ImageRegionSplitter< VImageDimension >::GetNumberOfSplits(), otb::ImageRegionSquareTileSplitter< VImageDimension >::GetNumberOfSplits(), otb::ImageRegionTileMapSplitter< VImageDimension >::GetNumberOfSplits(), otb::ImageWidgetBase< TPixel >::GetRevertedBufferIndex(), itk::ImageRegionMultidimensionalSplitter< VImageDimension >::GetSplit(), otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >::GetSplit(), itk::ImageRegionSplitter< VImageDimension >::GetSplit(), otb::ImageRegionTileMapSplitter< VImageDimension >::GetSplit(), otb::FixedSizeFullImageWidget< TPixel >::hDisplayed(), itk::MetaImageConverter< NDimensions, PixelType >::ImageSpatialObjectToMetaImage(), itk::ImageToImageFilterDetail::ImageToImageFilterDefaultCopyRegion(), otb::ImageAlternateViewer< TPixel >::IncrementalOpenGlBufferUpdate(), itk::ImageSpatialObject< TDimension, TPixelType >::IsInside(), main(), otb::RemoteSensingRegion< typename VertexType::CoordRepType >::RemoteSensingRegion(), otb::RegionGlComponent::Render(), otb::VerticalAsymptoteCurve::Render(), otb::HistogramCurve< THistogram >::Render(), otb::FullResolutionImageWidget< TPixel >::resize(), itk::fem::FEMRegistrationFilter< TMovingImage, TFixedImage >::SetDeformationField(), otb::VectorDataToLabelImageFilter< TVectorData, TOutputImage >::SetOutputParametersFromImage(), otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetOutputParametersFromImage(), itk::WarpImageFilter< TInputImage, TOutputImage, TDeformationField >::SetOutputParametersFromImage(), itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetOutputParametersFromImage(), itk::PhasedArray3DSpecialCoordinatesImage< TPixel >::TransformContinuousIndexToPhysicalPoint(), itk::PhasedArray3DSpecialCoordinatesImage< TPixel >::TransformIndexToPhysicalPoint(), itk::PhasedArray3DSpecialCoordinatesImage< TPixel >::TransformPhysicalPointToContinuousIndex(), itk::PhasedArray3DSpecialCoordinatesImage< TPixel >::TransformPhysicalPointToIndex(), otb::FullResolutionImageWidget< TPixel >::UpdateOpenGlBufferedRegionRequested(), otb::Curves2DWidget::UpdateSpaceToScreenTransform(), otb::FixedSizeFullImageWidget< TPixel >::wDisplayed(), and itk::ImageSeriesWriter< TInputImage, TOutputImage >::WriteFiles().
|
inline |
Definition at line 143 of file itkImageRegion.h.
|
inline |
Test if an index is inside
Definition at line 175 of file itkImageRegion.h.
Referenced by otb::HistogramCurve< THistogram >::Render(), itk::PhasedArray3DSpecialCoordinatesImage< TPixel >::TransformPhysicalPointToContinuousIndex(), and itk::PhasedArray3DSpecialCoordinatesImage< TPixel >::TransformPhysicalPointToIndex().
|
inline |
Test if a continuous index is inside the region. If ITK_USE_CENTERED_PIXEL_COORDINATES_CONSISTENTLY is on, 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 198 of file itkImageRegion.h.
|
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 232 of file itkImageRegion.h.
|
inline |
Compare two regions.
Definition at line 164 of file itkImageRegion.h.
|
inline |
operator=. ImageRegion is a lightweight object that is not reference counted, so operator= is public.
Definition at line 120 of file itkImageRegion.h.
|
inline |
Compare two regions.
Definition at line 154 of file itkImageRegion.h.
| void itk::ImageRegion< VImageDimension >::PadByRadius | ( | IndexValueType | 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 79 of file itkImageRegion.txx.
Referenced by otb::ImageAlternateViewer< TPixel >::ComputeRequestedRegion().
| void itk::ImageRegion< VImageDimension >::PadByRadius | ( | const IndexValueArrayType | radius | ) |
Definition at line 106 of file itkImageRegion.txx.
| void itk::ImageRegion< VImageDimension >::PadByRadius | ( | const SizeType & | radius | ) |
Definition at line 94 of file itkImageRegion.txx.
|
virtualinherited |
Print the region.
Definition at line 27 of file itkRegion.cxx.
References itk::Indent::GetNextIndent().
Referenced by itk::operator<<(), and itk::ImageIOBase::PrintSelf().
|
protectedvirtualinherited |
Definition at line 36 of file itkRegion.cxx.
|
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 66 of file itkImageRegion.txx.
|
protectedvirtualinherited |
Definition at line 43 of file itkRegion.cxx.
|
inline |
Set the index defining the corner of the region.
Definition at line 124 of file itkImageRegion.h.
Referenced by otb::ImageAlternateViewer< TPixel >::ComputeRequestedRegion(), itk::ImageIORegionAdaptor< VDimension >::Convert(), otb::ImageRegionAdaptativeSplitter< VImageDimension >::EstimateSplitMap(), itk::ImageToImageFilterDetail::ExtractImageFilterCopyRegion(), otb::FixedSizeFullImageWidget< TPixel >::FixedSizeFullImageWidget(), otb::FullResolutionImageWidget< TPixel >::FullResolutionImageWidget(), otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::GenerateData(), otb::ImageAlternateViewer< TPixel >::GetAdditionalBufferRegion(), otb::Rectangle< TValue >::GetBoundingRegion(), otb::SpectralResponse< TPrecision, TValuePrecision >::GetImage(), otb::RemoteSensingRegion< typename VertexType::CoordRepType >::GetImageRegion(), itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::GetJacobian(), otb::ImageWidgetPointForm::GetRegion(), otb::ImageWidgetRectangleForm::GetRegion(), 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(), otb::ImageWidgetBase< TPixel >::ImageWidgetBase(), otb::ImageAlternateViewer< TPixel >::Init(), otb::ImageViewerFullWidget< TPixel, TLabel >::RectangleROISelectionHandle(), otb::ZoomableImageWidget< TPixel >::resize(), otb::FullResolutionImageWidget< TPixel >::resize(), otb::FullResolutionImageWidget< TPixel >::SetUpperLeftCorner(), otb::ZoomableImageWidget< TPixel >::SetZoomFactor(), otb::ZoomableImageWidget< TPixel >::SetZoomUpperLeftCorner(), itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::TransformPoint(), otb::Curves2DWidget::UpdateSpaceToScreenTransform(), and itk::ImageSeriesWriter< TInputImage, TOutputImage >::WriteFiles().
|
inline |
Convenience methods to get and set the index of the particular dimension i.
Definition at line 147 of file itkImageRegion.h.
|
inline |
Set the size of the region. This plus the index determines the rectangular shape, or extent, of the region.
Definition at line 133 of file itkImageRegion.h.
Referenced by otb::ImageAlternateViewer< TPixel >::ComputeRequestedRegion(), itk::ImageIORegionAdaptor< VDimension >::Convert(), otb::ImageRegionAdaptativeSplitter< VImageDimension >::EstimateSplitMap(), itk::ImageToImageFilterDetail::ExtractImageFilterCopyRegion(), otb::FixedSizeFullImageWidget< TPixel >::FixedSizeFullImageWidget(), otb::FullResolutionImageWidget< TPixel >::FullResolutionImageWidget(), otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::GenerateData(), otb::ImageAlternateViewer< TPixel >::GetAdditionalBufferRegion(), otb::Rectangle< TValue >::GetBoundingRegion(), otb::SpectralResponse< TPrecision, TValuePrecision >::GetImage(), otb::RemoteSensingRegion< typename VertexType::CoordRepType >::GetImageRegion(), itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::GetJacobian(), otb::ImageWidgetPointForm::GetRegion(), otb::ImageWidgetRectangleForm::GetRegion(), 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(), otb::ImageWidgetBase< TPixel >::ImageWidgetBase(), otb::ImageViewerFullWidget< TPixel, TLabel >::RectangleROISelectionHandle(), otb::ZoomableImageWidget< TPixel >::resize(), otb::FullResolutionImageWidget< TPixel >::resize(), itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::SetFixedParameters(), itk::Image< BloxBoundaryPointPixel< TImageDimension >, TImageDimension >::SetRegions(), itk::VectorImage< TPixelType, Dimension >::SetRegions(), itk::SpecialCoordinatesImage< TPixel, 3 >::SetRegions(), otb::ZoomableImageWidget< TPixel >::SetZoomFactor(), otb::ZoomableImageWidget< TPixel >::SetZoomUpperLeftCorner(), itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::TransformPoint(), otb::Curves2DWidget::UpdateSpaceToScreenTransform(), and itk::ImageSeriesWriter< TInputImage, TOutputImage >::WriteFiles().
|
inline |
Convenience methods to get and set the size of the particular dimension i.
Definition at line 141 of file itkImageRegion.h.
| ImageRegion< VImageDimension >::SliceRegion itk::ImageRegion< VImageDimension >::Slice | ( | const unsigned long | 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 181 of file itkImageRegion.txx.
References itk::Size< VDimension >::Fill(), and itk::Index< VIndexDimension >::Fill().
|
friend |
Friends of ImageRegion
Definition at line 286 of file itkImageRegion.h.
|
static |
Dimension of the image available at compile time.
Definition at line 66 of file itkImageRegion.h.
|
private |
Definition at line 282 of file itkImageRegion.h.
|
private |
Definition at line 283 of file itkImageRegion.h.
|
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 71 of file itkImageRegion.h.