 |
Orfeo Toolbox
3.16
|
|
Orfeo Toolbox
3.16
|
Represent a n-dimensional index in a n-dimensional image. More...
#include <itkIndex.h>
Inheritance diagram for itk::Index< VIndexDimension >:Public Types | |
| typedef Index< VIndexDimension > | IndexType |
| typedef long | IndexValueType |
| typedef Functor::IndexLexicographicCompare < VIndexDimension > | LexicographicCompare |
| typedef Offset< VIndexDimension > | OffsetType |
| typedef OffsetType::OffsetValueType | OffsetValueType |
| typedef Index | Self |
| typedef Size< VIndexDimension > | SizeType |
Public Member Functions | |
| template<class TCoordRep > | |
| void | CopyWithCast (const FixedArray< TCoordRep, VIndexDimension > &point) |
| template<class TCoordRep > | |
| void | CopyWithRound (const FixedArray< TCoordRep, VIndexDimension > &point) |
| void | Fill (IndexValueType value) |
| IndexValueType | GetElement (unsigned long element) const |
| const IndexValueType * | GetIndex () const |
| bool | operator!= (const Self &vec) const |
| const Self | operator* (const SizeType &vec) const |
| const Self | operator+ (const SizeType &size) const |
| const Self | operator+ (const OffsetType &offset) const |
| const Self & | operator+= (const SizeType &size) |
| const Self & | operator+= (const OffsetType &offset) |
| const Self | operator- (const SizeType &size) const |
| const Self | operator- (const OffsetType &off) const |
| const OffsetType | operator- (const Self &vec) const |
| const Self & | operator-= (const SizeType &size) |
| const Self & | operator-= (const OffsetType &offset) |
| bool | operator== (const Self &vec) const |
| IndexValueType & | operator[] (unsigned int dim) |
| IndexValueType | operator[] (unsigned int dim) const |
| void | SetElement (unsigned long element, IndexValueType val) |
| void | SetIndex (const IndexValueType val[VIndexDimension]) |
Static Public Member Functions | |
| static Self | GetBasisIndex (unsigned int dim) |
| static unsigned int | GetIndexDimension () |
Public Attributes | |
| IndexValueType | m_Index [VIndexDimension] |
Represent a n-dimensional index in a n-dimensional image.
Index is a templated class to represent a multi-dimensional index, i.e. (i,j,k,...). Index is templated over the dimension of the index. ITK assumes the first element of an index is the fastest moving index.
For efficiency sake, Index does not define a default constructor, a copy constructor, or an operator=. We rely on the compiler to provide efficient bitwise copies.
Index is an "aggregate" class. Its data is public (m_Index) allowing for fast and convenient instantiations/assignments.
The following syntax for assigning an index is allowed/suggested:
Index<3> index = {{5, 2, 7}};
The double braces {{ and }} are needed to prevent a compiler warning about a partly bracketed initializer.
Definition at line 68 of file itkIndex.h.
| typedef Index<VIndexDimension> itk::Index< VIndexDimension >::IndexType |
Compatible Index and value typedef
Definition at line 74 of file itkIndex.h.
| typedef long itk::Index< VIndexDimension >::IndexValueType |
Definition at line 75 of file itkIndex.h.
| typedef Functor::IndexLexicographicCompare<VIndexDimension> itk::Index< VIndexDimension >::LexicographicCompare |
Lexicographic ordering functor type.
Definition at line 88 of file itkIndex.h.
| typedef Offset<VIndexDimension> itk::Index< VIndexDimension >::OffsetType |
Compatible Offset and Offset value typedef.
Definition at line 84 of file itkIndex.h.
| typedef OffsetType::OffsetValueType itk::Index< VIndexDimension >::OffsetValueType |
Definition at line 85 of file itkIndex.h.
| typedef Index itk::Index< VIndexDimension >::Self |
Standard class typedefs.
Definition at line 71 of file itkIndex.h.
| typedef Size<VIndexDimension> itk::Index< VIndexDimension >::SizeType |
Compatible Size typedef.
Definition at line 81 of file itkIndex.h.
|
inline |
Copy values from a FixedArray by casting each one of the components
Definition at line 280 of file itkIndex.h.
|
inline |
Copy values from a FixedArray by rounding each one of the components
Definition at line 266 of file itkIndex.h.
|
inline |
Set one value for the index in all dimensions. Useful for initializing an offset to zero.
Definition at line 254 of file itkIndex.h.
Referenced by itk::MRFImageFilter< TInputImage, TClassifiedImage >::Allocate(), itk::BresenhamLine< VDimension >::BuildLine(), itk::DeformableSimplexMesh3DGradientConstraintForceFilter< TInputMesh, TOutputMesh >::ComputeExternalForce(), itk::BalloonForceFilter< TInputMesh, TOutputMesh >::ComputeForce(), itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::ComputeUpdate(), itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::ConstNeighborhoodIterator(), itk::ImageIORegionAdaptor< VDimension >::Convert(), otb::ForwardFourierMellinTransformImageFilter< TPixel, TInterpol, Dimension >::GenerateOutputInformation(), otb::Rectangle< TValue >::GetBoundingRegion(), itk::KLMRegionGrowImageFilter< TInputImage, TOutputImage >::GetLabelledImage(), otb::ImageWidgetBoxForm::ImageWidgetBoxForm(), otb::ImageWidgetPointForm::ImageWidgetPointForm(), otb::ImageWidgetRectangleForm::ImageWidgetRectangleForm(), itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::Initialize(), otb::Functor::LabelObjectToPolygonFunctor< TLabelObject, TPolygon >::LabelObjectToPolygonFunctor(), itk::MetaImageConverter< NDimensions, PixelType >::MetaImageToImageMaskSpatialObject(), itk::MetaImageConverter< NDimensions, PixelType >::MetaImageToImageSpatialObject(), itk::ImageSpatialObject< TDimension, TPixelType >::SetImage(), and itk::ImageRegion< VImageDimension >::Slice().
|
static |
Return a basis vector of the form [0, ..., 0, 1, 0, ... 0] where the "1" is positioned in the location specified by the parameter "dim". Valid values of "dim" are 0, ..., VIndexDimension-1.
Definition at line 332 of file itkIndex.h.
References itk::Index< VIndexDimension >::m_Index.
|
inline |
Gets the value of one of the elements in the index. This method is mainly intended to facilitate the access to elements from Tcl and Python where C++ notation is not very convenient.
Definition at line 244 of file itkIndex.h.
Referenced by itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::ThreadedGenerateData().
|
inline |
Get the index. This provides a read only reference to the index.
Definition at line 220 of file itkIndex.h.
Referenced by itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::CollapsePhiLattice(), itk::ImageBase< ::itk::GetImageDimension< TImage >::ImageDimension >::ComputeIndex(), otb::ImageToSIFTKeyPointSetFilter< TInputImage, TOutputPointSet >::ComputeKeyPointDescriptor(), otb::ImageToSIFTKeyPointSetFilter< TInputImage, TOutputPointSet >::ComputeKeyPointOrientations(), itk::ImageBase< ::itk::GetImageDimension< TImage >::ImageDimension >::ComputeOffset(), otb::ImageToImageRCC8Calculator< TInputImage >::ConvertToBoolImage(), itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::Evaluate(), itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::EvaluateGradient(), itk::DifferenceOfGaussiansGradientImageFilter< TInputImage, TDataType >::GenerateData(), itk::DirectFourierReconstructionImageToImageFilter< TInputPixelType, TOutputPixelType >::GenerateData(), otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::GenerateData(), itk::HistogramToImageFilter< THistogram, TFunction >::GenerateData(), itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::GenerateData(), itk::ActiveShapeModelCalculator< TImage >::GenerateData(), otb::SparseUnmixingImageFilter< TInputImage, TOutputImage, VNbInputImage, TPrecision, TMotherWaveletOperator >::GenerateNumberOfComponentsRequired(), itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::GenerateOutputImageFast(), itk::DirectFourierReconstructionImageToImageFilter< TInputPixelType, TOutputPixelType >::GenerateOutputInformation(), itk::TileImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation(), itk::LabelObject< TLabel, VImageDimension >::GetIndex(), itk::HoughTransform2DLinesImageFilter< TInputPixelType, TOutputPixelType >::GetLines(), itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::Initialize(), itk::LabelObject< TLabel, VImageDimension >::Optimize(), itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::RefineControlPointLattice(), itk::SpatialObject< TDimension >::RequestedRegionIsOutsideOfTheBufferedRegion(), itk::ImageBase< VImageDimension >::RequestedRegionIsOutsideOfTheBufferedRegion(), itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::SetBound(), itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::ThreadedGenerateData(), itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::UpdatePointSet(), itk::SpatialObject< TDimension >::VerifyRequestedRegion(), and itk::ImageBase< VImageDimension >::VerifyRequestedRegion().
|
inlinestatic |
Get the dimension (size) of the index.
Definition at line 78 of file itkIndex.h.
|
inline |
Compare two indices.
Definition at line 199 of file itkIndex.h.
|
inline |
Multiply an index by a size (elementwise product). This method models a random access Index.
Definition at line 179 of file itkIndex.h.
|
inline |
Add a size to an index. This method models a random access Index.
Definition at line 92 of file itkIndex.h.
|
inline |
Add an offset to an index.
Definition at line 130 of file itkIndex.h.
|
inline |
Increment index by a size. This method models a random access Index.
Definition at line 102 of file itkIndex.h.
|
inline |
Increment index by an offset. This method models a random access Index.
Definition at line 140 of file itkIndex.h.
|
inline |
Subtract a size from an index. This method models a random access Index.
Definition at line 111 of file itkIndex.h.
|
inline |
Subtract an offset from an index.
Definition at line 158 of file itkIndex.h.
|
inline |
Subtract two indices. This method models a random access Index.
Definition at line 168 of file itkIndex.h.
|
inline |
Decrement index by a size. This method models a random access Index.
Definition at line 121 of file itkIndex.h.
|
inline |
Decrement index by an offset. This method models a random access Index.
Definition at line 149 of file itkIndex.h.
|
inline |
Compare two indices.
Definition at line 189 of file itkIndex.h.
|
inline |
Access an element of the index. Elements are numbered 0, ..., VIndexDimension-1. No bounds checking is performed.
Definition at line 209 of file itkIndex.h.
|
inline |
Access an element of the index. Elements are numbered 0, ..., VIndexDimension-1. This version can only be an rvalue. No bounds checking is performed.
Definition at line 215 of file itkIndex.h.
|
inline |
Sets the value of one of the elements in the index. This method is mainly intended to facilitate the access to elements from Tcl and Python where C++ notation is not very convenient.
Definition at line 235 of file itkIndex.h.
|
inline |
Set the index. Try to prototype this function so that val has to point to a block of memory that is the appropriate size.
Definition at line 226 of file itkIndex.h.
Referenced by otb::ImageToPathListAlignFilter< TInputImage, TOutputPath >::AngleCalculate(), otb::ImageToSIFTKeyPointSetFilter< TInputImage, TOutputPointSet >::ComputeKeyPointDescriptor(), otb::ImageToSIFTKeyPointSetFilter< TInputImage, TOutputPointSet >::ComputeKeyPointOrientations(), itk::GaussianBlurImageFunction< TInputImage, TOutput >::EvaluateAtIndex(), itk::DirectFourierReconstructionImageToImageFilter< TInputPixelType, TOutputPixelType >::GenerateData(), itk::FFTComplexConjugateToRealImageFilter< TPixel, VDimension >::GenerateOutputInformation(), itk::FFTComplexToComplexImageFilter< TPixel, NDimension >::GenerateOutputInformation(), itk::DirectFourierReconstructionImageToImageFilter< TInputPixelType, TOutputPixelType >::GenerateOutputInformation(), itk::Octree< TPixel, ColorTableSize, MappingFunctionType >::GetImage(), itk::fem::ImageMetricLoad< TMoving, TFixed >::GetPolynomialFitToMetric(), itk::fem::ImageMetricLoad< TMoving, TFixed >::MetricFiniteDiff(), and itk::watershed::Segmenter< TInputImage >::UpdateOutputInformation().
| IndexValueType itk::Index< VIndexDimension >::m_Index[VIndexDimension] |
Index is an "aggregate" class. Its data is public (m_Index) allowing for fast and convenient instantiations/assignments.
The following syntax for assigning an index is allowed/suggested: Index<3> index = {5, 2, 7};
Definition at line 262 of file itkIndex.h.
Referenced by itk::Index< itkGetStaticConstMacro(Dimension)>::CopyWithCast(), itk::Index< itkGetStaticConstMacro(Dimension)>::CopyWithRound(), itk::Index< itkGetStaticConstMacro(Dimension)>::Fill(), itk::Index< VIndexDimension >::GetBasisIndex(), itk::Index< itkGetStaticConstMacro(Dimension)>::GetElement(), itk::Index< itkGetStaticConstMacro(Dimension)>::GetIndex(), itk::Index< itkGetStaticConstMacro(Dimension)>::operator!=(), itk::Functor::IndexLexicographicCompare< VIndexDimension >::operator()(), itk::Index< itkGetStaticConstMacro(Dimension)>::operator*(), itk::Index< itkGetStaticConstMacro(Dimension)>::operator+(), itk::Index< itkGetStaticConstMacro(Dimension)>::operator+=(), itk::Index< itkGetStaticConstMacro(Dimension)>::operator-(), itk::Index< itkGetStaticConstMacro(Dimension)>::operator-=(), itk::Index< itkGetStaticConstMacro(Dimension)>::operator==(), itk::Index< itkGetStaticConstMacro(Dimension)>::operator[](), itk::Index< itkGetStaticConstMacro(Dimension)>::SetElement(), and itk::Index< itkGetStaticConstMacro(Dimension)>::SetIndex().
