Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
mitk::TemporalJoinImagesFilter Class Reference

Filter that fuses n input images into a single image with n time points. More...

#include <mitkTemporalJoinImagesFilter.h>

Inheritance diagram for mitk::TemporalJoinImagesFilter:
Collaboration diagram for mitk::TemporalJoinImagesFilter:

Public Types

typedef std::vector< mitk::TimePointType > TimeBoundsVectorType
 
- 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...
 

Public Member Functions

 mitkClassMacro (TemporalJoinImagesFilter, ImageToImageFilter)
 
virtual mitk::TimePointType GetFirstMinTimeBound () const
 
virtual void SetFirstMinTimeBound (mitk::TimePointType _arg)
 Set custom minimum time bound for the first time step. More...
 
virtual TimeBoundsVectorType GetMaxTimeBounds () const
 
void SetMaxTimeBounds (const TimeBoundsVectorType &bounds)
 Set custom maximum time bounds for all time steps. More...
 
- Public Member Functions inherited from mitk::ImageToImageFilter
 mitkClassMacro (ImageToImageFilter, ImageSource)
 
Pointer Clone () const
 
virtual void SetInput (const InputImageType *image)
 Set the image input of this process object. More...
 
virtual void SetInput (unsigned int idx, const InputImageType *image)
 Set the image input at the specified index. More...
 
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::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...
 

Protected Member Functions

 TemporalJoinImagesFilter ()
 
 ~TemporalJoinImagesFilter () override
 
void GenerateInputRequestedRegion () override
 Request the largest possible region from all inputs. More...
 
void GenerateOutputInformation () override
 Compute output information including time geometry and merged properties. More...
 
void GenerateData () override
 Copy the volume data from each input into the corresponding time step of the output. 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...
 

Additional Inherited Members

- 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

Filter that fuses n input images into a single image with n time points.

This filter takes n mitk::Image instances as inputs and fuses them into a new output image containing n time steps. The sequence of frames in the output image matches the sequence of inputs.

Precondition
All input images must have the same pixel type.
All input images must have the same geometry.
Postcondition
If no time bounds are defined, the dynamic image starts at 0 ms and each time step has a duration of 1 ms.

Definition at line 38 of file mitkTemporalJoinImagesFilter.h.

Member Typedef Documentation

◆ TimeBoundsVectorType

Constructor & Destructor Documentation

◆ TemporalJoinImagesFilter()

mitk::TemporalJoinImagesFilter::TemporalJoinImagesFilter ( )
inlineprotected

Definition at line 62 of file mitkTemporalJoinImagesFilter.h.

◆ ~TemporalJoinImagesFilter()

mitk::TemporalJoinImagesFilter::~TemporalJoinImagesFilter ( )
inlineoverrideprotected

Definition at line 63 of file mitkTemporalJoinImagesFilter.h.

Member Function Documentation

◆ GenerateData()

void mitk::TemporalJoinImagesFilter::GenerateData ( )
overrideprotected

Copy the volume data from each input into the corresponding time step of the output.

◆ GenerateInputRequestedRegion()

void mitk::TemporalJoinImagesFilter::GenerateInputRequestedRegion ( )
overrideprotected

Request the largest possible region from all inputs.

◆ GenerateOutputInformation()

void mitk::TemporalJoinImagesFilter::GenerateOutputInformation ( )
overrideprotected

Compute output information including time geometry and merged properties.

◆ GetFirstMinTimeBound()

virtual mitk::TimePointType mitk::TemporalJoinImagesFilter::GetFirstMinTimeBound ( ) const
virtual

◆ GetMaxTimeBounds()

virtual TimeBoundsVectorType mitk::TemporalJoinImagesFilter::GetMaxTimeBounds ( ) const
virtual

◆ mitkClassMacro()

mitk::TemporalJoinImagesFilter::mitkClassMacro ( TemporalJoinImagesFilter  ,
ImageToImageFilter   
)

◆ New()

static Pointer mitk::TemporalJoinImagesFilter::New ( )
static

◆ SetFirstMinTimeBound()

virtual void mitk::TemporalJoinImagesFilter::SetFirstMinTimeBound ( mitk::TimePointType  _arg)
virtual

Set custom minimum time bound for the first time step.

◆ SetMaxTimeBounds()

void mitk::TemporalJoinImagesFilter::SetMaxTimeBounds ( const TimeBoundsVectorType &  bounds)

Set custom maximum time bounds for all time steps.

The size of bounds must match the number of filter inputs.

Parameters
[in]boundsVector of maximum time bounds, one per time step.
Exceptions
mitk::Exceptionif the size of bounds does not match the number of inputs.

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