ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | List of all members
itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput > Class Template Reference

#include <itkConicShellInteriorExteriorSpatialFunction.h>

+ Inheritance diagram for itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >:
+ Collaboration diagram for itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using GradientType = CovariantVector< double, VDimension >
 
using InputType = typename Superclass::InputType
 
using OutputType = typename Superclass::OutputType
 
using Pointer = SmartPointer< Self >
 
using Self = ConicShellInteriorExteriorSpatialFunction
 
using Superclass = InteriorExteriorSpatialFunction< VDimension, TInput >
 
- Public Types inherited from itk::InteriorExteriorSpatialFunction< VDimension, TInput >
using ConstPointer = SmartPointer< const Self >
 
using InputType = typename Superclass::InputType
 
using OutputType = typename Superclass::OutputType
 
using Pointer = SmartPointer< Self >
 
using Self = InteriorExteriorSpatialFunction
 
using Superclass = SpatialFunction< bool, VDimension, TInput >
 
- Public Types inherited from itk::SpatialFunction< bool, VDimension, TInput >
using ConstPointer = SmartPointer< const Self >
 
using InputType = typename Superclass::InputType
 
using OutputType = typename Superclass::OutputType
 
using Pointer = SmartPointer< Self >
 
using Self = SpatialFunction
 
using Superclass = FunctionBase< TInput, bool >
 
- Public Types inherited from itk::FunctionBase< TInput, bool >
using ConstPointer = SmartPointer< const Self >
 
using InputType = TInput
 
using OutputType = bool
 
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

virtual ::itk::LightObject::Pointer CreateAnother () const
 
OutputType Evaluate (const InputType &position) const override
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::SpatialFunction< bool, VDimension, TInput >
OutputType Evaluate (const InputType &input) const override=0
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) 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
 
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
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
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
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 ()
 
InputType m_Origin
 
GradientType m_OriginGradient
 
double m_DistanceMin { 0.0 }
 
double m_DistanceMax { 0.0 }
 
double m_Epsilon { 0.0 }
 
bool m_Polarity { false }
 
virtual InputType GetOrigin () const
 
virtual void SetOrigin (InputType _arg)
 
GradientType GetOriginGradient ()
 
void SetOriginGradient (GradientType grad)
 
virtual double GetDistanceMin () const
 
virtual void SetDistanceMin (double _arg)
 
virtual double GetDistanceMax () const
 
virtual void SetDistanceMax (double _arg)
 
virtual double GetEpsilon () const
 
virtual void SetEpsilon (double _arg)
 
virtual bool GetPolarity () const
 
virtual void SetPolarity (bool _arg)
 
virtual void PolarityOn ()
 
virtual void PolarityOff ()
 
 ConicShellInteriorExteriorSpatialFunction ()
 
 ~ConicShellInteriorExteriorSpatialFunction () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 

Additional Inherited Members

- Static Public Attributes inherited from itk::SpatialFunction< bool, VDimension, TInput >
static constexpr unsigned int ImageDimension
 
- Protected Member Functions inherited from itk::InteriorExteriorSpatialFunction< VDimension, TInput >
 InteriorExteriorSpatialFunction ()=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~InteriorExteriorSpatialFunction () override=default
 
- Protected Member Functions inherited from itk::SpatialFunction< bool, VDimension, TInput >
void PrintSelf (std::ostream &os, Indent indent) const override
 
 SpatialFunction ()=default
 
 ~SpatialFunction () override=default
 
- Protected Member Functions inherited from itk::FunctionBase< TInput, bool >
 FunctionBase ()=default
 
 ~FunctionBase () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
class itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >

Spatial function implementation of a conic shell.

We are creating search areas from BoundaryPoint1 in which to look for candidate BoundaryPoint2's with which to form core atoms. Assume the "worst case" that BoundaryPoint2 is somewhere in that search area pointing directly at BoundaryPoint1.

The search area (ConicShell?) from each BoundaryPoint1 has the following parameters:

DistanceMax and DistanceMin from the location of the BoundaryPoint

AngleMax from the line along the gradient at the boundary point. This is determined in n dimensions by taking the dot product of two vectors, (1) the normalized gradient at BoundaryPoint1 and (2) the normalized vector from BoundaryPoint1 to BoundaryPoint2.

If the absolute value of that dot product is greater than (1 - epsilon) then you are in the ConicShell. This epsilon is the same one determining face-to-faceness in the IEEE TMI paper.

The polarity indicates which direction along the gradient of BoundaryPoint1 the function is to be evaluated.

Definition at line 60 of file itkConicShellInteriorExteriorSpatialFunction.h.

Member Typedef Documentation

◆ ConstPointer

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
using itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::ConstPointer = SmartPointer<const Self>

◆ GradientType

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
using itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::GradientType = CovariantVector<double, VDimension>

The type of vector used to store the gradient info.

Definition at line 85 of file itkConicShellInteriorExteriorSpatialFunction.h.

◆ InputType

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
using itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::InputType = typename Superclass::InputType

Input type for the function.

