ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate > Class Template Reference
Data Processing Objects » Functions » Image FunctionsGroup Core » | Module ITKImageFunction

#include <itkRayCastInterpolateImageFunction.h>

Detailed Description

template<typename TInputImage, typename TCoordinate = double>
class itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >

Projective interpolation of an image at specified positions.

RayCastInterpolateImageFunction casts rays through a 3-dimensional image and uses bilinear interpolation to integrate each plane of voxels traversed.

Warning
This interpolator works for 3-dimensional images only.
Examples
Examples/Filtering/DigitallyReconstructedRadiograph1.cxx.

Definition at line 41 of file itkRayCastInterpolateImageFunction.h.

+ Inheritance diagram for itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >:
+ Collaboration diagram for itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using DirectionType = Vector< TCoordinate, 3 >
 
using InputPointType = typename TransformType::InputPointType
 
using InterpolatorPointer = typename InterpolatorType::Pointer
 
using InterpolatorType = InterpolateImageFunction< TInputImage, TCoordinate >
 
using OutputPointType = typename TransformType::OutputPointType
 
using PixelType = typename Superclass::InputPixelType
 
using Pointer = SmartPointer< Self >
 
using Self = RayCastInterpolateImageFunction
 
using SizeType = typename TInputImage::SizeType
 
using Superclass = InterpolateImageFunction< TInputImage, TCoordinate >
 
using TransformJacobianType = typename TransformType::JacobianType
 
using TransformParametersType = typename TransformType::ParametersType
 
using TransformPointer = typename TransformType::Pointer
 
using TransformType = Transform< TCoordinate, 3, 3 >
 
- Public Types inherited from itk::InterpolateImageFunction< TInputImage, TCoordinate >
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
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, TCoordinate >
 
- Public Types inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordinate >
using ConstPointer = SmartPointer< const Self >
 
using ContinuousIndexType = ContinuousIndex< TCoordinate, Self::ImageDimension >
 
using CoordinateType = TCoordinate
 
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< TCoordinate, Self::ImageDimension >
 
using Self = ImageFunction
 
using Superclass = FunctionBase< Point< TCoordinate, Self::ImageDimension >, NumericTraits< TInputImage::PixelType >::RealType >
 
- Public Types inherited from itk::FunctionBase< Point< TCoordinate, TInputImage::ImageDimension >, NumericTraits< TInputImage::PixelType >::RealType >
using ConstPointer = SmartPointer< const Self >
 
using InputType = Point< TCoordinate, 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

OutputType Evaluate (const PointType &point) const override
 
OutputType EvaluateAtContinuousIndex (const ContinuousIndexType &index) const override
 
virtual InterpolatorType * GetModifiableInterpolator ()
 
const char * GetNameOfClass () const override
 
SizeType GetRadius () const override
 
bool IsInsideBuffer (const ContinuousIndexType &) const override
 
bool IsInsideBuffer (const IndexType &) const override
 
bool IsInsideBuffer (const PointType &) const override
 
virtual void SetInterpolator (InterpolatorType *_arg)
 
virtual void SetTransform (TransformType *_arg)
 
virtual TransformType * GetModifiableTransform ()
 
virtual void SetFocalPoint (InputPointType _arg)
 
virtual InputPointType GetFocalPoint () const
 
virtual void SetThreshold (double _arg)
 
virtual double GetThreshold () const
 
- Public Member Functions inherited from itk::InterpolateImageFunction< TInputImage, TCoordinate >
OutputType EvaluateAtIndex (const IndexType &index) const override
 
- Public Member Functions inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordinate >
void ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const
 
void ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const
 
virtual const ContinuousIndexType & GetEndContinuousIndex () const
 
virtual const IndexType & GetEndIndex () const
 
const InputImageType * GetInputImage () const
 
const char * GetNameOfClass () const override
 
virtual const ContinuousIndexType & GetStartContinuousIndex () const
 
