Medical Imaging Interaction Toolkit  2018.4.99-0a90f175
Medical Imaging Interaction Toolkit

Extracts a 2D slice from a 3D image. More...

#include <mitkExtractImageFilter.h>

Inheritance diagram for mitk::ExtractImageFilter:
Collaboration diagram for mitk::ExtractImageFilter:

Public Types

enum  DirectionCollapseStrategyEnum { DIRECTIONCOLLAPSETOUNKOWN, DIRECTIONCOLLAPSETOIDENTITY, DIRECTIONCOLLAPSETOSUBMATRIX, DIRECTIONCOLLAPSETOGUESS }
 
typedef enum mitk::ExtractImageFilter::DirectionCollapseStrategyEnum DIRECTIONCOLLAPSESTRATEGY
 
- Public Types inherited from mitk::ImageToImageFilter
typedef ImageToImageFilter Self
 
typedef ImageSource Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef Superclass::OutputImageRegionType OutputImageRegionType
 
typedef mitk::Image InputImageType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::ConstPointer InputImageConstPointer
 
typedef SlicedData::RegionType InputImageRegionType
 
- Public Types inherited from mitk::ImageSource
typedef ImageSource Self
 
typedef BaseDataSource Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef mitk::Image OutputImageType
 Some convenient typedefs. More...
 
typedef OutputImageType OutputType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef SlicedData::RegionType OutputImageRegionType
 
- Public Types inherited from mitk::BaseDataSource
typedef BaseDataSource Self
 
typedef itk::ProcessObject Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef BaseData OutputType
 
typedef itk::DataObject::DataObjectIdentifierType DataObjectIdentifierType
 

Public Member Functions

 mitkClassMacro (ExtractImageFilter, ImageToImageFilter)
 
Pointer Clone () const
 
virtual void SetSliceIndex (unsigned int _arg)
 Which slice to extract (first one has index 0). More...
 
virtual unsigned int GetSliceIndex () const
 
virtual void SetSliceDimension (unsigned int _arg)
 The orientation of the slice to be extracted. More...
 
virtual unsigned int GetSliceDimension () const
 
virtual void SetTimeStep (unsigned int _arg)
 Time step of the image to be extracted. More...
 
virtual unsigned int GetTimeStep () const
 
virtual void SetDirectionCollapseToStrategy (DIRECTIONCOLLAPSESTRATEGY _arg)
 Collapse strategy to be used. More...
 
virtual DIRECTIONCOLLAPSESTRATEGY GetDirectionCollapseToStrategy () const
 
- Public Member Functions inherited from mitk::ImageToImageFilter
virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
Pointer Clone () const
 
virtual void SetInput (const InputImageType *image)
 
virtual void SetInput (unsigned int, const InputImageType *image)
 
InputImageTypeGetInput (void)
 
InputImageTypeGetInput (unsigned int idx)
 
const InputImageTypeGetInput (void) const
 
const InputImageTypeGetInput (unsigned int idx) const
 
- Public Member Functions inherited from mitk::ImageSource
Pointer Clone () const
 
OutputTypeGetOutput ()
 Get the output data of this image source object. More...
 
const OutputTypeGetOutput () const
 
OutputTypeGetOutput (DataObjectPointerArraySizeType idx)
 
const OutputTypeGetOutput (DataObjectPointerArraySizeType idx) const
 
itk::DataObject::Pointer MakeOutput (DataObjectPointerArraySizeType idx) override
 Make a DataObject of the correct type to used as the specified output. More...
 
itk::DataObject::Pointer MakeOutput (const DataObjectIdentifierType &name) override
 
virtual vtkImageData * GetVtkImageData ()
 
virtual const vtkImageData * GetVtkImageData () const
 
- Public Member Functions inherited from mitk::BaseDataSource
OutputTypeGetOutput ()
 
const OutputTypeGetOutput () const
 
OutputTypeGetOutput (DataObjectPointerArraySizeType idx)
 
const OutputTypeGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void GraftOutput (OutputType *output)
 Graft the specified BaseData onto this BaseDataSource's output. More...
 
virtual void GraftOutput (const DataObjectIdentifierType &key, OutputType *output)
 
virtual void GraftNthOutput (unsigned int idx, OutputType *output)
 Graft the specified base data object onto this BaseDataSource's idx'th output. More...
 
bool Updating () const
 Access itk::ProcessObject::m_Updating. More...
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from mitk::ImageToImageFilter
static const char * GetStaticNameOfClass ()
 
static Pointer New ()
 
- Static Public Member Functions inherited from mitk::ImageSource
static const char * GetStaticNameOfClass ()
 
static Pointer New ()
 Method for creation through the object factory. More...
 
- Static Public Member Functions inherited from mitk::BaseDataSource
static const char * GetStaticNameOfClass ()
 

Protected Member Functions

 ExtractImageFilter ()
 
 ~ExtractImageFilter () override
 
void GenerateOutputInformation () override
 
void GenerateInputRequestedRegion () override
 
void GenerateData () override
 
template<typename TPixel , unsigned int VImageDimension>
void ItkImageProcessing (const itk::Image< TPixel, VImageDimension > *image)
 
- Protected Member Functions inherited from mitk::ImageToImageFilter
 ImageToImageFilter ()
 
 ~ImageToImageFilter () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
void GenerateInputRequestedRegion () override
 
- Protected Member Functions inherited from mitk::ImageSource
 ImageSource ()
 
 ~ImageSource () override
 
void GenerateData () override
 A version of GenerateData() specific for image processing filters. More...
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId)
 If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData(). More...
 
void PrepareOutputs () override
 This method is intentionally left blank. More...
 
virtual void AllocateOutputs ()
 The GenerateData method normally allocates the buffers for all of the outputs of a filter. More...
 
