Medical Imaging Interaction Toolkit  2023.12.99-63768887
Medical Imaging Interaction Toolkit
mitk::CropTimestepsImageFilter Class Reference

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

#include <mitkCropTimestepsImageFilter.h>

Inheritance diagram for mitk::CropTimestepsImageFilter:
Collaboration diagram for mitk::CropTimestepsImageFilter:

Public Member Functions

 mitkClassMacro (CropTimestepsImageFilter, SubImageSelector)
 
void SetInput (const InputImageType *image) override
 Sets the input image. More...
 
void SetInput (unsigned int index, const InputImageType *image) override
 
virtual void SetUpperBoundaryTimestep (unsigned int _arg)
 The last timestep to retain. More...
 
virtual unsigned int GetUpperBoundaryTimestep () const
 
virtual void SetLowerBoundaryTimestep (unsigned int _arg)
 The first timestep to retain. More...
 
virtual unsigned int GetLowerBoundaryTimestep () const
 
- Public Member Functions inherited from mitk::SubImageSelector
virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
Pointer Clone () const
 
virtual void SetPosNr (int p)
 
 SubImageSelector ()
 
 ~SubImageSelector () override
 
- Public Member Functions inherited from mitk::ImageToImageFilter
Pointer Clone () const
 
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::SubImageSelector
static const char * GetStaticNameOfClass ()
 
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 ()
 

Additional Inherited Members

- Public Types inherited from mitk::SubImageSelector
typedef SubImageSelector Self
 
typedef ImageToImageFilter Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- 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
 
- Protected Member Functions inherited from mitk::SubImageSelector
mitk::Image::ImageDataItemPointer GetSliceData (int s=0, int t=0, int n=0)
 
mitk::Image::ImageDataItemPointer GetVolumeData (int t=0, int n=0)
 
mitk::Image::ImageDataItemPointer GetChannelData (int n=0)
 
void SetSliceItem (mitk::Image::ImageDataItemPointer dataItem, int s=0, int t=0, int n=0)
 
void SetVolumeItem (mitk::Image::ImageDataItemPointer dataItem, int t=0, int n=0)
 
void SetChannelItem (mitk::Image::ImageDataItemPointer dataItem, int n=0)
 
- 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
 
- 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 at 2D+t and 3D+t images.

The filter is able to crop timesteps in front and/or at the end. Internally, a new image is created with the remaining volumes. The geometries and properties of the input image are transferred to the output image.

Definition at line 27 of file mitkCropTimestepsImageFilter.h.

Member Function Documentation

◆ GetLowerBoundaryTimestep()

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

◆ GetUpperBoundaryTimestep()

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

◆ mitkClassMacro()

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

◆ New()

static Pointer mitk::CropTimestepsImageFilter::New ( )
static

◆ SetInput() [1/2]

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

Sets the input image.

Precondition
the image has 4 Dimensions
the image has >1 timestep
the image is valid (valid geometry and volume)

Reimplemented from mitk::ImageToImageFilter.

◆ SetInput() [2/2]

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

Reimplemented from mitk::ImageToImageFilter.

◆ SetLowerBoundaryTimestep()

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

The first timestep to retain.

Set to 0 as default

Exceptions
if(LowerBoundaryTimestep > UpperBoundaryTimestep)

◆ SetUpperBoundaryTimestep()

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

The last timestep to retain.

Set to the maximum timestep of the input as default

Note
if the last timestep is larger than the maximum timestep of the input, it is corrected to the maximum timestep.
Exceptions
if(LowerBoundaryTimestep > UpperBoundaryTimestep)

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