ITK  5.0.0
Insight Segmentation and Registration 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>

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

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 40 of file itkFrustumSpatialFunction.h.

Public Types

using ConstPointer = SmartPointer< const Self >
 
enum  FrustumRotationPlaneType {
  RotateInXZPlane = 1,
  RotateInYZPlane
}
 
using InputType = typename Superclass::InputType
 
using OutputType = typename Superclass::OutputType
 
using Pointer = SmartPointer< Self >
 
using Self = FrustumSpatialFunction< VDimension, TInput >
 
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
 
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::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
 
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 noexceptoverride
 
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 ()
 

Protected Member Functions

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

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

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

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

Definition at line 50 of file itkFrustumSpatialFunction.h.

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

Input type for the function.

Definition at line 59 of file itkFrustumSpatialFunction.h.

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

Output type for the function.

Definition at line 62 of file itkFrustumSpatialFunction.h.

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

Definition at line 49 of file itkFrustumSpatialFunction.h.

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 47 of file itkFrustumSpatialFunction.h.

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

Definition at line 48 of file itkFrustumSpatialFunction.h.

Member Enumeration Documentation

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

Rotate the frustum in the XZ or the YZ plane.

Enumerator
RotateInXZPlane 
RotateInYZPlane 

Definition at line 65 of file itkFrustumSpatialFunction.h.

Constructor & Destructor Documentation

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

Member Function Documentation

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

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< VDimension, TInput >.

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.

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.

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.

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.

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.

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

Run-time type information (and related methods).

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

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

Definition at line 115 of file itkFrustumSpatialFunction.h.

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

Definition at line 116 of file itkFrustumSpatialFunction.h.

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

Definition at line 117 of file itkFrustumSpatialFunction.h.

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

Definition at line 114 of file itkFrustumSpatialFunction.h.

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

Definition at line 119 of file itkFrustumSpatialFunction.h.

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

Definition at line 120 of file itkFrustumSpatialFunction.h.

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

Definition at line 118 of file itkFrustumSpatialFunction.h.


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