ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
itk::NthElementImageAdaptor< TImage, TOutputPixelType > Class Template Reference

#include <itkNthElementImageAdaptor.h>

Detailed Description

template<typename TImage, typename TOutputPixelType>
class itk::NthElementImageAdaptor< TImage, TOutputPixelType >

Presents an image as being composed of the N-th element of its pixels.

It assumes that the pixels are of container type and have in their API an operator[]( unsigned int ) defined.

Additional casting is performed according to the input and output image types following C++ default casting rules.

ITK Sphinx Examples:
Examples
SphinxExamples/src/Core/ImageAdaptors/ExtractChannelOfImageWithMultipleComponents/Code.cxx, SphinxExamples/src/Core/ImageAdaptors/ProcessNthComponentOfVectorImage/Code.cxx, SphinxExamples/src/Filtering/CurvatureFlow/SmoothRGBImageUsingCurvatureFlow/Code.cxx, and SphinxExamples/src/Filtering/CurvatureFlow/SmoothRGBImageUsingMinMaxCurvatureFlow/Code.cxx.

Definition at line 58 of file itkNthElementImageAdaptor.h.

+ Inheritance diagram for itk::NthElementImageAdaptor< TImage, TOutputPixelType >:
+ Collaboration diagram for itk::NthElementImageAdaptor< TImage, TOutputPixelType >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = NthElementImageAdaptor
 
using Superclass = typename NthElementImageAdaptorHelper< TImage, TOutputPixelType >::Super
 
- Public Types inherited from itk::ImageAdaptor< TImage, TAccessor >
using AccessorFunctorType = typename InternalImageType::AccessorFunctorType::template Rebind< Self >::Type
 
using AccessorType = TAccessor
 
using ConstPointer = SmartPointer< const Self >
 
using ConstWeakPointer = WeakPointer< const Self >
 
using IndexValueType = typename IndexType::IndexValueType
 
using InternalImageType = TImage
 
using InternalPixelPointerType = InternalPixelType *
 
using InternalPixelType = typename TAccessor::InternalType
 
using IOPixelType = PixelType
 
using OffsetValueType = typename OffsetType::OffsetValueType
 
using PixelContainer = typename TImage::PixelContainer
 
using PixelContainerConstPointer = typename TImage::PixelContainerConstPointer
 
using PixelContainerPointer = typename TImage::PixelContainerPointer
 
using PixelType = typename TAccessor::ExternalType
 
using Pointer = SmartPointer< Self >
 
template<typename UPixelType , unsigned int VUImageDimension = TImage::ImageDimension>
using RebindImageType = itk::Image< UPixelType, VUImageDimension >
 
using Self = ImageAdaptor
 
using SizeValueType = typename SizeType::SizeValueType
 
using Superclass = ImageBase< Self::ImageDimension >
 
- Public Types inherited from itk::ImageBase< TImage::ImageDimension >
using ConstPointer = SmartPointer< const Self >
 
using DirectionType = Matrix< SpacePrecisionType, VImageDimension, VImageDimension >
 
using ImageDimensionType = unsigned int
 
using IndexType = Index< VImageDimension >
 
using IndexValueType = typename IndexType::IndexValueType
 
using OffsetType = Offset< VImageDimension >
 
using OffsetValueType = typename OffsetType::OffsetValueType
 
using Pointer = SmartPointer< Self >
 
using PointType = Point< PointValueType, VImageDimension >
 
using PointValueType = SpacePrecisionType
 
using RegionType = ImageRegion< VImageDimension >
 
using Self = ImageBase
 
using SizeType = Size< VImageDimension >
 
using SizeValueType = typename SizeType::SizeValueType
 
using SpacingType = Vector< SpacingValueType, VImageDimension >
 
using SpacingValueType = SpacePrecisionType
 
using Superclass = DataObject
 
- Public Types inherited from itk::DataObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = std::string
 
using DataObjectPointerArraySizeType = std::vector< Pointer >::size_type
 
using Pointer = SmartPointer< Self >
 
using Self = DataObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

const char * GetNameOfClass () const override
 
void SelectNthElement (unsigned int nth)
 
- Public Member Functions inherited from itk::ImageAdaptor< TImage, TAccessor >
void Allocate (bool initialize=false) override
 
IndexType ComputeIndex (OffsetValueType offset) const
 
void CopyInformation (const DataObject *data) override
 