virtual void BeforeThreadedGenerateData ()
 If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). More...
 
virtual void AfterThreadedGenerateData ()
 If an imaging filter needs to perform processing after all processing threads have completed, the filter can can provide an implementation for AfterThreadedGenerateData(). More...
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
 Split the output's RequestedRegion into "num" pieces, returning region "i" as "splitRegion". More...
 
- Protected Member Functions inherited from mitk::BaseDataSource
 BaseDataSource ()
 
 ~BaseDataSource () override
 

Protected Attributes

unsigned int m_SliceIndex
 
unsigned int m_SliceDimension
 
unsigned int m_TimeStep
 
DIRECTIONCOLLAPSESTRATEGY m_DirectionCollapseToStrategy
 

Additional Inherited Members

- Static Protected Member Functions inherited from mitk::ImageSource
static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 Static function used as a "callback" by the MultiThreader. More...
 
- Static Protected Member Functions inherited from mitk::BaseDataSource
static Pointer New ()
 

Detailed Description

Extracts a 2D slice from a 3D image.

Deprecated:
This class is deprecated. Use mitk::ExtractSliceFilter instead.
See also
ExtractSliceFilter
SegTool2D
OverwriteSliceImageFilter

There is a separate page describing the general design of QmitkInteractiveSegmentation: Technical design of QmitkSegmentation

This class takes a 3D mitk::Image as input and tries to extract one slice from it.

Two parameters determine which slice is extracted: the "slice dimension" is that one, which is constant for all points in the plane, e.g. axial would mean 2. The "slice index" is the slice index in the image direction you specified with "affected dimension". Indices count from zero.

Output will not be set if there was a problem extracting the desired slice.

Last contributor: $Author$

Definition at line 50 of file mitkExtractImageFilter.h.

Member Typedef Documentation

◆ DIRECTIONCOLLAPSESTRATEGY

Member Enumeration Documentation

◆ DirectionCollapseStrategyEnum

Enumerator
DIRECTIONCOLLAPSETOUNKOWN 
DIRECTIONCOLLAPSETOIDENTITY 
DIRECTIONCOLLAPSETOSUBMATRIX 
DIRECTIONCOLLAPSETOGUESS 

Definition at line 78 of file mitkExtractImageFilter.h.

Constructor & Destructor Documentation

◆ ExtractImageFilter()

mitk::ExtractImageFilter::ExtractImageFilter ( )
protected

◆ ~ExtractImageFilter()

mitk::ExtractImageFilter::~ExtractImageFilter ( )
overrideprotected

Member Function Documentation

◆ Clone()

Pointer mitk::ExtractImageFilter::Clone ( ) const

◆ GenerateData()

void mitk::ExtractImageFilter::GenerateData ( )
overrideprotected

◆ GenerateInputRequestedRegion()

void mitk::ExtractImageFilter::GenerateInputRequestedRegion ( )
overrideprotected

◆ GenerateOutputInformation()

void mitk::ExtractImageFilter::GenerateOutputInformation ( )
overrideprotected

◆ GetDirectionCollapseToStrategy()

virtual DIRECTIONCOLLAPSESTRATEGY mitk::ExtractImageFilter::GetDirectionCollapseToStrategy ( ) const
virtual

◆ GetSliceDimension()

virtual unsigned int mitk::ExtractImageFilter::GetSliceDimension ( ) const
virtual

◆ GetSliceIndex()

virtual unsigned int mitk::ExtractImageFilter::GetSliceIndex ( ) const
virtual

◆ GetTimeStep()

virtual unsigned int mitk::ExtractImageFilter::GetTimeStep ( ) const
virtual

◆ ItkImageProcessing()

template<typename TPixel , unsigned int VImageDimension>
void mitk::ExtractImageFilter::ItkImageProcessing ( const itk::Image< TPixel, VImageDimension > *  image)
protected

◆ mitkClassMacro()

mitk::ExtractImageFilter::mitkClassMacro ( ExtractImageFilter  ,
ImageToImageFilter   
)

◆ New()

static Pointer mitk::ExtractImageFilter::New ( )
static

◆ SetDirectionCollapseToStrategy()

virtual void mitk::ExtractImageFilter::SetDirectionCollapseToStrategy ( DIRECTIONCOLLAPSESTRATEGY  _arg)
virtual

Collapse strategy to be used.

◆ SetSliceDimension()

virtual void mitk::ExtractImageFilter::SetSliceDimension ( unsigned int  _arg)
virtual

The orientation of the slice to be extracted.

Parameter SliceDimension Number of the dimension which is constant for all pixels of the desired slice (e.g. 2 for axial)

◆ SetSliceIndex()

virtual void mitk::ExtractImageFilter::SetSliceIndex ( unsigned int  _arg)
virtual

Which slice to extract (first one has index 0).

◆ SetTimeStep()

virtual void mitk::ExtractImageFilter::SetTimeStep ( unsigned int  _arg)
virtual

Time step of the image to be extracted.

Member Data Documentation

◆ m_DirectionCollapseToStrategy

DIRECTIONCOLLAPSESTRATEGY mitk::ExtractImageFilter::m_DirectionCollapseToStrategy
protected

Definition at line 106 of file mitkExtractImageFilter.h.

◆ m_SliceDimension

unsigned int mitk::ExtractImageFilter::m_SliceDimension
protected

Definition at line 104 of file mitkExtractImageFilter.h.

◆ m_SliceIndex

unsigned int mitk::ExtractImageFilter::m_SliceIndex
protected

Definition at line 103 of file mitkExtractImageFilter.h.

◆ m_TimeStep

unsigned int mitk::ExtractImageFilter::m_TimeStep
protected

Definition at line 105 of file mitkExtractImageFilter.h.


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