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

#include <itkFrustumSpatialFunction.h>

Detailed Description

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

Spatial function implementation of a truncated pyramid.

Implements a function that returns 0 for points inside or on the surface of a truncated pyramid, 1 for points outside the truncated pyramid.

Definition at line 62 of file itkFrustumSpatialFunction.h.

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using FrustumRotationPlaneType = RotationPlaneEnum
 
using Pointer = SmartPointer< Self >
 
using RotationPlaneEnum = FrustumSpatialFunctionEnums::RotationPlane
 
using Self = FrustumSpatialFunction< VDimension, TInput >
 
using Superclass = InteriorExteriorSpatialFunction< VDimension, TInput >
 
- Public Types inherited from itk::InteriorExteriorSpatialFunction< 3, Point< double, 3 > >
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = InteriorExteriorSpatialFunction
 
using Superclass = SpatialFunction< bool, VDimension, Point< double, 3 > >
 
- Public Types inherited from itk::SpatialFunction< bool, VDimension, Point< double, 3 > >
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = SpatialFunction
 
using Superclass = FunctionBase< Point< double, 3 >, bool >
 
- Public Types inherited from itk::FunctionBase< Point< double, 3 >, bool >
using ConstPointer = SmartPointer< const Self >
 
using InputType = Point< double, 3 >
 
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
 
const char * GetNameOfClass () const override
 
virtual InputType GetApex () const
 
virtual void SetApex (InputType _arg)
 
virtual double GetAngleZ () const
 
virtual void SetAngleZ (double _arg)
 
virtual double GetApertureAngleX () const
 
virtual void SetApertureAngleX (double _arg)
 
virtual double GetApertureAngleY () const
 
virtual void SetApertureAngleY (double _arg)
 
virtual double GetTopPlane () const
 
virtual void SetTopPlane (double _arg)
 
virtual double GetBottomPlane () const
 
virtual void SetBottomPlane (double _arg)
 
virtual FrustumRotationPlaneType GetRotationPlane () const
 
virtual void SetRotationPlane (FrustumRotationPlaneType _arg)
 
- Public Member Functions inherited from itk::InteriorExteriorSpatialFunction< 3, Point< double, 3 > >
OutputType Evaluate (const InputType &input) const override=0
 
const char * GetNameOfClass () const override
 
- Public Member Functions inherited from itk::SpatialFunction< bool, VDimension, Point< double, 3 > >
OutputType Evaluate (const InputType &input) const override=0
 
const char * GetNameOfClass () const override
 
virtual OutputType Evaluate (const InputType &input) const=0
 
const char * GetNameOfClass () const override
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) 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
 
const char * GetNameOfClass () const override
 
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) const
 
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 Pointer CreateAnother () const
 
virtual void Delete ()
 
virtual const char * GetNameOfClass () const
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Register () const
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const noexcept
 

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

 FrustumSpatialFunction ()=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~FrustumSpatialFunction () override=default
 
- Protected Member Functions inherited from itk::InteriorExteriorSpatialFunction< 3, Point< double, 3 > >
 InteriorExteriorSpatialFunction ()=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~InteriorExteriorSpatialFunction () override=default
 
- Protected Member Functions inherited from itk::SpatialFunction< bool, VDimension, Point< double, 3 > >
void PrintSelf (std::ostream &os, Indent indent) const override
 
 SpatialFunction ()=default
 
 ~SpatialFunction () override=default
 
- Protected Member Functions inherited from itk::FunctionBase< Point< double, 3 >, bool >
 FunctionBase ()=default
 
 ~FunctionBase () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
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 PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

double m_AngleZ { 0.0f }
 
double m_ApertureAngleX { 0.0f }
 
double m_ApertureAngleY { 0.0f }
 
InputType m_Apex {}
 
double m_BottomPlane { 0.0f }
 
FrustumRotationPlaneType m_RotationPlane { RotationPlaneEnum::RotateInXZPlane }
 
double m_TopPlane { 0.0f }
 

Additional Inherited Members

- Static Public Attributes inherited from itk::SpatialFunction< bool, VDimension, Point< double, 3 > >
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::FrustumSpatialFunction< VDimension, TInput >::ConstPointer = SmartPointer<const Self>

