Definition of characteristics for an Ultrasound Probe Sector. More...

#include <cxProbeDefinition.h>

Public Types
enum	TYPE { tNONE =0, tSECTOR =1, tLINEAR =2 }

Public Member Functions
	ProbeDefinition (TYPE type=tNONE)

void	addXml (QDomNode dataNode) const

void	parseXml (QDomNode dataNode)

TYPE	getType () const

double	getDepthStart () const

double	getDepthEnd () const

double	getWidth () const

double	getTemporalCalibration () const

double	getCenterOffset () const

void	resample (QSize mSize)
	Set a new image size. Resample all other parameters to match this new image size, keeping sizes in millimeters fixed. More...

QString	getUid () const

void	setTemporalCalibration (double value)

void	setType (TYPE type)

void	setSector (double depthStart, double depthEnd, double width, double centerOffset=0)

void	setUid (QString uid)

void	updateClipRectFromSector ()

void	updateSectorFromClipRect ()

void	applySoundSpeedCompensationFactor (double factor)
	Compensate for soundspeed for linear probes. More...

double	getSoundSpeedCompensationFactor () const

Vector3D	getOrigin_u () const
	probe origin in image space u. (lower-left corner origin) More...

DoubleBoundingBox3D	getClipRect_u () const
	sector clipping rect in image space u. (lower-left corner origin) More...

Vector3D	getOrigin_p () const

Vector3D	getSpacing () const

DoubleBoundingBox3D	getClipRect_p () const

QSize	getSize () const

void	setOrigin_p (Vector3D origin_p)

void	setSpacing (Vector3D spacing)

void	setClipRect_p (DoubleBoundingBox3D clipRect_p)

void	setSize (QSize size)

void	setUseDigitalVideo (bool val)
	RTSource is digital (eg. US sector is set digitally, not read from .xml file) More...

bool	getUseDigitalVideo () const

void	setVariable (QString variableName, QVariant value)

QVariant	getVariable (QString variableName)

Detailed Description

Definition of characteristics for an Ultrasound Probe Sector.

NOTE: This documentation has been replaced by US Probe Definition.

*
*  * Definitions of probe geometry:
*
*  Sector probe:
*
*                    *   -------------- origin of t space
*                  '   '
*                '       '
*              '           '
*            '  '         '  '
*          '      ' ' ' '      '  ----- depth start
*        '                       '
*      '                           '
*        ' ' '               ' ' '
*              ' ' ' ' ' ' '  --------- depth end
*
*             width in radians
*
*
* Linear probe:
*
*         ' ' ' ' ' '*' ' ' ' ' ------- depth start, origin (*) of t space
*         '                   '
*         '                   '
*         '                   '
*         '                   '
*         '                   '
*         '                   '
*         ' ' ' ' ' ' ' ' ' ' ' ------- depth end
*
*              width in mm
*
*
* Associated image:
*
*            x                   coordinate space v (image): origin upper left corner, spacing in mm
*      v*---->
*       |
*       | ' ' ' ' ' ' ' ' ' ' '
*      y. '                   '  spacing in mm
*         '    y<--t@         '  @ = point called origin: calibration center = origin of t (tool) space.
*         '         |         '  (See also sscTool.h for definition of t space)
*      y^ '        z.         '
*       | '                   '
*       | ' ' ' ' ' ' ' ' ' ' '
*      u*---->                  coordinate space u (image): origin lower left corner
*            x
*
*
*
*            x                   coordinate space p (image in pixels): origin upper left corner, spacing in pixels
*      p*---->
*       |
*       | ' ' ' ' ' ' ' ' ' ' '  size: pixel dimensions (width, height)
*      y. '                   '
*         '                   '
*         '                   '
*         '                   '
*         '                   '
*         ' ' ' ' ' ' ' ' ' ' '
*
*
*

Definition at line 122 of file cxProbeDefinition.h.

Member Enumeration Documentation

enum cx::ProbeDefinition::TYPE

Enumerator
tNONE	undefined
tSECTOR	US beam is emitted radially in a flat cone.
tLINEAR	US beam is emitted straight forward.

Definition at line 125 of file cxProbeDefinition.h.

Constructor & Destructor Documentation

cx::ProbeDefinition::ProbeDefinition ( TYPE type = tNONE )

Definition at line 62 of file cxProbeDefinition.cpp.

Member Function Documentation

void cx::ProbeDefinition::addXml ( QDomNode dataNode ) const

Definition at line 70 of file cxProbeDefinition.cpp.

void cx::ProbeDefinition::applySoundSpeedCompensationFactor ( double factor )

Compensate for soundspeed for linear probes.

Definition at line 226 of file cxProbeDefinition.cpp.

double cx::ProbeDefinition::getCenterOffset ( ) const

