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 101 of file cxProbeDefinition.h.

Member Enumeration Documentation

◆ TYPE

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 104 of file cxProbeDefinition.h.

Constructor & Destructor Documentation

◆ ProbeDefinition()

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

Definition at line 41 of file cxProbeDefinition.cpp.

Member Function Documentation

◆ addXml()

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

Definition at line 49 of file cxProbeDefinition.cpp.

◆ applySoundSpeedCompensationFactor()

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

Compensate for soundspeed for linear probes.

Definition at line 205 of file cxProbeDefinition.cpp.

◆ getCenterOffset()

double cx::ProbeDefinition::getCenterOffset ( ) const

Definition at line 149 of file cxProbeDefinition.cpp.

◆ getClipRect_p()

DoubleBoundingBox3D cx::ProbeDefinition::getClipRect_p ( ) const

Definition at line 251 of file cxProbeDefinition.cpp.

◆ getClipRect_u()

DoubleBoundingBox3D cx::ProbeDefinition::getClipRect_u ( ) const

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

Definition at line 234 of file cxProbeDefinition.cpp.

◆ getDepthEnd()

double cx::ProbeDefinition::getDepthEnd ( ) const

Definition at line 134 of file cxProbeDefinition.cpp.

◆ getDepthStart()

double cx::ProbeDefinition::getDepthStart ( ) const

Definition at line 129 of file cxProbeDefinition.cpp.

◆ getOrigin_p()

Vector3D cx::ProbeDefinition::getOrigin_p ( ) const

Definition at line 241 of file cxProbeDefinition.cpp.

◆ getOrigin_u()

Vector3D cx::ProbeDefinition::getOrigin_u ( ) const

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

Definition at line 229 of file cxProbeDefinition.cpp.

◆ getSize()

QSize cx::ProbeDefinition::getSize ( ) const

Definition at line 256 of file cxProbeDefinition.cpp.

◆ getSoundSpeedCompensationFactor()

double cx::ProbeDefinition::getSoundSpeedCompensationFactor ( ) const

Definition at line 216 of file cxProbeDefinition.cpp.

◆ getSpacing()

Vector3D cx::ProbeDefinition::getSpacing ( ) const

Definition at line 246 of file cxProbeDefinition.cpp.

◆ getTemporalCalibration()

double cx::ProbeDefinition::getTemporalCalibration ( ) const

Definition at line 144 of file cxProbeDefinition.cpp.

◆ getType()

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

Definition at line 124 of file cxProbeDefinition.cpp.

◆ getUid()

QString cx::ProbeDefinition::getUid ( ) const

Definition at line 171 of file cxProbeDefinition.cpp.

◆ getUseDigitalVideo()

bool cx::ProbeDefinition::getUseDigitalVideo ( ) const

Definition at line 286 of file cxProbeDefinition.cpp.

◆ getVariable()

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

Definition at line 296 of file cxProbeDefinition.cpp.

◆ getWidth()

double cx::ProbeDefinition::getWidth ( ) const

Definition at line 139 of file cxProbeDefinition.cpp.

◆ parseXml()

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

Definition at line 67 of file cxProbeDefinition.cpp.

◆ resample()

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 154 of file cxProbeDefinition.cpp.

◆ setClipRect_p()

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

Definition at line 271 of file cxProbeDefinition.cpp.

◆ setOrigin_p()

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

Definition at line 261 of file cxProbeDefinition.cpp.

◆ setSector()

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

Definition at line 116 of file cxProbeDefinition.cpp.

◆ setSize()

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

Definition at line 276 of file cxProbeDefinition.cpp.

◆ setSpacing()

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

Definition at line 266 of file cxProbeDefinition.cpp.

◆ setTemporalCalibration()

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

Definition at line 106 of file cxProbeDefinition.cpp.

◆ setType()

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

Definition at line 111 of file cxProbeDefinition.cpp.

◆ setUid()

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

Definition at line 176 of file cxProbeDefinition.cpp.

◆ setUseDigitalVideo()

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

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

Definition at line 281 of file cxProbeDefinition.cpp.

◆ setVariable()

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

Definition at line 291 of file cxProbeDefinition.cpp.

◆ updateClipRectFromSector()

void cx::ProbeDefinition::updateClipRectFromSector ( )

Definition at line 181 of file cxProbeDefinition.cpp.

◆ updateSectorFromClipRect()

void cx::ProbeDefinition::updateSectorFromClipRect ( )

Definition at line 194 of file cxProbeDefinition.cpp.

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

/mnt/bamboo/bamboo/buildagent/xml-data/build-dir/NN-NI-BU2/CX/CX/source/resource/core/Tool/cxProbeDefinition.h
/mnt/bamboo/bamboo/buildagent/xml-data/build-dir/NN-NI-BU2/CX/CX/source/resource/core/Tool/cxProbeDefinition.cpp

Public Types

Public Member Functions