#include <rtkDrawGeometricPhantomImageFilter.h>

Inheritance diagram for rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >:

Collaboration diagram for rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >:

Public Types
using	ConstPointer = itk::SmartPointer< const Self >

using	GeometricPhantomConstPointer = GeometricPhantom::ConstPointer

using	Pointer = itk::SmartPointer< Self >

using	RotationMatrixType = ConvexShape::RotationMatrixType

using	ScalarType = ConvexShape::ScalarType

using	Self = DrawGeometricPhantomImageFilter

using	StringType = std::string

using	Superclass = itk::InPlaceImageFilter< TInputImage, TOutputImage >

using	VectorType = ConvexShape::VectorType

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual void	SetPhantomScale (const ScalarType _arg)


virtual const char *	GetNameOfClass () const


virtual const GeometricPhantom *	GetGeometricPhantom () const

virtual void	SetGeometricPhantom (const GeometricPhantom *_arg)


virtual void	SetConfigFile (StringType _arg)

virtual StringType	GetConfigFile ()


virtual void	SetPhantomScale (VectorType _arg)

virtual VectorType	GetPhantomScale ()


virtual void	SetOriginOffset (VectorType _arg)

virtual VectorType	GetOriginOffset ()


virtual void	SetIsForbildConfigFile (bool _arg)

virtual bool	GetIsForbildConfigFile () const

virtual void	IsForbildConfigFileOn ()

virtual void	IsForbildConfigFileOff ()


virtual void	SetRotationMatrix (RotationMatrixType _arg)

virtual RotationMatrixType	GetRotationMatrix ()


void	AddClipPlane (const VectorType &dir, const ScalarType &pos)

void	SetClipPlanes (const std::vector< VectorType > &dir, const std::vector< ScalarType > &pos)

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	DrawGeometricPhantomImageFilter ()

void	GenerateData () override

	~DrawGeometricPhantomImageFilter () override=default

Private Attributes
StringType	m_ConfigFile

GeometricPhantomConstPointer	m_GeometricPhantom

bool	m_IsForbildConfigFile { false }

VectorType	m_OriginOffset { 0. }

VectorType	m_PhantomScale { 1. }

std::vector< VectorType >	m_PlaneDirections

std::vector< ScalarType >	m_PlanePositions

RotationMatrixType	m_RotationMatrix

Detailed Description

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

Draws a GeometricPhantom in a 3D image.

Test:: rtkprojectgeometricphantomtest.cxx, rtkforbildtest.cxx

Author: Marc Vila, Simon Rit

Definition at line 39 of file rtkDrawGeometricPhantomImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputImage , class TOutputImage >

using rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::ConstPointer = itk::SmartPointer<const Self>

Definition at line 48 of file rtkDrawGeometricPhantomImageFilter.h.

◆ GeometricPhantomConstPointer

template<class TInputImage , class TOutputImage >

using rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::GeometricPhantomConstPointer = GeometricPhantom::ConstPointer

Convenient type alias.

Definition at line 51 of file rtkDrawGeometricPhantomImageFilter.h.

◆ Pointer

template<class TInputImage , class TOutputImage >

using rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::Pointer = itk::SmartPointer<Self>

Definition at line 47 of file rtkDrawGeometricPhantomImageFilter.h.

◆ RotationMatrixType

template<class TInputImage , class TOutputImage >

using rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::RotationMatrixType = ConvexShape::RotationMatrixType

Definition at line 54 of file rtkDrawGeometricPhantomImageFilter.h.

◆ ScalarType

template<class TInputImage , class TOutputImage >

using rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::ScalarType = ConvexShape::ScalarType

Definition at line 55 of file rtkDrawGeometricPhantomImageFilter.h.

◆ Self

template<class TInputImage , class TOutputImage >

using rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::Self = DrawGeometricPhantomImageFilter

Standard class type alias.

Definition at line 45 of file rtkDrawGeometricPhantomImageFilter.h.

◆ StringType

template<class TInputImage , class TOutputImage >

using rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::StringType = std::string

Definition at line 52 of file rtkDrawGeometricPhantomImageFilter.h.

◆ Superclass

template<class TInputImage , class TOutputImage >

using rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::Superclass = itk::InPlaceImageFilter<TInputImage, TOutputImage>

Definition at line 46 of file rtkDrawGeometricPhantomImageFilter.h.

◆ VectorType

