ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput > Class Template Reference

#include <itkEllipsoidInteriorExteriorSpatialFunction.h>

Detailed Description

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

Function implementation of an ellipsoid.

Implements a function that returns 1 for points inside or on the surface of a ellipsoid and 0 for points outside the ellipsoid. The orientation of the n-dimensional ellipsoid axes are defined by n orthogonal vectors. See Examples/EllipsoidInteriorExteriorSpatialFunction/README for an example of creating an Ellipsoid in an image.

Definition at line 39 of file itkEllipsoidInteriorExteriorSpatialFunction.h.

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using OrientationType = vnl_matrix_fixed< double, VDimension, VDimension >
 
using Pointer = SmartPointer< Self >
 
using Self = EllipsoidInteriorExteriorSpatialFunction
 
using Superclass = InteriorExteriorSpatialFunction< VDimension, TInput >
 
- Public Types inherited from itk::InteriorExteriorSpatialFunction< VDimension, TInput >
using ConstPointer = SmartPointer< const Self >
 
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 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

OutputType Evaluate (const InputType &position) const override
 
 itkOverrideGetNameOfClassMacro (EllipsoidInteriorExteriorSpatialFunction)
 
void SetOrientations (const OrientationType &)
 
virtual InputType GetCenter () const
 
virtual void SetCenter (InputType _arg)
 
virtual InputType GetAxes () const
 
virtual void SetAxes (InputType _arg)
 
- Public Member Functions inherited from itk::InteriorExteriorSpatialFunction< VDimension, TInput >
 itkOverrideGetNameOfClassMacro (InteriorExteriorSpatialFunction)
 
- Public Member Functions inherited from itk::SpatialFunction< bool, VDimension, TInput >
 itkOverrideGetNameOfClassMacro (SpatialFunction)
 
- Public Member Functions inherited from itk::FunctionBase< TInput, bool >
 itkOverrideGetNameOfClassMacro (FunctionBase)
 
- 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
 
 itkOverrideGetNameOfClassMacro (Object)
 
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
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkVirtualGetNameOfClassMacro (LightObject)
 
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 ()
 

Protected Member Functions

 EllipsoidInteriorExteriorSpatialFunction ()=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~EllipsoidInteriorExteriorSpatialFunction () override=default
 
- 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 ()
 
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

InputType m_Axes { MakeFilled<InputType>(1.0f) }
 
InputType m_Center {}
 
OrientationType m_Orientations {}
 

Additional Inherited Members

- Static Public Attributes inherited from itk::SpatialFunction< bool, VDimension, TInput >
static constexpr unsigned int ImageDimension
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

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

◆ OrientationType

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
using itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::OrientationType = vnl_matrix_fixed<double, VDimension, VDimension>

Typedef for the orientation matrix

Definition at line 64 of file itkEllipsoidInteriorExteriorSpatialFunction.h.

◆ Pointer

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

◆ Self

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

Standard class type aliases.

Definition at line 46 of file itkEllipsoidInteriorExteriorSpatialFunction.h.

◆ Superclass

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

Constructor & Destructor Documentation

◆ EllipsoidInteriorExteriorSpatialFunction()

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

◆ ~EllipsoidInteriorExteriorSpatialFunction()

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

Member Function Documentation

◆ Evaluate()

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

Evaluates the function at a given position.

Implements itk::InteriorExteriorSpatialFunction< VDimension, TInput >.

◆ GetAxes()

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

Get and set the axes lengths of the ellipsoid.

◆ GetCenter()

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

Set/Get and set the center of the ellipsoid.

◆ itkOverrideGetNameOfClassMacro()

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

Run-time type information (and related methods).

◆ New()

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

Method for creation through the object factory.

◆ PrintSelf()

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

◆ SetAxes()

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

Get and set the axes lengths of the ellipsoid.

◆ SetCenter()

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

Set/Get and set the center of the ellipsoid.

◆ SetOrientations()

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
void itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::SetOrientations ( const OrientationType )

Set the orientation vectors (must be orthogonal) of the ellipsoid axes. Must be normalized!!!!!

Member Data Documentation

◆ m_Axes

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
InputType itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::m_Axes { MakeFilled<InputType>(1.0f) }
private

The axes lengths of the ellipsoid.

Definition at line 97 of file itkEllipsoidInteriorExteriorSpatialFunction.h.

◆ m_Center

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
InputType itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::m_Center {}
private

The center of the ellipsoid.

Definition at line 94 of file itkEllipsoidInteriorExteriorSpatialFunction.h.

◆ m_Orientations

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
OrientationType itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::m_Orientations {}
private

The orientation vectors (must be orthogonal) of the ellipsoid axes.

Definition at line 100 of file itkEllipsoidInteriorExteriorSpatialFunction.h.


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