#include <visp3/ustk_core/usImageIo.h>

Static Public Member Functions
RF io
static void	read (usImageRF2D< short int > &imageRf2D, const std::string &headerFileName)

static void	read (usImageRF3D< short > &rfImage3D, const std::string &headerFileName)

static void	write (const usImageRF2D< short > &rfImage, const std::string &headerFileName, const std::string &imageExtension2D)

static void	write (const usImageRF2D< short > &rfImage, const std::string &headerFileName)

static void	write (const usImageRF3D< short > &rfImage3D, const std::string &headerFileName, const std::string &imageExtension2D)

static void	write (const usImageRF3D< short > &rfImage3D, const std::string &headerFileName)

Pre-scan io
static void	read (usImagePreScan2D< unsigned char > &preScanImage, const std::string &headerFileName)

static void	read (usImagePreScan3D< unsigned char > &preScanImage3D, const std::string &headerFileName)

static void	read (usImagePreScan2D< double > &preScanImage, const std::string &headerFileName)

static void	read (usImagePreScan3D< double > &preScanImage3D, const std::string &headerFileName)

static void	write (const usImagePreScan2D< unsigned char > &preScanImage, const std::string &headerFileName, const std::string &imageExtension2D)

static void	write (const usImagePreScan2D< unsigned char > &preScanImage, const std::string &headerFileName)

static void	write (const usImagePreScan3D< unsigned char > &preScanImage3D, const std::string &headerFileName, const std::string &imageExtension2D)

static void	write (const usImagePreScan3D< unsigned char > &preScanImage3D, const std::string &headerFileName)

static void	write (const usImagePreScan2D< double > &preScanImage, const std::string &headerFileName, const std::string &imageExtension2D)

static void	write (const usImagePreScan2D< double > &preScanImage, const std::string &headerFileName)

static void	write (const usImagePreScan3D< double > &preScanImage3D, const std::string &headerFileName, const std::string &imageExtension2D)

static void	write (const usImagePreScan3D< double > &preScanImage3D, const std::string &headerFileName)

Post-scan io
enum	usHeaderFormatType { FORMAT_XML , FORMAT_MHD , FORMAT_VOL , FORMAT_RF , HEADER_FORMAT_UNKNOWN }

static void	read (usImagePostScan2D< unsigned char > &postScanImage, const std::string &headerFileName)

static void	read (usImagePostScan3D< unsigned char > &postScanImage3D, const std::string &headerFileName)

static void	write (const usImagePostScan2D< unsigned char > &postScanImage, const std::string &headerFileName, const std::string &imageExtension2D)

static void	write (const usImagePostScan2D< unsigned char > &postScanImage, const std::string &headerFileName)

static void	write (const usImagePostScan3D< unsigned char > &postScanImage3D, const std::string &headerFileName, const std::string &imageExtension2D)

static void	write (const usImagePostScan3D< unsigned char > &postScanImage3D, const std::string &headerFileName)

static usHeaderFormatType	getHeaderFormat (const std::string &headerfilename)

Detailed Description

Input/output operations between ultrasound data and files (header + image file).

Definition at line 59 of file usImageIo.h.

Member Enumeration Documentation

◆ usHeaderFormatType

enum usImageIo::usHeaderFormatType

Enumerator
FORMAT_XML
FORMAT_MHD
FORMAT_VOL
FORMAT_RF
HEADER_FORMAT_UNKNOWN

Definition at line 152 of file usImageIo.h.

Member Function Documentation

◆ getHeaderFormat()

usImageIo::usHeaderFormatType usImageIo::getHeaderFormat ( const std::string & headerfilename )

static

Definition at line 50 of file usImageIo.cpp.

References FORMAT_MHD, FORMAT_RF, FORMAT_VOL, FORMAT_XML, and HEADER_FORMAT_UNKNOWN.

Referenced by usMHDSequenceReader::acquire(), usMHDSequenceReader::getImage(), read(), and write().

◆ read() [1/8]

void usImageIo::read	(	usImagePostScan2D< unsigned char > &	postScanImage,
		const std::string &	headerFileName
	)

static

Read 2D post-scan ultrasound image.

Parameters

[out]	postScanImage	The post-scan image to read.
[in]	headerFileName	The header file name.

Definition at line 839 of file usImageIo.cpp.

◆ read() [2/8]

