mitk::CropImageFilter Class Reference

Class implementing an mitk::ImageToImageFilter for casting any mitk image to a float image. More...

#include <mitkCropImageFilter.h>

Inheritance diagram for mitk::CropImageFilter:

Collaboration diagram for mitk::CropImageFilter:

Public Member Functions
	mitkClassMacro (CropImageFilter, ImageToImageFilter)
Pointer	Clone () const
virtual unsigned int	GetXPixelsCropStart ()
virtual void	SetXPixelsCropStart (unsigned int _arg)
virtual unsigned int	GetYPixelsCropStart ()
virtual void	SetYPixelsCropStart (unsigned int _arg)
virtual unsigned int	GetZPixelsCropStart ()
virtual void	SetZPixelsCropStart (unsigned int _arg)
virtual unsigned int	GetXPixelsCropEnd ()
virtual void	SetXPixelsCropEnd (unsigned int _arg)
virtual unsigned int	GetYPixelsCropEnd ()
virtual void	SetYPixelsCropEnd (unsigned int _arg)
virtual unsigned int	GetZPixelsCropEnd ()
virtual void	SetZPixelsCropEnd (unsigned int _arg)
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)
InputImageType *	GetInput (void)
InputImageType *	GetInput (unsigned int idx)
const InputImageType *	GetInput (void) const
const InputImageType *	GetInput (unsigned int idx) const
Public Member Functions inherited from mitk::ImageSource
Pointer	Clone () const
OutputType *	GetOutput ()
	Get the output data of this image source object. More...
const OutputType *	GetOutput () const
OutputType *	GetOutput (DataObjectPointerArraySizeType idx)
const OutputType *	GetOutput (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
OutputType *	GetOutput ()
const OutputType *	GetOutput () const
OutputType *	GetOutput (DataObjectPointerArraySizeType idx)
const OutputType *	GetOutput (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
	CropImageFilter ()
	~CropImageFilter () override
void	GenerateData () override
void	SanityCheckPreconditions ()
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_XPixelsCropStart
unsigned int	m_YPixelsCropStart
unsigned int	m_ZPixelsCropStart
unsigned int	m_XPixelsCropEnd
unsigned int	m_YPixelsCropEnd
unsigned int	m_ZPixelsCropEnd

Additional Inherited Members
Public Types inherited from mitk::ImageToImageFilter
typedef ImageToImageFilter	Self
typedef ImageSource	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer
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< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer
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< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer
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

Class implementing an mitk::ImageToImageFilter for casting any mitk image to a float image.

Definition at line 25 of file mitkCropImageFilter.h.

Constructor & Destructor Documentation

CropImageFilter()

mitk::CropImageFilter::CropImageFilter ( )

protected

Definition at line 17 of file mitkCropImageFilter.cpp.

References MITK_INFO.

~CropImageFilter()

mitk::CropImageFilter::~CropImageFilter ( )

overrideprotected

Definition at line 31 of file mitkCropImageFilter.cpp.

References MITK_INFO.

Member Function Documentation

Clone()

Pointer mitk::CropImageFilter::Clone

(

)

const

GenerateData()

void mitk::CropImageFilter::GenerateData ( )

overrideprotected

Definition at line 76 of file mitkCropImageFilter.cpp.

References mitk::ImageWriteAccessor::GetData(), mitk::ImageAccessorBase::GetData(), mitk::ImageToImageFilter::GetInput(), mitk::ImageSource::GetOutput(), m_XPixelsCropEnd, m_XPixelsCropStart, m_YPixelsCropEnd, m_YPixelsCropStart, m_ZPixelsCropEnd, m_ZPixelsCropStart, and SanityCheckPreconditions().

GetXPixelsCropEnd()

virtual unsigned int mitk::CropImageFilter::GetXPixelsCropEnd ( )

virtual

GetXPixelsCropStart()

virtual unsigned int mitk::CropImageFilter::GetXPixelsCropStart ( )

virtual

GetYPixelsCropEnd()

virtual unsigned int mitk::CropImageFilter::GetYPixelsCropEnd ( )

virtual

GetYPixelsCropStart()

virtual unsigned int mitk::CropImageFilter::GetYPixelsCropStart ( )

virtual

GetZPixelsCropEnd()

virtual unsigned int mitk::CropImageFilter::GetZPixelsCropEnd ( )

virtual

GetZPixelsCropStart()

virtual unsigned int mitk::CropImageFilter::GetZPixelsCropStart ( )

virtual

mitkClassMacro()

mitk::CropImageFilter::mitkClassMacro	(	CropImageFilter	,
		ImageToImageFilter
	)

New()

static Pointer mitk::CropImageFilter::New ( )

static

Referenced by mitk::PhotoacousticFilterService::ApplyCropping().

SanityCheckPreconditions()

void mitk::CropImageFilter::SanityCheckPreconditions ( )

protected

Definition at line 36 of file mitkCropImageFilter.cpp.

References mitk::ImageToImageFilter::GetInput(), m_XPixelsCropEnd, m_XPixelsCropStart, m_YPixelsCropEnd, m_YPixelsCropStart, m_ZPixelsCropEnd, m_ZPixelsCropStart, MITK_ERROR, MITK_INFO, and mitkThrow.

Referenced by GenerateData().

SetXPixelsCropEnd()

virtual void mitk::CropImageFilter::SetXPixelsCropEnd ( unsigned int  _arg )

virtual

SetXPixelsCropStart()

virtual void mitk::CropImageFilter::SetXPixelsCropStart ( unsigned int  _arg )

virtual

SetYPixelsCropEnd()

virtual void mitk::CropImageFilter::SetYPixelsCropEnd ( unsigned int  _arg )

virtual

SetYPixelsCropStart()

virtual void mitk::CropImageFilter::SetYPixelsCropStart ( unsigned int  _arg )

virtual

SetZPixelsCropEnd()

virtual void mitk::CropImageFilter::SetZPixelsCropEnd ( unsigned int  _arg )

virtual

SetZPixelsCropStart()

virtual void mitk::CropImageFilter::SetZPixelsCropStart ( unsigned int  _arg )

virtual

Member Data Documentation

m_XPixelsCropEnd

unsigned int mitk::CropImageFilter::m_XPixelsCropEnd

protected

Definition at line 59 of file mitkCropImageFilter.h.

Referenced by GenerateData(), and SanityCheckPreconditions().

m_XPixelsCropStart

unsigned int mitk::CropImageFilter::m_XPixelsCropStart

protected

Definition at line 56 of file mitkCropImageFilter.h.

Referenced by GenerateData(), and SanityCheckPreconditions().

m_YPixelsCropEnd

unsigned int mitk::CropImageFilter::m_YPixelsCropEnd

protected

Definition at line 60 of file mitkCropImageFilter.h.

Referenced by GenerateData(), and SanityCheckPreconditions().

m_YPixelsCropStart

unsigned int mitk::CropImageFilter::m_YPixelsCropStart

protected

Definition at line 57 of file mitkCropImageFilter.h.

Referenced by GenerateData(), and SanityCheckPreconditions().

m_ZPixelsCropEnd

unsigned int mitk::CropImageFilter::m_ZPixelsCropEnd

protected

Definition at line 61 of file mitkCropImageFilter.h.

Referenced by GenerateData(), and SanityCheckPreconditions().

m_ZPixelsCropStart

unsigned int mitk::CropImageFilter::m_ZPixelsCropStart

protected

Definition at line 58 of file mitkCropImageFilter.h.

Referenced by GenerateData(), and SanityCheckPreconditions().

---

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

• mitkCropImageFilter.h
• mitkCropImageFilter.cpp