template<class TInputImage , class TOutputImage >

using rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::VectorType = ConvexShape::VectorType

Definition at line 53 of file rtkDrawGeometricPhantomImageFilter.h.

Constructor & Destructor Documentation

◆ DrawGeometricPhantomImageFilter()

template<class TInputImage , class TOutputImage >

rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::DrawGeometricPhantomImageFilter ( )

protected

◆ ~DrawGeometricPhantomImageFilter()

template<class TInputImage , class TOutputImage >

rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::~DrawGeometricPhantomImageFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ AddClipPlane()

template<class TInputImage , class TOutputImage >

void rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::AddClipPlane	(	const VectorType &	dir,
		const ScalarType &	pos
	)

Add clipping plane to the object. The plane is defined by the equation dir * (x,y,z)' + pos = 0.

◆ CreateAnother()

template<class TInputImage , class TOutputImage >

virtual::itk::LightObject::Pointer rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::CreateAnother ( ) const

virtual

Reimplemented from itk::Object.

Reimplemented in rtk::DrawSheppLoganFilter< TInputImage, TOutputImage >.

◆ GenerateData()

template<class TInputImage , class TOutputImage >

void rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::GenerateData ( )

overrideprotectedvirtual

Reimplemented from itk::ImageSource< TOutputImage >.

Reimplemented in rtk::DrawSheppLoganFilter< TInputImage, TOutputImage >.

◆ GetConfigFile()

template<class TInputImage , class TOutputImage >

virtual StringType rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::GetConfigFile ( )

virtual

Get/Set the phantom file path.

◆ GetGeometricPhantom()

template<class TInputImage , class TOutputImage >

virtual const GeometricPhantom* rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::GetGeometricPhantom ( ) const

virtual

Get / Set the object pointer to the geometry.

◆ GetIsForbildConfigFile()

template<class TInputImage , class TOutputImage >

virtual bool rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::GetIsForbildConfigFile ( ) const

virtual

