ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
itk::BinaryThresholdSpatialFunction< TFunction > Class Template Reference

#include <itkBinaryThresholdSpatialFunction.h>

+ Inheritance diagram for itk::BinaryThresholdSpatialFunction< TFunction >:
+ Collaboration diagram for itk::BinaryThresholdSpatialFunction< TFunction >:

Detailed Description

template<typename TFunction>
class itk::BinaryThresholdSpatialFunction< TFunction >

A spatial functions that returns if the internal spatial function is within user specified thresholds.

BinaryThresholdSpatialFunction is a wrapper class for an internal spatial function and returns true if it is within user specified thresholds and false otherwise.

This class is templated over the internal spatial function type.

See Also
SpatialFunction

Definition at line 42 of file itkBinaryThresholdSpatialFunction.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef TFunction::OutputType FunctionOutputType
 
typedef TFunction FunctionType
 
typedef TFunction::InputType InputType
 
typedef Superclass::OutputType OutputType
 
typedef SmartPointer< SelfPointer
 
typedef
BinaryThresholdSpatialFunction 
Self
 
typedef SpatialFunction< bool,
TFunction::ImageDimension,
typename TFunction::InputType > 
Superclass
 
- Public Types inherited from itk::SpatialFunction< bool, TFunction::ImageDimension, TFunction::InputType >
typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::InputType InputType
 
typedef Superclass::OutputType OutputType
 
typedef SmartPointer< SelfPointer
 
typedef SpatialFunction Self
 
typedef FunctionBase
< TFunction::InputType, bool > 
Superclass
 
- Public Types inherited from itk::FunctionBase< TFunction::InputType, bool >
typedef SmartPointer< const SelfConstPointer
 
typedef TFunction::InputType InputType
 
typedef bool 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 OutputType Evaluate (const InputType &point) const override
 
virtual const char * GetNameOfClass () const
 
virtual void SetLowerThreshold (FunctionOutputType _arg)
 
virtual const FunctionOutputTypeGetLowerThreshold () const
 
virtual void SetUpperThreshold (FunctionOutputType _arg)
 
virtual const FunctionOutputTypeGetUpperThreshold () const
 
virtual void SetFunction (FunctionType *_arg)
 
virtual FunctionTypeGetModifiableFunction ()
 
virtual const FunctionTypeGetFunction () const
 
- 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 ()
 

Protected Member Functions

 BinaryThresholdSpatialFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~BinaryThresholdSpatialFunction () override
 
- Protected Member Functions inherited from itk::SpatialFunction< bool, TFunction::ImageDimension, TFunction::InputType >
void PrintSelf (std::ostream &os, Indent indent) const override
 
 SpatialFunction ()
 
virtual ~SpatialFunction () override
 
- Protected Member Functions inherited from itk::FunctionBase< TFunction::InputType, bool >
 FunctionBase ()
 
 ~FunctionBase () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~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

FunctionType::Pointer m_Function
 
FunctionOutputType m_LowerThreshold
 
FunctionOutputType m_UpperThreshold
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Additional Inherited Members

- Static Public Attributes inherited from itk::SpatialFunction< bool, TFunction::ImageDimension, TFunction::InputType >
static const unsigned int ImageDimension
 

Member Typedef Documentation

template<typename TFunction >
typedef SmartPointer< const Self > itk::BinaryThresholdSpatialFunction< TFunction >::ConstPointer

Definition at line 55 of file itkBinaryThresholdSpatialFunction.h.

template<typename TFunction >
typedef TFunction::OutputType itk::BinaryThresholdSpatialFunction< TFunction >::FunctionOutputType

Underlying function output type.

Definition at line 73 of file itkBinaryThresholdSpatialFunction.h.

template<typename TFunction >
typedef TFunction itk::BinaryThresholdSpatialFunction< TFunction >::FunctionType

Underlying function type.

Definition at line 70 of file itkBinaryThresholdSpatialFunction.h.

template<typename TFunction >
typedef TFunction::InputType itk::BinaryThresholdSpatialFunction< TFunction >::InputType

InputType typedef support.

Definition at line 67 of file itkBinaryThresholdSpatialFunction.h.