void usImageIo::read	(	usImagePostScan3D< unsigned char > &	postScanImage,
		const std::string &	headerFileName
	)

static

Read 3D post-scan ultrasound image

Parameters

[out]	postScanImage	The post-scan image to read.
[in]	headerFileName	The header file name with extenstion.

Definition at line 978 of file usImageIo.cpp.

References FORMAT_MHD, FORMAT_XML, getHeaderFormat(), us::NOT_SET, us::POSTSCAN_3D, usImage3D< Type >::resize(), usImagePostScan3D< Type >::setElementSpacingX(), usImagePostScan3D< Type >::setElementSpacingY(), usImagePostScan3D< Type >::setElementSpacingZ(), usMotorSettings::setFrameNumber(), usMotorSettings::setFramePitch(), usMotorSettings::setMotorRadius(), usMotorSettings::setMotorType(), usTransducerSettings::setSamplingFrequency(), usTransducerSettings::setScanLineNumber(), usTransducerSettings::setScanLinePitch(), usTransducerSettings::setTransducerConvexity(), usTransducerSettings::setTransducerRadius(), and usTransducerSettings::setTransmitFrequency().

◆ read() [3/8]

void usImageIo::read	(	usImagePreScan2D< double > &	preScan2D,
		const std::string &	headerFileName
	)

static

Read 2D double pre-scan ultrasound image.

Parameters

[out]	preScan2D	The pre-scan image to read.
[in]	headerFileName	The header file name to read.

Definition at line 710 of file usImageIo.cpp.

◆ read() [4/8]

void usImageIo::read	(	usImagePreScan2D< unsigned char > &	preScanImage,
		const std::string &	headerFileName
	)

static

Read 2D unsigned char pre-scan ultrasound image.

Parameters

[out]	preScanImage	The pre-scan image to read.
[in]	headerFileName	The header file name to read, with extension.

Definition at line 410 of file usImageIo.cpp.

◆ read() [5/8]

void usImageIo::read	(	usImagePreScan3D< double > &	preScan3DImage,
		const std::string &	headerFileName
	)

static

Read 3D double pre-scan ultrasound image.

Parameters

[out]	preScan3DImage	The pre-scan image to read.
[in]	headerFileName	The header file name to read.

Definition at line 737 of file usImageIo.cpp.

◆ read() [6/8]

void usImageIo::read	(	usImagePreScan3D< unsigned char > &	preScanImage,
		const std::string &	headerFileName
	)

static

Read 3D unsigned char pre-scan ultrasound image.

Parameters

[out]	preScanImage	The pre-scan image to read.
[in]	headerFileName	The header file name to read, with header extension.

Definition at line 552 of file usImageIo.cpp.

References usSequenceReader< ImageType >::acquire(), usSequenceReader< ImageType >::end(), FORMAT_MHD, FORMAT_VOL, FORMAT_XML, usImagePreScan2D< Type >::getBModeSampleNumber(), usSequenceReader< ImageType >::getFrameCount(), getHeaderFormat(), usImageSettingsXmlParser::getMotorSettings(), usTransducerSettings::getScanLineNumber(), usSequenceReader< ImageType >::getXmlParser(), usImagePreScan3D< Type >::insertFrame(), us::NOT_SET, usSequenceReader< ImageType >::open(), us::PRESCAN_3D, usImagePreScan3D< Type >::resize(), usImagePreScanSettings::setAxialResolution(), usTransducerSettings::setDepth(), usMotorSettings::setFrameNumber(), usMotorSettings::setFramePitch(), usImagePreScanSettings::setImagePreScanSettings(), usMotorSettings::setMotorRadius(), usMotorSettings::setMotorSettings(), usMotorSettings::setMotorType(), usTransducerSettings::setSamplingFrequency(), usTransducerSettings::setScanLineNumber(), usTransducerSettings::setScanLinePitch(), usSequenceReader< ImageType >::setSequenceFileName(), usTransducerSettings::setTransducerConvexity(), usTransducerSettings::setTransducerRadius(), and usTransducerSettings::setTransmitFrequency().

◆ read() [7/8]

void usImageIo::read	(	usImageRF2D< short int > &	imageRf2D,
		const std::string &	headerFileName
	)

static

Read 2D rf ultrasound image.

Parameters

[out]	imageRf2D	The RF image to read.
[in]	headerFileName	The header file name to read.

Warning: If you read .rf files, transducer settings are not available. You will have to set them by yourself.

