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

#include <itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h>

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using InputType = typename Superclass::InputType
 
using OutputType = typename Superclass::OutputType
 
using Pointer = SmartPointer< Self >
 
using Self = SymmetricEllipsoidInteriorExteriorSpatialFunction
 
using Superclass = InteriorExteriorSpatialFunction< VDimension >
 
using VectorType = Vector< double, VDimension >
 
- 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
 
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_Center
 
double m_UniqueAxis { 10 }
 
double m_SymmetricAxes { 5 }
 
Vector< double, VDimension > m_Orientation
 
double m_VectorRatio { 0.0 }
 
virtual InputType GetCenter () const
 
virtual void SetCenter (InputType _arg)
 
void SetOrientation (VectorType orientation, double uniqueAxis, double symmetricAxes)
 
 SymmetricEllipsoidInteriorExteriorSpatialFunction ()
 
 ~SymmetricEllipsoidInteriorExteriorSpatialFunction () 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
 
 ~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::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >

Function implementation of an ellipsoid.

Similar to EllipsoidInteriorExteriorSpatialFunction in that it implements a function that returns 1 for points inside or on the surface of a ellipsoid and 0 for points outside the ellipsoid. However, this ellipsoid is defined by a single orientation vector and deals only with symmetric ellipsoids. An n-dimensional symmetric ellipsoid is one which has m axes of equal length and (n - m) unique axes lengths. Specifically, this class deals with the case where (n - m) = 1 and the ellipsoid's major axis is oriented along a singles orientation vector.

Definition at line 39 of file itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h.

Member Typedef Documentation

◆ ConstPointer

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

◆ InputType

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

Input type for the function.

Definition at line 59 of file itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h.

◆ OutputType

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

Output type for the function.

Definition at line 62 of file itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h.

◆ Pointer

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

◆ Self

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

Standard class type aliases.

Definition at line 46 of file itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h.

◆ Superclass

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

◆ VectorType

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
using itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::VectorType = Vector<double, VDimension>

Constructor & Destructor Documentation

◆ SymmetricEllipsoidInteriorExteriorSpatialFunction()

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

The center of the ellipsoid.

◆ ~SymmetricEllipsoidInteriorExteriorSpatialFunction()

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

The center of the ellipsoid.

Member Function Documentation

◆ CreateAnother()

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

◆ Evaluate()

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

Evaluates the function at a given position.

Implements itk::InteriorExteriorSpatialFunction< VDimension, TInput >.

◆ GetCenter()

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

Get and set the center of the ellipsoid.

◆ GetNameOfClass()

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

Run-time information.

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

◆ New()

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

Method for creation through the object factory.

◆ PrintSelf()

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

The center of the ellipsoid.

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

◆ SetCenter()

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

The center of the ellipsoid.

◆ SetOrientation()

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
void itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::SetOrientation ( VectorType  orientation,
double  uniqueAxis,
double  symmetricAxes 
)

Set the orientation vector of the ellipsoid's unique axis and axes lengths. Must be normalized!!!!!

Member Data Documentation

◆ m_Center

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

The center of the ellipsoid.

Definition at line 87 of file itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h.

◆ m_Orientation

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
Vector<double, VDimension> itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::m_Orientation
private

The orientation vector of the ellipsoid's unique axis.

Definition at line 96 of file itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h.

◆ m_SymmetricAxes

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
double itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::m_SymmetricAxes { 5 }
private

The symmetric axes lengths of the ellipsoid.

Definition at line 93 of file itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h.

◆ m_UniqueAxis

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
double itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::m_UniqueAxis { 10 }
private

The unique axis length of the ellipsoid.

Definition at line 90 of file itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h.

◆ m_VectorRatio

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

The vector ratio.

Definition at line 99 of file itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h.


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