virtual const IndexType & GetStartIndex () const
 
virtual void SetInputImage (const InputImageType *ptr)
 
void ConvertPointToNearestIndex (const PointType &point, IndexType &index) const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) 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
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStamp & GetTimeStamp () 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) const
 
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::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 = Superclass::ImageDimension
 
static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension
 
- Static Public Attributes inherited from itk::InterpolateImageFunction< TInputImage, TCoordinate >
static constexpr unsigned int ImageDimension = Superclass::ImageDimension
 
- Static Public Attributes inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordinate >
static constexpr unsigned int ImageDimension
 

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const override
 
 RayCastInterpolateImageFunction ()
 
 ~RayCastInterpolateImageFunction () override=default
 
- Protected Member Functions inherited from itk::InterpolateImageFunction< TInputImage, TCoordinate >
 InterpolateImageFunction ()=default
 
 ~InterpolateImageFunction () override=default
 
- Protected Member Functions inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordinate >
 ImageFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ImageFunction () override=default
 
- Protected Member Functions inherited from itk::FunctionBase< Point< TCoordinate, TInputImage::ImageDimension >, NumericTraits< TInputImage::PixelType >::RealType >
 FunctionBase ()=default
 
 ~FunctionBase () override=default
 
- 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 ()
 

Protected Attributes

InputPointType m_FocalPoint {}
 
InterpolatorPointer m_Interpolator {}
 
double m_Threshold {}
 
TransformPointer m_Transform {}
 
- Protected Attributes inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordinate >
ContinuousIndexType m_EndContinuousIndex
 
IndexType m_EndIndex
 
InputImageConstPointer m_Image
 
ContinuousIndexType m_StartContinuousIndex
 
IndexType m_StartIndex
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TCoordinate = double>
using itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::ConstPointer = SmartPointer<const Self>

Definition at line 50 of file itkRayCastInterpolateImageFunction.h.

◆ DirectionType

template<typename TInputImage , typename TCoordinate = double>
using itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::DirectionType = Vector<TCoordinate, 3>

Definition at line 71 of file itkRayCastInterpolateImageFunction.h.

◆ InputPointType

template<typename TInputImage , typename TCoordinate = double>
using itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::InputPointType = typename TransformType::InputPointType

Definition at line 62 of file itkRayCastInterpolateImageFunction.h.

◆ InterpolatorPointer

template<typename TInputImage , typename TCoordinate = double>
using itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::InterpolatorPointer = typename InterpolatorType::Pointer

Definition at line 76 of file itkRayCastInterpolateImageFunction.h.

◆ InterpolatorType

template<typename TInputImage , typename TCoordinate = double>
using itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::InterpolatorType = InterpolateImageFunction<TInputImage, TCoordinate>

Type of the Interpolator Base class

Definition at line 74 of file itkRayCastInterpolateImageFunction.h.

◆ OutputPointType

template<typename TInputImage , typename TCoordinate = double>
using itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::OutputPointType = typename TransformType::OutputPointType

Definition at line 63 of file itkRayCastInterpolateImageFunction.h.

◆ PixelType

template<typename TInputImage , typename TCoordinate = double>
using itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::PixelType = typename Superclass::InputPixelType

Definition at line 67 of file itkRayCastInterpolateImageFunction.h.

◆ Pointer

template<typename TInputImage , typename TCoordinate = double>
using itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::Pointer = SmartPointer<Self>

Definition at line 49 of file itkRayCastInterpolateImageFunction.h.

◆ Self

template<typename TInputImage , typename TCoordinate = double>
using itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::Self = RayCastInterpolateImageFunction

Standard class type aliases.

Definition at line 47 of file itkRayCastInterpolateImageFunction.h.

◆ SizeType

template<typename TInputImage , typename TCoordinate = double>
using itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::SizeType = typename TInputImage::SizeType

