Crops timesteps from 2D+t and 3D+t images. More...

#include <mitkCropTimestepsImageFilter.h>

Inheritance diagram for mitk::CropTimestepsImageFilter:

[legend]

Collaboration diagram for mitk::CropTimestepsImageFilter:

[legend]

Public Member Functions
	mitkClassMacro (CropTimestepsImageFilter, SubImageSelector)

void	SetInput (const InputImageType *image) override
	Set the input image. More...

void	SetInput (unsigned int index, const InputImageType *image) override
	Set the input image at the specified index (only index 0 is valid). More...

virtual void	SetUpperBoundaryTimestep (unsigned int _arg)
	Set the last timestep to retain (exclusive upper bound). More...

virtual unsigned int	GetUpperBoundaryTimestep () const
	Get the upper boundary timestep (exclusive). More...

virtual void	SetLowerBoundaryTimestep (unsigned int _arg)
	Set the first timestep to retain (inclusive lower bound, default: 0). More...

virtual unsigned int	GetLowerBoundaryTimestep () const
	Get the lower boundary timestep (inclusive). More...

Public Member Functions inherited from mitk::SubImageSelector
	mitkClassMacro (SubImageSelector, ImageToImageFilter)

Pointer	Clone () const

virtual void	SetPosNr (int p)
	Set the position number for sub-image selection. More...

	SubImageSelector ()

	~SubImageSelector () override

Public Member Functions inherited from mitk::ImageToImageFilter
	mitkClassMacro (ImageToImageFilter, ImageSource)

Pointer	Clone () const

InputImageType *	GetInput (void)
	Get the input image (non-const). More...

InputImageType *	GetInput (unsigned int idx)
	Get the input image at the specified index (non-const). More...

const InputImageType *	GetInput (void) const
	Get the input image (const). More...

const InputImageType *	GetInput (unsigned int idx) const
	Get the input image at the specified index (const). More...

Public Member Functions inherited from mitk::ImageSource
	mitkClassMacro (ImageSource, BaseDataSource)

Pointer	Clone () const

mitkBaseDataSourceGetOutputDeclarations itk::DataObject::Pointer	MakeOutput (DataObjectPointerArraySizeType idx) override
	Get the output data of this image source object. More...

itk::DataObject::Pointer	MakeOutput (const DataObjectIdentifierType &name) override

virtual vtkImageData *	GetVtkImageData ()
	Get the output as VTK image data (non-const version). More...

virtual const vtkImageData *	GetVtkImageData () const
	Get the output as VTK image data (const version). More...

Public Member Functions inherited from mitk::BaseDataSource
	mitkClassMacroItkParent (BaseDataSource, itk::ProcessObject)

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)
	Graft the specified base data object onto a named output. More...

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
	Check whether the pipeline is currently executing. More...

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from mitk::SubImageSelector
static Pointer	New ()

Static Public Member Functions inherited from mitk::ImageToImageFilter
static Pointer	New ()
	Method for creation through the object factory. More...

Static Public Member Functions inherited from mitk::ImageSource
static Pointer	New ()
	Method for creation through the object factory. More...

Additional Inherited Members
Public Types inherited from mitk::ImageToImageFilter
typedef Superclass::OutputImageRegionType	OutputImageRegionType
	Superclass typedefs. More...

typedef mitk::Image	InputImageType
	Some convenient typedefs. More...

typedef InputImageType::Pointer	InputImagePointer

typedef InputImageType::ConstPointer	InputImageConstPointer

typedef SlicedData::RegionType	InputImageRegionType

Public Types inherited from mitk::ImageSource
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 BaseData	OutputType
	Output data type. More...

typedef itk::DataObject::DataObjectIdentifierType	DataObjectIdentifierType
	Identifier type for named data objects. More...

Protected Member Functions inherited from mitk::SubImageSelector
mitk::Image::ImageDataItemPointer	GetSliceData (int s=0, int t=0, int n=0)
	Get the data item for the specified slice. More...

mitk::Image::ImageDataItemPointer	GetVolumeData (int t=0, int n=0)
	Get the data item for the specified volume. More...

mitk::Image::ImageDataItemPointer	GetChannelData (int n=0)
	Get the data item for the specified channel. More...

