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

Extract a region of interest from the input image. More...

#include <sitkRegionOfInterestImageFilter.h>

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

Public Types

using PixelIDTypeList = NonLabelPixelIDTypeList
 
using Self = RegionOfInterestImageFilter
 
- 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::vector< int > GetIndex () const
 
std::string GetName () const
 
std::vector< unsigned int > GetSize () const
 
 RegionOfInterestImageFilter ()
 
SelfSetIndex (std::vector< int > Index)
 Set the inclusive starting index of the region extracted. More...
 
void SetRegionOfInterest (const std::vector< unsigned int > &Region)
 
SelfSetSize (std::vector< unsigned int > Size)
 Size in pixels of the region extracted. More...
 
std::string ToString () const
 
virtual ~RegionOfInterestImageFilter ()
 
- 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::vector< int > m_Index {std::vector<int>(3, 0)}
 
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
std::vector< unsigned int > m_Size {std::vector<unsigned int>(3, 1)}
 

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::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

Extract a region of interest from the input image.

This filter produces an output image of the same dimension as the input image. The user specifies the region of the input image that will be contained in the output image. The origin coordinates of the output images will be computed in such a way that if mapped to physical space, the output image will overlay the input image with perfect registration. In other words, a registration process between the output image and the input image will return an identity transform.

If you are interested in changing the dimension of the image, you may want to consider the ExtractImageFilter . For example for extracting a 2D image from a slice of a 3D image.

The region to extract is set using the method SetRegionOfInterest.

See also
ExtractImageFilter
itk::simple::RegionOfInterest for the procedural interface
itk::RegionOfInterestImageFilter for the Doxygen on the original ITK class.

Definition at line 48 of file sitkRegionOfInterestImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

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

Setup for member function dispatching

Definition at line 100 of file sitkRegionOfInterestImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 60 of file sitkRegionOfInterestImageFilter.h.

◆ Self

Definition at line 50 of file sitkRegionOfInterestImageFilter.h.

Constructor & Destructor Documentation

◆ ~RegionOfInterestImageFilter()

virtual itk::simple::RegionOfInterestImageFilter::~RegionOfInterestImageFilter ( )
virtual

Destructor

◆ RegionOfInterestImageFilter()

itk::simple::RegionOfInterestImageFilter::RegionOfInterestImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

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

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >
Image itk::simple::RegionOfInterestImageFilter::ExecuteInternal ( const Image image1)
private

◆ GetIndex()

std::vector<int> itk::simple::RegionOfInterestImageFilter::GetIndex ( ) const
inline

Definition at line 79 of file sitkRegionOfInterestImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 82 of file sitkRegionOfInterestImageFilter.h.

◆ GetSize()

std::vector<unsigned int> itk::simple::RegionOfInterestImageFilter::GetSize ( ) const
inline

Definition at line 70 of file sitkRegionOfInterestImageFilter.h.

◆ SetIndex()

Self& itk::simple::RegionOfInterestImageFilter::SetIndex ( std::vector< int >  Index)
inline

Set the inclusive starting index of the region extracted.

Definition at line 75 of file sitkRegionOfInterestImageFilter.h.

◆ SetRegionOfInterest()

void itk::simple::RegionOfInterestImageFilter::SetRegionOfInterest ( const std::vector< unsigned int > &  Region)

Sets the region extracted by a single array of the starting indexes followed by the sizes in pixels.

◆ SetSize()

Self& itk::simple::RegionOfInterestImageFilter::SetSize ( std::vector< unsigned int >  Size)
inline

Size in pixels of the region extracted.

Definition at line 66 of file sitkRegionOfInterestImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 104 of file sitkRegionOfInterestImageFilter.h.

Member Data Documentation

◆ m_Index

std::vector<int> itk::simple::RegionOfInterestImageFilter::m_Index {std::vector<int>(3, 0)}
private

Definition at line 111 of file sitkRegionOfInterestImageFilter.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::RegionOfInterestImageFilter::m_MemberFactory
private

Definition at line 106 of file sitkRegionOfInterestImageFilter.h.

◆ m_Size

std::vector<unsigned int> itk::simple::RegionOfInterestImageFilter::m_Size {std::vector<unsigned int>(3, 1)}
private

Definition at line 109 of file sitkRegionOfInterestImageFilter.h.


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