const RegionTypeGetBufferedRegion () const override
 
InternalPixelTypeGetBufferPointer ()
 
const InternalPixelTypeGetBufferPointer () const
 
const DirectionTypeGetDirection () const override
 
const RegionTypeGetLargestPossibleRegion () const override
 
ModifiedTimeType GetMTime () const override
 
const OffsetValueTypeGetOffsetTable () const
 
const PointTypeGetOrigin () const override
 
PixelType GetPixel (const IndexType &index) const
 
AccessorTypeGetPixelAccessor ()
 
const AccessorTypeGetPixelAccessor () const
 
PixelContainerPointer GetPixelContainer ()
 
const PixelContainerGetPixelContainer () const
 
const RegionTypeGetRequestedRegion () const override
 
const SpacingTypeGetSpacing () const override
 
virtual void Graft (const Self *imgData)
 
void Initialize () override
 
void Modified () const override
 
PixelType operator[] (const IndexType &index) const
 
void PropagateRequestedRegion () override
 
void SetBufferedRegion (const RegionType &region) override
 
void SetDirection (const DirectionType &direction) override
 
virtual void SetImage (TImage *)
 
void SetLargestPossibleRegion (const RegionType &region) override
 
void SetOrigin (const double *origin) override
 
void SetOrigin (const float *origin) override
 
void SetOrigin (const PointType origin) override
 
void SetPixel (const IndexType &index, const PixelType &value)
 
void SetPixelAccessor (const AccessorType &accessor)
 
void SetPixelContainer (PixelContainer *container)
 
void SetRequestedRegion (const DataObject *data) override
 
void SetRequestedRegion (const RegionType &region) override
 
void SetRequestedRegionToLargestPossibleRegion () override
 
void SetSpacing (const double *spacing) override
 
void SetSpacing (const float *spacing) override
 
void SetSpacing (const SpacingType &spacing) override
 
template<typename TCoordRep >
void TransformContinuousIndexToPhysicalPoint (const ContinuousIndex< TCoordRep, Self::ImageDimension > &index, Point< TCoordRep, Self::ImageDimension > &point) const
 
template<typename TCoordRep , typename TIndexRep >
Point< TCoordRep, TImage::ImageDimension > TransformContinuousIndexToPhysicalPoint (const ContinuousIndex< TIndexRep, Self::ImageDimension > &index) const
 
template<typename TCoordRep >
Point< TCoordRep, Self::ImageDimensionTransformIndexToPhysicalPoint (const IndexType &index) const
 
template<typename TCoordRep >
void TransformIndexToPhysicalPoint (const IndexType &index, Point< TCoordRep, Self::ImageDimension > &point) const
 
template<typename TCoordRep >
void TransformLocalVectorToPhysicalVector (const FixedArray< TCoordRep, Self::ImageDimension > &inputGradient, FixedArray< TCoordRep, Self::ImageDimension > &outputGradient) const
 
template<typename TVector >
TVector TransformLocalVectorToPhysicalVector (const TVector &inputGradient) const
 
template<typename TCoordRep >
bool TransformPhysicalPointToContinuousIndex (const Point< TCoordRep, Self::ImageDimension > &point, ContinuousIndex< TCoordRep, Self::ImageDimension > &index) const
 
template<typename TIndexRep , typename TCoordRep >
ContinuousIndex< TIndexRep, TImage::ImageDimension > TransformPhysicalPointToContinuousIndex (const Point< TCoordRep, TImage::ImageDimension > &point) const
 
template<typename TCoordRep >
IndexType TransformPhysicalPointToIndex (const Point< TCoordRep, Self::ImageDimension > &point) const
 
template<typename TCoordRep >
bool TransformPhysicalPointToIndex (const Point< TCoordRep, Self::ImageDimension > &point, IndexType &index) const
 
template<typename TCoordRep >
void TransformPhysicalVectorToLocalVector (const FixedArray< TCoordRep, Self::ImageDimension > &inputGradient, FixedArray< TCoordRep, Self::ImageDimension > &outputGradient) const
 
template<typename TVector >
TVector TransformPhysicalVectorToLocalVector (const TVector &inputGradient) const
 
void Update () override
 
void UpdateOutputData () override
 
void UpdateOutputInformation () override
 
bool VerifyRequestedRegion () override
 