Definition at line 170 of file cxProbeDefinition.cpp.

DoubleBoundingBox3D cx::ProbeDefinition::getClipRect_p ( ) const

Definition at line 270 of file cxProbeDefinition.cpp.

DoubleBoundingBox3D cx::ProbeDefinition::getClipRect_u ( ) const

sector clipping rect in image space u. (lower-left corner origin)

Definition at line 253 of file cxProbeDefinition.cpp.

double cx::ProbeDefinition::getDepthEnd ( ) const

Definition at line 155 of file cxProbeDefinition.cpp.

double cx::ProbeDefinition::getDepthStart ( ) const

Definition at line 150 of file cxProbeDefinition.cpp.

Vector3D cx::ProbeDefinition::getOrigin_p ( ) const

Definition at line 260 of file cxProbeDefinition.cpp.

Vector3D cx::ProbeDefinition::getOrigin_u ( ) const

probe origin in image space u. (lower-left corner origin)

Definition at line 248 of file cxProbeDefinition.cpp.

QSize cx::ProbeDefinition::getSize ( ) const

Definition at line 275 of file cxProbeDefinition.cpp.

double cx::ProbeDefinition::getSoundSpeedCompensationFactor ( ) const

Definition at line 235 of file cxProbeDefinition.cpp.

Vector3D cx::ProbeDefinition::getSpacing ( ) const

Definition at line 265 of file cxProbeDefinition.cpp.

double cx::ProbeDefinition::getTemporalCalibration ( ) const

Definition at line 165 of file cxProbeDefinition.cpp.

ProbeDefinition::TYPE cx::ProbeDefinition::getType ( ) const

Definition at line 145 of file cxProbeDefinition.cpp.

QString cx::ProbeDefinition::getUid ( ) const

Definition at line 192 of file cxProbeDefinition.cpp.

bool cx::ProbeDefinition::getUseDigitalVideo ( ) const

Definition at line 305 of file cxProbeDefinition.cpp.

QVariant cx::ProbeDefinition::getVariable ( QString variableName )

Definition at line 315 of file cxProbeDefinition.cpp.

double cx::ProbeDefinition::getWidth ( ) const

Definition at line 160 of file cxProbeDefinition.cpp.

void cx::ProbeDefinition::parseXml ( QDomNode dataNode )

Definition at line 88 of file cxProbeDefinition.cpp.

void cx::ProbeDefinition::resample ( QSize mSize )

Set a new image size. Resample all other parameters to match this new image size, keeping sizes in millimeters fixed.

Definition at line 175 of file cxProbeDefinition.cpp.

void cx::ProbeDefinition::setClipRect_p ( DoubleBoundingBox3D clipRect_p )

Definition at line 290 of file cxProbeDefinition.cpp.

void cx::ProbeDefinition::setOrigin_p ( Vector3D origin_p )

Definition at line 280 of file cxProbeDefinition.cpp.

void cx::ProbeDefinition::setSector	(	double	depthStart,
		double	depthEnd,
		double	width,
		double	centerOffset = `0`
	)

Definition at line 137 of file cxProbeDefinition.cpp.

void cx::ProbeDefinition::setSize ( QSize size )

Definition at line 295 of file cxProbeDefinition.cpp.

void cx::ProbeDefinition::setSpacing ( Vector3D spacing )

Definition at line 285 of file cxProbeDefinition.cpp.

void cx::ProbeDefinition::setTemporalCalibration ( double value )

Definition at line 127 of file cxProbeDefinition.cpp.

void cx::ProbeDefinition::setType ( TYPE type )

Definition at line 132 of file cxProbeDefinition.cpp.

void cx::ProbeDefinition::setUid ( QString uid )

Definition at line 197 of file cxProbeDefinition.cpp.

void cx::ProbeDefinition::setUseDigitalVideo ( bool val )

RTSource is digital (eg. US sector is set digitally, not read from .xml file)

Definition at line 300 of file cxProbeDefinition.cpp.

void cx::ProbeDefinition::setVariable	(	QString	variableName,
		QVariant	value
	)

Definition at line 310 of file cxProbeDefinition.cpp.

void cx::ProbeDefinition::updateClipRectFromSector ( )

Definition at line 202 of file cxProbeDefinition.cpp.

void cx::ProbeDefinition::updateSectorFromClipRect ( )

Definition at line 215 of file cxProbeDefinition.cpp.

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

/media/jenkins/bamboo/buildagent/xml-data/build-dir/FX-RE-JOB1/CX/CX/source/resource/core/Tool/cxProbeDefinition.h
/media/jenkins/bamboo/buildagent/xml-data/build-dir/FX-RE-JOB1/CX/CX/source/resource/core/Tool/cxProbeDefinition.cpp

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation