RTK  2.5.0
Reconstruction Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <rtkDrawEllipsoidImageFilter.h>

+ Inheritance diagram for rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >:

Public Types

using ConstPointer = itk::SmartPointer< const Self >
 
using Pointer = itk::SmartPointer< Self >
 
using PointType = ConvexShape::PointType
 
using ScalarType = ConvexShape::ScalarType
 
using Self = DrawEllipsoidImageFilter
 
using Superclass = DrawConvexImageFilter< TInputImage, TOutputImage >
 
using VectorType = ConvexShape::VectorType
 
- Public Types inherited from rtk::DrawConvexImageFilter< TInputImage, TOutputImage >
using ConstPointer = itk::SmartPointer< const Self >
 
using ConvexShapePointer = ConvexShape::Pointer
 
using OutputImageRegionType = typename TOutputImage::RegionType
 
using Pointer = itk::SmartPointer< Self >
 
using PointType = ConvexShape::PointType
 
using ScalarType = ConvexShape::ScalarType
 
using Self = DrawConvexImageFilter
 
using Superclass = itk::InPlaceImageFilter< TInputImage, TOutputImage >
 
using VectorType = ConvexShape::VectorType
 

Public Member Functions

void AddClipPlane (const VectorType &dir, const ScalarType &pos)
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
virtual ScalarType GetDensity ()
 
virtual void SetDensity (ScalarType _arg)
 
virtual const std::vector< VectorType > & GetPlaneDirections () const
 
virtual const std::vector< ScalarType > & GetPlanePositions () const
 
virtual PointType GetCenter ()
 
virtual void SetCenter (PointType _arg)
 
virtual VectorType GetAxis ()
 
virtual void SetAxis (VectorType _arg)
 
virtual ScalarType GetAngle ()
 
virtual void SetAngle (ScalarType _arg)
 
- Public Member Functions inherited from rtk::DrawConvexImageFilter< TInputImage, TOutputImage >
virtual ConvexShapeGetModifiableConvexShape ()
 
virtual const ConvexShapeGetConvexShape () const
 
virtual void SetConvexShape (ConvexShape *_arg)
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from rtk::DrawConvexImageFilter< TInputImage, TOutputImage >
static Pointer New ()
 

Protected Member Functions

void BeforeThreadedGenerateData () override
 
 DrawEllipsoidImageFilter ()
 
 ~DrawEllipsoidImageFilter () override=default
 
- Protected Member Functions inherited from rtk::DrawConvexImageFilter< TInputImage, TOutputImage >
 DrawConvexImageFilter ()
 
void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override
 
 ~DrawConvexImageFilter () override=default
 

Private Attributes

ScalarType m_Angle { 0. }
 
VectorType m_Axis
 
PointType m_Center
 
ScalarType m_Density { 1. }
 
std::vector< VectorTypem_PlaneDirections
 
std::vector< ScalarTypem_PlanePositions
 

Detailed Description

template<class TInputImage, class TOutputImage>
class rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >

Draws an ellipsoid in a 3D image.

Test:
rtkdrawgeometricphantomtest.cxx, rtkforbildtest.cxx
Author
Marc Vila, Simon Rit

Definition at line 38 of file rtkDrawEllipsoidImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputImage , class TOutputImage >
using rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >::ConstPointer = itk::SmartPointer<const Self>

Definition at line 47 of file rtkDrawEllipsoidImageFilter.h.

◆ Pointer

template<class TInputImage , class TOutputImage >
using rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >::Pointer = itk::SmartPointer<Self>

Definition at line 46 of file rtkDrawEllipsoidImageFilter.h.

◆ PointType

template<class TInputImage , class TOutputImage >
using rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >::PointType = ConvexShape::PointType

Convenient type alias.

Definition at line 50 of file rtkDrawEllipsoidImageFilter.h.

◆ ScalarType

template<class TInputImage , class TOutputImage >
using rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >::ScalarType = ConvexShape::ScalarType

Definition at line 52 of file rtkDrawEllipsoidImageFilter.h.

◆ Self

template<class TInputImage , class TOutputImage >
using rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >::Self = DrawEllipsoidImageFilter

Standard class type alias.

Definition at line 44 of file rtkDrawEllipsoidImageFilter.h.

◆ Superclass

template<class TInputImage , class TOutputImage >
using rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >::Superclass = DrawConvexImageFilter<TInputImage, TOutputImage>

Definition at line 45 of file rtkDrawEllipsoidImageFilter.h.

◆ VectorType

template<class TInputImage , class TOutputImage >
using rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >::VectorType = ConvexShape::VectorType