Definition at line 69 of file itkRayCastInterpolateImageFunction.h.

◆ Superclass

template<typename TInputImage , typename TCoordinate = double>
using itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::Superclass = InterpolateImageFunction<TInputImage, TCoordinate>

Definition at line 48 of file itkRayCastInterpolateImageFunction.h.

◆ TransformJacobianType

template<typename TInputImage , typename TCoordinate = double>
using itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::TransformJacobianType = typename TransformType::JacobianType

Definition at line 65 of file itkRayCastInterpolateImageFunction.h.

◆ TransformParametersType

template<typename TInputImage , typename TCoordinate = double>
using itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::TransformParametersType = typename TransformType::ParametersType

Definition at line 64 of file itkRayCastInterpolateImageFunction.h.

◆ TransformPointer

template<typename TInputImage , typename TCoordinate = double>
using itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::TransformPointer = typename TransformType::Pointer

Definition at line 61 of file itkRayCastInterpolateImageFunction.h.

◆ TransformType

template<typename TInputImage , typename TCoordinate = double>
using itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::TransformType = Transform<TCoordinate, 3, 3>

Type of the Transform Base class The fixed image should be a 3D image

Definition at line 59 of file itkRayCastInterpolateImageFunction.h.

Constructor & Destructor Documentation

◆ RayCastInterpolateImageFunction()

template<typename TInputImage , typename TCoordinate = double>
itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::RayCastInterpolateImageFunction ( )
protected

◆ ~RayCastInterpolateImageFunction()

template<typename TInputImage , typename TCoordinate = double>
itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::~RayCastInterpolateImageFunction ( )
overrideprotecteddefault

Member Function Documentation

◆ Evaluate()

template<typename TInputImage , typename TCoordinate = double>
OutputType itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::Evaluate ( const PointType &  point) const
overridevirtual

Interpolate the image at a point position.

Returns the interpolated image intensity at a specified point position. No bounds checking is done. The point is assume to lie within the image buffer.

ImageFunction::IsInsideBuffer() can be used to check bounds before calling the method.

Reimplemented from itk::InterpolateImageFunction< TInputImage, TCoordinate >.

◆ EvaluateAtContinuousIndex()

template<typename TInputImage , typename TCoordinate = double>
OutputType itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::EvaluateAtContinuousIndex ( const ContinuousIndexType &  index) const
overridevirtual

Interpolate the image at a continuous index position

Returns the interpolated image intensity at a specified index position. No bounds checking is done. The point is assume to lie within the image buffer.

Subclasses must override this method.

ImageFunction::IsInsideBuffer() can be used to check bounds before calling the method.

Implements itk::InterpolateImageFunction< TInputImage, TCoordinate >.

◆ GetFocalPoint()

template<typename TInputImage , typename TCoordinate = double>
virtual InputPointType itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::GetFocalPoint ( ) const
virtual

The focal point or position of the ray source.

◆ GetModifiableInterpolator()

template<typename TInputImage , typename TCoordinate = double>
virtual InterpolatorType* itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::GetModifiableInterpolator ( )
virtual

Get a pointer to the Interpolator.

◆ GetModifiableTransform()

template<typename TInputImage , typename TCoordinate = double>
virtual TransformType* itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::GetModifiableTransform ( )
virtual

Connect the Transform. This Transformation is used to calculate the new focal point position.

◆ GetNameOfClass()

template<typename TInputImage , typename TCoordinate = double>
const char* itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::InterpolateImageFunction< TInputImage, TCoordinate >.

◆ GetRadius()

template<typename TInputImage , typename TCoordinate = double>
SizeType itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::GetRadius ( ) const
inlineoverridevirtual

Get the radius required for interpolation.

This defines the number of surrounding pixels required to interpolate at a given point.

Implements itk::InterpolateImageFunction< TInputImage, TCoordinate >.

Definition at line 177 of file itkRayCastInterpolateImageFunction.h.

