RTK: rtk::DrawBoxImageFilter< TInputImage, TOutputImage > Class Template Reference

RTK 2.5.0

Reconstruction Toolkit

#include <rtkDrawBoxImageFilter.h>

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

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

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

using	ImageBaseType = BoxShape::ImageBaseType

using	Pointer = itk::SmartPointer< Self >

using	PointType = BoxShape::PointType

using	RotationMatrixType = BoxShape::RotationMatrixType

using	ScalarType = BoxShape::ScalarType

using	Self = DrawBoxImageFilter

using	Superclass = DrawConvexImageFilter< TInputImage, TOutputImage >

using	VectorType = BoxShape::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

void	SetBoxFromImage (const ImageBaseType *img, bool bWithExternalHalfPixelBorder=true)


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 VectorType	GetBoxMin ()

virtual void	SetBoxMin (VectorType _arg)

virtual VectorType	GetBoxMax ()

virtual void	SetBoxMax (VectorType _arg)

virtual RotationMatrixType	GetDirection ()

virtual void	SetDirection (RotationMatrixType _arg)

Public Member Functions inherited from rtk::DrawConvexImageFilter< TInputImage, TOutputImage >
virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual ConvexShape *	GetModifiableConvexShape ()

virtual const ConvexShape *	GetConvexShape () 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

	DrawBoxImageFilter ()

	~DrawBoxImageFilter ()=default

Protected Member Functions inherited from rtk::DrawConvexImageFilter< TInputImage, TOutputImage >
void	BeforeThreadedGenerateData () override

	DrawConvexImageFilter ()

void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override

	~DrawConvexImageFilter () override=default

Private Attributes
VectorType	m_BoxMax { 0. }

VectorType	m_BoxMin { 0. }

ScalarType	m_Density { 1. }

RotationMatrixType	m_Direction

std::vector< VectorType >	m_PlaneDirections

std::vector< ScalarType >	m_PlanePositions

Detailed Description

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

Draws a 3D image user defined BoxShape.

Test:: rtkdrawgeometricphantomtest.cxx, rtkforbildtest.cxx

Author: Marc Vila, Simon Rit

Definition at line 39 of file rtkDrawBoxImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputImage , class TOutputImage >

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

Definition at line 48 of file rtkDrawBoxImageFilter.h.

◆ ImageBaseType

template<class TInputImage , class TOutputImage >

using rtk::DrawBoxImageFilter< TInputImage, TOutputImage >::ImageBaseType = BoxShape::ImageBaseType

Definition at line 55 of file rtkDrawBoxImageFilter.h.

◆ Pointer

template<class TInputImage , class TOutputImage >

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

Definition at line 47 of file rtkDrawBoxImageFilter.h.

◆ PointType

template<class TInputImage , class TOutputImage >

using rtk::DrawBoxImageFilter< TInputImage, TOutputImage >::PointType = BoxShape::PointType

Convenient type alias.

Definition at line 51 of file rtkDrawBoxImageFilter.h.

◆ RotationMatrixType

template<class TInputImage , class TOutputImage >

using rtk::DrawBoxImageFilter< TInputImage, TOutputImage >::RotationMatrixType = BoxShape::RotationMatrixType

Definition at line 54 of file rtkDrawBoxImageFilter.h.

◆ ScalarType

template<class TInputImage , class TOutputImage >

using rtk::DrawBoxImageFilter< TInputImage, TOutputImage >::ScalarType = BoxShape::ScalarType

Definition at line 53 of file rtkDrawBoxImageFilter.h.

◆ Self

template<class TInputImage , class TOutputImage >

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

Standard class type alias.

Definition at line 45 of file rtkDrawBoxImageFilter.h.

◆ Superclass

template<class TInputImage , class TOutputImage >

using rtk::DrawBoxImageFilter< TInputImage, TOutputImage >::Superclass = DrawConvexImageFilter<TInputImage, TOutputImage>

Definition at line 46 of file rtkDrawBoxImageFilter.h.

◆ VectorType

template<class TInputImage , class TOutputImage >

using rtk::DrawBoxImageFilter< TInputImage, TOutputImage >::VectorType = BoxShape::VectorType

Definition at line 52 of file rtkDrawBoxImageFilter.h.

Constructor & Destructor Documentation

◆ DrawBoxImageFilter()

template<class TInputImage , class TOutputImage >

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

protected

◆ ~DrawBoxImageFilter()

template<class TInputImage , class TOutputImage >

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

protecteddefault

Member Function Documentation

◆ AddClipPlane()

template<class TInputImage , class TOutputImage >

void rtk::DrawBoxImageFilter< 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::DrawBoxImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData ( )

