SimpleITK  2.0.0rc2.post38
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::VectorIndexSelectionCastImageFilter Class Reference

Extracts the selected index of the vector that is the input pixel type. More...

#include <sitkVectorIndexSelectionCastImageFilter.h>

+ Inheritance diagram for itk::simple::VectorIndexSelectionCastImageFilter:
+ Collaboration diagram for itk::simple::VectorIndexSelectionCastImageFilter:

Public Types

using PixelIDTypeList = VectorPixelIDTypeList
 
using Self = VectorIndexSelectionCastImageFilter
 
- Public Types inherited from itk::simple::ImageFilter
using Self = ImageFilter
 
- Public Types inherited from itk::simple::ProcessObject
using Self = ProcessObject
 

Public Member Functions

Image Execute (const Image &image1)
 
Image Execute (Image &&image1)
 
unsigned int GetIndex () const
 
std::string GetName () const
 
PixelIDValueEnum GetOutputPixelType () const
 Get the ouput pixel type. More...
 
SelfSetIndex (unsigned int Index)
 
SelfSetOutputPixelType (PixelIDValueEnum OutputPixelType)
 Set the output pixel type of the scalar component to extract. More...
 
std::string ToString () const
 
 VectorIndexSelectionCastImageFilter ()
 
virtual ~VectorIndexSelectionCastImageFilter ()
 
- 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
 

Private Types

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

Private Member Functions

template<class TImageType1 , class TImageType2 >
Image DualExecuteInternal (const Image &image1)
 

Private Attributes

std::unique_ptr< detail::DualMemberFunctionFactory< MemberFunctionType > > m_DualMemberFactory
 
unsigned int m_Index {0u}
 
bool m_InPlace {false}
 
PixelIDValueEnum m_OutputPixelType {itk::simple::sitkUnknown}
 

Friends

struct detail::DualExecuteInternalAddressor< MemberFunctionType >
 

Additional Inherited Members

- 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...
 
- 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::ProcessObjectGetActiveProcess ()
 
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
 
NonCopyableoperator= (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<class TImageType >
static Image CastITKToImage (TImageType *img)
 
static const itk::EventObjectGetITKEventObject (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)
 

Detailed Description

Extracts the selected index of the vector that is the input pixel type.

This filter is templated over the input image type and output image type.

The filter expect the input image pixel type to be a vector and the output image pixel type to be a scalar. The only requirement on the type used for representing the vector is that it must provide an operator[].

See also
ComposeImageFilter
itk::simple::VectorIndexSelectionCast for the procedural interface
itk::VectorIndexSelectionCastImageFilter for the Doxygen on the original ITK class.

Definition at line 47 of file sitkVectorIndexSelectionCastImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

Setup for member function dispatching

Definition at line 99 of file sitkVectorIndexSelectionCastImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 59 of file sitkVectorIndexSelectionCastImageFilter.h.

◆ Self

Definition at line 49 of file sitkVectorIndexSelectionCastImageFilter.h.

Constructor & Destructor Documentation

◆ ~VectorIndexSelectionCastImageFilter()

virtual itk::simple::VectorIndexSelectionCastImageFilter::~VectorIndexSelectionCastImageFilter ( )
virtual

Destructor

◆ VectorIndexSelectionCastImageFilter()

itk::simple::VectorIndexSelectionCastImageFilter::VectorIndexSelectionCastImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ DualExecuteInternal()

template<class TImageType1 , class TImageType2 >
Image itk::simple::VectorIndexSelectionCastImageFilter::DualExecuteInternal ( const Image image1)
private

◆ Execute() [1/2]

Image itk::simple::VectorIndexSelectionCastImageFilter::Execute ( const Image image1)

◆ Execute() [2/2]

Image itk::simple::VectorIndexSelectionCastImageFilter::Execute ( Image &&  image1)

Execute the filter on the input image

◆ GetIndex()

unsigned int itk::simple::VectorIndexSelectionCastImageFilter::GetIndex ( ) const
inline

Get/Set methods for the index

Definition at line 71 of file sitkVectorIndexSelectionCastImageFilter.h.

◆ GetName()

std::string itk::simple::VectorIndexSelectionCastImageFilter::GetName ( ) const
inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 84 of file sitkVectorIndexSelectionCastImageFilter.h.

◆ GetOutputPixelType()

PixelIDValueEnum itk::simple::VectorIndexSelectionCastImageFilter::GetOutputPixelType ( ) const
inline

Get the ouput pixel type.

Definition at line 81 of file sitkVectorIndexSelectionCastImageFilter.h.

◆ SetIndex()

Self& itk::simple::VectorIndexSelectionCastImageFilter::SetIndex ( unsigned int  Index)
inline

Get/Set methods for the index

Definition at line 66 of file sitkVectorIndexSelectionCastImageFilter.h.

◆ SetOutputPixelType()

Self& itk::simple::VectorIndexSelectionCastImageFilter::SetOutputPixelType ( PixelIDValueEnum  OutputPixelType)
inline

Set the output pixel type of the scalar component to extract.

Definition at line 76 of file sitkVectorIndexSelectionCastImageFilter.h.

◆ ToString()

std::string itk::simple::VectorIndexSelectionCastImageFilter::ToString ( ) const
virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::DualExecuteInternalAddressor< MemberFunctionType >

Definition at line 101 of file sitkVectorIndexSelectionCastImageFilter.h.

Member Data Documentation

◆ m_DualMemberFactory

std::unique_ptr<detail::DualMemberFunctionFactory<MemberFunctionType> > itk::simple::VectorIndexSelectionCastImageFilter::m_DualMemberFactory
private

Definition at line 105 of file sitkVectorIndexSelectionCastImageFilter.h.

◆ m_Index

unsigned int itk::simple::VectorIndexSelectionCastImageFilter::m_Index {0u}
private

Definition at line 110 of file sitkVectorIndexSelectionCastImageFilter.h.

◆ m_InPlace

bool itk::simple::VectorIndexSelectionCastImageFilter::m_InPlace {false}
private

Definition at line 115 of file sitkVectorIndexSelectionCastImageFilter.h.

◆ m_OutputPixelType

PixelIDValueEnum itk::simple::VectorIndexSelectionCastImageFilter::m_OutputPixelType {itk::simple::sitkUnknown}
private

Definition at line 112 of file sitkVectorIndexSelectionCastImageFilter.h.


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