Medical Imaging Interaction Toolkit  2022.04.99-01b95b17
Medical Imaging Interaction Toolkit
mitk::ToFImageWriter Class Reference

Writer class for ToF images. More...

#include <mitkToFImageWriter.h>

Inheritance diagram for mitk::ToFImageWriter:
Collaboration diagram for mitk::ToFImageWriter:

Public Types

enum  ToFImageType { ToFImageType3D, ToFImageType2DPlusT }
 

Public Member Functions

 ToFImageWriter ()
 
 ~ToFImageWriter () override
 
 mitkClassMacroItkParent (ToFImageWriter, itk::Object)
 
Pointer Clone () const
 
virtual std::string GetDistanceImageFileName ()
 
virtual std::string GetAmplitudeImageFileName ()
 
virtual std::string GetIntensityImageFileName ()
 
virtual std::string GetRGBImageFileName ()
 
virtual std::string GetExtension ()
 
virtual int GetToFCaptureWidth ()
 
virtual int GetToFCaptureHeight ()
 
virtual int GetRGBCaptureWidth ()
 
virtual int GetRGBCaptureHeight ()
 
virtual bool GetDistanceImageSelected ()
 
virtual bool GetAmplitudeImageSelected ()
 
virtual bool GetIntensityImageSelected ()
 
virtual bool GetRGBImageSelected ()
 
virtual void SetDistanceImageFileName (std::string _arg)
 
virtual void SetAmplitudeImageFileName (std::string _arg)
 
virtual void SetIntensityImageFileName (std::string _arg)
 
virtual void SetRGBImageFileName (std::string _arg)
 
virtual void SetExtension (std::string _arg)
 
virtual void SetToFCaptureWidth (int _arg)
 
virtual void SetToFCaptureHeight (int _arg)
 
virtual void SetRGBCaptureWidth (int _arg)
 
virtual void SetRGBCaptureHeight (int _arg)
 
virtual void SetDistanceImageSelected (bool _arg)
 
virtual void SetAmplitudeImageSelected (bool _arg)
 
virtual void SetIntensityImageSelected (bool _arg)
 
virtual void SetRGBImageSelected (bool _arg)
 
ToFImageWriter::ToFImageType GetToFImageType ()
 Get the type of image to be written. More...
 
void SetToFImageType (ToFImageWriter::ToFImageType toFImageType)
 Set the type of image to be written. More...
 
virtual void Open ()
 Open file(s) for writing. More...
 
virtual void Close ()
 Close file(s) add header and write. More...
 
virtual void Add (float *, float *, float *, unsigned char *=nullptr)
 Add new data to file. More...
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

void CheckForFileExtension (std::string &fileName)
 Checks file name if file extension exists. If not an error message is returned. More...
 

Protected Attributes

std::string m_Extension
 file extension used for saving images More...
 
std::string m_DistanceImageFileName
 file name for saving the distance image More...
 
std::string m_AmplitudeImageFileName
 file name for saving the amplitude image More...
 
std::string m_IntensityImageFileName
 file name for saving the intensity image More...
 
std::string m_RGBImageFileName
 file name for saving the RGB image More...
 
int m_NumOfFrames
 number of frames written to the image. Used for pic header. More...
 
bool m_DistanceImageSelected
 flag indicating if distance image should be recorded More...
 
bool m_AmplitudeImageSelected
 flag indicating if amplitude image should be recorded More...
 
bool m_IntensityImageSelected
 flag indicating if intensity image should be recorded More...
 
bool m_RGBImageSelected
 flag indicating if RGB image should be recorded More...
 
int m_ToFCaptureWidth
 width (x-dimension) of the images to record. More...
 
int m_ToFCaptureHeight
 height (y-dimension) of the images to record. More...
 
int m_RGBCaptureWidth
 width (x-dimension) of the images to record. More...
 
int m_RGBCaptureHeight
 height (y-dimension) of the images to record. More...
 
int m_ToFPixelNumber
 number of pixels (widht*height) of the images to record More...
 
int m_ToFImageSizeInBytes
 size of the image to save in bytes More...
 
int m_RGBPixelNumber
 number of pixels (widht*height) of the images to record More...
 
int m_RGBImageSizeInBytes
 size of the image to save in bytes More...
 
ToFImageWriter::ToFImageType m_ToFImageType
 type of image to be recorded: ToFImageType3D (0) or ToFImageType2DPlusT (1) More...
 

Detailed Description

Writer class for ToF images.

This writer class allows streaming of ToF data into a file. Image information is included in the header of the nrrd file. Writer can simultaneously save "distance", "intensity" and "amplitude" image. Images can be written as 3D volume (ToFImageType::ToFImageType3D) or temporal image stack (ToFImageType::ToFImageType2DPlusT)

Definition at line 34 of file mitkToFImageWriter.h.

Member Enumeration Documentation

◆ ToFImageType

Enumerator
ToFImageType3D 
ToFImageType2DPlusT 

Definition at line 76 of file mitkToFImageWriter.h.

