ITK  5.1.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
itk::OrientImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <itkOrientImageFilter.h>

+ Inheritance diagram for itk::OrientImageFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for itk::OrientImageFilter< TInputImage, TOutputImage >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using CoordinateOrientationCode = SpatialOrientation::ValidCoordinateOrientationFlags
 
using FlipAxesArrayType = typename FlipperType::FlipAxesArrayType
 
using FlipperType = FlipImageFilter< TInputImage >
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage
 
using OutputImageConstPointer = typename OutputImageType::ConstPointer
 
using OutputImagePixelType = typename OutputImageType::PixelType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = TOutputImage
 
using PermuteOrderArrayType = typename PermuterType::PermuteOrderArrayType
 
using PermuterType = PermuteAxesImageFilter< TInputImage >
 
using Pointer = SmartPointer< Self >
 
using Self = OrientImageFilter
 
using Superclass = ImageToImageFilter< TInputImage, TOutputImage >
 
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage
 
using OutputImagePixelType = typename Superclass::OutputImagePixelType
 
using OutputImageRegionType = typename Superclass::OutputImageRegionType
 
using Pointer = SmartPointer< Self >
 
using Self = ImageToImageFilter
 
using Superclass = ImageSource< TOutputImage >
 
- Public Types inherited from itk::ImageSource< TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = Superclass::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType
 
using OutputImagePixelType = typename OutputImageType::PixelType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = TOutputImage
 
using Pointer = SmartPointer< Self >
 
using Self = ImageSource
 
using Superclass = ProcessObject
 
- Public Types inherited from itk::ProcessObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = DataObject::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArray = std::vector< DataObjectPointer >
 
using DataObjectPointerArraySizeType = DataObjectPointerArray::size_type
 
using MultiThreaderType = MultiThreaderBase
 
using NameArray = std::vector< DataObjectIdentifierType >
 
using Pointer = SmartPointer< Self >
 
using Self = ProcessObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
void PopBackInput () override
 
void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *image)
 
virtual void PushFrontInput (const InputImageType *image)
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetInput (const InputImageType *image)
 
virtual void SetInput (unsigned int, const TInputImage *image)
 
virtual void SetCoordinateTolerance (double _arg)
 
virtual double GetCoordinateTolerance () const
 
virtual void SetDirectionTolerance (double _arg)
 
virtual double GetDirectionTolerance () const
 
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
OutputImageTypeGetOutput (unsigned int idx)
 
