usMHDSequenceWriter Class Reference

#include <visp3/ustk_core/usMHDSequenceWriter.h>

Public Member Functions
	usMHDSequenceWriter ()
	~usMHDSequenceWriter ()
void	setSequenceDirectory (const std::string sequenceDirectory)
void	write (const usImageRF2D< short int > &image, const uint64_t timestamp)
void	write (const usImagePreScan2D< unsigned char > &image, const uint64_t timestamp)
void	write (const usImagePostScan2D< unsigned char > &image, const uint64_t timestamp)
void	write (const usImageRF3D< short int > &image, const std::vector< uint64_t > timestamp)
void	write (const usImagePreScan3D< unsigned char > &image, const std::vector< uint64_t > timestamp)
void	write (const usImagePostScan3D< unsigned char > &image, const uint64_t timestamp)

Detailed Description

Writer for a sequence of images stored as mhd/raw files in a directory Image filenames are set based on the following format: "image%05d.mhd" and "image%05d.raw". An internal counter is incremented every time write() is called, to update the filename of the new image in the sequence.

Examples

tutorial-MHD-sequence-reader.cpp, and tutorial-ustk-virtual-server-RF3D.cpp.

Definition at line 56 of file usMHDSequenceWriter.h.

Constructor & Destructor Documentation

usMHDSequenceWriter()

usMHDSequenceWriter::usMHDSequenceWriter

(

)

Constructor, initializes the member attribues.

Definition at line 6 of file usMHDSequenceWriter.cpp.

~usMHDSequenceWriter()

usMHDSequenceWriter::~usMHDSequenceWriter

(

)

Destructor.

Definition at line 12 of file usMHDSequenceWriter.cpp.

Member Function Documentation

setSequenceDirectory()

void usMHDSequenceWriter::setSequenceDirectory

(

const std::string

sequenceDirectory

)

Setter for the directory where to write the mhd sequence. To call before calling write !

Parameters

sequenceDirectory

The directory path.

Examples

tutorial-MHD-sequence-reader.cpp, and tutorial-ustk-virtual-server-RF3D.cpp.

Definition at line 18 of file usMHDSequenceWriter.cpp.

References us::NOT_SET.

Referenced by usNetworkGrabberPostScan2D::activateRecording(), usNetworkGrabberPreScan2D::activateRecording(), usNetworkGrabberPreScan3D::activateRecording(), usNetworkGrabberRF2D::activateRecording(), and usNetworkGrabberRF3D::activateRecording().

write() [1/6]

void usMHDSequenceWriter::write	(	const usImagePostScan2D< unsigned char > &	image,
		const uint64_t	timestamp
	)

Writing method for usImagePostScan2D images in a sequence.

Parameters

image	The usImagePostScan2D image to write.
timestamp	The timestamp of the image.

Definition at line 147 of file usMHDSequenceWriter.cpp.

References usImagePostScan2D< Type >::getHeightResolution(), usTransducerSettings::getSamplingFrequency(), usTransducerSettings::getScanLineNumber(), usTransducerSettings::getScanLinePitch(), usTransducerSettings::getTransducerRadius(), usTransducerSettings::getTransmitFrequency(), usImagePostScan2D< Type >::getWidthResolution(), usTransducerSettings::isTransducerConvex(), us::NOT_SET, and us::POSTSCAN_2D.

write() [2/6]

void usMHDSequenceWriter::write	(	const usImagePostScan3D< unsigned char > &	image,
		const uint64_t	timestamp
	)

Writing method for usImagePostScan3D images in a sequence.

Parameters

image	The usImagePostScan3D image to write.
timestamp	The timestamp of the volume.

Definition at line 330 of file usMHDSequenceWriter.cpp.

References usMotorSettings::getFrameNumber(), usMotorSettings::getFramePitch(), usImage3D< Type >::getHeight(), usMotorSettings::getMotorRadius(), usMotorSettings::getMotorType(), usImage3D< Type >::getNumberOfFrames(), usTransducerSettings::getSamplingFrequency(), usTransducerSettings::getScanLineNumber(), usTransducerSettings::getScanLinePitch(), usTransducerSettings::getTransducerRadius(), usTransducerSettings::getTransmitFrequency(), usImage3D< Type >::getWidth(), usTransducerSettings::isTransducerConvex(), us::NOT_SET, and us::POSTSCAN_3D.

