usSequenceReader3D< ImageType > Class Template Reference

#include <visp3/ustk_core/usSequenceReader3D.h>

Public Member Functions
	usSequenceReader3D ()
virtual	~usSequenceReader3D ()
void	acquire (ImageType &image)
void	getVolume (usImagePreScan3D< unsigned char > &preScanImage, int volumeNumberInSequence)
bool	end ()
long	getImageNumber () const
void	setSequenceFileName (const std::string &sequenceFileName)
void	acquire (usImagePreScan3D< unsigned char > &image)
void	acquire (usImagePostScan3D< unsigned char > &image)
void	getVolume (usImagePreScan3D< unsigned char > &preScanImage, int volumeNumberInSequence)

Detailed Description

template<class ImageType>
class usSequenceReader3D< ImageType >

Reading of sequences of ultrasound images.

This class is used to grab ultrasound volumes from a sequence.

Warning

This class reads .vol files which don't contain transducer/motor informations. If yout want to use the volumes grabbed by this class make sure to complete them by yourself.

Definition at line 63 of file usSequenceReader3D.h.

Constructor & Destructor Documentation

usSequenceReader3D()

template<class ImageType >

usSequenceReader3D< ImageType >::usSequenceReader3D

Default constructor.

Definition at line 125 of file usSequenceReader3D.h.

~usSequenceReader3D()

template<class ImageType >

usSequenceReader3D< ImageType >::~usSequenceReader3D

virtual

Destructor.

Definition at line 133 of file usSequenceReader3D.h.

Member Function Documentation

acquire() [1/3]

template<class ImageType >

void usSequenceReader3D< ImageType >::acquire

(

ImageType &

image

)

acquire() [2/3]

void usSequenceReader3D< usImagePostScan3D< unsigned char > >::acquire

(

usImagePostScan3D< unsigned char > &

image

)

Sequence image acquisition (grabber-style : an internal counter is incremented to open next image at the next call).

Parameters

image

Image of the sequence to read.

Definition at line 323 of file usSequenceReader3D.h.

References usImage3D< Type >::resize().

acquire() [3/3]

void usSequenceReader3D< usImagePreScan3D< unsigned char > >::acquire

(

usImagePreScan3D< unsigned char > &

image

)

Sequence image acquisition (grabber-style : an internal counter is incremented to open next image at the next call).

Parameters

image

Image of the sequence to read.

Definition at line 298 of file usSequenceReader3D.h.

References usImagePreScan3D< Type >::resize().

end()

template<class ImageType >

bool usSequenceReader3D< ImageType >::end ( )

inline

Returns

true if the end of the sequence is reached.

Definition at line 100 of file usSequenceReader3D.h.

getImageNumber()

template<class ImageType >

long usSequenceReader3D< ImageType >::getImageNumber ( ) const

inline

Definition at line 112 of file usSequenceReader3D.h.

getVolume() [1/2]

template<class ImageType >

void usSequenceReader3D< ImageType >::getVolume	(	usImagePreScan3D< unsigned char > &	preScanImage,
		int	volumeNumberInSequence
	)

getVolume() [2/2]

void usSequenceReader3D< usImagePreScan3D< unsigned char > >::getVolume	(	usImagePreScan3D< unsigned char > &	preScanImage,
		int	volumeNumberInSequence
	)

Read a 3D unsigned char pre-scan ultrasound image contained in a sequence. Works only for .vol files.

Parameters

[out]	preScanImage	The pre-scan image to read.
[in]	volumeNumberInSequence	The image number of the image to read in the sequence (from 0 to total volume Number - 1).

Warning

Using this method between 2 calls of acquire() breaks the sequence grabbing system (the offset in the vol file is broken by calling this method).

Definition at line 354 of file usSequenceReader3D.h.

References usImagePreScan3D< Type >::resize().

setSequenceFileName()

template<class ImageType >

void usSequenceReader3D< ImageType >::setSequenceFileName

(

const std::string &

fileName

)

FileName setter.

Parameters

fileName

Name of the .vol file.

Definition at line 139 of file usSequenceReader3D.h.