ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | List of all members
itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare > Class Template Reference

#include <itkLabelImageGaussianInterpolateImageFunction.h>

+ Inheritance diagram for itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >:
+ Collaboration diagram for itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >:

Public Types

using ArrayType = typename Superclass::ArrayType
 
using ConstPointer = SmartPointer< const Self >
 
using ContinuousIndexType = typename Superclass::ContinuousIndexType
 
using IndexType = typename Superclass::IndexType
 
using InputImageType = typename Superclass::InputImageType
 
using InputPixelType = typename TInputImage::PixelType
 
using OutputType = typename Superclass::OutputType
 
using Pointer = SmartPointer< Self >
 
using RealType = typename Superclass::RealType
 
using Self = LabelImageGaussianInterpolateImageFunction
 
using Superclass = GaussianInterpolateImageFunction< TInputImage, TCoordRep >
 
- Public Types inherited from itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >
using ArrayType = FixedArray< RealType, ImageDimension >
 
using ConstPointer = SmartPointer< const Self >
 
using ContinuousIndexType = typename Superclass::ContinuousIndexType
 
using IndexType = typename Superclass::IndexType
 
using InputImageType = typename Superclass::InputImageType
 
using OutputType = typename Superclass::OutputType
 
using Pointer = SmartPointer< Self >
 
using RealType = typename Superclass::RealType
 
using Self = GaussianInterpolateImageFunction
 
using SizeType = typename Superclass::SizeType
 
using Superclass = InterpolateImageFunction< TInputImage, TCoordRep >
 
- Public Types inherited from itk::InterpolateImageFunction< TInputImage, TCoordRep >
using ConstPointer = SmartPointer< const Self >
 
using ContinuousIndexType = typename Superclass::ContinuousIndexType
 
using IndexType = typename Superclass::IndexType
 
using IndexValueType = typename Superclass::IndexValueType
 
using InputImageType = typename Superclass::InputImageType
 
using OutputType = typename Superclass::OutputType
 
using Pointer = SmartPointer< Self >
 
using PointType = typename Superclass::PointType
 
using RealType = typename NumericTraits< typename TInputImage::PixelType >::RealType
 
using Self = InterpolateImageFunction
 
using SizeType = typename InputImageType::SizeType
 
using Superclass = ImageFunction< TInputImage, typename NumericTraits< typename TInputImage::PixelType >::RealType, TCoordRep >
 
- Public Types inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
using ConstPointer = SmartPointer< const Self >
 
using ContinuousIndexType = ContinuousIndex< TCoordRep, Self::ImageDimension >
 
using CoordRepType = TCoordRep
 
using IndexType = typename InputImageType::IndexType
 
using IndexValueType = typename InputImageType::IndexValueType
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImageType = TInputImage
 
using InputPixelType = typename InputImageType::PixelType
 
using OutputType = NumericTraits< TInputImage::PixelType >::RealType
 
using Pointer = SmartPointer< Self >
 
using PointType = Point< TCoordRep, Self::ImageDimension >
 
using Self = ImageFunction
 
using Superclass = FunctionBase< Point< TCoordRep, Self::ImageDimension >, NumericTraits< TInputImage::PixelType >::RealType >
 
- Public Types inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, NumericTraits< TInputImage::PixelType >::RealType >
using ConstPointer = SmartPointer< const Self >
 
using InputType = Point< TCoordRep, TInputImage::ImageDimension >
 
using OutputType = NumericTraits< TInputImage::PixelType >::RealType
 
using Pointer = SmartPointer< Self >
 
using Self = FunctionBase
 
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

virtual ::itk::LightObject::Pointer CreateAnother () const
 
OutputType EvaluateAtContinuousIndex (const ContinuousIndexType &cindex) const override
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >
void SetInputImage (const TInputImage *image) override
 
virtual void SetSigma (const ArrayType s)
 
virtual void SetSigma (RealType *s)
 
virtual ArrayType GetSigma () const
 
virtual void SetAlpha (const RealType a)
 
virtual RealType GetAlpha () const
 
virtual void SetParameters (RealType *sigma, RealType alpha)
 
SizeType GetRadius () const override
 
- Public Member Functions inherited from itk::InterpolateImageFunction< TInputImage, TCoordRep >
OutputType Evaluate (const PointType &point) const override
 
OutputType EvaluateAtIndex (const IndexType &index) const override
 