Examples: testUsImagePostScan2DMhdParser.cpp, testUsImagePostScan2DXmlParser.cpp, testUsImagePostScan3DMhdParser.cpp, testUsImagePreScan2DMhdParser.cpp, testUsImagePreScan2DXmlParser.cpp, testUsImagePreScan3DMhdParser.cpp, testUsImageRf2DMhdParser.cpp, testUsImageRf3DMhdParser.cpp, tutorial-confidence-map.cpp, tutorial-elastography-2D-basic.cpp, tutorial-elastography-3D-basic.cpp, tutorial-image-display-qwidget.cpp, and tutorial-rfFileToPreScanConversion.cpp.

Definition at line 153 of file usImageIo.cpp.

References FORMAT_MHD, FORMAT_RF, usImagePreScanSettings::getAxialResolution(), getHeaderFormat(), us::NOT_SET, usImageRF2D< Type >::resize(), us::RF_2D, usImagePreScanSettings::setAxialResolution(), usTransducerSettings::setDepth(), usImagePreScanSettings::setImagePreScanSettings(), usTransducerSettings::setSamplingFrequency(), usTransducerSettings::setScanLinePitch(), usTransducerSettings::setTransducerConvexity(), usTransducerSettings::setTransducerRadius(), and usTransducerSettings::setTransmitFrequency().

Referenced by usResliceMatrixViewer::openPostScan3D(), us3DSceneSlicing::us3DSceneSlicing(), usMedicalImageViewer::usMedicalImageViewer(), and usResliceMatrixViewer::usResliceMatrixViewer().

◆ read() [8/8]

void usImageIo::read	(	usImageRF3D< short > &	imageRf3,
		const std::string &	headerFileName
	)

static

Read 3D rf ultrasound image.

Parameters

[out]	imageRf3	The RF image to read.
[in]	headerFileName	The header file name to read.

Definition at line 269 of file usImageIo.cpp.

References FORMAT_MHD, getHeaderFormat(), us::NOT_SET, usImageRF3D< Type >::resize(), us::RF_3D, usImagePreScanSettings::setAxialResolution(), usTransducerSettings::setDepth(), usMotorSettings::setFrameNumber(), usMotorSettings::setFramePitch(), usImagePreScanSettings::setImagePreScanSettings(), usMotorSettings::setMotorRadius(), usMotorSettings::setMotorSettings(), usMotorSettings::setMotorType(), usTransducerSettings::setSamplingFrequency(), usTransducerSettings::setScanLineNumber(), usTransducerSettings::setScanLinePitch(), usTransducerSettings::setTransducerConvexity(), usTransducerSettings::setTransducerRadius(), and usTransducerSettings::setTransmitFrequency().

◆ write() [1/16]

void usImageIo::write	(	const usImagePostScan2D< unsigned char > &	postScanImage,
		const std::string &	headerFileName
	)

static

Write 2D post-scan ultrasound image and settings.

Parameters

postScanImage	Image to write.
headerFileName	The header file name with the desired extension.

Definition at line 749 of file usImageIo.cpp.

References FORMAT_MHD, FORMAT_XML, getHeaderFormat(), and write().

◆ write() [2/16]

void usImageIo::write	(	const usImagePostScan2D< unsigned char > &	postScanImage,
		const std::string &	headerFileName,
		const std::string &	imageExtension2D
	)

static

Write 2D post-scan ultrasound image and settings.

Parameters

postScanImage	Image to write.
headerFileName	The header file name with the desired extension.
imageExtension2D	The 2D image extension.

Definition at line 766 of file usImageIo.cpp.

References FORMAT_MHD, FORMAT_XML, getHeaderFormat(), usImagePostScan2D< Type >::getHeightResolution(), usTransducerSettings::getSamplingFrequency(), usTransducerSettings::getScanLineNumber(), usTransducerSettings::getScanLinePitch(), usTransducerSettings::getTransducerRadius(), usTransducerSettings::getTransmitFrequency(), usImagePostScan2D< Type >::getWidthResolution(), usTransducerSettings::isTransducerConvex(), us::POSTSCAN_2D, usImageSettingsXmlParser::setImageFileName(), usImageSettingsXmlParser::setImageSettings(), and usImageSettingsXmlParser::setImageType().

◆ write() [3/16]

void usImageIo::write	(	const usImagePostScan3D< unsigned char > &	postScanImage,
		const std::string &	headerFileName
	)