Constructor & Destructor Documentation

◆ ToFImageWriter()

mitk::ToFImageWriter::ToFImageWriter ( )

◆ ~ToFImageWriter()

mitk::ToFImageWriter::~ToFImageWriter ( )
override

Member Function Documentation

◆ Add()

virtual void mitk::ToFImageWriter::Add ( float *  ,
float *  ,
float *  ,
unsigned char *  = nullptr 
)
inlinevirtual

Add new data to file.

Reimplemented in mitk::ToFImageCsvWriter, and mitk::ToFNrrdImageWriter.

Definition at line 98 of file mitkToFImageWriter.h.

◆ CheckForFileExtension()

void mitk::ToFImageWriter::CheckForFileExtension ( std::string &  fileName)
protected

Checks file name if file extension exists. If not an error message is returned.

◆ Clone()

Pointer mitk::ToFImageWriter::Clone ( ) const

◆ Close()

virtual void mitk::ToFImageWriter::Close ( )
inlinevirtual

Close file(s) add header and write.

Reimplemented in mitk::ToFImageCsvWriter, and mitk::ToFNrrdImageWriter.

Definition at line 94 of file mitkToFImageWriter.h.

◆ GetAmplitudeImageFileName()

virtual std::string mitk::ToFImageWriter::GetAmplitudeImageFileName ( )
virtual

◆ GetAmplitudeImageSelected()

virtual bool mitk::ToFImageWriter::GetAmplitudeImageSelected ( )
virtual

◆ GetDistanceImageFileName()

virtual std::string mitk::ToFImageWriter::GetDistanceImageFileName ( )
virtual

◆ GetDistanceImageSelected()

virtual bool mitk::ToFImageWriter::GetDistanceImageSelected ( )
virtual

◆ GetExtension()

virtual std::string mitk::ToFImageWriter::GetExtension ( )
virtual

◆ GetIntensityImageFileName()

virtual std::string mitk::ToFImageWriter::GetIntensityImageFileName ( )
virtual

◆ GetIntensityImageSelected()

virtual bool mitk::ToFImageWriter::GetIntensityImageSelected ( )
virtual

◆ GetRGBCaptureHeight()

virtual int mitk::ToFImageWriter::GetRGBCaptureHeight ( )
virtual

◆ GetRGBCaptureWidth()

virtual int mitk::ToFImageWriter::GetRGBCaptureWidth ( )
virtual

◆ GetRGBImageFileName()

virtual std::string mitk::ToFImageWriter::GetRGBImageFileName ( )
virtual

◆ GetRGBImageSelected()

virtual bool mitk::ToFImageWriter::GetRGBImageSelected ( )
virtual

◆ GetToFCaptureHeight()

virtual int mitk::ToFImageWriter::GetToFCaptureHeight ( )
virtual

◆ GetToFCaptureWidth()

virtual int mitk::ToFImageWriter::GetToFCaptureWidth ( )
virtual

◆ GetToFImageType()

ToFImageWriter::ToFImageType mitk::ToFImageWriter::GetToFImageType ( )

Get the type of image to be written.

Returns
ToF image type: ToFImageType3D (0) or ToFImageType2DPlusT (1)

◆ mitkClassMacroItkParent()

mitk::ToFImageWriter::mitkClassMacroItkParent ( ToFImageWriter  ,
itk::Object   
)

◆ New()

static Pointer mitk::ToFImageWriter::New ( )
static

◆ Open()

virtual void mitk::ToFImageWriter::Open ( )
inlinevirtual

Open file(s) for writing.

Reimplemented in mitk::ToFImageCsvWriter, and mitk::ToFNrrdImageWriter.

Definition at line 90 of file mitkToFImageWriter.h.

◆ SetAmplitudeImageFileName()

virtual void mitk::ToFImageWriter::SetAmplitudeImageFileName ( std::string  _arg)
virtual

◆ SetAmplitudeImageSelected()

virtual void mitk::ToFImageWriter::SetAmplitudeImageSelected ( bool  _arg)
virtual

◆ SetDistanceImageFileName()

virtual void mitk::ToFImageWriter::SetDistanceImageFileName ( std::string  _arg)
virtual

◆ SetDistanceImageSelected()

virtual void mitk::ToFImageWriter::SetDistanceImageSelected ( bool  _arg)
virtual

◆ SetExtension()

virtual void mitk::ToFImageWriter::SetExtension ( std::string  _arg)
virtual

◆ SetIntensityImageFileName()

virtual void mitk::ToFImageWriter::SetIntensityImageFileName ( std::string  _arg)
virtual

◆ SetIntensityImageSelected()

virtual void mitk::ToFImageWriter::SetIntensityImageSelected ( bool  _arg)
virtual

◆ SetRGBCaptureHeight()

virtual void mitk::ToFImageWriter::SetRGBCaptureHeight ( int  _arg)
virtual

◆ SetRGBCaptureWidth()

virtual void mitk::ToFImageWriter::SetRGBCaptureWidth ( int  _arg)
virtual