void	SetSliceItem (mitk::Image::ImageDataItemPointer dataItem, int s=0, int t=0, int n=0)
	Set the data item for the specified slice in the output image. More...

void	SetVolumeItem (mitk::Image::ImageDataItemPointer dataItem, int t=0, int n=0)
	Set the data item for the specified volume in the output image. More...

void	SetChannelItem (mitk::Image::ImageDataItemPointer dataItem, int n=0)
	Set the data item for the specified channel in the output image. More...

Protected Member Functions inherited from mitk::ImageToImageFilter
	ImageToImageFilter ()

	~ImageToImageFilter () override

void	PrintSelf (std::ostream &os, itk::Indent indent) const override
	Print self information to the given stream. More...

void	GenerateInputRequestedRegion () override
	Determine the input requested region to produce the output requested region. More...

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 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 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 ()
	Constructor. More...

	~BaseDataSource () override
	Destructor. More...

Static Protected Member Functions inherited from mitk::ImageSource
static itk::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

Crops timesteps from 2D+t and 3D+t images.

This filter removes timesteps from the beginning and/or end of a 4D image. A new image is created containing only the timesteps within the specified range [LowerBoundaryTimestep, UpperBoundaryTimestep). The geometries and properties of the input image are transferred to the output image.

Precondition: The input image must have 4 dimensions and more than 1 timestep.

See also: SubImageSelector; ImageTimeSelector

Definition at line 36 of file mitkCropTimestepsImageFilter.h.

Member Function Documentation

◆ GetLowerBoundaryTimestep()

virtual unsigned int mitk::CropTimestepsImageFilter::GetLowerBoundaryTimestep ( ) const

virtual

Get the lower boundary timestep (inclusive).

Returns: The lower boundary timestep.

◆ GetUpperBoundaryTimestep()

virtual unsigned int mitk::CropTimestepsImageFilter::GetUpperBoundaryTimestep ( ) const

virtual

Get the upper boundary timestep (exclusive).

Returns: The upper boundary timestep.

◆ mitkClassMacro()

mitk::CropTimestepsImageFilter::mitkClassMacro	(	CropTimestepsImageFilter	,
		SubImageSelector
	)

◆ New()

static Pointer mitk::CropTimestepsImageFilter::New ( )

static

◆ SetInput() [1/2]

void mitk::CropTimestepsImageFilter::SetInput ( const InputImageType * image )

overridevirtual

Set the input image.

Parameters

[in] image The 4D image to crop.

Precondition: The image must have 4 dimensions.; The image must have more than 1 timestep.; The image must be valid (valid geometry and volume).

Reimplemented from mitk::ImageToImageFilter.

◆ SetInput() [2/2]

void mitk::CropTimestepsImageFilter::SetInput	(	unsigned int	index,
		const InputImageType *	image
	)

overridevirtual

Set the input image at the specified index (only index 0 is valid).

Parameters

[in]	index	Must be 0.
[in]	image	The 4D image to crop.

Exceptions

mitk::Exception if index is not 0.

Reimplemented from mitk::ImageToImageFilter.

◆ SetLowerBoundaryTimestep()

virtual void mitk::CropTimestepsImageFilter::SetLowerBoundaryTimestep ( unsigned int _arg )

virtual

Set the first timestep to retain (inclusive lower bound, default: 0).

Parameters

[in] _arg The lower boundary timestep (inclusive).

Exceptions

mitk::Exception if LowerBoundaryTimestep > UpperBoundaryTimestep.

◆ SetUpperBoundaryTimestep()

virtual void mitk::CropTimestepsImageFilter::SetUpperBoundaryTimestep ( unsigned int _arg )

virtual

Set the last timestep to retain (exclusive upper bound).

Defaults to the maximum timestep of the input. If set to a value larger than the input's maximum timestep, it is clamped.

Parameters

[in] _arg The upper boundary timestep (exclusive).

Exceptions

mitk::Exception if LowerBoundaryTimestep > UpperBoundaryTimestep.

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

mitkCropTimestepsImageFilter.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetLowerBoundaryTimestep()

◆ GetUpperBoundaryTimestep()

◆ mitkClassMacro()

◆ New()

◆ SetInput() [1/2]

◆ SetInput() [2/2]

◆ SetLowerBoundaryTimestep()

◆ SetUpperBoundaryTimestep()