static

Write 3D post-scan ultrasound image and settings

Parameters

postScanImage	Image to write.
headerFileName	The header file name.

Definition at line 902 of file usImageIo.cpp.

References FORMAT_MHD, FORMAT_XML, getHeaderFormat(), and write().

◆ write() [4/16]

void usImageIo::write	(	const usImagePostScan3D< unsigned char > &	postScanImage,
		const std::string &	headerFileName,
		const std::string &	imageExtension2D
	)

static

Write 3D post-scan ultrasound image and settings

Parameters

postScanImage	Image to write.
headerFileName	The header file name.
imageExtension2D	The 2D image extension.

Definition at line 919 of file usImageIo.cpp.

References FORMAT_MHD, FORMAT_XML, usImagePostScan3D< Type >::getElementSpacingX(), usImagePostScan3D< Type >::getElementSpacingY(), usImagePostScan3D< Type >::getElementSpacingZ(), usMotorSettings::getFrameNumber(), usMotorSettings::getFramePitch(), getHeaderFormat(), 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(), and us::POSTSCAN_3D.

◆ write() [5/16]

static void usImageIo::write	(	const usImagePreScan2D< double > &	preScanImage,
		const std::string &	headerFileName
	)

static

◆ write() [6/16]

void usImageIo::write	(	const usImagePreScan2D< double > &	preScan2DImage,
		const std::string &	headerFileName,
		const std::string &	imageExtension2D
	)

static

Write 2D double pre-scan ultrasound image.

Parameters

preScan2DImage	The pre-scan image to write.
headerFileName	The header file name to write.
imageExtension2D	The 2D image extension.

Definition at line 696 of file usImageIo.cpp.

◆ write() [7/16]

void usImageIo::write	(	const usImagePreScan2D< unsigned char > &	preScanImage,
		const std::string &	headerFileName
	)

static

Write 2D unsigned char pre-scan ultrasound image.

Parameters

preScanImage	The pre-scan image to write.
headerFileName	The header file name to write, with extension.

Definition at line 320 of file usImageIo.cpp.

References FORMAT_MHD, FORMAT_XML, getHeaderFormat(), and write().

◆ write() [8/16]

void usImageIo::write	(	const usImagePreScan2D< unsigned char > &	preScanImage,
		const std::string &	headerFileName,
		const std::string &	imageExtension2D
	)

static

Write 2D unsigned char pre-scan ultrasound image.

Parameters

preScanImage	The pre-scan image to write.
headerFileName	The header file name to write, with extension.
imageExtension2D	The image extention name to write (ex : ".png").

Definition at line 339 of file usImageIo.cpp.

References FORMAT_MHD, FORMAT_XML, usImagePreScanSettings::getAxialResolution(), usImagePreScan2D< Type >::getBModeSampleNumber(), getHeaderFormat(), usTransducerSettings::getSamplingFrequency(), usTransducerSettings::getScanLineNumber(), usTransducerSettings::getScanLinePitch(), usTransducerSettings::getTransducerRadius(), usTransducerSettings::getTransmitFrequency(), usTransducerSettings::isTransducerConvex(), us::PRESCAN_2D, usImageSettingsXmlParser::setImageFileName(), usImageSettingsXmlParser::setImageSettings(), and usImageSettingsXmlParser::setImageType().

◆ write() [9/16]

static void usImageIo::write	(	const usImagePreScan3D< double > &	preScanImage3D,
		const std::string &	headerFileName
	)

static

◆ write() [10/16]

void usImageIo::write	(	const usImagePreScan3D< double > &	preScan3DImage,
		const std::string &	headerFileName,
		const std::string &	imageExtension2D
	)

static

Write 3D double pre-scan ultrasound image.

Parameters

preScan3DImage	The pre-scan image to write.
headerFileName	The header file name to write.
imageExtension2D	The 2D image extension.

Definition at line 723 of file usImageIo.cpp.

◆ write() [11/16]

void usImageIo::write	(	const usImagePreScan3D< unsigned char > &	preScanImage,
		const std::string &	headerFileName
	)

static

Write 3D unsigned char pre-scan ultrasound image.

Parameters

preScanImage	The pre-scan image to write.
headerFileName	The header file name to write.

Definition at line 475 of file usImageIo.cpp.

References FORMAT_MHD, FORMAT_XML, getHeaderFormat(), and write().

