Medical Imaging Interaction Toolkit  2018.04.99-3ec0dd08
Medical Imaging Interaction Toolkit
mitk::OverwriteDirectedPlaneImageFilter Class Reference

Writes a 2D slice into a 3D image. More...

#include <mitkOverwriteDirectedPlaneImageFilter.h>

Inheritance diagram for mitk::OverwriteDirectedPlaneImageFilter:
Collaboration diagram for mitk::OverwriteDirectedPlaneImageFilter:

Public Member Functions

 mitkClassMacro (OverwriteDirectedPlaneImageFilter, ImageToImageFilter)
 
Pointer Clone () const
 
const BaseGeometryGetPlaneGeometry3D () const
 Which plane to overwrite. More...
 
void SetPlaneGeometry3D (const BaseGeometry *geometry)
 
virtual void SetTimeStep (unsigned int _arg)
 Time step of the slice to overwrite. More...
 
virtual unsigned int GetTimeStep () const
 
virtual void SetCreateUndoInformation (bool _arg)
 Whether to create undo operation in the MITK undo stack. More...
 
virtual bool GetCreateUndoInformation () const
 
virtual void SetSliceImage (Image *_arg)
 
const ImageGetSliceImage ()
 
const ImageGetLastDifferenceImage ()
 
- 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

 OverwriteDirectedPlaneImageFilter ()
 
 ~OverwriteDirectedPlaneImageFilter () override
 
void GenerateData () override
 
template<typename TPixel , unsigned int VImageDimension>
void ItkSliceOverwriting (itk::Image< TPixel, VImageDimension > *input3D)
 
template<typename TPixel , unsigned int VImageDimension>
void ItkImageSwitch (itk::Image< TPixel, VImageDimension > *image)
 
template<typename TPixel1 , unsigned int VImageDimension1, typename TPixel2 , unsigned int VImageDimension2>
void ItkImageProcessing (itk::Image< TPixel1, VImageDimension1 > *itkImage1, itk::Image< TPixel2, VImageDimension2 > *itkImage2)
 
- 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

Image::ConstPointer m_SliceImage
 
Image::Pointer m_SliceDifferenceImage
 
const BaseGeometrym_PlaneGeometry
 
const BaseGeometrym_ImageGeometry3D
 
unsigned int m_TimeStep
 
unsigned int m_Dimension0
 
unsigned int m_Dimension1
 
bool m_CreateUndoInformation
 

Additional Inherited Members

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

Writes a 2D slice into a 3D image.

Deprecated:
This class is deprecated. Use mitkVtkImageOverwrite instead.
See also
mitkVtkImageOverwrite
SegTool2D
ContourTool
ExtractImageFilter

This class takes a 3D mitk::Image as input and tries to replace one slice in it with the second input image, which is specified by calling SetSliceImage with a 2D mitk::Image.

Two parameters determine which slice is replaced: 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.

This class works with all kind of image types, the only restrictions being that the input is 3D, and the slice image is 2D.

If requested by SetCreateUndoInformation(true), this class will create instances of ApplyDiffImageOperation for the undo stack. These operations will (on user request) be executed by DiffImageApplier to perform undo.

Last contributor:

Author
maleike

Definition at line 55 of file mitkOverwriteDirectedPlaneImageFilter.h.

Constructor & Destructor Documentation

◆ OverwriteDirectedPlaneImageFilter()

mitk::OverwriteDirectedPlaneImageFilter::OverwriteDirectedPlaneImageFilter ( )
protected

◆ ~OverwriteDirectedPlaneImageFilter()

mitk::OverwriteDirectedPlaneImageFilter::~OverwriteDirectedPlaneImageFilter ( )
overrideprotected

Member Function Documentation

◆ Clone()

Pointer mitk::OverwriteDirectedPlaneImageFilter::Clone ( ) const

◆ GenerateData()

void mitk::OverwriteDirectedPlaneImageFilter::GenerateData ( )
overrideprotected

◆ GetCreateUndoInformation()

virtual bool mitk::OverwriteDirectedPlaneImageFilter::GetCreateUndoInformation ( ) const
virtual

◆ GetLastDifferenceImage()

const Image* mitk::OverwriteDirectedPlaneImageFilter::GetLastDifferenceImage ( )
inline

Definition at line 84 of file mitkOverwriteDirectedPlaneImageFilter.h.

