ITK  4.13.0
Insight Segmentation and Registration 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

#include <itkNeighborhoodOperatorImageFunction.h>

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

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
Wiki Examples:
Examples:
WikiExamples/Functions/NeighborhoodOperatorImageFunction.cxx.

Definition at line 41 of file itkNeighborhoodOperatorImageFunction.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::ContinuousIndexType 
ContinuousIndexType
 
typedef Superclass::IndexType IndexType
 
typedef TInputImage InputImageType
 
typedef InputImageType::PixelType InputPixelType
 
typedef Neighborhood< TOutput,
itkGetStaticConstMacro(ImageDimension) > 
NeighborhoodType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::PointType PointType
 
typedef
NeighborhoodOperatorImageFunction 
Self
 
typedef ImageFunction
< TInputImage, TOutput > 
Superclass
 
- Public Types inherited from itk::ImageFunction< TInputImage, TOutput >
typedef SmartPointer< const SelfConstPointer
 
typedef ContinuousIndex< float,
itkGetStaticConstMacro(ImageDimension) > 
ContinuousIndexType
 
typedef float CoordRepType
 
typedef InputImageType::IndexType IndexType
 
typedef
InputImageType::IndexValueType 
IndexValueType
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef TInputImage InputImageType
 
typedef InputImageType::PixelType InputPixelType
 
typedef TOutput OutputType
 
typedef SmartPointer< SelfPointer
 
typedef Point< float,
itkGetStaticConstMacro(ImageDimension) > 
PointType
 
typedef ImageFunction Self
 
typedef FunctionBase< Point
< float,
itkGetStaticConstMacro(ImageDimension) >
, TOutput > 
Superclass
 
- Public Types inherited from itk::FunctionBase< Point< float, TInputImage::ImageDimension >, TOutput >
typedef SmartPointer< const SelfConstPointer
 
typedef Point< float,
TInputImage::ImageDimension > 
InputType
 
typedef TOutput OutputType
 
typedef SmartPointer< SelfPointer
 
typedef FunctionBase Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual TOutput EvaluateAtIndex (const IndexType &index) const override
 
virtual const char * GetNameOfClass () const
 
void SetOperator (const NeighborhoodType &p) const
 
virtual TOutput Evaluate (const PointType &) const override
 
virtual 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
 
void ConvertPointToNearestIndex (const PointType &point, IndexType &index) const
 
virtual TOutput 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 ContinuousIndexTypeGetEndContinuousIndex () const
 
virtual const IndexTypeGetEndIndex () const
 
const InputImageTypeGetInputImage () const
 
virtual const ContinuousIndexTypeGetStartContinuousIndex () const
 
virtual const IndexTypeGetStartIndex () 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
 
- Public Member Functions inherited from itk::FunctionBase< Point< float, TInputImage::ImageDimension >, TOutput >
virtual OutputType Evaluate (const InputType &input) const =0
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) 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
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
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 flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static const unsigned int ImageDimension = InputImageType::ImageDimension
 
- Static Public Attributes inherited from itk::ImageFunction< TInputImage, TOutput >
static const unsigned int ImageDimension
 

Protected Member Functions

 NeighborhoodOperatorImageFunction ()
 
 NeighborhoodOperatorImageFunction (const Self &)
 
void operator= (const Self &)
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~NeighborhoodOperatorImageFunction ()
 
- Protected Member Functions inherited from itk::ImageFunction< TInputImage, TOutput >
 ImageFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ImageFunction ()
 
- Protected Member Functions inherited from itk::FunctionBase< Point< float, TInputImage::ImageDimension >, TOutput >
 FunctionBase ()
 
 ~FunctionBase ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- 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
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TInputImage , typename TOutput >
typedef SmartPointer< const Self > itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >::ConstPointer

Definition at line 54 of file itkNeighborhoodOperatorImageFunction.h.

template<typename TInputImage , typename TOutput >
typedef Superclass::ContinuousIndexType itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >::ContinuousIndexType

Definition at line 63 of file itkNeighborhoodOperatorImageFunction.h.

template<typename TInputImage , typename TOutput >
typedef Superclass::IndexType itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >::IndexType

Definition at line 62 of file itkNeighborhoodOperatorImageFunction.h.

template<typename TInputImage , typename TOutput >
typedef TInputImage itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >::InputImageType

InputImageType typedef support.

Definition at line 57 of file itkNeighborhoodOperatorImageFunction.h.

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

Definition at line 61 of file itkNeighborhoodOperatorImageFunction.h.

template<typename TInputImage , typename TOutput >
typedef Neighborhood< TOutput, itkGetStaticConstMacro(ImageDimension) > itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >::NeighborhoodType

Definition at line 72 of file itkNeighborhoodOperatorImageFunction.h.

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

Smart pointer typedef support.

Definition at line 53 of file itkNeighborhoodOperatorImageFunction.h.

template<typename TInputImage , typename TOutput >
typedef Superclass::PointType itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >::PointType

Point typedef support.

Definition at line 75 of file itkNeighborhoodOperatorImageFunction.h.

template<typename TInputImage , typename TOutput >
typedef NeighborhoodOperatorImageFunction itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >::Self

Standard "Self" typedef

Definition at line 47 of file itkNeighborhoodOperatorImageFunction.h.

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

Standard "Superclass" typedef

Definition at line 50 of file itkNeighborhoodOperatorImageFunction.h.

Constructor & Destructor Documentation

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

Definition at line 118 of file itkNeighborhoodOperatorImageFunction.h.

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

Definition at line 120 of file itkNeighborhoodOperatorImageFunction.h.

Member Function Documentation

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

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

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

Definition at line 92 of file itkNeighborhoodOperatorImageFunction.h.

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

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

Definition at line 106 of file itkNeighborhoodOperatorImageFunction.h.

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

Evaluate the function at specified Index position

template<typename TInputImage , typename TOutput >
virtual const char* itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageFunction< TInputImage, TOutput >.

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

Method for creation through the object factory.

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

Definition at line 122 of file itkNeighborhoodOperatorImageFunction.h.

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.

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 83 of file itkNeighborhoodOperatorImageFunction.h.

Member Data Documentation

template<typename TInputImage , typename TOutput >
const unsigned int itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >::ImageDimension = InputImageType::ImageDimension
static

Dimension of the underlying image.

Definition at line 70 of file itkNeighborhoodOperatorImageFunction.h.

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

Definition at line 127 of file itkNeighborhoodOperatorImageFunction.h.


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