itk::simple::SliceImageFilter Class Reference

Slices an image based on a starting index and a stopping index, and a step size. More...

#include <sitkSliceImageFilter.h>

Inheritance diagram for itk::simple::SliceImageFilter:

Collaboration diagram for itk::simple::SliceImageFilter:

Detailed Description

Slices an image based on a starting index and a stopping index, and a step size.

This class is designed to facilitate the implementation of extended sliced based indexing into images.

The input and output image must be of the same dimension.

The input parameters are a starting and stopping index as well as a stepping size. The starting index indicates the first pixels to be used and for each dimension the index is incremented by the step until the index is equal to or "beyond" the stopping index. If the step is negative then the image will be reversed in the dimension, and the stopping index is expected to be less then the starting index. If the stopping index is already beyond the starting index then an image of size zero will be returned.

The output image's starting index is always zero. The origin is the physical location of the starting index. The output directions cosine matrix is that of the input but with sign changes matching that of the step's sign.

Note

In certain combinations such as with start=1, and step>1 while the physical location of the center of the pixel remains the same, the extent (edge to edge space) of the output image will be beyond the extent of the original image.

See also

itk::simple::Slice for the procedural interface

itk::SliceImageFilter for the Doxygen on the original ITK class.

Definition at line 49 of file sitkSliceImageFilter.h.

Public Types
using	PixelIDTypeList = NonLabelPixelIDTypeList
using	Self = SliceImageFilter
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)
std::string	GetName () const
std::vector< int32_t >	GetStart () const
std::vector< int >	GetStep () const
std::vector< int32_t >	GetStop () const
Self &	SetStart (std::vector< int32_t > Start)
Self &	SetStep (int value)
Self &	SetStep (std::vector< int > Step)
Self &	SetStop (std::vector< int32_t > Stop)
	SliceImageFilter ()
std::string	ToString () const
virtual	~SliceImageFilter ()
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 TImageType >
Image	ExecuteInternal (const Image &image1)

Private Attributes
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory
std::vector< int32_t >	m_Start {std::vector<int32_t>(3, 0)}
std::vector< int >	m_Step {std::vector<int>(3, 1)}
std::vector< int32_t >	m_Stop {std::vector<int32_t>(3, std::numeric_limits<int32_t>::max())}

Friends
struct	detail::MemberFunctionAddressor< 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::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::SliceImageFilter::MemberFunctionType = Image (Self::*)( const Image& image1 )

private

Setup for member function dispatching

Definition at line 112 of file sitkSliceImageFilter.h.

PixelIDTypeList

using itk::simple::SliceImageFilter::PixelIDTypeList = NonLabelPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 61 of file sitkSliceImageFilter.h.

Self

using itk::simple::SliceImageFilter::Self = SliceImageFilter

Definition at line 51 of file sitkSliceImageFilter.h.

Constructor & Destructor Documentation

~SliceImageFilter()

virtual itk::simple::SliceImageFilter::~SliceImageFilter ( )

virtual

Destructor

SliceImageFilter()

itk::simple::SliceImageFilter::SliceImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Execute()

Image itk::simple::SliceImageFilter::Execute

(

const Image &

image1

)

Execute the filter on the input image

ExecuteInternal()

template<class TImageType >

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

private

GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 98 of file sitkSliceImageFilter.h.

GetStart()

std::vector<int32_t> itk::simple::SliceImageFilter::GetStart ( ) const

inline

Set/Get the first index extracted from the input image

Definition at line 72 of file sitkSliceImageFilter.h.

GetStep()

std::vector<int> itk::simple::SliceImageFilter::GetStep ( ) const

inline

Set/Get the stride of indexes extracted An exception will be generated if 0.

Definition at line 95 of file sitkSliceImageFilter.h.

GetStop()

std::vector<int32_t> itk::simple::SliceImageFilter::GetStop ( ) const

inline

Set/Get the excluded end of the range

Definition at line 82 of file sitkSliceImageFilter.h.

SetStart()

Self& itk::simple::SliceImageFilter::SetStart ( std::vector< int32_t >  Start )

inline

Set/Get the first index extracted from the input image

Definition at line 67 of file sitkSliceImageFilter.h.

SetStep() [1/2]

Self& itk::simple::SliceImageFilter::SetStep ( int  value )

inline

Set the values of the Step vector all to value

Definition at line 90 of file sitkSliceImageFilter.h.

SetStep() [2/2]

Self& itk::simple::SliceImageFilter::SetStep ( std::vector< int >  Step )

inline

Set/Get the stride of indexes extracted An exception will be generated if 0.

Definition at line 87 of file sitkSliceImageFilter.h.

SetStop()

Self& itk::simple::SliceImageFilter::SetStop ( std::vector< int32_t >  Stop )

inline

Set/Get the excluded end of the range

Definition at line 77 of file sitkSliceImageFilter.h.

ToString()

std::string itk::simple::SliceImageFilter::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 116 of file sitkSliceImageFilter.h.

Member Data Documentation

m_MemberFactory

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

private

Definition at line 118 of file sitkSliceImageFilter.h.

m_Start

std::vector<int32_t> itk::simple::SliceImageFilter::m_Start {std::vector<int32_t>(3, 0)}

private

Definition at line 121 of file sitkSliceImageFilter.h.

m_Step

std::vector<int> itk::simple::SliceImageFilter::m_Step {std::vector<int>(3, 1)}

private

Definition at line 125 of file sitkSliceImageFilter.h.

m_Stop

std::vector<int32_t> itk::simple::SliceImageFilter::m_Stop {std::vector<int32_t>(3, std::numeric_limits<int32_t>::max())}

private

Definition at line 123 of file sitkSliceImageFilter.h.

---

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

• sitkSliceImageFilter.h