Writer class for ToF nrrd images. More...

#include <mitkToFNrrdImageWriter.h>

Inheritance diagram for mitk::ToFNrrdImageWriter:

Public Member Functions
	mitkClassMacro (ToFNrrdImageWriter, ToFImageWriter)

	itkFactorylessNewMacro (Self)

	itkCloneMacro (Self)

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

void	Close () override
	Close file(s) add header and write.

void	Add (float distanceFloatData, float amplitudeFloatData, float intensityFloatData, unsigned char rgbData=nullptr) override
	Add new data to file.

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.

Protected Attributes
std::ofstream	m_DistanceOutfile
	file for distance image

std::ofstream	m_AmplitudeOutfile
	file for amplitude image

std::ofstream	m_IntensityOutfile
	file for intensity image

std::ofstream	m_RGBOutfile
	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

Writer class for ToF nrrd images.

This writer class allows streaming of ToF data into a nrrd file. This class uses the itkNrrdImageIO class 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 31 of file mitkToFNrrdImageWriter.h.

Member Function Documentation

◆ Add()

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

overridevirtual

Add new data to file.

Reimplemented from mitk::ToFImageWriter.

Definition at line 83 of file mitkToFNrrdImageWriter.cpp.

◆ Close()

void mitk::ToFNrrdImageWriter::Close ( )

overridevirtual

Close file(s) add header and write.

Reimplemented from mitk::ToFImageWriter.

Definition at line 63 of file mitkToFNrrdImageWriter.cpp.

◆ itkCloneMacro()

mitk::ToFNrrdImageWriter::itkCloneMacro ( Self )

◆ itkFactorylessNewMacro()

mitk::ToFNrrdImageWriter::itkFactorylessNewMacro ( Self )

◆ mitkClassMacro()

mitk::ToFNrrdImageWriter::mitkClassMacro	(	ToFNrrdImageWriter	,
		ToFImageWriter	)

◆ Open()

void mitk::ToFNrrdImageWriter::Open ( )

overridevirtual

Open file(s) for writing.

Reimplemented from mitk::ToFImageWriter.

Definition at line 31 of file mitkToFNrrdImageWriter.cpp.

Member Data Documentation

◆ m_AmplitudeOutfile

std::ofstream mitk::ToFNrrdImageWriter::m_AmplitudeOutfile

protected

file for amplitude image

Definition at line 54 of file mitkToFNrrdImageWriter.h.

◆ m_DistanceOutfile

std::ofstream mitk::ToFNrrdImageWriter::m_DistanceOutfile

protected

file for distance image

Definition at line 53 of file mitkToFNrrdImageWriter.h.

◆ m_IntensityOutfile

std::ofstream mitk::ToFNrrdImageWriter::m_IntensityOutfile

protected

file for intensity image

Definition at line 55 of file mitkToFNrrdImageWriter.h.

◆ m_RGBOutfile

std::ofstream mitk::ToFNrrdImageWriter::m_RGBOutfile

protected

file for intensity image

Definition at line 56 of file mitkToFNrrdImageWriter.h.

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

Modules/ToFHardware/mitkToFNrrdImageWriter.h
Modules/ToFHardware/mitkToFNrrdImageWriter.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Add()

◆ Close()

◆ itkCloneMacro()

◆ itkFactorylessNewMacro()

◆ mitkClassMacro()

◆ Open()

Member Data Documentation

◆ m_AmplitudeOutfile

◆ m_DistanceOutfile

◆ m_IntensityOutfile

◆ m_RGBOutfile