usPostScanToPreScan2DConverter Class Reference

#include <visp3/ustk_core/usPostScanToPreScan2DConverter.h>

Public Member Functions
	usPostScanToPreScan2DConverter ()
	usPostScanToPreScan2DConverter (const usImagePostScan2D< unsigned char > &inputSettings, const int BModeSampleNumber, const int scanLineNumber)
	usPostScanToPreScan2DConverter (const usTransducerSettings &transducerSettings, const int BModeSampleNumber, const int scanLineNumber, const double xResolution, const double yResolution)
	~usPostScanToPreScan2DConverter ()
void	convert (const usImagePostScan2D< unsigned char > &imageToConvert, usImagePreScan2D< unsigned char > &imageConverted, int preScanSamples)

Protected Member Functions
void	init (const usImagePostScan2D< unsigned char > &inputSettings, const int BModeSampleNumber, const int scanLineNumber)
void	init (const usTransducerSettings &inputSettings, const int BModeSampleNumber, const int scanLineNumber, const double xResolution, const double yResolution)

Detailed Description

2D back-scan converter

This class allows to convert a 2D post-scan ultrasound image to a pre-scan image. The convertion is applied in the convert() method.

Considering the following usImagePostScan2D image (convex or linear) as input:

this class generates an usImagePreScan2D (convex or linear) as output:

Here is an example of how to use the converter, to build a pre-scan image from a post-scan image.

#include <visp3/ustk_core/usPostScanToPreScan2DConverter.h>
 
int main()
{
  // example of 2D post-scan image settings
  unsigned int width = 320;
  unsigned int height = 240;
  double transducerRadius = 0.045;
  double scanLinePitch = 0.0012;
  unsigned int scanLineNumber = 256;
  bool isTransducerConvex = true;
  double widthResolution = 0.002;
  double heightResolution = 0.002;
 
  vpImage<unsigned char> I(height, width); // to fill
  usImagePostScan2D<unsigned char> postScan2d;
  postScan2d.setTransducerRadius(transducerRadius);
  postScan2d.setScanLinePitch(scanLinePitch);
  postScan2d.setScanLineNumber(scanLineNumber);
  postScan2d.setTransducerConvexity(isTransducerConvex);
  postScan2d.setWidthResolution(widthResolution);
  postScan2d.setHeightResolution(heightResolution);
  postScan2d.setData(I);
 
  usImagePreScan2D <unsigned char> preScan; // converter output
  usPostScanToPreScan2DConverter backConverter;
  backConverter.convert(postScan2d, preScan, 480); // preScan is now an image built from postScan image
}

Examples

tutorial-servo-target-confidence.cpp, tutorial-sonosite-confidence-control.cpp, tutorial-sonosite-confidence-map.cpp, and tutorial-ultrasonix-servo-target-confidence.cpp.

Definition at line 90 of file usPostScanToPreScan2DConverter.h.

Constructor & Destructor Documentation

usPostScanToPreScan2DConverter() [1/3]

usPostScanToPreScan2DConverter::usPostScanToPreScan2DConverter

(

)

Default constructor.

Definition at line 39 of file usPostScanToPreScan2DConverter.cpp.

usPostScanToPreScan2DConverter() [2/3]

usPostScanToPreScan2DConverter::usPostScanToPreScan2DConverter	(	const usImagePostScan2D< unsigned char > &	inputSettings,
		const int	BModeSampleNumber,
		const int	scanLineNumber
	)

Initialisation constructor.

Parameters

inputSettings	Post-scan settings you want to use to back-convert image.
BModeSampleNumber	Number of samples along a scan line : height of the pre-scan image built by run().
scanLineNumber	Number of scan lines : width of the pre-scan image built by run().

Definition at line 47 of file usPostScanToPreScan2DConverter.cpp.

References init().

usPostScanToPreScan2DConverter() [3/3]

usPostScanToPreScan2DConverter::usPostScanToPreScan2DConverter	(	const usTransducerSettings &	transducerSettings,
		const int	BModeSampleNumber,
		const int	scanLineNumber,
		const double	xResolution,
		const double	yResolution
	)

Default constructor.

Definition at line 56 of file usPostScanToPreScan2DConverter.cpp.

References init().

~usPostScanToPreScan2DConverter()

usPostScanToPreScan2DConverter::~usPostScanToPreScan2DConverter

(

)

Destructor.

Definition at line 66 of file usPostScanToPreScan2DConverter.cpp.

Member Function Documentation

convert()

void usPostScanToPreScan2DConverter::convert	(	const usImagePostScan2D< unsigned char > &	imageToConvert,
		usImagePreScan2D< unsigned char > &	imageConverted,
		int	preScanSamples
	)

Run the back-scan converter.

Parameters

[in]	imageToConvert	Post-scan image to convert back.
[out]	imageConverted	Pre-scan image obtained after back conversion.
[in]	preScanSamples	Pre-scan samples number wanted in output.

Examples

tutorial-servo-target-confidence.cpp, tutorial-sonosite-confidence-control.cpp, tutorial-sonosite-confidence-map.cpp, and tutorial-ultrasonix-servo-target-confidence.cpp.

Definition at line 192 of file usPostScanToPreScan2DConverter.cpp.

References usImagePreScan2D< Type >::getBModeSampleNumber(), usTransducerSettings::getDepth(), usTransducerSettings::getFieldOfView(), usTransducerSettings::getScanLineNumber(), usTransducerSettings::getTransducerRadius(), init(), usTransducerSettings::isTransducerConvex(), usImagePreScan2D< Type >::resize(), usImagePreScanSettings::setAxialResolution(), usTransducerSettings::setFieldOfView(), usImagePreScanSettings::setImagePreScanSettings(), usImagePreScan2D< Type >::setScanLineNumber(), usTransducerSettings::setTransducerConvexity(), and usTransducerSettings::setTransducerRadius().

init() [1/2]

void usPostScanToPreScan2DConverter::init ( const usImagePostScan2D< unsigned char > &  inputSettings, const int  BModeSampleNumber, const int  scanLineNumber  )

protected

Initialize the back-scan converter.

Parameters

inputSettings	Post-scan settings you want to use to back-convert image.
BModeSampleNumber	Number of samples along a scan line : height of the pre-scan image built by run().
scanLineNumber	Number of scan lines : width of the pre-scan image built by run().

Definition at line 74 of file usPostScanToPreScan2DConverter.cpp.

References usTransducerSettings::getDepth(), usTransducerSettings::getFieldOfView(), usImagePostScan2D< Type >::getHeightResolution(), usTransducerSettings::getScanLinePitch(), usTransducerSettings::getTransducerRadius(), usImagePostScan2D< Type >::getWidthResolution(), and usTransducerSettings::isTransducerConvex().

Referenced by convert(), and usPostScanToPreScan2DConverter().

init() [2/2]

void usPostScanToPreScan2DConverter::init ( const usTransducerSettings &  transducerSettings, const int  BModeSampleNumber, const int  scanLineNumber, const double  xResolution, const double  yResolution  )

protected

Initialize the back-scan converter.

Parameters

transducerSettings	Transducer settings of the pre-scan image.
xResolution	Height of a pixel
yResolution	Width of a pixel.
BModeSampleNumber	Number of pre-scan samples you want in output of back conversion.
scanLineNumber	Number of scan lines you want in output of back conversion.

Definition at line 137 of file usPostScanToPreScan2DConverter.cpp.

References usTransducerSettings::getDepth(), usTransducerSettings::getFieldOfView(), usTransducerSettings::getTransducerRadius(), and usTransducerSettings::isTransducerConvex().