RTK  2.1.0
Reconstruction Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
rtk::GeometricPhantom Class Reference

#include <rtkGeometricPhantom.h>

+ Inheritance diagram for rtk::GeometricPhantom:
+ Collaboration diagram for rtk::GeometricPhantom:

Public Types

using ConstPointer = itk::SmartPointer< const Self >
using ConvexShapePointer = ConvexShape::Pointer
using ConvexShapeVector = std::vector< ConvexShapePointer >
using Pointer = itk::SmartPointer< Self >
using PointType = ConvexShape::PointType
using RotationMatrixType = ConvexShape::RotationMatrixType
using ScalarType = ConvexShape::ScalarType
using Self = GeometricPhantom
using Superclass = itk::DataObject
using VectorType = ConvexShape::VectorType

Public Member Functions

void AddClipPlane (const VectorType &dir, const ScalarType &pos)
void AddConvexShape (const ConvexShape *co)
virtual ::itk::LightObject::Pointer CreateAnother () const
virtual const ConvexShapeVectorGetConvexShapes () const
virtual const char * GetNameOfClass () const
virtual void Rescale (const VectorType &r)
virtual void Rotate (const RotationMatrixType &r)
virtual void Translate (const VectorType &t)

Static Public Member Functions

static Pointer New ()

Protected Member Functions

 GeometricPhantom ()=default
 ~GeometricPhantom () override=default

Private Attributes

ConvexShapeVector m_ConvexShapes
std::vector< VectorTypem_PlaneDirections
std::vector< ScalarTypem_PlanePositions

Detailed Description

Container for a geometric phantom, i.e., a set of ConvexShapes.

Simon Rit

Definition at line 36 of file rtkGeometricPhantom.h.

Member Typedef Documentation

◆ ConstPointer

Definition at line 45 of file rtkGeometricPhantom.h.

◆ ConvexShapePointer

Convenient type alias.

Definition at line 48 of file rtkGeometricPhantom.h.

◆ ConvexShapeVector

Definition at line 49 of file rtkGeometricPhantom.h.

◆ Pointer

Definition at line 44 of file rtkGeometricPhantom.h.

◆ PointType

Definition at line 50 of file rtkGeometricPhantom.h.

◆ RotationMatrixType

Definition at line 53 of file rtkGeometricPhantom.h.

◆ ScalarType

Definition at line 52 of file rtkGeometricPhantom.h.

◆ Self

Standard class type alias.

Definition at line 42 of file rtkGeometricPhantom.h.

◆ Superclass

Definition at line 43 of file rtkGeometricPhantom.h.

◆ VectorType

Definition at line 51 of file rtkGeometricPhantom.h.

Constructor & Destructor Documentation

◆ GeometricPhantom()

rtk::GeometricPhantom::GeometricPhantom ( )

◆ ~GeometricPhantom()

rtk::GeometricPhantom::~GeometricPhantom ( )

Member Function Documentation

◆ AddClipPlane()

void rtk::GeometricPhantom::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.

◆ AddConvexShape()

void rtk::GeometricPhantom::AddConvexShape ( const ConvexShape co)

Add convex object to phantom.

◆ CreateAnother()

virtual::itk::LightObject::Pointer rtk::GeometricPhantom::CreateAnother ( ) const

Reimplemented from itk::Object.

Reimplemented in rtk::SheppLoganPhantom.

◆ GetConvexShapes()

virtual const ConvexShapeVector& rtk::GeometricPhantom::GetConvexShapes ( ) const

Get reference to vector of objects.

◆ GetNameOfClass()

virtual const char* rtk::GeometricPhantom::GetNameOfClass ( ) const

Run-time type information (and related methods).

Reimplemented from itk::DataObject.

Reimplemented in rtk::SheppLoganPhantom.

◆ New()

static Pointer rtk::GeometricPhantom::New ( )

Method for creation through the object factory.

◆ Rescale()

virtual void rtk::GeometricPhantom::Rescale ( const VectorType r)

Rescale object along each direction by a 3D vector.

◆ Rotate()

virtual void rtk::GeometricPhantom::Rotate ( const RotationMatrixType r)

Rotate object according to a 3D rotation matrix.

◆ Translate()

virtual void rtk::GeometricPhantom::Translate ( const VectorType t)

Translate object by a given 3D vector.

Member Data Documentation

◆ m_ConvexShapes

ConvexShapeVector rtk::GeometricPhantom::m_ConvexShapes

Definition at line 91 of file rtkGeometricPhantom.h.

◆ m_PlaneDirections

std::vector<VectorType> rtk::GeometricPhantom::m_PlaneDirections

Definition at line 92 of file rtkGeometricPhantom.h.

◆ m_PlanePositions

std::vector<ScalarType> rtk::GeometricPhantom::m_PlanePositions

Definition at line 93 of file rtkGeometricPhantom.h.

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