Medical Imaging Interaction Toolkit  2022.04.99-b2814023
Medical Imaging Interaction Toolkit
mitk::ToFImageCsvWriter Class Reference

CSV writer class for ToF image data. More...

#include <mitkToFImageCsvWriter.h>

Inheritance diagram for mitk::ToFImageCsvWriter:
Collaboration diagram for mitk::ToFImageCsvWriter:

Public Member Functions

 ToFImageCsvWriter ()
 standard ctor More...
 
 ~ToFImageCsvWriter () override
 standard ~ctor More...
 
 mitkClassMacro (ToFImageCsvWriter, ToFImageWriter)
 
Pointer Clone () const
 
void Open () override
 Checks for file extensions and opens the output files. More...
 
void Close () override
 Closes the output files. More...
 
void Add (float *distanceFloatData, float *amplitudeFloatData, float *intensityFloatData, unsigned char *rgbData=nullptr) override
 Pushes the image data to the output files. More...
 
- Public Member Functions inherited from mitk::ToFImageWriter
 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...
 

Static Public Member Functions

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

Protected Attributes

Image::Pointer m_MitkImage
 mitk image used for pic header creation More...
 
FILE * m_DistanceOutfile
 file for distance image More...
 
FILE * m_AmplitudeOutfile
 file for amplitude image More...
 
FILE * m_IntensityOutfile
 file for intensity image More...
 
- Protected Attributes inherited from mitk::ToFImageWriter
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...
 

Additional Inherited Members

- Public Types inherited from mitk::ToFImageWriter
enum  ToFImageType { ToFImageType3D, ToFImageType2DPlusT }
 
- Protected Member Functions inherited from mitk::ToFImageWriter
void CheckForFileExtension (std::string &fileName)
 Checks file name if file extension exists. If not an error message is returned. More...
 

Detailed Description

CSV writer class for ToF image data.

This writer class allows streaming of ToF data into a CSV file. Writer can simultaneously save "distance", "intensity" and "amplitude" image data. Output files are written as 1D CSV data stream.

Definition at line 29 of file mitkToFImageCsvWriter.h.

Constructor & Destructor Documentation

◆ ToFImageCsvWriter()

mitk::ToFImageCsvWriter::ToFImageCsvWriter ( )

standard ctor

◆ ~ToFImageCsvWriter()

mitk::ToFImageCsvWriter::~ToFImageCsvWriter ( )
override

standard ~ctor

Member Function Documentation

◆ Add()

void mitk::ToFImageCsvWriter::Add ( float *  distanceFloatData,
float *  amplitudeFloatData,
float *  intensityFloatData,
unsigned char *  rgbData = nullptr 
)
overridevirtual

Pushes the image data to the output files.

Parameters
distanceFloatDatafrom distance image as float value
amplitudeFloatDatafrom amplitude image as float value
intensityFloatDatafrom intensity image as float value
rgbData

Reimplemented from mitk::ToFImageWriter.

◆ Clone()

Pointer mitk::ToFImageCsvWriter::Clone ( ) const

◆ Close()

void mitk::ToFImageCsvWriter::Close ( )
overridevirtual

Closes the output files.

Reimplemented from mitk::ToFImageWriter.

◆ mitkClassMacro()

mitk::ToFImageCsvWriter::mitkClassMacro ( ToFImageCsvWriter  ,
ToFImageWriter   
)

◆ New()

static Pointer mitk::ToFImageCsvWriter::New ( )
static

◆ Open()

void mitk::ToFImageCsvWriter::Open ( )
overridevirtual

Checks for file extensions and opens the output files.

Reimplemented from mitk::ToFImageWriter.

Member Data Documentation

◆ m_AmplitudeOutfile

FILE* mitk::ToFImageCsvWriter::m_AmplitudeOutfile
protected

file for amplitude image

Definition at line 67 of file mitkToFImageCsvWriter.h.

◆ m_DistanceOutfile

FILE* mitk::ToFImageCsvWriter::m_DistanceOutfile
protected

file for distance image

Definition at line 66 of file mitkToFImageCsvWriter.h.

◆ m_IntensityOutfile

FILE* mitk::ToFImageCsvWriter::m_IntensityOutfile
protected

file for intensity image

Definition at line 68 of file mitkToFImageCsvWriter.h.

◆ m_MitkImage

Image::Pointer mitk::ToFImageCsvWriter::m_MitkImage
protected

mitk image used for pic header creation

Definition at line 65 of file mitkToFImageCsvWriter.h.


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