- Public Member Functions inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
NumericTraits< TInputImage::PixelType >::RealType Evaluate (const PointType &point) const override=0
 
virtual NumericTraits< TInputImage::PixelType >::RealType EvaluateAtContinuousIndex (const ContinuousIndexType &index) const=0
 
virtual NumericTraits< TInputImage::PixelType >::RealType EvaluateAtIndex (const IndexType &index) const=0
 
const InputImageTypeGetInputImage () const
 
virtual bool IsInsideBuffer (const IndexType &index) const
 
virtual bool IsInsideBuffer (const ContinuousIndexType &index) const
 
virtual bool IsInsideBuffer (const PointType &point) const
 
void ConvertPointToNearestIndex (const PointType &point, IndexType &index) const
 
void ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const
 
void ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const
 
virtual const IndexTypeGetStartIndex () const
 
virtual const IndexTypeGetEndIndex () const
 
virtual const ContinuousIndexTypeGetStartContinuousIndex () const
 
virtual const ContinuousIndexTypeGetEndContinuousIndex () 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
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () 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::GaussianInterpolateImageFunction< TInputImage, TCoordRep >
static Pointer New ()
 
- 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 ()
 

Static Public Attributes

static constexpr unsigned int ImageDimension = TInputImage::ImageDimension
 
- Static Public Attributes inherited from itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >
static constexpr unsigned int ImageDimension = TInputImage::ImageDimension
 
- Static Public Attributes inherited from itk::InterpolateImageFunction< TInputImage, TCoordRep >
static constexpr unsigned int ImageDimension = Superclass::ImageDimension
 
- Static Public Attributes inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
static constexpr unsigned int ImageDimension
 

Protected Member Functions

 LabelImageGaussianInterpolateImageFunction ()=default
 
 ~LabelImageGaussianInterpolateImageFunction () override=default
 
- Protected Member Functions inherited from itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >
 GaussianInterpolateImageFunction ()
 
 ~GaussianInterpolateImageFunction () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void ComputeBoundingBox ()
 
RegionType ComputeInterpolationRegion (const ContinuousIndexType &) const
 
virtual void ComputeErrorFunctionArray (const RegionType &region, unsigned int dimension, RealType cindex, vnl_vector< RealType > &erfArray, vnl_vector< RealType > &gerfArray, bool evaluateGradient=false) const
 
virtual void SetBoundingBoxStart (ArrayType _arg)
 
virtual ArrayType GetBoundingBoxStart () const
 
virtual void SetBoundingBoxEnd (ArrayType _arg)
 
virtual ArrayType GetBoundingBoxEnd () const
 
virtual void SetCutOffDistance (ArrayType _arg)
 
virtual ArrayType GetCutOffDistance () const
 
- Protected Member Functions inherited from itk::InterpolateImageFunction< TInputImage, TCoordRep >
 InterpolateImageFunction ()=default
 
 ~InterpolateImageFunction () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
- Protected Member Functions inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
 ImageFunction ()
 
 ~ImageFunction () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
- Protected Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, NumericTraits< TInputImage::PixelType >::RealType >
 FunctionBase ()=default
 
 ~FunctionBase () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
- 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 ()
 

Private Member Functions

OutputType EvaluateAtContinuousIndex (const ContinuousIndexType &, OutputType *) const override
 

Additional Inherited Members

- Protected Types inherited from itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >
using RegionType = ImageRegion< ImageDimension >
 
- Protected Attributes inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
InputImageConstPointer m_Image
 
IndexType m_StartIndex
 
IndexType m_EndIndex
 
ContinuousIndexType m_StartContinuousIndex
 
ContinuousIndexType m_EndContinuousIndex
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

template<typename TInputImage, typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>
class itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >

Interpolation function for multi-label images that implicitly smooths each unique value in the image corresponding to each label set element and returns the corresponding label set element with the largest weight.

This filter is an alternative to nearest neighbor interpolation for multi-label images. Given a multi-label image I with label set L, this function returns a label at the non-voxel position I(x), based on the following rule

\[ I(x) = \arg\max_{l \in L} (G_\sigma * I_l)(x) \]

Where $ I_l $ is the l-th binary component of the multilabel image. In other words, each label in the multi-label image is convolved with a Gaussian, and the label for which the response is largest is returned. For sigma=0, this is just nearest neighbor interpolation.