virtual void GraftOutput (DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual const float & GetProgress () const
 
void UpdateProgress (float progress)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputInformation ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
MultiThreaderTypeGetMultiThreader () const
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void PrepareOutputs ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static void SetGlobalDefaultDirectionTolerance (double)
 
static double GetGlobalDefaultDirectionTolerance ()
 
static void SetGlobalDefaultCoordinateTolerance (double)
 
static double GetGlobalDefaultCoordinateTolerance ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension
 
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension
 
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
CoordinateOrientationCode m_GivenCoordinateOrientation { SpatialOrientation::ITK_COORDINATE_ORIENTATION_RIP }
 
CoordinateOrientationCode m_DesiredCoordinateOrientation { SpatialOrientation::ITK_COORDINATE_ORIENTATION_RIP }
 
bool m_UseImageDirection { false }
 
PermuteOrderArrayType m_PermuteOrder
 
FlipAxesArrayType m_FlipAxes
 
std::map< std::string, CoordinateOrientationCodem_StringToCode
 
std::map< CoordinateOrientationCode, std::string > m_CodeToString
 
virtual CoordinateOrientationCode GetGivenCoordinateOrientation () const
 
void SetGivenCoordinateOrientation (CoordinateOrientationCode newCode)
 
void SetGivenCoordinateDirection (const typename TInputImage::DirectionType &GivenDirection)
 
virtual CoordinateOrientationCode GetDesiredCoordinateOrientation () const
 
void SetDesiredCoordinateOrientation (CoordinateOrientationCode newCode)
 
void SetDesiredCoordinateDirection (const typename TOutputImage::DirectionType &DesiredDirection)
 
virtual void UseImageDirectionOn ()
 
virtual void UseImageDirectionOff ()
 
virtual bool GetUseImageDirection () const
 
virtual void SetUseImageDirection (bool _arg)
 
virtual const PermuteOrderArrayTypeGetPermuteOrder () const
 
virtual const FlipAxesArrayTypeGetFlipAxes () const
 
void SetDesiredCoordinateOrientationToAxial ()
 
void SetDesiredCoordinateOrientationToCoronal ()
 
void SetDesiredCoordinateOrientationToSagittal ()
 
void GenerateOutputInformation () override
 
 OrientImageFilter ()
 
 ~OrientImageFilter () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void GenerateInputRequestedRegion () override
 
void EnlargeOutputRequestedRegion (DataObject *) override
 
void DeterminePermutationsAndFlips (const SpatialOrientation::ValidCoordinateOrientationFlags fixed_orient, const SpatialOrientation::ValidCoordinateOrientationFlags moving_orient)
 
bool NeedToPermute ()
 
bool NeedToFlip ()
 
void GenerateData () override
 
std::string GetMajorAxisFromPatientRelativeDirectionCosine (double x, double y, double z)
 

Additional Inherited Members

- Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
 
using OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
 ImageToImageFilter ()
 
 ~ImageToImageFilter () override
 
void VerifyInputInformation () ITKv5_CONST override
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
void PushBackInput (const DataObject *input) override
 
void PushFrontInput (const DataObject *input) override
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
 ImageSource ()
 
 ~ImageSource () override=default
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual void AfterThreadedGenerateData ()
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
virtual void DynamicMultiThreadingOff ()
 
- Protected Member Functions inherited from itk::ProcessObject
 ProcessObject ()
 
 ~ProcessObject () override
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void AddInput (DataObject *input)
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
virtual void SetPrimaryInput (DataObject *input)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
virtual void AddOutput (DataObject *output)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
virtual void VerifyPreconditions () ITKv5_CONST
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void RestoreInputReleaseDataFlags ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBaseGetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool m_DynamicMultiThreading
 
- Protected Attributes inherited from itk::ProcessObject
bool m_Updating
 
TimeStamp m_OutputInformationMTime
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

template<typename TInputImage, typename TOutputImage>
class itk::OrientImageFilter< TInputImage, TOutputImage >

Permute axes and then flip images as needed to obtain agreement in coordinateOrientation codes.

This class satisfies a common requirement in medical imaging, which is to properly orient a 3 dimensional image with respect to anatomical features. Due to the wide variety of hardware used to generate 3D images of human anatomy, and the even wider variety of image processing software, it is often necessary to re-orient image volume data.

OrientImageFilter depends on a set of constants that describe all possible labeled according to the following scheme: Directions are labeled in terms of following pairs:

The initials of these directions are used in a 3 letter code in the enumerated type itk::SpatialOrientation::ValidCoordinateOrientationFlags. The initials are given fastest moving index first, second fastest second, third fastest third. Examples:

In order to use this filter, you need to supply an input image, the current orientation of the input image (set with SetGivenCoordinateOrientation) and the desired orientation. (set with SetDesiredCoordinateOrientation). You may explicitly set the DesiredOrientation with SetDesiredCoordinateOrientation (if UseImageDirection is "off") or you can use the image's direction cosines to set the DesiredOrientation (if UseImageDirection is "on"). When reading image files that define the coordinate orientation of the image, the current orientation is stored in the MetadataDictionary for the itk::Image object and the Image.Direction direction cosine matrix created from the file.

As an example, if you wished to keep all images within your program in the orientation corresponding to the Analyze file format's 'CORONAL' orientation you could do something like the following

// DEPRECATED -- using metadata for orientation is no longer supported
//
#include "itkAnalyzeImageIO.h"
#include "itkImage.h"
using ImageType = itk::Image<unsigned char,3>;
using ImageReaderType = itk::ImageFileReader< TstImageType >;
ImageType::Pointer ReadAnalyzeFile(const char *path)
{
itk::AnalyzeImageIO::Pointer io = itk::AnalyzeImageIO::New();
ImageReaderType::Pointer fileReader = ImageReaderType::New();
fileReader->SetImageIO(io);
fileReader->SetFileName(path);
fileReader->Update();
ImageType::Pointer rval = fileReader->GetOutput();
// DEPRECATED -- use direction cosines
//
itk::ExposeMetaData<itk::SpatialOrientation::ValidCoordinateOrientationFlags>
(rval->GetMetaDataDictionary(),itk::ITK_CoordinateOrientation,fileOrientation);
orienter->SetGivenCoordinateOrientation(fileOrientation); // deprecated
orienter->SetDesiredCoordinateOrientation(itk::SpatialOrientation::ITK_COORDINATE_ORIENTATION_RIP);
orienter->SetInput(rval);
orienter->Update();
rval = orienter->GetOutput();
return rval;
}

Or, using the direction cosines of the image,

#include "itkAnalyzeImageIO.h"
#include "itkImage.h"
using ImageType = itk::Image<unsigned char,3>;
using ImageReaderType = itk::ImageFileReader< ImageType >;
ImageType::Pointer ReadAnalyzeFile(const char *path)
{
itk::AnalyzeImageIO::Pointer io = itk::AnalyzeImageIO::New();
ImageReaderType::Pointer fileReader = ImageReaderType::New();
fileReader->SetImageIO(io);
fileReader->SetFileName(path);
fileReader->Update();
ImageType::Pointer rval = fileReader->GetOutput();
orienter->UseImageDirectionOn();
orienter->SetDesiredCoordinateOrientation(itk::SpatialOrientation::ITK_COORDINATE_ORIENTATION_RIP);
orienter->SetInput(rval);
orienter->Update();
rval = orienter->GetOutput();
return rval;
}

Definition at line 141 of file itkOrientImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage, typename TOutputImage>
using itk::OrientImageFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 150 of file itkOrientImageFilter.h.

◆ CoordinateOrientationCode

template<typename TInputImage, typename TOutputImage>
using itk::OrientImageFilter< TInputImage, TOutputImage >::CoordinateOrientationCode = SpatialOrientation::ValidCoordinateOrientationFlags

Definition at line 163 of file itkOrientImageFilter.h.

◆ FlipAxesArrayType

template<typename TInputImage, typename TOutputImage>
using itk::OrientImageFilter< TInputImage, TOutputImage >::FlipAxesArrayType = typename FlipperType::FlipAxesArrayType

Definition at line 171 of file itkOrientImageFilter.h.

◆ FlipperType

template<typename TInputImage, typename TOutputImage>
using itk::OrientImageFilter< TInputImage, TOutputImage >::FlipperType = FlipImageFilter<TInputImage>

Axes flipper type.

Definition at line 170 of file itkOrientImageFilter.h.

◆ InputImageConstPointer

template<typename TInputImage, typename TOutputImage>
using itk::OrientImageFilter< TInputImage, TOutputImage >::InputImageConstPointer = typename InputImageType::ConstPointer

Definition at line 155 of file itkOrientImageFilter.h.

◆ InputImagePixelType

template<typename TInputImage, typename TOutputImage>
using itk::OrientImageFilter< TInputImage, TOutputImage >::InputImagePixelType = typename InputImageType::PixelType

Definition at line 157 of file itkOrientImageFilter.h.

◆ InputImagePointer

template<typename TInputImage, typename TOutputImage>
using itk::OrientImageFilter< TInputImage, TOutputImage >::InputImagePointer = typename InputImageType::Pointer

Definition at line 154 of file itkOrientImageFilter.h.

◆ InputImageRegionType

template<typename TInputImage, typename TOutputImage>
using itk::OrientImageFilter< TInputImage, TOutputImage >::InputImageRegionType = typename InputImageType::RegionType

Definition at line 156 of file itkOrientImageFilter.h.

◆ InputImageType

template<typename TInputImage, typename TOutputImage>
using itk::OrientImageFilter< TInputImage, TOutputImage >::InputImageType = TInputImage

Some convenient type alias.

Definition at line 153 of file itkOrientImageFilter.h.

◆ OutputImageConstPointer

template<typename TInputImage, typename TOutputImage>
using itk::OrientImageFilter< TInputImage, TOutputImage >::OutputImageConstPointer = typename OutputImageType::ConstPointer

Definition at line 160 of file itkOrientImageFilter.h.

◆ OutputImagePixelType

template<typename TInputImage, typename TOutputImage>
using itk::OrientImageFilter< TInputImage, TOutputImage >::OutputImagePixelType = typename OutputImageType::PixelType

Definition at line 162 of file itkOrientImageFilter.h.

◆ OutputImagePointer

template<typename TInputImage, typename TOutputImage>
using itk::OrientImageFilter< TInputImage, TOutputImage >::OutputImagePointer = typename OutputImageType::Pointer

Definition at line 159 of file itkOrientImageFilter.h.

◆ OutputImageRegionType

template<typename TInputImage, typename TOutputImage>
using itk::OrientImageFilter< TInputImage, TOutputImage >::OutputImageRegionType = typename OutputImageType::RegionType

Definition at line 161 of file itkOrientImageFilter.h.

◆ OutputImageType

template<typename TInputImage, typename TOutputImage>
using itk::OrientImageFilter< TInputImage, TOutputImage >::OutputImageType = TOutputImage

Definition at line 158 of file itkOrientImageFilter.h.

◆ PermuteOrderArrayType

template<typename TInputImage, typename TOutputImage>
using itk::OrientImageFilter< TInputImage, TOutputImage >::PermuteOrderArrayType = typename PermuterType::PermuteOrderArrayType

Definition at line 167 of file itkOrientImageFilter.h.

◆ PermuterType

template<typename TInputImage, typename TOutputImage>
using itk::OrientImageFilter< TInputImage, TOutputImage >::PermuterType = PermuteAxesImageFilter<TInputImage>

Axes permuter type.

Definition at line 166 of file itkOrientImageFilter.h.

◆ Pointer

template<typename TInputImage, typename TOutputImage>
using itk::OrientImageFilter< TInputImage, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 149 of file itkOrientImageFilter.h.

◆ Self

template<typename TInputImage, typename TOutputImage>
using itk::OrientImageFilter< TInputImage, TOutputImage >::Self = OrientImageFilter

Standard class type aliases.

Definition at line 147 of file itkOrientImageFilter.h.

◆ Superclass

template<typename TInputImage, typename TOutputImage>
using itk::OrientImageFilter< TInputImage, TOutputImage >::Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 148 of file itkOrientImageFilter.h.

Constructor & Destructor Documentation

◆ OrientImageFilter()

template<typename TInputImage, typename TOutputImage>
itk::OrientImageFilter< TInputImage, TOutputImage >::OrientImageFilter ( )
protected

Set/Get the orientation codes to define the coordinate transform.

◆ ~OrientImageFilter()

template<typename TInputImage, typename TOutputImage>
itk::OrientImageFilter< TInputImage, TOutputImage >::~OrientImageFilter ( )
overrideprotecteddefault

Set/Get the orientation codes to define the coordinate transform.

Member Function Documentation

◆ CreateAnother()

template<typename TInputImage, typename TOutputImage>
virtual::itk::LightObject::Pointer itk::OrientImageFilter< TInputImage, TOutputImage >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

◆ DeterminePermutationsAndFlips()

template<typename TInputImage, typename TOutputImage>
void itk::OrientImageFilter< TInputImage, TOutputImage >::DeterminePermutationsAndFlips ( const SpatialOrientation::ValidCoordinateOrientationFlags  fixed_orient,
const SpatialOrientation::ValidCoordinateOrientationFlags  moving_orient 
)
protected

Set/Get the orientation codes to define the coordinate transform.

◆ EnlargeOutputRequestedRegion()

template<typename TInputImage, typename TOutputImage>
void itk::OrientImageFilter< TInputImage, TOutputImage >::EnlargeOutputRequestedRegion ( DataObject )
overrideprotectedvirtual

OrientImageFilter will produce the entire output.

Reimplemented from itk::ProcessObject.

◆ GenerateData()

template<typename TInputImage, typename TOutputImage>
void itk::OrientImageFilter< TInputImage, TOutputImage >::GenerateData ( )
overrideprotectedvirtual

Single-threaded version of GenerateData. This filter delegates to PermuteAxesImageFilter and FlipImageFilter.

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GenerateInputRequestedRegion()

template<typename TInputImage, typename TOutputImage>
void itk::OrientImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( )
overrideprotectedvirtual

OrientImageFilter needs the entire input be available. Thus, it needs to provide an implementation of GenerateInputRequestedRegion().

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

◆ GenerateOutputInformation()

template<typename TInputImage, typename TOutputImage>
void itk::OrientImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation ( )
overridevirtual

OrientImageFilter produces an image which is a different dimensionality than its input image, in general. As such, OrientImageFilter needs to provide an implementation for GenerateOutputInformation() in order to inform the pipeline execution model. The original documentation of this method is below.

See also
ProcessObject::GenerateOutputInformaton()

Reimplemented from itk::ProcessObject.

◆ GetDesiredCoordinateOrientation()

template<typename TInputImage, typename TOutputImage>
virtual CoordinateOrientationCode itk::OrientImageFilter< TInputImage, TOutputImage >::GetDesiredCoordinateOrientation ( ) const
virtual

Set/Get the orientation codes to define the coordinate transform.

◆ GetFlipAxes()

template<typename TInputImage, typename TOutputImage>
virtual const FlipAxesArrayType& itk::OrientImageFilter< TInputImage, TOutputImage >::GetFlipAxes ( ) const
virtual

Get flip axes.

◆ GetGivenCoordinateOrientation()

template<typename TInputImage, typename TOutputImage>
virtual CoordinateOrientationCode itk::OrientImageFilter< TInputImage, TOutputImage >::GetGivenCoordinateOrientation ( ) const
virtual

Set/Get the orientation codes to define the coordinate transform.

◆ GetMajorAxisFromPatientRelativeDirectionCosine()

template<typename TInputImage, typename TOutputImage>
std::string itk::OrientImageFilter< TInputImage, TOutputImage >::GetMajorAxisFromPatientRelativeDirectionCosine ( double  x,
double  y,
double  z 
)
private

Set/Get the orientation codes to define the coordinate transform.

◆ GetNameOfClass()

template<typename TInputImage, typename TOutputImage>
virtual const char* itk::OrientImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
virtual

Runtime information support.

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

◆ GetPermuteOrder()

template<typename TInputImage, typename TOutputImage>
virtual const PermuteOrderArrayType& itk::OrientImageFilter< TInputImage, TOutputImage >::GetPermuteOrder ( ) const
virtual

Get axes permute order.

◆ GetUseImageDirection()

template<typename TInputImage, typename TOutputImage>
virtual bool itk::OrientImageFilter< TInputImage, TOutputImage >::GetUseImageDirection ( ) const
virtual

Set/Get the orientation codes to define the coordinate transform.

◆ NeedToFlip()

template<typename TInputImage, typename TOutputImage>
bool itk::OrientImageFilter< TInputImage, TOutputImage >::NeedToFlip ( )
protected

Returns true if flipping is required. Returns false otherwise.

◆ NeedToPermute()

template<typename TInputImage, typename TOutputImage>
bool itk::OrientImageFilter< TInputImage, TOutputImage >::NeedToPermute ( )
protected

Returns true if a permute is required. Returns false otherwise.

◆ New()

template<typename TInputImage, typename TOutputImage>
static Pointer itk::OrientImageFilter< TInputImage, TOutputImage >::New ( )
static

Standard New method.

◆ PrintSelf()

template<typename TInputImage, typename TOutputImage>
void itk::OrientImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Set/Get the orientation codes to define the coordinate transform.

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

◆ SetDesiredCoordinateDirection()

template<typename TInputImage, typename TOutputImage>
void itk::OrientImageFilter< TInputImage, TOutputImage >::SetDesiredCoordinateDirection ( const typename TOutputImage::DirectionType &  DesiredDirection)
inline

Set/Get the orientation codes to define the coordinate transform.

Definition at line 200 of file itkOrientImageFilter.h.

◆ SetDesiredCoordinateOrientation()

template<typename TInputImage, typename TOutputImage>
void itk::OrientImageFilter< TInputImage, TOutputImage >::SetDesiredCoordinateOrientation ( CoordinateOrientationCode  newCode)

Set/Get the orientation codes to define the coordinate transform.

◆ SetDesiredCoordinateOrientationToAxial()

template<typename TInputImage, typename TOutputImage>
void itk::OrientImageFilter< TInputImage, TOutputImage >::SetDesiredCoordinateOrientationToAxial ( )
inline

Convenience methods to set desired slice orientation These methods allow a limited selection of slice orientations without having to specify the SpatialOrientation.

SetDesiredCoordinateOrientationToAxial is equivalent to SetDesiredCoordinateOrientation (ITK_COORDINATE_ORIENTATION_RAI).

SetDesiredCoordinateOrientationToCoronal is equivalent to SetDesiredCoordinateOrientation (ITK_COORDINATE_ORIENTATION_RSA).

SetDesiredCoordinateOrientationToSagittal is equivalent to SetDesiredCoordinateOrientation (ITK_COORDINATE_ORIENTATION_ASL).

Definition at line 236 of file itkOrientImageFilter.h.

References itk::SpatialOrientation::ITK_COORDINATE_ORIENTATION_RAI.

◆ SetDesiredCoordinateOrientationToCoronal()

template<typename TInputImage, typename TOutputImage>
void itk::OrientImageFilter< TInputImage, TOutputImage >::SetDesiredCoordinateOrientationToCoronal ( )
inline

Set/Get the orientation codes to define the coordinate transform.

Definition at line 242 of file itkOrientImageFilter.h.

References itk::SpatialOrientation::ITK_COORDINATE_ORIENTATION_RSA.

◆ SetDesiredCoordinateOrientationToSagittal()

template<typename TInputImage, typename TOutputImage>
void itk::OrientImageFilter< TInputImage, TOutputImage >::SetDesiredCoordinateOrientationToSagittal ( )
inline

Set/Get the orientation codes to define the coordinate transform.

Definition at line 248 of file itkOrientImageFilter.h.

References itk::SpatialOrientation::ITK_COORDINATE_ORIENTATION_ASL.

◆ SetGivenCoordinateDirection()

template<typename TInputImage, typename TOutputImage>
void itk::OrientImageFilter< TInputImage, TOutputImage >::SetGivenCoordinateDirection ( const typename TInputImage::DirectionType &  GivenDirection)
inline

Set/Get the orientation codes to define the coordinate transform.

Definition at line 190 of file itkOrientImageFilter.h.

◆ SetGivenCoordinateOrientation()

template<typename TInputImage, typename TOutputImage>
void itk::OrientImageFilter< TInputImage, TOutputImage >::SetGivenCoordinateOrientation ( CoordinateOrientationCode  newCode)

Set/Get the orientation codes to define the coordinate transform.

◆ SetUseImageDirection()

template<typename TInputImage, typename TOutputImage>
virtual void itk::OrientImageFilter< TInputImage, TOutputImage >::SetUseImageDirection ( bool  _arg)
virtual

Set/Get the orientation codes to define the coordinate transform.

◆ UseImageDirectionOff()

template<typename TInputImage, typename TOutputImage>
virtual void itk::OrientImageFilter< TInputImage, TOutputImage >::UseImageDirectionOff ( )
virtual

Set/Get the orientation codes to define the coordinate transform.

◆ UseImageDirectionOn()

template<typename TInputImage, typename TOutputImage>
virtual void itk::OrientImageFilter< TInputImage, TOutputImage >::UseImageDirectionOn ( )
virtual

Controls how the GivenCoordinateOrientation is determined. If set to On, the direction cosines determine the coordinate orientation. If set to Off, the user must use the SetGivenCoordinateOrientation method to establish the orientation. For compatibility with the original API, the default value is Off.

Member Data Documentation

◆ InputImageDimension

template<typename TInputImage, typename TOutputImage>
constexpr unsigned int itk::OrientImageFilter< TInputImage, TOutputImage >::InputImageDimension = TInputImage::ImageDimension
staticconstexpr

ImageDimension constants

Definition at line 174 of file itkOrientImageFilter.h.

◆ m_CodeToString

template<typename TInputImage, typename TOutputImage>
std::map<CoordinateOrientationCode, std::string> itk::OrientImageFilter< TInputImage, TOutputImage >::m_CodeToString
private

Set/Get the orientation codes to define the coordinate transform.

Definition at line 317 of file itkOrientImageFilter.h.

◆ m_DesiredCoordinateOrientation

template<typename TInputImage, typename TOutputImage>
CoordinateOrientationCode itk::OrientImageFilter< TInputImage, TOutputImage >::m_DesiredCoordinateOrientation { SpatialOrientation::ITK_COORDINATE_ORIENTATION_RIP }
private

Set/Get the orientation codes to define the coordinate transform.

Definition at line 310 of file itkOrientImageFilter.h.

◆ m_FlipAxes

template<typename TInputImage, typename TOutputImage>
FlipAxesArrayType itk::OrientImageFilter< TInputImage, TOutputImage >::m_FlipAxes
private

Set/Get the orientation codes to define the coordinate transform.

Definition at line 314 of file itkOrientImageFilter.h.

◆ m_GivenCoordinateOrientation

template<typename TInputImage, typename TOutputImage>
CoordinateOrientationCode itk::OrientImageFilter< TInputImage, TOutputImage >::m_GivenCoordinateOrientation { SpatialOrientation::ITK_COORDINATE_ORIENTATION_RIP }
private

Set/Get the orientation codes to define the coordinate transform.

Definition at line 309 of file itkOrientImageFilter.h.

◆ m_PermuteOrder

template<typename TInputImage, typename TOutputImage>
PermuteOrderArrayType itk::OrientImageFilter< TInputImage, TOutputImage >::m_PermuteOrder
private

Set/Get the orientation codes to define the coordinate transform.

Definition at line 313 of file itkOrientImageFilter.h.

◆ m_StringToCode

template<typename TInputImage, typename TOutputImage>
std::map<std::string, CoordinateOrientationCode> itk::OrientImageFilter< TInputImage, TOutputImage >::m_StringToCode
private

Set/Get the orientation codes to define the coordinate transform.

Definition at line 316 of file itkOrientImageFilter.h.

◆ m_UseImageDirection

template<typename TInputImage, typename TOutputImage>
bool itk::OrientImageFilter< TInputImage, TOutputImage >::m_UseImageDirection { false }
private

Set/Get the orientation codes to define the coordinate transform.

Definition at line 311 of file itkOrientImageFilter.h.

◆ OutputImageDimension

template<typename TInputImage, typename TOutputImage>
constexpr unsigned int itk::OrientImageFilter< TInputImage, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension
staticconstexpr

Definition at line 175 of file itkOrientImageFilter.h.


The documentation for this class was generated from the following file:
itkImage.h
itk::SmartPointer< Self >
itk::ImageFileReader
Data source that reads image data from a single file.
Definition: itkImageFileReader.h:75
itk::SpatialOrientation::ITK_COORDINATE_ORIENTATION_RIP
Definition: itkSpatialOrientation.h:87
itkMetaDataObject.h
itk::OrientImageFilter::New
static Pointer New()
itk::SpatialOrientation::ValidCoordinateOrientationFlags
ValidCoordinateOrientationFlags
Definition: itkSpatialOrientation.h:84
itk::Image
Templated n-dimensional image class.
Definition: itkImage.h:86
itkOrientImageFilter.h