- Public Member Functions inherited from itk::ImageBase< TImage::ImageDimension >
void AllocateInitialized ()
 
OffsetValueType ComputeOffset (const IndexType &ind) const
 
void CopyInformation (const DataObject *data) override
 
virtual const DirectionTypeGetInverseDirection () const
 
const char * GetNameOfClass () const override
 
void Initialize () override
 
bool IsCongruentImageGeometry (const ImageBase *otherImage, double coordinateTolerance, double directionTolerance) const
 
bool IsSameImageGeometryAs (const ImageBase *otherImage, double coordinateTolerance=DefaultImageCoordinateTolerance, double directionTolerance=DefaultImageDirectionTolerance) const
 
bool RequestedRegionIsOutsideOfTheBufferedRegion () override
 
virtual void SetRegions (const SizeType &size)
 
void SetRequestedRegion (const DataObject *data) override
 
void SetRequestedRegionToLargestPossibleRegion () override
 
void TransformLocalVectorToPhysicalVector (const FixedArray< TCoordRep, VImageDimension > &inputGradient, FixedArray< TCoordRep, VImageDimension > &outputGradient) const
 
ContinuousIndex< TIndexRep, VImageDimension > TransformPhysicalPointToContinuousIndex (const Point< TCoordRep, VImageDimension > &point) const
 
bool TransformPhysicalPointToContinuousIndex (const Point< TCoordRep, VImageDimension > &point, ContinuousIndex< TIndexRep, VImageDimension > &index) const
 
bool TransformPhysicalPointToIndex (const Point< TCoordRep, VImageDimension > &point, IndexType &index) const
 
void TransformPhysicalVectorToLocalVector (const FixedArray< TCoordRep, VImageDimension > &inputGradient, FixedArray< TCoordRep, VImageDimension > &outputGradient) const
 
void UpdateOutputData () override
 
void UpdateOutputInformation () override
 
bool VerifyRequestedRegion () override
 
virtual void SetOrigin (const double origin[VImageDimension])
 
virtual void SetOrigin (const float origin[VImageDimension])
 
virtual void SetRegions (const RegionType &region)
 
const OffsetValueTypeGetOffsetTable () const
 
IndexType ComputeIndex (OffsetValueType offset) const
 
virtual void SetSpacing (const double spacing[VImageDimension])
 
virtual void SetSpacing (const float spacing[VImageDimension])
 
IndexType TransformPhysicalPointToIndex (const Point< TCoordRep, VImageDimension > &point) const
 
void TransformContinuousIndexToPhysicalPoint (const ContinuousIndex< TIndexRep, VImageDimension > &index, Point< TCoordRep, VImageDimension > &point) const
 
Point< TCoordRep, VImageDimension > TransformContinuousIndexToPhysicalPoint (const ContinuousIndex< TIndexRep, VImageDimension > &index) const
 
void TransformIndexToPhysicalPoint (const IndexType &index, Point< TCoordRep, VImageDimension > &point) const
 
Point< TCoordRep, VImageDimension > TransformIndexToPhysicalPoint (const IndexType &index) const
 
TVector TransformLocalVectorToPhysicalVector (const TVector &inputGradient) const
 
TVector TransformPhysicalVectorToLocalVector (const TVector &inputGradient) const
 
virtual unsigned int GetNumberOfComponentsPerPixel () const
 
virtual void SetNumberOfComponentsPerPixel (unsigned int)
 
- Public Member Functions inherited from itk::DataObject
virtual void DataHasBeenGenerated ()
 
void DisconnectPipeline ()
 
bool GetDataReleased () const
 
virtual const bool & GetReleaseDataFlag () const
 
SmartPointer< ProcessObjectGetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierTypeGetSourceOutputName () const
 
virtual ModifiedTimeType GetUpdateMTime () const
 
virtual void PrepareForNewData ()
 
void ReleaseData ()
 
virtual void ReleaseDataFlagOn ()
 
virtual void ResetPipeline ()
 
void SetReleaseDataFlag (bool flag)
 
bool ShouldIReleaseData () const
 
void UpdateSource () const
 
void SetPipelineMTime (ModifiedTimeType time)
 
virtual const ModifiedTimeTypeGetPipelineMTime () const
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
virtual const RealTimeStampGetRealTimeStamp () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageAdaptor< TImage, TAccessor >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageBase< TImage::ImageDimension >
static unsigned int GetImageDimension ()
 
