ITK
6.0.0
Insight Toolkit
|
#include <itkImageFunction.h>
Evaluates a function of an image at specified position.
ImageFunction is a baseclass for all objects that evaluates a function of an image at index, continuous index or point. This class is templated over the input image type, the type of the function output and the coordinate representation type (e.g. float or double).
The input image is set via method SetInputImage(). Methods Evaluate, EvaluateAtIndex and EvaluateAtContinuousIndex respectively evaluates the function at an geometric point, image index and continuous image index.
Definition at line 55 of file itkImageFunction.h.
Public Member Functions | |
void | ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const |
void | ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const |
OutputType | Evaluate (const PointType &point) const override=0 |
virtual TOutput | EvaluateAtContinuousIndex (const ContinuousIndexType &index) const =0 |
virtual TOutput | EvaluateAtIndex (const IndexType &index) const =0 |
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) |
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 |
Public Member Functions inherited from itk::FunctionBase< Point< float, TInputImage::ImageDimension >, TOutput > | |
virtual OutputType | Evaluate (const InputType &input) const=0 |
const char * | GetNameOfClass () const override |
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 |
const char * | GetNameOfClass () const override |
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 Pointer | CreateAnother () const |
virtual void | Delete () |
virtual const char * | GetNameOfClass () const |
virtual int | GetReferenceCount () const |
void | Print (std::ostream &os, Indent indent=0) const |
virtual void | Register () const |
virtual void | SetReferenceCount (int) |
virtual void | UnRegister () const noexcept |
Static Public Attributes | |
static constexpr unsigned int | ImageDimension = TInputImage::ImageDimension |
Protected Member Functions | |
ImageFunction () | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
~ImageFunction () override=default | |
Protected Member Functions inherited from itk::FunctionBase< Point< float, TInputImage::ImageDimension >, TOutput > | |
FunctionBase ()=default | |
~FunctionBase () override=default | |
Protected Member Functions inherited from itk::Object | |
Object () | |
bool | PrintObservers (std::ostream &os, Indent indent) const |
void | PrintSelf (std::ostream &os, Indent indent) const override |
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 | PrintSelf (std::ostream &os, Indent indent) const |
virtual void | PrintTrailer (std::ostream &os, Indent indent) const |
virtual | ~LightObject () |
Protected Attributes | |
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 {} |
Additional Inherited Members | |
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 () |
using itk::ImageFunction< TInputImage, TOutput, TCoordRep >::ConstPointer = SmartPointer<const Self> |
Definition at line 69 of file itkImageFunction.h.
using itk::ImageFunction< TInputImage, TOutput, TCoordRep >::ContinuousIndexType = ContinuousIndex<TCoordRep, Self::ImageDimension> |
ContinuousIndex Type.
Definition at line 94 of file itkImageFunction.h.
using itk::ImageFunction< TInputImage, TOutput, TCoordRep >::CoordRepType = TCoordRep |
CoordRepType type alias support
Definition at line 87 of file itkImageFunction.h.
using itk::ImageFunction< TInputImage, TOutput, TCoordRep >::IndexType = typename InputImageType::IndexType |
Index Type.
Definition at line 90 of file itkImageFunction.h.
using itk::ImageFunction< TInputImage, TOutput, TCoordRep >::IndexValueType = typename InputImageType::IndexValueType |
Definition at line 91 of file itkImageFunction.h.
using itk::ImageFunction< TInputImage, TOutput, TCoordRep >::InputImageConstPointer = typename InputImageType::ConstPointer |
InputImagePointer type alias support
Definition at line 81 of file itkImageFunction.h.
using itk::ImageFunction< TInputImage, TOutput, TCoordRep >::InputImageType = TInputImage |
InputImageType type alias support
Definition at line 75 of file itkImageFunction.h.
using itk::ImageFunction< TInputImage, TOutput, TCoordRep >::InputPixelType = typename InputImageType::PixelType |
InputPixel type alias support
Definition at line 78 of file itkImageFunction.h.
using itk::ImageFunction< TInputImage, TOutput, TCoordRep >::OutputType = TOutput |
OutputType type alias support
Definition at line 84 of file itkImageFunction.h.
using itk::ImageFunction< TInputImage, TOutput, TCoordRep >::Pointer = SmartPointer<Self> |
Definition at line 68 of file itkImageFunction.h.
using itk::ImageFunction< TInputImage, TOutput, TCoordRep >::PointType = Point<TCoordRep, Self::ImageDimension> |
Point Type.
Definition at line 97 of file itkImageFunction.h.
using itk::ImageFunction< TInputImage, TOutput, TCoordRep >::Self = ImageFunction |
Standard class type aliases.
Definition at line 64 of file itkImageFunction.h.
using itk::ImageFunction< TInputImage, TOutput, TCoordRep >::Superclass = FunctionBase<Point<TCoordRep, Self::ImageDimension>, TOutput> |
Definition at line 66 of file itkImageFunction.h.
|
protected |
|
overrideprotecteddefault |
|
inline |
Convert continuous index to nearest index.
Definition at line 203 of file itkImageFunction.h.
|
inline |
Convert point to continuous index
Definition at line 196 of file itkImageFunction.h.
References itk::point().
|
inline |
Convert point to nearest index.
Definition at line 187 of file itkImageFunction.h.
References itk::point().
|
overridepure virtual |
Evaluate the function at specified Point position. Subclasses must provide this method.
Implements itk::FunctionBase< Point< float, TInputImage::ImageDimension >, TOutput >.
Implemented in itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >, itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >, itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >, itk::BinaryThresholdImageFunction< TInputImage, float >, itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >, itk::BSplineInterpolateImageFunction< TImageType, float, TImageType::PixelType >, itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >, itk::CovarianceImageFunction< TInputImage, TCoordRep >, itk::ExtrapolateImageFunction< TInputImage, TCoordRep >, itk::ExtrapolateImageFunction< TInputImage, float >, itk::GaussianBlurImageFunction< TInputImage, TOutput >, itk::InterpolateImageFunction< TInputImage, TCoordRep >, itk::InterpolateImageFunction< TImageType, double >, itk::InterpolateImageFunction< TImageType, float >, itk::InterpolateImageFunction< TInputImage, double >, itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >, itk::MeanImageFunction< TInputImage, TCoordRep >, itk::MedianImageFunction< TInputImage, TCoordRep >, itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >, itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >, itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >, itk::SumOfSquaresImageFunction< TInputImage, TCoordRep >, itk::VarianceImageFunction< TInputImage, TCoordRep >, itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >, itk::VectorInterpolateImageFunction< TInputImage, double >, itk::VectorInterpolateImageFunction< TInputImage, float >, itk::VectorMeanImageFunction< TInputImage, TCoordRep >, itk::DiscreteGaussianDerivativeImageFunction< TInputImage, TOutput >, itk::DiscreteGradientMagnitudeGaussianImageFunction< TInputImage, TOutput >, and itk::DiscreteHessianGaussianImageFunction< TInputImage, TOutput >.
|
pure virtual |
Evaluate the function at specified ContinuousIndex position. Subclasses must provide this method.
Implemented in itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >, itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >, itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >, itk::CovarianceImageFunction< TInputImage, TCoordRep >, itk::GaussianBlurImageFunction< TInputImage, TOutput >, itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >, itk::GaussianInterpolateImageFunction< TInputImage, double >, itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >, itk::MeanImageFunction< TInputImage, TCoordRep >, itk::MedianImageFunction< TInputImage, TCoordRep >, itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >, itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >, itk::SumOfSquaresImageFunction< TInputImage, TCoordRep >, itk::VarianceImageFunction< TInputImage, TCoordRep >, itk::VectorMeanImageFunction< TInputImage, TCoordRep >, itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >, itk::BinaryThresholdImageFunction< TInputImage, float >, itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >, itk::BSplineInterpolateImageFunction< TImageType, float, TImageType::PixelType >, itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >, itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >, itk::NearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >, itk::NearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >, itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >, itk::VectorLinearInterpolateImageFunction< TInputImage, TCoordRep >, itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >, itk::VectorNearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >, itk::WindowedSincInterpolateImageFunction< TInputImage, VRadius, TWindowFunction, TBoundaryCondition, TCoordRep >, itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >, itk::DiscreteGaussianDerivativeImageFunction< TInputImage, TOutput >, itk::DiscreteGradientMagnitudeGaussianImageFunction< TInputImage, TOutput >, itk::DiscreteHessianGaussianImageFunction< TInputImage, TOutput >, itk::ExtrapolateImageFunction< TInputImage, TCoordRep >, itk::ExtrapolateImageFunction< TInputImage, float >, itk::InterpolateImageFunction< TInputImage, TCoordRep >, itk::InterpolateImageFunction< TImageType, double >, itk::InterpolateImageFunction< TImageType, float >, itk::InterpolateImageFunction< TInputImage, double >, itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >, itk::VectorInterpolateImageFunction< TInputImage, double >, and itk::VectorInterpolateImageFunction< TInputImage, float >.
|
pure virtual |
Evaluate the function at specified Index position. Subclasses must provide this method.
Implemented in itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >, itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >, itk::BinaryThresholdImageFunction< TInputImage, float >, itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >, itk::CovarianceImageFunction< TInputImage, TCoordRep >, itk::GaussianBlurImageFunction< TInputImage, TOutput >, itk::GaussianDerivativeImageFunction< TInputImage, TOutput >, itk::InterpolateImageFunction< TInputImage, TCoordRep >, itk::InterpolateImageFunction< TImageType, double >, itk::InterpolateImageFunction< TImageType, float >, itk::InterpolateImageFunction< TInputImage, double >, itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >, itk::MeanImageFunction< TInputImage, TCoordRep >, itk::MedianImageFunction< TInputImage, TCoordRep >, itk::NearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >, itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >, itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >, itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >, itk::SumOfSquaresImageFunction< TInputImage, TCoordRep >, itk::VarianceImageFunction< TInputImage, TCoordRep >, itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >, itk::VectorInterpolateImageFunction< TInputImage, double >, itk::VectorInterpolateImageFunction< TInputImage, float >, itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >, itk::VectorMeanImageFunction< TInputImage, TCoordRep >, itk::DiscreteGaussianDerivativeImageFunction< TInputImage, TOutput >, itk::DiscreteGradientMagnitudeGaussianImageFunction< TInputImage, TOutput >, itk::DiscreteHessianGaussianImageFunction< TInputImage, TOutput >, itk::ExtrapolateImageFunction< TInputImage, TCoordRep >, and itk::ExtrapolateImageFunction< TInputImage, float >.
|
virtual |
|
virtual |
|
inline |
Get the input image.
Definition at line 108 of file itkImageFunction.h.
|
overridevirtual |
Reimplemented from itk::Object.
Reimplemented in itk::InterpolateImageFunction< TImageType, double >, itk::InterpolateImageFunction< TImageType, float >, itk::InterpolateImageFunction< TInputImage, double >, itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >, itk::VectorInterpolateImageFunction< TInputImage, double >, and itk::VectorInterpolateImageFunction< TInputImage, float >.
|
virtual |
|
virtual |
|
inlinevirtual |
Check if a continuous index is inside the image buffer.
Reimplemented in itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >, and itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >.
Definition at line 156 of file itkImageFunction.h.
|
inlinevirtual |
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.
Reimplemented in itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >, and itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >.
Definition at line 135 of file itkImageFunction.h.
|
inlinevirtual |
Check if a point is inside the image buffer.
Reimplemented in itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >, and itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >.
Definition at line 174 of file itkImageFunction.h.
References itk::point().
|
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::Object.
Reimplemented in itk::InterpolateImageFunction< TImageType, double >, itk::InterpolateImageFunction< TImageType, float >, itk::InterpolateImageFunction< TInputImage, double >, and itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >.
|
virtual |
Set the input image.
Reimplemented in itk::WindowedSincInterpolateImageFunction< TInputImage, VRadius, TWindowFunction, TBoundaryCondition, TCoordRep >, itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >, itk::GaussianBlurImageFunction< TInputImage, TOutput >, itk::GaussianDerivativeImageFunction< TInputImage, TOutput >, itk::DiscreteGaussianDerivativeImageFunction< TInputImage, TOutput >, itk::DiscreteGradientMagnitudeGaussianImageFunction< TInputImage, TOutput >, itk::DiscreteHessianGaussianImageFunction< TInputImage, TOutput >, itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >, itk::BSplineInterpolateImageFunction< TImageType, float, TImageType::PixelType >, itk::BSplineResampleImageFunction< TImageType, TCoordRep >, itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >, itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >, itk::GaussianInterpolateImageFunction< TInputImage, double >, and itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >.
|
staticconstexpr |
Dimension underlying input image.
Definition at line 61 of file itkImageFunction.h.
|
protected |
Definition at line 228 of file itkImageFunction.h.
|
protected |
Definition at line 225 of file itkImageFunction.h.
|
protected |
Const pointer to the input image.
Definition at line 221 of file itkImageFunction.h.
|
protected |
Definition at line 227 of file itkImageFunction.h.
|
protected |
Cache some values for testing if indices are inside buffered region.
Definition at line 224 of file itkImageFunction.h.