Definition at line 79 of file itkConicShellInteriorExteriorSpatialFunction.h.

◆ OutputType

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
using itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::OutputType = typename Superclass::OutputType

Output type for the function.

Definition at line 82 of file itkConicShellInteriorExteriorSpatialFunction.h.

◆ Pointer

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
using itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::Pointer = SmartPointer<Self>

◆ Self

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
using itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::Self = ConicShellInteriorExteriorSpatialFunction

Standard class type aliases.

Definition at line 67 of file itkConicShellInteriorExteriorSpatialFunction.h.

◆ Superclass

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
using itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::Superclass = InteriorExteriorSpatialFunction<VDimension, TInput>

Constructor & Destructor Documentation

◆ ConicShellInteriorExteriorSpatialFunction()

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::ConicShellInteriorExteriorSpatialFunction ( )
protected

Set/Get the origin of the function.

◆ ~ConicShellInteriorExteriorSpatialFunction()

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::~ConicShellInteriorExteriorSpatialFunction ( )
overrideprotecteddefault

Set/Get the origin of the function.

Member Function Documentation

◆ CreateAnother()

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
virtual::itk::LightObject::Pointer itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::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::LightObject.

◆ Evaluate()

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
OutputType itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::Evaluate ( const InputType position) const
overridevirtual

Evaluates the function at a given position.

Implements itk::InteriorExteriorSpatialFunction< VDimension, TInput >.

◆ GetDistanceMax()

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
virtual double itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::GetDistanceMax ( ) const
virtual

Set/Get the maximum search distance.

◆ GetDistanceMin()

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
virtual double itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::GetDistanceMin ( ) const
virtual

Set/Get the minimum search distance.

◆ GetEpsilon()

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
virtual double itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::GetEpsilon ( ) const
virtual

Set/Get the tolerance of the in/out comparison.

◆ GetNameOfClass()

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
virtual const char* itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::GetNameOfClass ( ) const
virtual

Run time information.

Reimplemented from itk::InteriorExteriorSpatialFunction< VDimension, TInput >.

◆ GetOrigin()

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
virtual InputType itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::GetOrigin ( ) const
virtual

Set/Get the origin of the function.

◆ GetOriginGradient()

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
GradientType itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::GetOriginGradient ( )
inline

Set/Get the gradient at the origin of the function.

Definition at line 98 of file itkConicShellInteriorExteriorSpatialFunction.h.

◆ GetPolarity()

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
virtual bool itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::GetPolarity ( ) const
virtual

Set/Get direction along the gradient to search. Set to true to use the direction that the gradient is pointing; set to false for the opposite direction. Default is Off.

◆ New()

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
static Pointer itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::New ( )
static

Method for creation through the object factory.

◆ PolarityOff()

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
virtual void itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::PolarityOff ( )
virtual

Set/Get the origin of the function.

◆ PolarityOn()

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
virtual void itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::PolarityOn ( )
virtual

Set/Get the origin of the function.

◆ PrintSelf()

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
void itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Set/Get the origin of the function.

Reimplemented from itk::LightObject.

◆ SetDistanceMax()

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
virtual void itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::SetDistanceMax ( double  _arg)
virtual

Set/Get the origin of the function.

◆ SetDistanceMin()

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
virtual void itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::SetDistanceMin ( double  _arg)
virtual

Set/Get the origin of the function.

◆ SetEpsilon()

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
virtual void itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::SetEpsilon ( double  _arg)
virtual

Set/Get the origin of the function.

◆ SetOrigin()

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
virtual void itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::SetOrigin ( InputType  _arg)
virtual

Set/Get the origin of the function.

◆ SetOriginGradient()

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
void itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::SetOriginGradient ( GradientType  grad)

Set/Get the origin of the function.

◆ SetPolarity()

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
virtual void itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::SetPolarity ( bool  _arg)
virtual

Set/Get the origin of the function.

Member Data Documentation

◆ m_DistanceMax

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
double itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::m_DistanceMax { 0.0 }
private

Set/Get the origin of the function.

Definition at line 139 of file itkConicShellInteriorExteriorSpatialFunction.h.

◆ m_DistanceMin

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
double itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::m_DistanceMin { 0.0 }
private

Set/Get the origin of the function.

Definition at line 138 of file itkConicShellInteriorExteriorSpatialFunction.h.

◆ m_Epsilon

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
double itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::m_Epsilon { 0.0 }
private

Set/Get the origin of the function.

Definition at line 140 of file itkConicShellInteriorExteriorSpatialFunction.h.

◆ m_Origin

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
InputType itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::m_Origin
private

Set/Get the origin of the function.

Definition at line 136 of file itkConicShellInteriorExteriorSpatialFunction.h.

◆ m_OriginGradient

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
GradientType itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::m_OriginGradient
private

Set/Get the origin of the function.

Definition at line 137 of file itkConicShellInteriorExteriorSpatialFunction.h.

◆ m_Polarity

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
bool itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::m_Polarity { false }
private

Set/Get the origin of the function.

Definition at line 141 of file itkConicShellInteriorExteriorSpatialFunction.h.


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