Definition at line 71 of file itkFrustumSpatialFunction.h.

◆ FrustumRotationPlaneType

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
using itk::FrustumSpatialFunction< VDimension, TInput >::FrustumRotationPlaneType = RotationPlaneEnum

Rotate the frustum in the XZ or the YZ plane.

Definition at line 88 of file itkFrustumSpatialFunction.h.

◆ Pointer

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

Definition at line 70 of file itkFrustumSpatialFunction.h.

◆ RotationPlaneEnum

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
using itk::FrustumSpatialFunction< VDimension, TInput >::RotationPlaneEnum = FrustumSpatialFunctionEnums::RotationPlane

Definition at line 73 of file itkFrustumSpatialFunction.h.

◆ Self

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

Standard class type aliases.

Definition at line 68 of file itkFrustumSpatialFunction.h.

◆ Superclass

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

Definition at line 69 of file itkFrustumSpatialFunction.h.

Constructor & Destructor Documentation

◆ FrustumSpatialFunction()

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

◆ ~FrustumSpatialFunction()

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

Member Function Documentation

◆ Evaluate()

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

Evaluates the function at a given position.

Implements itk::InteriorExteriorSpatialFunction< 3, Point< double, 3 > >.

◆ GetAngleZ()

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

Set/Get the angle of the pyramid axis with respect to the Z axis.

◆ GetApertureAngleX()

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

Set/Get the aperture angle in the X axis.

◆ GetApertureAngleY()

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

Set/Get the aperture angle in the Y axis.

◆ GetApex()

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

Set/Get the apex of the pyramid.

◆ GetBottomPlane()

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

Set/Get the bottom plane distance to the apex.

◆ GetNameOfClass()

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
const char * itk::FrustumSpatialFunction< VDimension, TInput >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::LightObject.

◆ GetRotationPlane()

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
virtual FrustumRotationPlaneType itk::FrustumSpatialFunction< VDimension, TInput >::GetRotationPlane ( ) const
virtual

Set/Get the plane in which the frustum should rotate.

◆ GetTopPlane()

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

Set/Get the top plane distance to the apex.

◆ New()

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

Method for creation through the object factory.

◆ PrintSelf()

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

◆ SetAngleZ()

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

Set/Get the angle of the pyramid axis with respect to the Z axis.

◆ SetApertureAngleX()

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

Set/Get the aperture angle in the X axis.

◆ SetApertureAngleY()

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

Set/Get the aperture angle in the Y axis.

◆ SetApex()

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

Set/Get the apex of the pyramid.

◆ SetBottomPlane()

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

Set/Get the bottom plane distance to the apex.

◆ SetRotationPlane()

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

Set/Get the plane in which the frustum should rotate.

◆ SetTopPlane()

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

Set/Get the top plane distance to the apex.

Member Data Documentation

◆ m_AngleZ

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
double itk::FrustumSpatialFunction< VDimension, TInput >::m_AngleZ { 0.0f }
private

Definition at line 143 of file itkFrustumSpatialFunction.h.

◆ m_ApertureAngleX

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
double itk::FrustumSpatialFunction< VDimension, TInput >::m_ApertureAngleX { 0.0f }
private

Definition at line 144 of file itkFrustumSpatialFunction.h.

◆ m_ApertureAngleY

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
double itk::FrustumSpatialFunction< VDimension, TInput >::m_ApertureAngleY { 0.0f }
private

Definition at line 145 of file itkFrustumSpatialFunction.h.

◆ m_Apex

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

Definition at line 142 of file itkFrustumSpatialFunction.h.

◆ m_BottomPlane

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
double itk::FrustumSpatialFunction< VDimension, TInput >::m_BottomPlane { 0.0f }
private

Definition at line 147 of file itkFrustumSpatialFunction.h.

◆ m_RotationPlane

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
FrustumRotationPlaneType itk::FrustumSpatialFunction< VDimension, TInput >::m_RotationPlane { RotationPlaneEnum::RotateInXZPlane }
private

Definition at line 148 of file itkFrustumSpatialFunction.h.

◆ m_TopPlane

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
double itk::FrustumSpatialFunction< VDimension, TInput >::m_TopPlane { 0.0f }
private

Definition at line 146 of file itkFrustumSpatialFunction.h.


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