overrideprotectedvirtual

Reimplemented from itk::ImageSource< TOutputImage >.

◆ CreateAnother()

template<class TInputImage , class TOutputImage >

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

virtual

Reimplemented from itk::Object.

◆ GetBoxMax()

template<class TInputImage , class TOutputImage >

virtual VectorType rtk::DrawBoxImageFilter< TInputImage, TOutputImage >::GetBoxMax ( )

virtual

Get/Set the box parameters. See rtk::BoxShape.

◆ GetBoxMin()

template<class TInputImage , class TOutputImage >

virtual VectorType rtk::DrawBoxImageFilter< TInputImage, TOutputImage >::GetBoxMin ( )

virtual

Get/Set the box parameters. See rtk::BoxShape.

◆ GetDensity()

template<class TInputImage , class TOutputImage >

virtual ScalarType rtk::DrawBoxImageFilter< TInputImage, TOutputImage >::GetDensity ( )

virtual

Get / Set the constant density of the volume

◆ GetDirection()

template<class TInputImage , class TOutputImage >

virtual RotationMatrixType rtk::DrawBoxImageFilter< TInputImage, TOutputImage >::GetDirection ( )

virtual

Get/Set the box parameters. See rtk::BoxShape.

◆ GetNameOfClass()

template<class TInputImage , class TOutputImage >

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

virtual

Run-time type information (and related methods).

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

◆ GetPlaneDirections()

template<class TInputImage , class TOutputImage >

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

virtual

Get reference to vector of plane parameters.

◆ GetPlanePositions()

template<class TInputImage , class TOutputImage >

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

virtual

Get reference to vector of plane parameters.

◆ New()

template<class TInputImage , class TOutputImage >

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

static

Method for creation through the object factory.

◆ SetBoxFromImage()

template<class TInputImage , class TOutputImage >

void rtk::DrawBoxImageFilter< TInputImage, TOutputImage >::SetBoxFromImage	(	const ImageBaseType *	img,
		bool	bWithExternalHalfPixelBorder = `true`
	)

Set the box from an image. See rtk::BoxShape::SetBoxFromImage.

◆ SetBoxMax()

template<class TInputImage , class TOutputImage >

virtual void rtk::DrawBoxImageFilter< TInputImage, TOutputImage >::SetBoxMax ( VectorType _arg )

virtual

Get/Set the box parameters. See rtk::BoxShape.

◆ SetBoxMin()

template<class TInputImage , class TOutputImage >

virtual void rtk::DrawBoxImageFilter< TInputImage, TOutputImage >::SetBoxMin ( VectorType _arg )

virtual

Get/Set the box parameters. See rtk::BoxShape.

◆ SetDensity()

template<class TInputImage , class TOutputImage >

virtual void rtk::DrawBoxImageFilter< TInputImage, TOutputImage >::SetDensity ( ScalarType _arg )

virtual

Get / Set the constant density of the volume

◆ SetDirection()

template<class TInputImage , class TOutputImage >

virtual void rtk::DrawBoxImageFilter< TInputImage, TOutputImage >::SetDirection ( RotationMatrixType _arg )

virtual

Get/Set the box parameters. See rtk::BoxShape.

Member Data Documentation

◆ m_BoxMax

template<class TInputImage , class TOutputImage >

VectorType rtk::DrawBoxImageFilter< TInputImage, TOutputImage >::m_BoxMax { 0. }

private

Definition at line 108 of file rtkDrawBoxImageFilter.h.

◆ m_BoxMin

template<class TInputImage , class TOutputImage >

VectorType rtk::DrawBoxImageFilter< TInputImage, TOutputImage >::m_BoxMin { 0. }

private

Definition at line 107 of file rtkDrawBoxImageFilter.h.

◆ m_Density

template<class TInputImage , class TOutputImage >

ScalarType rtk::DrawBoxImageFilter< TInputImage, TOutputImage >::m_Density { 1. }

private

Definition at line 103 of file rtkDrawBoxImageFilter.h.

◆ m_Direction

template<class TInputImage , class TOutputImage >

RotationMatrixType rtk::DrawBoxImageFilter< TInputImage, TOutputImage >::m_Direction

private

Definition at line 109 of file rtkDrawBoxImageFilter.h.

◆ m_PlaneDirections

template<class TInputImage , class TOutputImage >

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

private

Definition at line 104 of file rtkDrawBoxImageFilter.h.

◆ m_PlanePositions

template<class TInputImage , class TOutputImage >

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

private

Definition at line 105 of file rtkDrawBoxImageFilter.h.

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

rtkDrawBoxImageFilter.h