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

#include <mitkToFImageCsvWriter.h>

Inheritance diagram for mitk::ToFImageCsvWriter:

Public Member Functions
	ToFImageCsvWriter ()
	standard ctor

	~ToFImageCsvWriter () override
	standard ~ctor

	mitkClassMacro (ToFImageCsvWriter, ToFImageWriter)

	itkFactorylessNewMacro (Self)

	itkCloneMacro (Self) void Open() override
	Checks for file extensions and opens the output files.

void	Close () override
	Closes the output files.

void	Add (float distanceFloatData, float amplitudeFloatData, float intensityFloatData, unsigned char rgbData=nullptr) override
	Pushes the image data to the output files.

Public Member Functions inherited from mitk::ToFImageWriter
	ToFImageWriter ()

	~ToFImageWriter () override

	mitkClassMacroItkParent (ToFImageWriter, itk::Object)

	itkFactorylessNewMacro (Self)

	itkCloneMacro (Self)

	itkGetMacro (DistanceImageFileName, std::string)

	itkGetMacro (AmplitudeImageFileName, std::string)

	itkGetMacro (IntensityImageFileName, std::string)

	itkGetMacro (RGBImageFileName, std::string)

	itkGetMacro (Extension, std::string)

	itkGetMacro (ToFCaptureWidth, int)

	itkGetMacro (ToFCaptureHeight, int)

	itkGetMacro (RGBCaptureWidth, int)

	itkGetMacro (RGBCaptureHeight, int)

	itkGetMacro (DistanceImageSelected, bool)

	itkGetMacro (AmplitudeImageSelected, bool)

	itkGetMacro (IntensityImageSelected, bool)

	itkGetMacro (RGBImageSelected, bool)

	itkSetMacro (DistanceImageFileName, std::string)

	itkSetMacro (AmplitudeImageFileName, std::string)

	itkSetMacro (IntensityImageFileName, std::string)

	itkSetMacro (RGBImageFileName, std::string)

	itkSetMacro (Extension, std::string)

	itkSetMacro (ToFCaptureWidth, int)

	itkSetMacro (ToFCaptureHeight, int)

	itkSetMacro (RGBCaptureWidth, int)

	itkSetMacro (RGBCaptureHeight, int)

	itkSetMacro (DistanceImageSelected, bool)

	itkSetMacro (AmplitudeImageSelected, bool)

	itkSetMacro (IntensityImageSelected, bool)

	itkSetMacro (RGBImageSelected, bool)

ToFImageWriter::ToFImageType	GetToFImageType ()
	Get the type of image to be written.

void	SetToFImageType (ToFImageWriter::ToFImageType toFImageType)
	Set the type of image to be written.

virtual void	Open ()
	Open file(s) for writing.

Protected Attributes
Image::Pointer	m_MitkImage
	mitk image used for pic header creation

FILE *	m_DistanceOutfile
	file for distance image

FILE *	m_AmplitudeOutfile
	file for amplitude image

FILE *	m_IntensityOutfile
	file for intensity image

Protected Attributes inherited from mitk::ToFImageWriter
std::string	m_Extension
	file extension used for saving images

std::string	m_DistanceImageFileName
	file name for saving the distance image

std::string	m_AmplitudeImageFileName
	file name for saving the amplitude image

std::string	m_IntensityImageFileName
	file name for saving the intensity image

std::string	m_RGBImageFileName
	file name for saving the RGB image

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

bool	m_DistanceImageSelected
	flag indicating if distance image should be recorded

bool	m_AmplitudeImageSelected
	flag indicating if amplitude image should be recorded

bool	m_IntensityImageSelected
	flag indicating if intensity image should be recorded

bool	m_RGBImageSelected
	flag indicating if RGB image should be recorded

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

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

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

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

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

int	m_ToFImageSizeInBytes
	size of the image to save in bytes

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

int	m_RGBImageSizeInBytes
	size of the image to save in bytes

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

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.

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

Definition at line 16 of file mitkToFImageCsvWriter.cpp.

◆ ~ToFImageCsvWriter()

mitk::ToFImageCsvWriter::~ToFImageCsvWriter ( )

override

standard ~ctor

Definition at line 22 of file mitkToFImageCsvWriter.cpp.

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

distanceFloatData	from distance image as float value
amplitudeFloatData	from amplitude image as float value
intensityFloatData	from intensity image as float value
rgbData

Reimplemented from mitk::ToFImageWriter.

Definition at line 66 of file mitkToFImageCsvWriter.cpp.

◆ Close()

void mitk::ToFImageCsvWriter::Close ( )

overridevirtual

Closes the output files.

Reimplemented from mitk::ToFImageWriter.

Definition at line 50 of file mitkToFImageCsvWriter.cpp.

◆ itkCloneMacro()

mitk::ToFImageCsvWriter::itkCloneMacro ( Self )

override

Checks for file extensions and opens the output files.

◆ itkFactorylessNewMacro()

mitk::ToFImageCsvWriter::itkFactorylessNewMacro ( Self )

◆ mitkClassMacro()

mitk::ToFImageCsvWriter::mitkClassMacro	(	ToFImageCsvWriter	,
		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 files:

Modules/ToFHardware/mitkToFImageCsvWriter.h
Modules/ToFHardware/mitkToFImageCsvWriter.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ToFImageCsvWriter()

◆ ~ToFImageCsvWriter()

Member Function Documentation

◆ Add()

◆ Close()

◆ itkCloneMacro()

◆ itkFactorylessNewMacro()

◆ mitkClassMacro()

Member Data Documentation

◆ m_AmplitudeOutfile

◆ m_DistanceOutfile

◆ m_IntensityOutfile

◆ m_MitkImage