template<typename TFunction >
typedef Superclass::OutputType itk::BinaryThresholdSpatialFunction< TFunction >::OutputType

OutputType typedef support.

Definition at line 61 of file itkBinaryThresholdSpatialFunction.h.

template<typename TFunction >
typedef SmartPointer< Self > itk::BinaryThresholdSpatialFunction< TFunction >::Pointer

Definition at line 54 of file itkBinaryThresholdSpatialFunction.h.

template<typename TFunction >
typedef BinaryThresholdSpatialFunction itk::BinaryThresholdSpatialFunction< TFunction >::Self

Standard class typedefs.

Definition at line 49 of file itkBinaryThresholdSpatialFunction.h.

template<typename TFunction >
typedef SpatialFunction< bool, TFunction::ImageDimension, typename TFunction::InputType > itk::BinaryThresholdSpatialFunction< TFunction >::Superclass

Definition at line 52 of file itkBinaryThresholdSpatialFunction.h.

Constructor & Destructor Documentation

template<typename TFunction >
itk::BinaryThresholdSpatialFunction< TFunction >::BinaryThresholdSpatialFunction ( )
protected
template<typename TFunction >
itk::BinaryThresholdSpatialFunction< TFunction >::~BinaryThresholdSpatialFunction ( )
overrideprotected

Member Function Documentation

template<typename TFunction >
virtual::itk::LightObject::Pointer itk::BinaryThresholdSpatialFunction< TFunction >::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 TFunction >
virtual OutputType itk::BinaryThresholdSpatialFunction< TFunction >::Evaluate ( const InputType point) const
overridevirtual

Evaluate the function at a given position.

Implements itk::SpatialFunction< bool, TFunction::ImageDimension, TFunction::InputType >.

template<typename TFunction >
virtual const FunctionType* itk::BinaryThresholdSpatialFunction< TFunction >::GetFunction ( ) const
virtual

Set/Get the underlying function.

template<typename TFunction >
virtual const FunctionOutputType& itk::BinaryThresholdSpatialFunction< TFunction >::GetLowerThreshold ( ) const
virtual

Set/Get the lower threshold.

template<typename TFunction >
virtual FunctionType* itk::BinaryThresholdSpatialFunction< TFunction >::GetModifiableFunction ( )
virtual

Set/Get the underlying function.

template<typename TFunction >
virtual const char* itk::BinaryThresholdSpatialFunction< TFunction >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::SpatialFunction< bool, TFunction::ImageDimension, TFunction::InputType >.

template<typename TFunction >
virtual const FunctionOutputType& itk::BinaryThresholdSpatialFunction< TFunction >::GetUpperThreshold ( ) const
virtual

Set/Get the upper threshold.

template<typename TFunction >
static Pointer itk::BinaryThresholdSpatialFunction< TFunction >::New ( )
static

New macro for creation of through the object factory.

template<typename TFunction >
void itk::BinaryThresholdSpatialFunction< TFunction >::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 TFunction >
virtual void itk::BinaryThresholdSpatialFunction< TFunction >::SetFunction ( FunctionType _arg)
virtual

Set/Get the underlying function.

template<typename TFunction >
virtual void itk::BinaryThresholdSpatialFunction< TFunction >::SetLowerThreshold ( FunctionOutputType  _arg)
virtual

Set/Get the lower threshold.

template<typename TFunction >
virtual void itk::BinaryThresholdSpatialFunction< TFunction >::SetUpperThreshold ( FunctionOutputType  _arg)
virtual

Set/Get the upper threshold.

Member Data Documentation

template<typename TFunction >
FunctionType::Pointer itk::BinaryThresholdSpatialFunction< TFunction >::m_Function
protected

Definition at line 102 of file itkBinaryThresholdSpatialFunction.h.

template<typename TFunction >
FunctionOutputType itk::BinaryThresholdSpatialFunction< TFunction >::m_LowerThreshold
protected

Definition at line 99 of file itkBinaryThresholdSpatialFunction.h.

template<typename TFunction >
FunctionOutputType itk::BinaryThresholdSpatialFunction< TFunction >::m_UpperThreshold
protected

Definition at line 100 of file itkBinaryThresholdSpatialFunction.h.


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