MITK-IGT
IGT Extension of MITK
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
mitk::ToFImageRecorderFilter Class Reference

Filter that allows recording of processed ToF images Internally the ToFImageWriter is used for writing. More...

#include <mitkToFImageRecorderFilter.h>

Inheritance diagram for mitk::ToFImageRecorderFilter:

Public Member Functions

 mitkClassMacro (ToFImageRecorderFilter, ImageToImageFilter)
 
 itkFactorylessNewMacro (Self)
 
 itkCloneMacro (Self)
 
void SetFileName (std::string fileName)
 Set file name for writing image files This filename will be appended by "_DistanceImage", "_AmplitudeImage", or "_IntensityImage" for the single images.
 
void SetImageType (ToFImageWriter::ToFImageType tofImageType)
 Set image type for recording.
 
ToFImageWriter::Pointer GetToFImageWriter ()
 Returns a pointer to the ToFImageWriter internally used.
 
void SetToFImageWriter (ToFImageWriter::Pointer tofImageWriter)
 Sets a pointer to the ToFImageWriter internally used.
 
void StartRecording ()
 start recording of data
 
void StopRecording ()
 stop recording of data
 
void SetInput (const InputImageType *input) override
 sets the input of this filter
 
void SetInput (unsigned int idx, const InputImageType *input) override
 sets the input of this filter at idx
 
Image * GetInput ()
 returns the input of this filter
 
Image * GetInput (unsigned int idx)
 returns the input with id idx of this filter
 

Protected Member Functions

 ToFImageRecorderFilter ()
 standard constructor
 
 ~ToFImageRecorderFilter () override
 standard destructor
 
void GenerateData () override
 method generating the output of this filter. Called in the updated process of the pipeline. This method generates the output of the ToFSurfaceSource: The generated surface of the 3d points
 
void CreateOutputsForAllInputs ()
 Create an output for each input.
 

Protected Attributes

bool m_RecordingStarted
 flag indicating if filter is currently recording
 
ToFImageWriter::Pointer m_ToFImageWriter
 image writer used for streaming input data to file
 
std::string m_FileExtension
 

Detailed Description

Filter that allows recording of processed ToF images Internally the ToFImageWriter is used for writing.

Definition at line 28 of file mitkToFImageRecorderFilter.h.

Constructor & Destructor Documentation

◆ ToFImageRecorderFilter()

mitk::ToFImageRecorderFilter::ToFImageRecorderFilter ( )
protected

standard constructor

Definition at line 24 of file mitkToFImageRecorderFilter.cpp.

◆ ~ToFImageRecorderFilter()

mitk::ToFImageRecorderFilter::~ToFImageRecorderFilter ( )
overrideprotected

standard destructor

Definition at line 29 of file mitkToFImageRecorderFilter.cpp.

Member Function Documentation

◆ CreateOutputsForAllInputs()

void mitk::ToFImageRecorderFilter::CreateOutputsForAllInputs ( )
protected

Create an output for each input.

This Method sets the number of outputs to the number of inputs and creates missing outputs objects.

Warning
any additional outputs that exist before the method is called are deleted

Definition at line 154 of file mitkToFImageRecorderFilter.cpp.

◆ GenerateData()

void mitk::ToFImageRecorderFilter::GenerateData ( )
overrideprotected

method generating the output of this filter. Called in the updated process of the pipeline. This method generates the output of the ToFSurfaceSource: The generated surface of the 3d points

Definition at line 65 of file mitkToFImageRecorderFilter.cpp.

◆ GetInput() [1/2]

mitk::Image * mitk::ToFImageRecorderFilter::GetInput ( )

returns the input of this filter

Definition at line 142 of file mitkToFImageRecorderFilter.cpp.

◆ GetInput() [2/2]

mitk::Image * mitk::ToFImageRecorderFilter::GetInput ( unsigned int idx)

returns the input with id idx of this filter

Definition at line 147 of file mitkToFImageRecorderFilter.cpp.

◆ GetToFImageWriter()

mitk::ToFImageWriter::Pointer mitk::ToFImageRecorderFilter::GetToFImageWriter ( )

Returns a pointer to the ToFImageWriter internally used.

Returns
ToFImageWriter

Definition at line 109 of file mitkToFImageRecorderFilter.cpp.

◆ itkCloneMacro()

mitk::ToFImageRecorderFilter::itkCloneMacro ( Self )

◆ itkFactorylessNewMacro()

mitk::ToFImageRecorderFilter::itkFactorylessNewMacro ( Self )

◆ mitkClassMacro()

mitk::ToFImageRecorderFilter::mitkClassMacro ( ToFImageRecorderFilter ,
ImageToImageFilter  )

◆ SetFileName()

void mitk::ToFImageRecorderFilter::SetFileName ( std::string fileName)

Set file name for writing image files This filename will be appended by "_DistanceImage", "_AmplitudeImage", or "_IntensityImage" for the single images.

Parameters
fileNamebase file name to save image filtes

Definition at line 33 of file mitkToFImageRecorderFilter.cpp.

◆ SetImageType()

void mitk::ToFImageRecorderFilter::SetImageType ( ToFImageWriter::ToFImageType tofImageType)

Set image type for recording.

Parameters
tofImageTypeeither 3D Volume (ToFImageType3D) or temporal image stack (ToFImageType2DPlusT)

Definition at line 60 of file mitkToFImageRecorderFilter.cpp.

◆ SetInput() [1/2]

void mitk::ToFImageRecorderFilter::SetInput ( const InputImageType * input)
override

sets the input of this filter

Parameters
inputis the distance image of e.g. a ToF camera

Definition at line 119 of file mitkToFImageRecorderFilter.cpp.

◆ SetInput() [2/2]

void mitk::ToFImageRecorderFilter::SetInput ( unsigned int idx,
const InputImageType * input )
override

sets the input of this filter at idx

Parameters
idxnumber of the current input
inputis the distance image of e.g. a ToF camera

Definition at line 124 of file mitkToFImageRecorderFilter.cpp.

◆ SetToFImageWriter()

void mitk::ToFImageRecorderFilter::SetToFImageWriter ( ToFImageWriter::Pointer tofImageWriter)

Sets a pointer to the ToFImageWriter internally used.

Parameters
tofImageWriterToFImageWriter

Definition at line 114 of file mitkToFImageRecorderFilter.cpp.

◆ StartRecording()

void mitk::ToFImageRecorderFilter::StartRecording ( )

start recording of data

Definition at line 92 of file mitkToFImageRecorderFilter.cpp.

◆ StopRecording()

void mitk::ToFImageRecorderFilter::StopRecording ( )

stop recording of data

Definition at line 103 of file mitkToFImageRecorderFilter.cpp.

Member Data Documentation

◆ m_FileExtension

std::string mitk::ToFImageRecorderFilter::m_FileExtension
protected

Definition at line 112 of file mitkToFImageRecorderFilter.h.

◆ m_RecordingStarted

bool mitk::ToFImageRecorderFilter::m_RecordingStarted
protected

flag indicating if filter is currently recording

Definition at line 110 of file mitkToFImageRecorderFilter.h.

◆ m_ToFImageWriter

ToFImageWriter::Pointer mitk::ToFImageRecorderFilter::m_ToFImageWriter
protected

image writer used for streaming input data to file

Definition at line 111 of file mitkToFImageRecorderFilter.h.

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