Permute axes and flip images as needed to obtain an approximation to the desired orientation. More...

#include <sitkDICOMOrientImageFilter.h>

Inheritance diagram for itk::simple::DICOMOrientImageFilter:

Collaboration diagram for itk::simple::DICOMOrientImageFilter:

Detailed Description

Permute axes and flip images as needed to obtain an approximation to the desired orientation.

The physical location of all pixels in the image remains the same, but the meta-data and the ordering of the stored pixels may change.

DICOMOrientImageFilter depends on a set of constants that describe all possible labels. Directions are labeled in terms of following pairs:

Left and Right (Subject's left and right)

Anterior and Posterior (Subject's front and back)

Inferior and Superior (Subject's bottom and top, i.e. feet and head)

The initials of these directions are used in a 3 letter code in the enumerated type OrientationEnum. The initials are given fastest moving index first, second fastest second, third fastest third, where the label's direction indicates increasing values.

An ITK image with an identity direction cosine matrix is in LPS (Left, Posterior, Superior) orientation as defined by the DICOM standard.

\[ LPS = \begin{Bmatrix} from\ right\ to\ \textbf{L}eft \\ from\ anterior\ towards\ \textbf{P}osterior \\ from\ inferior\ towards\ \textbf{S}uperior \end{Bmatrix} \]

The output orientation is specified with SetDesiredCoordinateOrientation. The input coordinate orientation is computed from the input image's direction cosine matrix.

See also: itk::simple::DICOMOrient for the procedural interface; itk::DICOMOrientImageFilter for the Doxygen on the original ITK class.

Definition at line 60 of file sitkDICOMOrientImageFilter.h.

Public Types
using	PixelIDTypeList = typelist2::append< BasicPixelIDTypeList, VectorPixelIDTypeList >::type

using	Self = DICOMOrientImageFilter

Public Types inherited from itk::simple::ImageFilter
using	Self = ImageFilter

Public Types inherited from itk::simple::ProcessObject
using	Self = ProcessObject

Public Member Functions
	DICOMOrientImageFilter ()

Image	Execute (const Image &image1)

std::string	GetDesiredCoordinateOrientation () const

std::vector< bool >	GetFlipAxes () const

std::string	GetName () const

std::vector< unsigned int >	GetPermuteOrder () const

Self &	SetDesiredCoordinateOrientation (std::string DesiredCoordinateOrientation)

std::string	ToString () const

virtual	~DICOMOrientImageFilter ()

Public Member Functions inherited from itk::simple::ImageFilter
	ImageFilter ()

virtual	~ImageFilter ()=0

Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()

virtual int	AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
	Directly add a callback to observe an event. More...

virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event. More...

virtual float	GetProgress () const
	An Active Measurement of the progress of execution. More...

virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event. More...

	ProcessObject ()

virtual void	RemoveAllCommands ()
	Remove all registered commands. More...

virtual	~ProcessObject ()

virtual void	DebugOn ()

virtual void	DebugOff ()

virtual bool	GetDebug () const

virtual void	SetDebug (bool debugFlag)

virtual void	SetNumberOfThreads (unsigned int n)

virtual unsigned int	GetNumberOfThreads () const

virtual void	SetNumberOfWorkUnits (unsigned int n)

virtual unsigned int	GetNumberOfWorkUnits () const

Static Public Member Functions
static std::vector< double >	GetDirectionCosinesFromOrientation (const std::string &str)

static std::string	GetOrientationFromDirectionCosines (const std::vector< double > &direction)

Static Public Member Functions inherited from itk::simple::ProcessObject
static bool	GetGlobalDefaultDebug ()

static void	GlobalDefaultDebugOff ()

static void	GlobalDefaultDebugOn ()

static void	SetGlobalDefaultDebug (bool debugFlag)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static void	SetGlobalWarningDisplay (bool flag)

static bool	GetGlobalWarningDisplay ()

static double	GetGlobalDefaultCoordinateTolerance ()
	Access the global tolerance to determine congruent spaces. More...

static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces. More...

static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces. More...

static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces. More...

static bool	SetGlobalDefaultThreader (const std::string &threader)
	Set/Get the default threader used for process objects. More...

static std::string	GetGlobalDefaultThreader ()
	Set/Get the default threader used for process objects. More...

static void	SetGlobalDefaultNumberOfThreads (unsigned int n)

static unsigned int	GetGlobalDefaultNumberOfThreads ()
	Set/Get the default threader used for process objects. More...

Private Types
using	MemberFunctionType = Image(Self::*)(const Image &image1)

Private Member Functions
template<class TImageType >
Image	ExecuteInternal (const Image &image1)

Private Attributes
std::string	m_DesiredCoordinateOrientation {std::string("LPS")}

std::vector< bool >	m_FlipAxes {std::vector<bool>()}

std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

std::vector< unsigned int >	m_PermuteOrder {std::vector<unsigned int>()}

Friends
struct	detail::MemberFunctionAddressor< MemberFunctionType >

Additional Inherited Members
Protected Member Functions inherited from itk::simple::ImageFilter
void	CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)

void	CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)

void	CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)

Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long	AddITKObserver (const itk::EventObject &, itk::Command *)

virtual itk::ProcessObject *	GetActiveProcess ()

virtual void	OnActiveProcessDelete ()

virtual void	onCommandDelete (const itk::simple::Command *cmd) noexcept

virtual void	PreUpdate (itk::ProcessObject *p)

virtual void	RemoveITKObserver (EventCommand &e)

Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()=default

	NonCopyable (const NonCopyable &)=delete

NonCopyable &	operator= (const NonCopyable &)=delete

Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType >
static void	FixNonZeroIndex (TImageType *img)

Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer	CastImageToITK (const Image &img)