Interpret config file as Forbild file (see http://www.imp.uni-erlangen.de/phantoms/).

◆ GetNameOfClass()

template<class TInputImage , class TOutputImage >

virtual const char* rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Reimplemented in rtk::DrawSheppLoganFilter< TInputImage, TOutputImage >.

◆ GetOriginOffset()

template<class TInputImage , class TOutputImage >

virtual VectorType rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::GetOriginOffset ( )

virtual

Get / Set the spatial offset of the phantom relative to its center. The default value is (0, 0, 0).

◆ GetPhantomScale()

template<class TInputImage , class TOutputImage >

virtual VectorType rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::GetPhantomScale ( )

virtual

Multiplicative scaling factor along each 3D component.

◆ GetRotationMatrix()

template<class TInputImage , class TOutputImage >

virtual RotationMatrixType rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::GetRotationMatrix ( )

virtual

Get / Set a rotation matrix for the phantom. Default is identity.

◆ IsForbildConfigFileOff()

template<class TInputImage , class TOutputImage >

virtual void rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::IsForbildConfigFileOff ( )

virtual

Interpret config file as Forbild file (see http://www.imp.uni-erlangen.de/phantoms/).

◆ IsForbildConfigFileOn()

template<class TInputImage , class TOutputImage >

virtual void rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::IsForbildConfigFileOn ( )

virtual

Interpret config file as Forbild file (see http://www.imp.uni-erlangen.de/phantoms/).

◆ New()

template<class TInputImage , class TOutputImage >

static Pointer rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::New ( )

static

Method for creation through the object factory.

◆ SetClipPlanes()

template<class TInputImage , class TOutputImage >

void rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::SetClipPlanes	(	const std::vector< VectorType > &	dir,
		const std::vector< ScalarType > &	pos
	)

Add clipping plane to the object. The plane is defined by the equation dir * (x,y,z)' + pos = 0.

◆ SetConfigFile()

template<class TInputImage , class TOutputImage >

virtual void rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::SetConfigFile ( StringType _arg )

virtual

Get/Set the phantom file path.

◆ SetGeometricPhantom()

template<class TInputImage , class TOutputImage >

virtual void rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::SetGeometricPhantom ( const GeometricPhantom * _arg )

virtual

Get / Set the object pointer to the geometry.

◆ SetIsForbildConfigFile()

template<class TInputImage , class TOutputImage >

virtual void rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::SetIsForbildConfigFile ( bool _arg )

virtual

Interpret config file as Forbild file (see http://www.imp.uni-erlangen.de/phantoms/).

◆ SetOriginOffset()

template<class TInputImage , class TOutputImage >

virtual void rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::SetOriginOffset ( VectorType _arg )

virtual

Get / Set the spatial offset of the phantom relative to its center. The default value is (0, 0, 0).

◆ SetPhantomScale() [1/2]

template<class TInputImage , class TOutputImage >

virtual void rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::SetPhantomScale ( VectorType _arg )

virtual

Multiplicative scaling factor along each 3D component.

◆ SetPhantomScale() [2/2]

template<class TInputImage , class TOutputImage >

virtual void rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::SetPhantomScale ( const ScalarType _arg )

inlinevirtual

Set isotropic scaling factor.

Definition at line 85 of file rtkDrawGeometricPhantomImageFilter.h.

◆ SetRotationMatrix()

template<class TInputImage , class TOutputImage >

virtual void rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::SetRotationMatrix ( RotationMatrixType _arg )

virtual

Get / Set a rotation matrix for the phantom. Default is identity.

Member Data Documentation

◆ m_ConfigFile

template<class TInputImage , class TOutputImage >

StringType rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::m_ConfigFile

private

Definition at line 125 of file rtkDrawGeometricPhantomImageFilter.h.

◆ m_GeometricPhantom

template<class TInputImage , class TOutputImage >

GeometricPhantomConstPointer rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::m_GeometricPhantom

private

Definition at line 124 of file rtkDrawGeometricPhantomImageFilter.h.

◆ m_IsForbildConfigFile

template<class TInputImage , class TOutputImage >

bool rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::m_IsForbildConfigFile { false }

private

Definition at line 128 of file rtkDrawGeometricPhantomImageFilter.h.

◆ m_OriginOffset

template<class TInputImage , class TOutputImage >

VectorType rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::m_OriginOffset { 0. }

private

Definition at line 127 of file rtkDrawGeometricPhantomImageFilter.h.

◆ m_PhantomScale

template<class TInputImage , class TOutputImage >

VectorType rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::m_PhantomScale { 1. }

private

Definition at line 126 of file rtkDrawGeometricPhantomImageFilter.h.

◆ m_PlaneDirections

template<class TInputImage , class TOutputImage >

std::vector<VectorType> rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::m_PlaneDirections

private

Definition at line 130 of file rtkDrawGeometricPhantomImageFilter.h.

◆ m_PlanePositions

template<class TInputImage , class TOutputImage >

std::vector<ScalarType> rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::m_PlanePositions

private

Definition at line 131 of file rtkDrawGeometricPhantomImageFilter.h.

◆ m_RotationMatrix

template<class TInputImage , class TOutputImage >

RotationMatrixType rtk::DrawGeometricPhantomImageFilter< TInputImage, TOutputImage >::m_RotationMatrix

private

Definition at line 129 of file rtkDrawGeometricPhantomImageFilter.h.

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

rtkDrawGeometricPhantomImageFilter.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

◆ ConstPointer

◆ GeometricPhantomConstPointer

◆ Pointer

◆ RotationMatrixType

◆ ScalarType

◆ Self

◆ StringType

◆ Superclass

◆ VectorType

Constructor & Destructor Documentation

◆ DrawGeometricPhantomImageFilter()

◆ ~DrawGeometricPhantomImageFilter()

Member Function Documentation

◆ AddClipPlane()

◆ CreateAnother()

◆ GenerateData()

◆ GetConfigFile()

◆ GetGeometricPhantom()

◆ GetIsForbildConfigFile()

◆ GetNameOfClass()

◆ GetOriginOffset()

◆ GetPhantomScale()

◆ GetRotationMatrix()

◆ IsForbildConfigFileOff()

◆ IsForbildConfigFileOn()

◆ New()

◆ SetClipPlanes()

◆ SetConfigFile()

◆ SetGeometricPhantom()

◆ SetIsForbildConfigFile()

◆ SetOriginOffset()

◆ SetPhantomScale() [1/2]

◆ SetPhantomScale() [2/2]

◆ SetRotationMatrix()

Member Data Documentation

◆ m_ConfigFile

◆ m_GeometricPhantom

◆ m_IsForbildConfigFile

◆ m_OriginOffset

◆ m_PhantomScale

◆ m_PlaneDirections

◆ m_PlanePositions

◆ m_RotationMatrix

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