◆ write() [12/16]

void usImageIo::write	(	const usImagePreScan3D< unsigned char > &	preScanImage,
		const std::string &	headerFileName,
		const std::string &	imageExtension2D
	)

static

Write 3D unsigned char pre-scan ultrasound image.

Parameters

preScanImage	The pre-scan image to write.
headerFileName	The header file name to write.
imageExtension2D	The 2D image extension.

Definition at line 492 of file usImageIo.cpp.

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

◆ write() [13/16]

void usImageIo::write	(	const usImageRF2D< short > &	imageRf2D,
		const std::string &	headerFileName
	)

static

Write 2D rf ultrasound image.

Parameters

imageRf2D	The RF image to write.
headerFileName	The header file name to write.

Definition at line 87 of file usImageIo.cpp.

References FORMAT_MHD, FORMAT_XML, getHeaderFormat(), and write().

◆ write() [14/16]

void usImageIo::write	(	const usImageRF2D< short > &	imageRf2D,
		const std::string &	headerFileName,
		const std::string &	imageExtension2D
	)

static

Write 2D rf ultrasound image.

Parameters

imageRf2D	The RF image to write.
headerFileName	The header file name to write.
imageExtension2D	The 2D image extension.

Examples: testUsImagePostScan2DMhdParser.cpp, testUsImagePostScan2DXmlParser.cpp, testUsImagePostScan3DMhdParser.cpp, testUsImagePreScan2DMhdParser.cpp, testUsImagePreScan2DXmlParser.cpp, testUsImagePreScan3DMhdParser.cpp, testUsImageRf2DMhdParser.cpp, testUsImageRf3DMhdParser.cpp, tutorial-confidence-map.cpp, tutorial-elastography-3D-basic.cpp, tutorial-rfFileToPreScanConversion.cpp, tutorial-ultrasonix-qt-grabbing-RF3D.cpp, tutorial-ultrasonix-qt-grabbing-pre-scan3D.cpp, tutorial-ustk-virtual-server-postScan2D.cpp, and tutorial-ustk-virtual-server-preScan2D.cpp.

Definition at line 104 of file usImageIo.cpp.

References FORMAT_MHD, usImagePreScanSettings::getAxialResolution(), getHeaderFormat(), usImageRF2D< Type >::getRFSampleNumber(), usTransducerSettings::getSamplingFrequency(), usTransducerSettings::getScanLineNumber(), usTransducerSettings::getScanLinePitch(), usTransducerSettings::getTransducerRadius(), usTransducerSettings::getTransmitFrequency(), usTransducerSettings::isTransducerConvex(), and us::RF_2D.

Referenced by usResliceMatrixViewer::getView1Slice(), and write().

◆ write() [15/16]

void usImageIo::write	(	const usImageRF3D< short > &	imageRf3D,
		const std::string &	headerFileName
	)

static

Write 3D rf ultrasound image.

Parameters

imageRf3D	The RF image to write.
headerFileName	The header file name to write.

Definition at line 200 of file usImageIo.cpp.

References FORMAT_MHD, FORMAT_XML, getHeaderFormat(), and write().

◆ write() [16/16]

void usImageIo::write	(	const usImageRF3D< short > &	imageRf3D,
		const std::string &	headerFileName,
		const std::string &	imageExtension3D
	)

static

Write 3D rf ultrasound image.

Parameters

imageRf3D	The RF image to write.
headerFileName	The header file name to write.
imageExtension3D	The 3D image extension.

Definition at line 217 of file usImageIo.cpp.

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

Static Public Member Functions

Post-scan io

Detailed Description

Member Enumeration Documentation

◆ usHeaderFormatType

Member Function Documentation

◆ getHeaderFormat()

◆ read() [1/8]

◆ read() [2/8]

◆ read() [3/8]

◆ read() [4/8]

◆ read() [5/8]

◆ read() [6/8]

◆ read() [7/8]

◆ read() [8/8]

◆ write() [1/16]

◆ write() [2/16]

◆ write() [3/16]

◆ write() [4/16]

◆ write() [5/16]

◆ write() [6/16]

◆ write() [7/16]

◆ write() [8/16]

◆ write() [9/16]

◆ write() [10/16]

◆ write() [11/16]

◆ write() [12/16]

◆ write() [13/16]

◆ write() [14/16]

◆ write() [15/16]

◆ write() [16/16]