◆ GetPlaneGeometry3D()

const BaseGeometry* mitk::OverwriteDirectedPlaneImageFilter::GetPlaneGeometry3D ( ) const
inline

Which plane to overwrite.

Definition at line 65 of file mitkOverwriteDirectedPlaneImageFilter.h.

◆ GetSliceImage()

const Image* mitk::OverwriteDirectedPlaneImageFilter::GetSliceImage ( )
inline

Definition at line 83 of file mitkOverwriteDirectedPlaneImageFilter.h.

◆ GetTimeStep()

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

◆ ItkImageProcessing()

template<typename TPixel1 , unsigned int VImageDimension1, typename TPixel2 , unsigned int VImageDimension2>
void mitk::OverwriteDirectedPlaneImageFilter::ItkImageProcessing ( itk::Image< TPixel1, VImageDimension1 > *  itkImage1,
itk::Image< TPixel2, VImageDimension2 > *  itkImage2 
)
protected

◆ ItkImageSwitch()

template<typename TPixel , unsigned int VImageDimension>
void mitk::OverwriteDirectedPlaneImageFilter::ItkImageSwitch ( itk::Image< TPixel, VImageDimension > *  image)
protected

◆ ItkSliceOverwriting()

template<typename TPixel , unsigned int VImageDimension>
void mitk::OverwriteDirectedPlaneImageFilter::ItkSliceOverwriting ( itk::Image< TPixel, VImageDimension > *  input3D)
protected

◆ mitkClassMacro()

mitk::OverwriteDirectedPlaneImageFilter::mitkClassMacro ( OverwriteDirectedPlaneImageFilter  ,
ImageToImageFilter   
)

◆ New()

static Pointer mitk::OverwriteDirectedPlaneImageFilter::New ( )
static

◆ SetCreateUndoInformation()

virtual void mitk::OverwriteDirectedPlaneImageFilter::SetCreateUndoInformation ( bool  _arg)
virtual

Whether to create undo operation in the MITK undo stack.

◆ SetPlaneGeometry3D()

void mitk::OverwriteDirectedPlaneImageFilter::SetPlaneGeometry3D ( const BaseGeometry geometry)
inline

Definition at line 69 of file mitkOverwriteDirectedPlaneImageFilter.h.

◆ SetSliceImage()

virtual void mitk::OverwriteDirectedPlaneImageFilter::SetSliceImage ( Image _arg)
virtual

◆ SetTimeStep()

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

Time step of the slice to overwrite.

Member Data Documentation

◆ m_CreateUndoInformation

bool mitk::OverwriteDirectedPlaneImageFilter::m_CreateUndoInformation
protected

Definition at line 112 of file mitkOverwriteDirectedPlaneImageFilter.h.

◆ m_Dimension0

unsigned int mitk::OverwriteDirectedPlaneImageFilter::m_Dimension0
protected

Definition at line 109 of file mitkOverwriteDirectedPlaneImageFilter.h.

◆ m_Dimension1

unsigned int mitk::OverwriteDirectedPlaneImageFilter::m_Dimension1
protected

Definition at line 110 of file mitkOverwriteDirectedPlaneImageFilter.h.

◆ m_ImageGeometry3D

const BaseGeometry* mitk::OverwriteDirectedPlaneImageFilter::m_ImageGeometry3D
protected

Definition at line 107 of file mitkOverwriteDirectedPlaneImageFilter.h.

◆ m_PlaneGeometry

const BaseGeometry* mitk::OverwriteDirectedPlaneImageFilter::m_PlaneGeometry
protected

Definition at line 106 of file mitkOverwriteDirectedPlaneImageFilter.h.

◆ m_SliceDifferenceImage

Image::Pointer mitk::OverwriteDirectedPlaneImageFilter::m_SliceDifferenceImage
protected

Definition at line 104 of file mitkOverwriteDirectedPlaneImageFilter.h.

◆ m_SliceImage

Image::ConstPointer mitk::OverwriteDirectedPlaneImageFilter::m_SliceImage
protected

Definition at line 103 of file mitkOverwriteDirectedPlaneImageFilter.h.

◆ m_TimeStep

unsigned int mitk::OverwriteDirectedPlaneImageFilter::m_TimeStep
protected

Definition at line 108 of file mitkOverwriteDirectedPlaneImageFilter.h.


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