◆ GetThreshold()

template<typename TInputImage , typename TCoordinate = double>
virtual double itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::GetThreshold ( ) const
virtual

The threshold above which voxels along the ray path are integrated.

◆ IsInsideBuffer() [1/3]

template<typename TInputImage , typename TCoordinate = double>
bool itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::IsInsideBuffer ( const ContinuousIndexType &  index) const
inlineoverridevirtual

Check if a continuous index is inside the image buffer.

Warning
For efficiency, no validity checking of the input image is done.

Reimplemented from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordinate >.

Definition at line 165 of file itkRayCastInterpolateImageFunction.h.

◆ IsInsideBuffer() [2/3]

template<typename TInputImage , typename TCoordinate = double>
bool itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::IsInsideBuffer ( const IndexType &  index) const
inlineoverridevirtual

Check if an index is inside the image buffer. 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.

Warning
For efficiency, no validity checking of the input image is done.

Reimplemented from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordinate >.

Definition at line 171 of file itkRayCastInterpolateImageFunction.h.

◆ IsInsideBuffer() [3/3]

template<typename TInputImage , typename TCoordinate = double>
bool itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::IsInsideBuffer ( const PointType &  ) const
inlineoverridevirtual

Check if a point is inside the image buffer.

Warning
For efficiency, no validity checking of the input image pointer is done.

Reimplemented from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordinate >.

Definition at line 159 of file itkRayCastInterpolateImageFunction.h.

◆ New()

template<typename TInputImage , typename TCoordinate = double>
static Pointer itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TCoordinate = double>
void itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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::InterpolateImageFunction< TInputImage, TCoordinate >.

◆ SetFocalPoint()

template<typename TInputImage , typename TCoordinate = double>
virtual void itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::SetFocalPoint ( InputPointType  _arg)
virtual

The focal point or position of the ray source.

◆ SetInterpolator()

template<typename TInputImage , typename TCoordinate = double>
virtual void itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::SetInterpolator ( InterpolatorType *  _arg)
virtual

Connect the Interpolator.

◆ SetThreshold()

template<typename TInputImage , typename TCoordinate = double>
virtual void itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::SetThreshold ( double  _arg)
virtual

The threshold above which voxels along the ray path are integrated.

◆ SetTransform()

template<typename TInputImage , typename TCoordinate = double>
virtual void itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::SetTransform ( TransformType *  _arg)
virtual

Connect the Transform. This Transformation is used to calculate the new focal point position.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TCoordinate = double>
constexpr unsigned int itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::ImageDimension = Superclass::ImageDimension
staticconstexpr

Dimension underlying input image.

Definition at line 94 of file itkRayCastInterpolateImageFunction.h.

◆ InputImageDimension

template<typename TInputImage , typename TCoordinate = double>
constexpr unsigned int itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::InputImageDimension = TInputImage::ImageDimension
staticconstexpr

Constants for the image dimensions

Definition at line 53 of file itkRayCastInterpolateImageFunction.h.

◆ m_FocalPoint

template<typename TInputImage , typename TCoordinate = double>
InputPointType itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::m_FocalPoint {}
protected

Definition at line 195 of file itkRayCastInterpolateImageFunction.h.

◆ m_Interpolator

template<typename TInputImage , typename TCoordinate = double>
InterpolatorPointer itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::m_Interpolator {}
protected

Definition at line 197 of file itkRayCastInterpolateImageFunction.h.

◆ m_Threshold

template<typename TInputImage , typename TCoordinate = double>
double itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::m_Threshold {}
protected

Definition at line 196 of file itkRayCastInterpolateImageFunction.h.

◆ m_Transform

template<typename TInputImage , typename TCoordinate = double>
TransformPointer itk::RayCastInterpolateImageFunction< TInputImage, TCoordinate >::m_Transform {}
protected

Definition at line 194 of file itkRayCastInterpolateImageFunction.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16