Definition at line 51 of file rtkDrawEllipsoidImageFilter.h.

Constructor & Destructor Documentation

◆ DrawEllipsoidImageFilter()

template<class TInputImage , class TOutputImage >
rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >::DrawEllipsoidImageFilter ( )
protected

◆ ~DrawEllipsoidImageFilter()

template<class TInputImage , class TOutputImage >
rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >::~DrawEllipsoidImageFilter ( )
overrideprotecteddefault

Member Function Documentation

◆ AddClipPlane()

template<class TInputImage , class TOutputImage >
void rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >::AddClipPlane ( const VectorType dir,
const ScalarType pos 
)

See ConvexShape for the definition of clip planes.

◆ BeforeThreadedGenerateData()

template<class TInputImage , class TOutputImage >
void rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData ( )
overrideprotectedvirtual

ConvexShape must be created in the BeforeThreadedGenerateData in the daugter classes.

Reimplemented from rtk::DrawConvexImageFilter< TInputImage, TOutputImage >.

◆ CreateAnother()

template<class TInputImage , class TOutputImage >
virtual::itk::LightObject::Pointer rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >::CreateAnother ( ) const
virtual

◆ GetAngle()

template<class TInputImage , class TOutputImage >
virtual ScalarType rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >::GetAngle ( )
virtual

Get/Set the rotation angle around the y axis.

◆ GetAxis()

template<class TInputImage , class TOutputImage >
virtual VectorType rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >::GetAxis ( )
virtual

Get/Set the semi-principal axes of the ellipsoid.

◆ GetCenter()

template<class TInputImage , class TOutputImage >
virtual PointType rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >::GetCenter ( )
virtual

Get/Set the center of the ellipsoid.

◆ GetDensity()

template<class TInputImage , class TOutputImage >
virtual ScalarType rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >::GetDensity ( )
virtual

Get / Set the constant density of the volume

◆ GetNameOfClass()

template<class TInputImage , class TOutputImage >
virtual const char* rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
virtual

◆ GetPlaneDirections()

template<class TInputImage , class TOutputImage >
virtual const std::vector<VectorType>& rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >::GetPlaneDirections ( ) const
virtual

Get reference to vector of plane parameters.

◆ GetPlanePositions()

template<class TInputImage , class TOutputImage >
virtual const std::vector<ScalarType>& rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >::GetPlanePositions ( ) const
virtual

Get reference to vector of plane parameters.

◆ New()

template<class TInputImage , class TOutputImage >
static Pointer rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >::New ( )
static

Method for creation through the object factory.

◆ SetAngle()

template<class TInputImage , class TOutputImage >
virtual void rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >::SetAngle ( ScalarType  _arg)
virtual

Get/Set the rotation angle around the y axis.

◆ SetAxis()

template<class TInputImage , class TOutputImage >
virtual void rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >::SetAxis ( VectorType  _arg)
virtual

Get/Set the semi-principal axes of the ellipsoid.

◆ SetCenter()

template<class TInputImage , class TOutputImage >
virtual void rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >::SetCenter ( PointType  _arg)
virtual

Get/Set the center of the ellipsoid.

◆ SetDensity()

template<class TInputImage , class TOutputImage >
virtual void rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >::SetDensity ( ScalarType  _arg)
virtual

Get / Set the constant density of the volume

Member Data Documentation

◆ m_Angle

template<class TInputImage , class TOutputImage >
ScalarType rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >::m_Angle { 0. }
private

Definition at line 108 of file rtkDrawEllipsoidImageFilter.h.

◆ m_Axis

template<class TInputImage , class TOutputImage >
VectorType rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >::m_Axis
private

Definition at line 107 of file rtkDrawEllipsoidImageFilter.h.

◆ m_Center

template<class TInputImage , class TOutputImage >
PointType rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >::m_Center
private

Definition at line 106 of file rtkDrawEllipsoidImageFilter.h.

◆ m_Density

template<class TInputImage , class TOutputImage >
ScalarType rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >::m_Density { 1. }
private

Definition at line 102 of file rtkDrawEllipsoidImageFilter.h.

◆ m_PlaneDirections

template<class TInputImage , class TOutputImage >
std::vector<VectorType> rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >::m_PlaneDirections
private

Definition at line 103 of file rtkDrawEllipsoidImageFilter.h.

◆ m_PlanePositions

template<class TInputImage , class TOutputImage >
std::vector<ScalarType> rtk::DrawEllipsoidImageFilter< TInputImage, TOutputImage >::m_PlanePositions
private

Definition at line 104 of file rtkDrawEllipsoidImageFilter.h.


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