This class defines an N-dimensional Gaussian interpolation function for label using the vnl error function. The two parameters associated with this function are:

Note
The input image can be of any type, but the number of unique intensity values in the image will determine the amount of memory needed to complete each interpolation.
Author
Paul Yushkevich
Nick Tustison
ITK Sphinx Examples:
Examples
SphinxExamples/src/Core/ImageFunction/ResampleSegmentedImage/Code.cxx.

Definition at line 72 of file itkLabelImageGaussianInterpolateImageFunction.h.

Member Typedef Documentation

◆ ArrayType

template<typename TInputImage , typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>
using itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >::ArrayType = typename Superclass::ArrayType

Array type alias support

Definition at line 110 of file itkLabelImageGaussianInterpolateImageFunction.h.

◆ ConstPointer

template<typename TInputImage , typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>
using itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >::ConstPointer = SmartPointer<const Self>

◆ ContinuousIndexType

template<typename TInputImage , typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>
using itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >::ContinuousIndexType = typename Superclass::ContinuousIndexType

ContinuousIndex type alias support

Definition at line 107 of file itkLabelImageGaussianInterpolateImageFunction.h.

◆ IndexType

template<typename TInputImage , typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>
using itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >::IndexType = typename Superclass::IndexType

Index type alias support

Definition at line 104 of file itkLabelImageGaussianInterpolateImageFunction.h.

◆ InputImageType

template<typename TInputImage , typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>
using itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >::InputImageType = typename Superclass::InputImageType

InputImageType type alias support

Definition at line 98 of file itkLabelImageGaussianInterpolateImageFunction.h.

◆ InputPixelType

template<typename TInputImage , typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>
using itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >::InputPixelType = typename TInputImage::PixelType

◆ OutputType

template<typename TInputImage , typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>
using itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >::OutputType = typename Superclass::OutputType

OutputType type alias support

Definition at line 95 of file itkLabelImageGaussianInterpolateImageFunction.h.

◆ Pointer

template<typename TInputImage , typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>
using itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >::Pointer = SmartPointer<Self>

◆ RealType

template<typename TInputImage , typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>
using itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >::RealType = typename Superclass::RealType

RealType type alias support

Definition at line 101 of file itkLabelImageGaussianInterpolateImageFunction.h.

◆ Self

template<typename TInputImage , typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>
using itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >::Self = LabelImageGaussianInterpolateImageFunction

Standard class type aliases.

Definition at line 79 of file itkLabelImageGaussianInterpolateImageFunction.h.

◆ Superclass

template<typename TInputImage , typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>
using itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >::Superclass = GaussianInterpolateImageFunction<TInputImage, TCoordRep>

Constructor & Destructor Documentation

◆ LabelImageGaussianInterpolateImageFunction()

template<typename TInputImage , typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>
itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >::LabelImageGaussianInterpolateImageFunction ( )
protecteddefault

◆ ~LabelImageGaussianInterpolateImageFunction()

template<typename TInputImage , typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>
itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >::~LabelImageGaussianInterpolateImageFunction ( )
overrideprotecteddefault

Member Function Documentation

◆ CreateAnother()

template<typename TInputImage , typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>
virtual::itk::LightObject::Pointer itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >.

◆ EvaluateAtContinuousIndex() [1/2]

template<typename TInputImage , typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>
OutputType itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >::EvaluateAtContinuousIndex ( const ContinuousIndexType ,
OutputType  
) const
overrideprivatevirtual

Evaluate function value at the given index

Reimplemented from itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >.

◆ EvaluateAtContinuousIndex() [2/2]

template<typename TInputImage , typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>
OutputType itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >::EvaluateAtContinuousIndex ( const ContinuousIndexType cindex) const
inlineoverridevirtual

Evaluate at the given index

Reimplemented from itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >.

Definition at line 116 of file itkLabelImageGaussianInterpolateImageFunction.h.

◆ GetNameOfClass()

template<typename TInputImage , typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>
virtual const char* itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >.

◆ New()

template<typename TInputImage , typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>
static Pointer itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >::New ( )
static

Method for creation through the object factory.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>
constexpr unsigned int itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >::ImageDimension = TInputImage::ImageDimension
staticconstexpr

ImageDimension constant

Definition at line 92 of file itkLabelImageGaussianInterpolateImageFunction.h.


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