◆ SetRGBImageFileName()

virtual void mitk::ToFImageWriter::SetRGBImageFileName ( std::string  _arg)
virtual

◆ SetRGBImageSelected()

virtual void mitk::ToFImageWriter::SetRGBImageSelected ( bool  _arg)
virtual

◆ SetToFCaptureHeight()

virtual void mitk::ToFImageWriter::SetToFCaptureHeight ( int  _arg)
virtual

◆ SetToFCaptureWidth()

virtual void mitk::ToFImageWriter::SetToFCaptureWidth ( int  _arg)
virtual

◆ SetToFImageType()

void mitk::ToFImageWriter::SetToFImageType ( ToFImageWriter::ToFImageType  toFImageType)

Set the type of image to be written.

Parameters
toFImageTypetype of the ToF image: ToFImageType3D (0) or ToFImageType2DPlusT (1)

Member Data Documentation

◆ m_AmplitudeImageFileName

std::string mitk::ToFImageWriter::m_AmplitudeImageFileName
protected

file name for saving the amplitude image

Definition at line 110 of file mitkToFImageWriter.h.

◆ m_AmplitudeImageSelected

bool mitk::ToFImageWriter::m_AmplitudeImageSelected
protected

flag indicating if amplitude image should be recorded

Definition at line 116 of file mitkToFImageWriter.h.

◆ m_DistanceImageFileName

std::string mitk::ToFImageWriter::m_DistanceImageFileName
protected

file name for saving the distance image

Definition at line 109 of file mitkToFImageWriter.h.

◆ m_DistanceImageSelected

bool mitk::ToFImageWriter::m_DistanceImageSelected
protected

flag indicating if distance image should be recorded

Definition at line 115 of file mitkToFImageWriter.h.

◆ m_Extension

std::string mitk::ToFImageWriter::m_Extension
protected

file extension used for saving images

Definition at line 108 of file mitkToFImageWriter.h.

◆ m_IntensityImageFileName

std::string mitk::ToFImageWriter::m_IntensityImageFileName
protected

file name for saving the intensity image

Definition at line 111 of file mitkToFImageWriter.h.

◆ m_IntensityImageSelected

bool mitk::ToFImageWriter::m_IntensityImageSelected
protected

flag indicating if intensity image should be recorded

Definition at line 117 of file mitkToFImageWriter.h.

◆ m_NumOfFrames

int mitk::ToFImageWriter::m_NumOfFrames
protected

number of frames written to the image. Used for pic header.

Definition at line 114 of file mitkToFImageWriter.h.

◆ m_RGBCaptureHeight

int mitk::ToFImageWriter::m_RGBCaptureHeight
protected

height (y-dimension) of the images to record.

Definition at line 122 of file mitkToFImageWriter.h.

◆ m_RGBCaptureWidth

int mitk::ToFImageWriter::m_RGBCaptureWidth
protected

width (x-dimension) of the images to record.

Definition at line 121 of file mitkToFImageWriter.h.

◆ m_RGBImageFileName

std::string mitk::ToFImageWriter::m_RGBImageFileName
protected

file name for saving the RGB image

Definition at line 112 of file mitkToFImageWriter.h.

◆ m_RGBImageSelected

bool mitk::ToFImageWriter::m_RGBImageSelected
protected

flag indicating if RGB image should be recorded

Definition at line 118 of file mitkToFImageWriter.h.

◆ m_RGBImageSizeInBytes

int mitk::ToFImageWriter::m_RGBImageSizeInBytes
protected

size of the image to save in bytes

Definition at line 126 of file mitkToFImageWriter.h.

◆ m_RGBPixelNumber

int mitk::ToFImageWriter::m_RGBPixelNumber
protected

number of pixels (widht*height) of the images to record

Definition at line 125 of file mitkToFImageWriter.h.

◆ m_ToFCaptureHeight

int mitk::ToFImageWriter::m_ToFCaptureHeight
protected

height (y-dimension) of the images to record.

Definition at line 120 of file mitkToFImageWriter.h.

◆ m_ToFCaptureWidth

int mitk::ToFImageWriter::m_ToFCaptureWidth
protected

width (x-dimension) of the images to record.

Definition at line 119 of file mitkToFImageWriter.h.

◆ m_ToFImageSizeInBytes

int mitk::ToFImageWriter::m_ToFImageSizeInBytes
protected

size of the image to save in bytes

Definition at line 124 of file mitkToFImageWriter.h.

◆ m_ToFImageType

ToFImageWriter::ToFImageType mitk::ToFImageWriter::m_ToFImageType
protected

type of image to be recorded: ToFImageType3D (0) or ToFImageType2DPlusT (1)

Definition at line 127 of file mitkToFImageWriter.h.

◆ m_ToFPixelNumber

int mitk::ToFImageWriter::m_ToFPixelNumber
protected

number of pixels (widht*height) of the images to record

Definition at line 123 of file mitkToFImageWriter.h.


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