write() [3/6]

void usMHDSequenceWriter::write	(	const usImagePreScan2D< unsigned char > &	image,
		const uint64_t	timestamp
	)

Writing method for usImagePreScan2D images in a sequence.

Parameters

image	The usImagePreScan2D image to write.
timestamp	The timestamp of the image.

Definition at line 90 of file usMHDSequenceWriter.cpp.

References usImagePreScanSettings::getAxialResolution(), usTransducerSettings::getSamplingFrequency(), usTransducerSettings::getScanLineNumber(), usTransducerSettings::getScanLinePitch(), usTransducerSettings::getTransducerRadius(), usTransducerSettings::getTransmitFrequency(), usTransducerSettings::isTransducerConvex(), us::NOT_SET, and us::PRESCAN_2D.

write() [4/6]

void usMHDSequenceWriter::write	(	const usImagePreScan3D< unsigned char > &	image,
		const std::vector< uint64_t >	timestamp
	)

Writing method for usImagePreScan3D images in a sequence.

Parameters

image	The usImagePreScan3D image to write.
timestamp	The timestamps of every frame of the volume (inverted in case of odd volume in sequence !).

Definition at line 267 of file usMHDSequenceWriter.cpp.

References usImagePreScanSettings::getAxialResolution(), usMotorSettings::getFrameNumber(), usMotorSettings::getFramePitch(), usImage3D< Type >::getHeight(), usMotorSettings::getMotorRadius(), usMotorSettings::getMotorType(), usImage3D< Type >::getNumberOfFrames(), usTransducerSettings::getSamplingFrequency(), usTransducerSettings::getScanLineNumber(), usTransducerSettings::getScanLinePitch(), usTransducerSettings::getTransducerRadius(), usTransducerSettings::getTransmitFrequency(), usImage3D< Type >::getWidth(), usTransducerSettings::isTransducerConvex(), us::NOT_SET, and us::PRESCAN_3D.

write() [5/6]

void usMHDSequenceWriter::write	(	const usImageRF2D< short int > &	image,
		const uint64_t	timestamp
	)

Writing method for usImageRF2D images in a sequence.

Parameters

image	The usImageRF2D image to write.
timestamp	The timestamp of the image.

Examples

tutorial-MHD-sequence-reader.cpp, and tutorial-ustk-virtual-server-RF3D.cpp.

Definition at line 34 of file usMHDSequenceWriter.cpp.

References usImagePreScanSettings::getAxialResolution(), usImageRF2D< Type >::getHeight(), usTransducerSettings::getSamplingFrequency(), usTransducerSettings::getScanLineNumber(), usTransducerSettings::getScanLinePitch(), usTransducerSettings::getTransducerRadius(), usTransducerSettings::getTransmitFrequency(), usImageRF2D< Type >::getWidth(), usTransducerSettings::isTransducerConvex(), us::NOT_SET, and us::RF_2D.

Referenced by usNetworkGrabberPostScan2D::dataArrived(), usNetworkGrabberRF2D::dataArrived(), usNetworkGrabberPreScan3D::includeFrameInVolume(), usNetworkGrabberRF3D::includeFrameInVolume(), and usNetworkGrabberPreScan2D::invertRowsCols().

write() [6/6]

void usMHDSequenceWriter::write	(	const usImageRF3D< short int > &	image,
		const std::vector< uint64_t >	timestamp
	)

Writing method for usImageRF3D images in a sequence.

Parameters

image	The usImageRF3D image to write.
timestamp	The timestamps of every frame of the volume (inverted in case of odd volume in sequence !).

Definition at line 205 of file usMHDSequenceWriter.cpp.

References usImagePreScanSettings::getAxialResolution(), usMotorSettings::getFrameNumber(), usMotorSettings::getFramePitch(), usImageRF3D< Type >::getHeight(), usMotorSettings::getMotorRadius(), usMotorSettings::getMotorType(), usImageRF3D< Type >::getNumberOfFrames(), usTransducerSettings::getSamplingFrequency(), usTransducerSettings::getScanLineNumber(), usTransducerSettings::getScanLinePitch(), usTransducerSettings::getTransducerRadius(), usTransducerSettings::getTransmitFrequency(), usImageRF3D< Type >::getWidth(), usTransducerSettings::isTransducerConvex(), us::NOT_SET, and us::RF_3D.