static Pointer New ()
 
- Static Public Member Functions inherited from itk::DataObject
static bool GetGlobalReleaseDataFlag ()
 
static void GlobalReleaseDataFlagOff ()
 
static void GlobalReleaseDataFlagOn ()
 
static Pointer New ()
 
static void SetGlobalReleaseDataFlag (bool val)
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

 NthElementImageAdaptor ()=default
 
 ~NthElementImageAdaptor () override=default
 
- Protected Member Functions inherited from itk::ImageAdaptor< TImage, TAccessor >
void Graft (const DataObject *data) override
 
 ImageAdaptor ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ImageAdaptor () override=default
 
- Protected Member Functions inherited from itk::ImageBase< TImage::ImageDimension >
virtual void ComputeIndexToPhysicalPointMatrices ()
 
void ComputeOffsetTable ()
 
void Graft (const DataObject *data) override
 
 ImageBase ()=default
 
virtual void InitializeBufferedRegion ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ImageBase () override=default
 
OffsetValueType FastComputeOffset (const IndexType &ind) const
 
IndexType FastComputeIndex (OffsetValueType offset) const
 
- Protected Member Functions inherited from itk::DataObject
 DataObject ()
 
virtual void PropagateResetPipeline ()
 
 ~DataObject () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Additional Inherited Members

- Static Public Attributes inherited from itk::ImageAdaptor< TImage, TAccessor >
static constexpr unsigned int ImageDimension = TImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageBase< TImage::ImageDimension >
static constexpr ImageDimensionType ImageDimension
 
- Protected Attributes inherited from itk::ImageBase< TImage::ImageDimension >
SpacingType m_Spacing
 
PointType m_Origin
 
DirectionType m_Direction
 
DirectionType m_InverseDirection
 
DirectionType m_IndexToPhysicalPoint
 
DirectionType m_PhysicalPointToIndex
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

template<typename TImage , typename TOutputPixelType >
using itk::NthElementImageAdaptor< TImage, TOutputPixelType >::ConstPointer = SmartPointer<const Self>

Definition at line 67 of file itkNthElementImageAdaptor.h.

◆ Pointer

template<typename TImage , typename TOutputPixelType >
using itk::NthElementImageAdaptor< TImage, TOutputPixelType >::Pointer = SmartPointer<Self>

Definition at line 66 of file itkNthElementImageAdaptor.h.

◆ Self

template<typename TImage , typename TOutputPixelType >
using itk::NthElementImageAdaptor< TImage, TOutputPixelType >::Self = NthElementImageAdaptor

Standard class type aliases.

Definition at line 64 of file itkNthElementImageAdaptor.h.

◆ Superclass

template<typename TImage , typename TOutputPixelType >
using itk::NthElementImageAdaptor< TImage, TOutputPixelType >::Superclass = typename NthElementImageAdaptorHelper<TImage, TOutputPixelType>::Super

Definition at line 65 of file itkNthElementImageAdaptor.h.

Constructor & Destructor Documentation

◆ NthElementImageAdaptor()

template<typename TImage , typename TOutputPixelType >
itk::NthElementImageAdaptor< TImage, TOutputPixelType >::NthElementImageAdaptor ( )
protecteddefault

◆ ~NthElementImageAdaptor()

template<typename TImage , typename TOutputPixelType >
itk::NthElementImageAdaptor< TImage, TOutputPixelType >::~NthElementImageAdaptor ( )
overrideprotecteddefault

Member Function Documentation

◆ GetNameOfClass()

template<typename TImage , typename TOutputPixelType >
const char* itk::NthElementImageAdaptor< TImage, TOutputPixelType >::GetNameOfClass ( ) const
overridevirtual

Run-time type information (and related methods).

Reimplemented from itk::ImageAdaptor< TImage, TAccessor >.

◆ New()

template<typename TImage , typename TOutputPixelType >
static Pointer itk::NthElementImageAdaptor< TImage, TOutputPixelType >::New ( )
static

Method for creation through the object factory.

◆ SelectNthElement()

template<typename TImage , typename TOutputPixelType >
void itk::NthElementImageAdaptor< TImage, TOutputPixelType >::SelectNthElement ( unsigned int  nth)
inline

Select the element number to be accessed

Definition at line 77 of file itkNthElementImageAdaptor.h.


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