ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput > Class Template Reference
Group Core » Module ITKImageFunction

#include <itkNeighborhoodOperatorImageFunction.h>

Detailed Description

template<typename TInputImage, typename TOutput>
class itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >

Compute the convolution of a neighborhood operator with the image at a specific location in space, i.e. point, index or continuous index. This class is templated over the input image type.

See also
NeighborhoodOperator
ImageFunction
ITK Sphinx Examples:
Examples
SphinxExamples/src/Core/ImageFunction/MultiplyKernelWithAnImageAtLocation/Code.cxx.

Definition at line 41 of file itkNeighborhoodOperatorImageFunction.h.

+ Inheritance diagram for itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >:
+ Collaboration diagram for itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using InputImageType = TInputImage
 
using InputPixelType = typename InputImageType::PixelType
 
using NeighborhoodType = Neighborhood< TOutput, Self::ImageDimension >
 
using Pointer = SmartPointer< Self >
 
using Self = NeighborhoodOperatorImageFunction
 
using Superclass = ImageFunction< TInputImage, TOutput >
 
- Public Types inherited from itk::ImageFunction< TInputImage, TOutput >
using ConstPointer = SmartPointer< const Self >
 
using ContinuousIndexType = ContinuousIndex< float, Self::ImageDimension >
 
using CoordinateType = float
 
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 = TOutput
 
using Pointer = SmartPointer< Self >
 
using PointType = Point< float, Self::ImageDimension >
 
using Self = ImageFunction
 
using Superclass = FunctionBase< Point< float, Self::ImageDimension >, TOutput >
 
- Public Types inherited from itk::FunctionBase< Point< float, TInputImage::ImageDimension >, TOutput >
using ConstPointer = SmartPointer< const Self >
 
using InputType = Point< float, TInputImage::ImageDimension >
 
using OutputType = TOutput
 
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

TOutput EvaluateAtIndex (const IndexType &index) const override
 
const char * GetNameOfClass () const override
 
void SetOperator (const NeighborhoodType &p) const
 
TOutput Evaluate (const PointType &) const override
 
TOutput EvaluateAtContinuousIndex (const ContinuousIndexType &) const override
 
- Public Member Functions inherited from itk::ImageFunction< TInputImage, TOutput >
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)
 
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::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 = InputImageType::ImageDimension
 
- Static Public Attributes inherited from itk::ImageFunction< TInputImage, TOutput >
static constexpr unsigned int ImageDimension
 

Protected Member Functions

 NeighborhoodOperatorImageFunction ()=default
 
 NeighborhoodOperatorImageFunction (const Self &)
 
void operator= (const Self &)
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~NeighborhoodOperatorImageFunction () override=default
 
- Protected Member Functions inherited from itk::ImageFunction< TInputImage, TOutput >
 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
 
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 ()
 

Private Attributes

NeighborhoodType m_Operator {}
 

Additional Inherited Members

- Protected Attributes inherited from itk::ImageFunction< TInputImage, TOutput >
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 TOutput >
using itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >::ConstPointer = SmartPointer<const Self>

Definition at line 53 of file itkNeighborhoodOperatorImageFunction.h.

◆ InputImageType

template<typename TInputImage , typename TOutput >
using itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >::InputImageType = TInputImage

InputImageType type alias support

Definition at line 59 of file itkNeighborhoodOperatorImageFunction.h.

◆ InputPixelType

template<typename TInputImage , typename TOutput >
using itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >::InputPixelType = typename InputImageType::PixelType

Definition at line 60 of file itkNeighborhoodOperatorImageFunction.h.

◆ NeighborhoodType

template<typename TInputImage , typename TOutput >
using itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >::NeighborhoodType = Neighborhood<TOutput, Self::ImageDimension>

Definition at line 70 of file itkNeighborhoodOperatorImageFunction.h.

◆ Pointer

template<typename TInputImage , typename TOutput >
using itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >::Pointer = SmartPointer<Self>

Smart pointer type alias support

Definition at line 52 of file itkNeighborhoodOperatorImageFunction.h.

◆ Self

template<typename TInputImage , typename TOutput >
using itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >::Self = NeighborhoodOperatorImageFunction

Standard "Self" type alias

Definition at line 46 of file itkNeighborhoodOperatorImageFunction.h.

◆ Superclass

template<typename TInputImage , typename TOutput >
using itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >::Superclass = ImageFunction<TInputImage, TOutput>

Standard "Superclass" type alias

Definition at line 49 of file itkNeighborhoodOperatorImageFunction.h.

Constructor & Destructor Documentation

◆ NeighborhoodOperatorImageFunction() [1/2]

template<typename TInputImage , typename TOutput >
itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >::NeighborhoodOperatorImageFunction ( )
protecteddefault

◆ NeighborhoodOperatorImageFunction() [2/2]

template<typename TInputImage , typename TOutput >
itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >::NeighborhoodOperatorImageFunction ( const Self &  )
inlineprotected

Definition at line 117 of file itkNeighborhoodOperatorImageFunction.h.

◆ ~NeighborhoodOperatorImageFunction()

template<typename TInputImage , typename TOutput >
itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >::~NeighborhoodOperatorImageFunction ( )
overrideprotecteddefault

Member Function Documentation

◆ Evaluate()

template<typename TInputImage , typename TOutput >
TOutput itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >::Evaluate ( const PointType &  ) const
inlineoverridevirtual

Evaluate the function in the given dimension at specified point Subclasses should override this method.

Implements itk::ImageFunction< TInputImage, TOutput >.

Definition at line 92 of file itkNeighborhoodOperatorImageFunction.h.

◆ EvaluateAtContinuousIndex()

template<typename TInputImage , typename TOutput >
TOutput itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >::EvaluateAtContinuousIndex ( const ContinuousIndexType &  ) const
inlineoverridevirtual

Evaluate the function at specified ContinuousIndex position. Subclasses should override this method.

Implements itk::ImageFunction< TInputImage, TOutput >.

Definition at line 107 of file itkNeighborhoodOperatorImageFunction.h.

◆ EvaluateAtIndex()

template<typename TInputImage , typename TOutput >
TOutput itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >::EvaluateAtIndex ( const IndexType &  index) const
overridevirtual

Evaluate the function at specified Index position

Implements itk::ImageFunction< TInputImage, TOutput >.

◆ GetNameOfClass()

template<typename TInputImage , typename TOutput >
const char* itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ New()

template<typename TInputImage , typename TOutput >
static Pointer itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >::New ( )
static

Method for creation through the object factory.

◆ operator=()

template<typename TInputImage , typename TOutput >
void itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >::operator= ( const Self &  )
inlineprotected

Definition at line 122 of file itkNeighborhoodOperatorImageFunction.h.

◆ PrintSelf()

template<typename TInputImage , typename TOutput >
void itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >::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::Object.

◆ SetOperator()

template<typename TInputImage , typename TOutput >
void itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >::SetOperator ( const NeighborhoodType &  p) const
inline

Set the input image. Sets the operator that is used to filter the image. Note that the operator is stored as an internal COPY (it is not part of the pipeline).

Definition at line 82 of file itkNeighborhoodOperatorImageFunction.h.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TOutput >
constexpr unsigned int itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >::ImageDimension = InputImageType::ImageDimension
staticconstexpr

Dimension of the underlying image.

Definition at line 68 of file itkNeighborhoodOperatorImageFunction.h.

◆ m_Operator

template<typename TInputImage , typename TOutput >
NeighborhoodType itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >::m_Operator {}
mutableprivate

Definition at line 128 of file itkNeighborhoodOperatorImageFunction.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