template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)

template<unsigned int VImageDimension, unsigned int VLength, template< unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< VLength >, VImageDimension > *img)

template<class TImageType >
static Image	CastITKToImage (TImageType *img)

static const itk::EventObject &	GetITKEventObject (EventEnum e)

template<typename T >
static std::ostream &	ToStringHelper (std::ostream &os, const T &v)

static std::ostream &	ToStringHelper (std::ostream &os, const char &v)

static std::ostream &	ToStringHelper (std::ostream &os, const signed char &v)

static std::ostream &	ToStringHelper (std::ostream &os, const unsigned char &v)

Member Typedef Documentation

◆ MemberFunctionType

using itk::simple::DICOMOrientImageFilter::MemberFunctionType = Image (Self::*)( const Image& image1 )

private

Setup for member function dispatching

Definition at line 124 of file sitkDICOMOrientImageFilter.h.

◆ PixelIDTypeList

using itk::simple::DICOMOrientImageFilter::PixelIDTypeList = typelist2::append<BasicPixelIDTypeList, VectorPixelIDTypeList>::type

Define the pixels types supported by this filter

Definition at line 72 of file sitkDICOMOrientImageFilter.h.

◆ Self

using itk::simple::DICOMOrientImageFilter::Self = DICOMOrientImageFilter

Definition at line 62 of file sitkDICOMOrientImageFilter.h.

Constructor & Destructor Documentation

◆ ~DICOMOrientImageFilter()

virtual itk::simple::DICOMOrientImageFilter::~DICOMOrientImageFilter ( )

virtual

Destructor

◆ DICOMOrientImageFilter()

itk::simple::DICOMOrientImageFilter::DICOMOrientImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

Image itk::simple::DICOMOrientImageFilter::Execute ( const Image & image1 )

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >

Image itk::simple::DICOMOrientImageFilter::ExecuteInternal ( const Image & image1 )

private

◆ GetDesiredCoordinateOrientation()

std::string itk::simple::DICOMOrientImageFilter::GetDesiredCoordinateOrientation ( ) const

inline

Set/Get the desired coordinate orientation for the output image

Definition at line 87 of file sitkDICOMOrientImageFilter.h.

◆ GetDirectionCosinesFromOrientation()

static std::vector<double> itk::simple::DICOMOrientImageFilter::GetDirectionCosinesFromOrientation ( const std::string & str )

static

◆ GetFlipAxes()

std::vector<bool> itk::simple::DICOMOrientImageFilter::GetFlipAxes ( ) const

inline

    Get flip axes.

This value is computed during Update.

    This is a measurement. Its value is updated in the Execute
    methods, so the value will only be valid after an execution.

Definition at line 96 of file sitkDICOMOrientImageFilter.h.

◆ GetName()

std::string itk::simple::DICOMOrientImageFilter::GetName ( ) const

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 110 of file sitkDICOMOrientImageFilter.h.

◆ GetOrientationFromDirectionCosines()

static std::string itk::simple::DICOMOrientImageFilter::GetOrientationFromDirectionCosines ( const std::vector< double > & direction )

static

Custom public declarations

◆ GetPermuteOrder()

std::vector<unsigned int> itk::simple::DICOMOrientImageFilter::GetPermuteOrder ( ) const

inline

    Get axes permute order.

This value is computed during Update.

    This is a measurement. Its value is updated in the Execute
    methods, so the value will only be valid after an execution.

Definition at line 106 of file sitkDICOMOrientImageFilter.h.

◆ SetDesiredCoordinateOrientation()

Self& itk::simple::DICOMOrientImageFilter::SetDesiredCoordinateOrientation ( std::string DesiredCoordinateOrientation )

inline

Set/Get the desired coordinate orientation for the output image

Definition at line 82 of file sitkDICOMOrientImageFilter.h.

◆ ToString()

std::string itk::simple::DICOMOrientImageFilter::ToString ( ) const

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 128 of file sitkDICOMOrientImageFilter.h.

Member Data Documentation

◆ m_DesiredCoordinateOrientation

std::string itk::simple::DICOMOrientImageFilter::m_DesiredCoordinateOrientation {std::string("LPS")}

private

Definition at line 133 of file sitkDICOMOrientImageFilter.h.

◆ m_FlipAxes

std::vector<bool> itk::simple::DICOMOrientImageFilter::m_FlipAxes {std::vector<bool>()}

private

Definition at line 136 of file sitkDICOMOrientImageFilter.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::DICOMOrientImageFilter::m_MemberFactory

private

Definition at line 130 of file sitkDICOMOrientImageFilter.h.

◆ m_PermuteOrder

std::vector<unsigned int> itk::simple::DICOMOrientImageFilter::m_PermuteOrder {std::vector<unsigned int>()}

private

Definition at line 138 of file sitkDICOMOrientImageFilter.h.

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

sitkDICOMOrientImageFilter.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Member Typedef Documentation

◆ MemberFunctionType

◆ PixelIDTypeList

◆ Self

Constructor & Destructor Documentation

◆ ~DICOMOrientImageFilter()

◆ DICOMOrientImageFilter()

Member Function Documentation

◆ Execute()

◆ ExecuteInternal()

◆ GetDesiredCoordinateOrientation()

◆ GetDirectionCosinesFromOrientation()

◆ GetFlipAxes()

◆ GetName()

◆ GetOrientationFromDirectionCosines()

◆ GetPermuteOrder()

◆ SetDesiredCoordinateOrientation()

◆ ToString()

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Member Data Documentation

◆ m_DesiredCoordinateOrientation

◆ m_FlipAxes

◆ m_MemberFactory

◆ m_PermuteOrder