usAcquisitionParameters Class Reference

#include <visp3/ustk_grabber/usAcquisitionParameters.h>

Public Types
enum	usMotorStep {   US_STATIC_MOTOR = 0 , US_ANGLE_PITCH_1 = 2 , US_ANGLE_PITCH_2 = 4 , US_ANGLE_PITCH_3 = 8 ,   US_ANGLE_PITCH_4 = 16 , US_ANGLE_PITCH_5 = 32 }

Public Member Functions
	usAcquisitionParameters ()
	~usAcquisitionParameters ()
bool	getActivateMotor () const
usMotorStep	getSepsPerFrame () const
usMotorStep	getSepsPerFrameMax () const
usMotorStep	getSepsPerFrameMin () const
int	getFramesPerVolume () const
int	getFramesPerVolumeMax () const
int	getFramesPerVolumeMin () const
int	getImageDepth () const
int	getImageDepthMax () const
int	getImageDepthMin () const
int	getImagingMode () const
int	getImagingModeMax () const
int	getImagingModeMin () const
int	getMotorPosition () const
int	getMotorPositionMax () const
int	getMotorPositionMin () const
int	getPostScanHeigh () const
bool	getPostScanMode () const
int	getPostScanWidth () const
int	getSamplingFrequency () const
int	getSamplingFrequencyMax () const
int	getSamplingFrequencyMin () const
int	getSector () const
int	getSectorMax () const
int	getSectorMin () const
int	getTransmitFrequency () const
int	getTransmitFrequencyMax () const
int	getTransmitFrequencyMin () const
void	setActivateMotor (bool activateMotor)
void	setSepsPerFrame (usMotorStep anglePerFrame)
void	setSepsPerFrameMax (usMotorStep anglePerFrameMax)
void	setSepsPerFrameMin (usMotorStep anglePerFrameMin)
void	setFramesPerVolume (int framesPerVolume)
void	setFramesPerVolumeMax (int framesPerVolumeMax)
void	setFramesPerVolumeMin (int framesPerVolumeMin)
void	setImageDepth (int imageDepth)
void	setImageDepthMax (int imageDepthMax)
void	setImageDepthMin (int imageDepthMin)
void	setImagingMode (int imagingMode)
void	setImagingModeMax (int imagingModeMax)
void	setImagingModeMin (int imagingModeMin)
void	setMotorPosition (int motorPosition)
void	setMotorPositionMax (int motorPositionMax)
void	setMotorPositionMin (int motorPositionMin)
void	setPostScanHeigh (int postScanHeigh)
void	setPostScanMode (bool postScanMode)
void	setPostScanWidth (int postScanWidth)
void	setSamplingFrequency (int samplingFrequency)
void	setSamplingFrequencyMax (int samplingFrequencyMax)
void	setSamplingFrequencyMin (int samplingFrequencyMin)
void	setSector (int sector)
void	setSectorMax (int sectorMax)
void	setSectorMin (int sectorMin)
void	setTransmitFrequency (int transmitFrequency)
void	setTransmitFrequencyMax (int transmitFrequencyMax)
void	setTransmitFrequencyMin (int transmitFrequencyMin)

Detailed Description

Class to store acquisition parameters for ultrasound station.

Definition at line 48 of file usAcquisitionParameters.h.

Member Enumeration Documentation

usMotorStep

enum usAcquisitionParameters::usMotorStep

For 4DC7 3D probe motor movement.

Enumerator
US_STATIC_MOTOR	motor not moving (2D case)
US_ANGLE_PITCH_1	2 motor steps per frame = 0.36585 degrees. Not working for 4DC7 probe !
US_ANGLE_PITCH_2	4 motor steps per frame = 0.7317 degrees
US_ANGLE_PITCH_3	8 motor steps per frame = 1.4634 degrees
US_ANGLE_PITCH_4	8 motor steps per frame = 2.9268 degrees. Not working for 4DC7 probe !
US_ANGLE_PITCH_5	8 motor steps per frame = 5.8536 degrees. Not working for 4DC7 probe !

Definition at line 52 of file usAcquisitionParameters.h.

Constructor & Destructor Documentation

usAcquisitionParameters()

usAcquisitionParameters::usAcquisitionParameters

(

)

Constructor.

Definition at line 39 of file usAcquisitionParameters.cpp.

~usAcquisitionParameters()

usAcquisitionParameters::~usAcquisitionParameters

(

)

Destructor.

Definition at line 52 of file usAcquisitionParameters.cpp.

Member Function Documentation

getActivateMotor()

bool usAcquisitionParameters::getActivateMotor ( ) const

inline

Definition at line 76 of file usAcquisitionParameters.h.

Referenced by usNetworkGrabber::getMotorActivation(), and usNetworkGrabber::sendAcquisitionParametersSlot().

getFramesPerVolume()

int usAcquisitionParameters::getFramesPerVolume ( ) const

inline

Definition at line 82 of file usAcquisitionParameters.h.

Referenced by usNetworkGrabber::getFramesPerVolume(), and usNetworkGrabber::sendAcquisitionParametersSlot().

getFramesPerVolumeMax()

int usAcquisitionParameters::getFramesPerVolumeMax ( ) const

inline

Definition at line 83 of file usAcquisitionParameters.h.

Referenced by usNetworkGrabber::setFramesPerVolume().

getFramesPerVolumeMin()

int usAcquisitionParameters::getFramesPerVolumeMin ( ) const

inline

Definition at line 84 of file usAcquisitionParameters.h.

Referenced by usNetworkGrabber::setFramesPerVolume().

getImageDepth()

int usAcquisitionParameters::getImageDepth ( ) const

inline

Definition at line 86 of file usAcquisitionParameters.h.

Referenced by usNetworkGrabber::getImageDepth(), and usNetworkGrabber::sendAcquisitionParametersSlot().

getImageDepthMax()

int usAcquisitionParameters::getImageDepthMax ( ) const

inline

Definition at line 87 of file usAcquisitionParameters.h.

Referenced by usNetworkGrabber::setImageDepth().

getImageDepthMin()

int usAcquisitionParameters::getImageDepthMin ( ) const

inline

Definition at line 88 of file usAcquisitionParameters.h.

Referenced by usNetworkGrabber::setImageDepth().

getImagingMode()

int usAcquisitionParameters::getImagingMode ( ) const

inline

Definition at line 90 of file usAcquisitionParameters.h.

Referenced by usNetworkGrabber::getImagingMode(), and usNetworkGrabber::sendAcquisitionParametersSlot().

getImagingModeMax()

int usAcquisitionParameters::getImagingModeMax ( ) const

inline

Definition at line 91 of file usAcquisitionParameters.h.

Referenced by usNetworkGrabber::setImagingMode().

getImagingModeMin()

int usAcquisitionParameters::getImagingModeMin ( ) const

inline

Definition at line 92 of file usAcquisitionParameters.h.

Referenced by usNetworkGrabber::setImagingMode().

getMotorPosition()

int usAcquisitionParameters::getMotorPosition ( ) const

inline

Definition at line 94 of file usAcquisitionParameters.h.

Referenced by usNetworkGrabber::getMotorPosition(), and usNetworkGrabber::sendAcquisitionParametersSlot().

getMotorPositionMax()

int usAcquisitionParameters::getMotorPositionMax ( ) const

inline

Definition at line 95 of file usAcquisitionParameters.h.

Referenced by usNetworkGrabber::setMotorPosition().

getMotorPositionMin()

int usAcquisitionParameters::getMotorPositionMin ( ) const

inline

Definition at line 96 of file usAcquisitionParameters.h.

Referenced by usNetworkGrabber::setMotorPosition().

getPostScanHeigh()

int usAcquisitionParameters::getPostScanHeigh ( ) const

inline

Definition at line 98 of file usAcquisitionParameters.h.

Referenced by usNetworkGrabber::getPostScanHeigh(), and usNetworkGrabber::sendAcquisitionParametersSlot().

getPostScanMode()

bool usAcquisitionParameters::getPostScanMode ( ) const

inline

Definition at line 100 of file usAcquisitionParameters.h.

Referenced by usNetworkGrabber::getPostScanMode(), and usNetworkGrabber::sendAcquisitionParametersSlot().

getPostScanWidth()

int usAcquisitionParameters::getPostScanWidth ( ) const

inline

Definition at line 102 of file usAcquisitionParameters.h.

Referenced by usNetworkGrabber::getPostScanWidth(), and usNetworkGrabber::sendAcquisitionParametersSlot().

getSamplingFrequency()

int usAcquisitionParameters::getSamplingFrequency ( void  ) const

inline

Definition at line 104 of file usAcquisitionParameters.h.

Referenced by usNetworkGrabber::getSamplingFrequency(), and usNetworkGrabber::sendAcquisitionParametersSlot().

getSamplingFrequencyMax()

int usAcquisitionParameters::getSamplingFrequencyMax ( ) const

inline

Definition at line 105 of file usAcquisitionParameters.h.

Referenced by usNetworkGrabber::setSamplingFrequency().

getSamplingFrequencyMin()

int usAcquisitionParameters::getSamplingFrequencyMin ( ) const

inline

Definition at line 106 of file usAcquisitionParameters.h.

Referenced by usNetworkGrabber::setSamplingFrequency().

getSector()

int usAcquisitionParameters::getSector ( ) const

inline

Definition at line 108 of file usAcquisitionParameters.h.

Referenced by usNetworkGrabber::getSector(), and usNetworkGrabber::sendAcquisitionParametersSlot().

getSectorMax()

int usAcquisitionParameters::getSectorMax ( ) const

inline

Definition at line 109 of file usAcquisitionParameters.h.

Referenced by usNetworkGrabber::setSector().

getSectorMin()

int usAcquisitionParameters::getSectorMin ( ) const

inline

Definition at line 110 of file usAcquisitionParameters.h.

Referenced by usNetworkGrabber::setSector().

getSepsPerFrame()

usMotorStep usAcquisitionParameters::getSepsPerFrame ( ) const

inline

Definition at line 78 of file usAcquisitionParameters.h.

Referenced by usNetworkGrabber::getStepsPerFrame(), and usNetworkGrabber::sendAcquisitionParametersSlot().

getSepsPerFrameMax()

usMotorStep usAcquisitionParameters::getSepsPerFrameMax ( ) const

inline

Definition at line 79 of file usAcquisitionParameters.h.

getSepsPerFrameMin()

usMotorStep usAcquisitionParameters::getSepsPerFrameMin ( ) const

inline

Definition at line 80 of file usAcquisitionParameters.h.

getTransmitFrequency()

int usAcquisitionParameters::getTransmitFrequency ( ) const

inline

Definition at line 112 of file usAcquisitionParameters.h.

Referenced by usNetworkGrabber::getTransmitFrequency(), and usNetworkGrabber::sendAcquisitionParametersSlot().

getTransmitFrequencyMax()

int usAcquisitionParameters::getTransmitFrequencyMax ( ) const

inline

Definition at line 113 of file usAcquisitionParameters.h.

Referenced by usNetworkGrabber::setTransmitFrequency().

getTransmitFrequencyMin()

int usAcquisitionParameters::getTransmitFrequencyMin ( ) const

inline

Definition at line 114 of file usAcquisitionParameters.h.

Referenced by usNetworkGrabber::setTransmitFrequency().

setActivateMotor()

void usAcquisitionParameters::setActivateMotor

(

bool

activateMotor

)

Setter for motor activation.

Parameters

activateMotor

Boolean to activate the motor sweep (true) or not (false).

Definition at line 58 of file usAcquisitionParameters.cpp.

Referenced by usNetworkGrabber::readAcquisitionParameters(), and usNetworkGrabber::setMotorActivation().

setFramesPerVolume()

void usAcquisitionParameters::setFramesPerVolume

(

int

framesPerVolume

)

Setter for framesPerVolume.

Parameters

framesPerVolume

Number of frames in a volume acquisition.

Definition at line 82 of file usAcquisitionParameters.cpp.

Referenced by usNetworkGrabber::readAcquisitionParameters(), and usNetworkGrabber::setFramesPerVolume().

setFramesPerVolumeMax()

void usAcquisitionParameters::setFramesPerVolumeMax

(

int

framesPerVolumeMax

)

Setter for framesPerVolume.

Parameters

framesPerVolumeMax

Maximum number of frames in a volume acquisition.

Definition at line 88 of file usAcquisitionParameters.cpp.

Referenced by usNetworkGrabber::readAcquisitionParameters().

setFramesPerVolumeMin()

void usAcquisitionParameters::setFramesPerVolumeMin

(

int

framesPerVolumeMin

)

Setter for framesPerVolumeMin.

Parameters

framesPerVolumeMin

Minimum number of frames in a volume acquisition.

Definition at line 97 of file usAcquisitionParameters.cpp.

setImageDepth()

void usAcquisitionParameters::setImageDepth

(

int

imageDepth

)

Setter for imageDepth.

Parameters

imageDepth

Depth of the echo image, in millimeters.

Definition at line 106 of file usAcquisitionParameters.cpp.

Referenced by usNetworkGrabber::readAcquisitionParameters(), and usNetworkGrabber::setImageDepth().

setImageDepthMax()

void usAcquisitionParameters::setImageDepthMax

(

int

imageDepthMax

)

Setter for imageDepthMax.

Parameters

imageDepthMax

Max depth of the probe for the echo image, in millimeters.

Definition at line 112 of file usAcquisitionParameters.cpp.

Referenced by usNetworkGrabber::readAcquisitionParameters().

setImageDepthMin()

void usAcquisitionParameters::setImageDepthMin

(

int

imageDepthMin

)

Setter for imageDepthMin.

Parameters

imageDepthMin

Min depth of the probe for the echo image, in millimeters.

Definition at line 118 of file usAcquisitionParameters.cpp.

Referenced by usNetworkGrabber::readAcquisitionParameters().

setImagingMode()

void usAcquisitionParameters::setImagingMode

(

int

imagingMode

)

Setter for imagingMode.

Parameters

imagingMode

Code for imaging mode (0 = pre-scan B-MODE, RF mode = 12)

Definition at line 124 of file usAcquisitionParameters.cpp.

Referenced by usNetworkGrabber::readAcquisitionParameters(), and usNetworkGrabber::setImagingMode().

setImagingModeMax()

void usAcquisitionParameters::setImagingModeMax

(

int

imagingModeMax

)

Setter for imagingModeMax.

Parameters

imagingModeMax

Code for imaging mode max.

Definition at line 130 of file usAcquisitionParameters.cpp.

Referenced by usNetworkGrabber::readAcquisitionParameters().

setImagingModeMin()

void usAcquisitionParameters::setImagingModeMin

(

int

imagingModeMin

)

Setter for imagingModeMin.

Parameters

imagingModeMin

Code for imaging mode min.

Definition at line 136 of file usAcquisitionParameters.cpp.

Referenced by usNetworkGrabber::readAcquisitionParameters().

setMotorPosition()

void usAcquisitionParameters::setMotorPosition

(

int

motorPosition

)

Setter for motorPosition, to set a fixed motor position.

Parameters

motorPosition

Motor position in degrees.

Definition at line 142 of file usAcquisitionParameters.cpp.

Referenced by usNetworkGrabber::readAcquisitionParameters(), and usNetworkGrabber::setMotorPosition().

setMotorPositionMax()

void usAcquisitionParameters::setMotorPositionMax

(

int

motorPositionMax

)

Setter for motorPositionMax.

Parameters

motorPositionMax

Max motor position in degrees of the current probe.

Definition at line 148 of file usAcquisitionParameters.cpp.

Referenced by usNetworkGrabber::readAcquisitionParameters().

setMotorPositionMin()

void usAcquisitionParameters::setMotorPositionMin

(

int

motorPositionMin

)

Setter for motorPositionMin.

Parameters

motorPositionMin

Min motor position in degrees of the current probe.

Definition at line 154 of file usAcquisitionParameters.cpp.

Referenced by usNetworkGrabber::readAcquisitionParameters().

setPostScanHeigh()

void usAcquisitionParameters::setPostScanHeigh

(

int

postScanHeigh

)

Setter for postScanHeigh.

Parameters

postScanHeigh

Height of the post-scan image in px.

Definition at line 160 of file usAcquisitionParameters.cpp.

Referenced by usNetworkGrabber::readAcquisitionParameters(), and usNetworkGrabber::setPostScanHeigh().

setPostScanMode()

void usAcquisitionParameters::setPostScanMode

(

bool

postScanMode

)

Setter for postScanMode.

Parameters

postScanMode

Boolean to acquire scan-converted images (true), or not (false).

Definition at line 166 of file usAcquisitionParameters.cpp.

Referenced by usNetworkGrabber::readAcquisitionParameters(), and usNetworkGrabber::setPostScanMode().

setPostScanWidth()

void usAcquisitionParameters::setPostScanWidth

(

int

postScanWidth

)

Setter for postScanWidth.

Parameters

postScanWidth

Width of the post-scan image in px.

Definition at line 172 of file usAcquisitionParameters.cpp.

Referenced by usNetworkGrabber::readAcquisitionParameters(), and usNetworkGrabber::setPostScanWidth().

setSamplingFrequency()

void usAcquisitionParameters::setSamplingFrequency

(

int

samplingFrequency

)

Setter for samplingFrequency.

Parameters

samplingFrequency

Sampling frequency of the acquisition (Hz).

Definition at line 178 of file usAcquisitionParameters.cpp.

Referenced by usNetworkGrabber::readAcquisitionParameters(), and usNetworkGrabber::setSamplingFrequency().

setSamplingFrequencyMax()

void usAcquisitionParameters::setSamplingFrequencyMax

(

int

samplingFrequencyMax

)

Setter for samplingFrequencyMax.

Parameters

samplingFrequencyMax

Max sampling frequency of the acquisition (Hz).

Definition at line 184 of file usAcquisitionParameters.cpp.

Referenced by usNetworkGrabber::readAcquisitionParameters().

setSamplingFrequencyMin()

void usAcquisitionParameters::setSamplingFrequencyMin

(

int

samplingFrequencyMin

)

Setter for samplingFrequencyMin.

Parameters

samplingFrequencyMin

Min sampling frequency of the acquisition (Hz).

Definition at line 193 of file usAcquisitionParameters.cpp.

Referenced by usNetworkGrabber::readAcquisitionParameters().

setSector()

void usAcquisitionParameters::setSector

(

int

sector

)

Setter for sector.

Parameters

sector

Percentage of the total width of the transducers used to acquire an image.

Definition at line 202 of file usAcquisitionParameters.cpp.

Referenced by usNetworkGrabber::readAcquisitionParameters(), and usNetworkGrabber::setSector().

setSectorMax()

void usAcquisitionParameters::setSectorMax

(

int

sectorMax

)

Setter for sectorMax.

Parameters

sectorMax

Max percentage of the width of the transducers used to acquire an image.

Definition at line 208 of file usAcquisitionParameters.cpp.

Referenced by usNetworkGrabber::readAcquisitionParameters().

setSectorMin()

void usAcquisitionParameters::setSectorMin

(

int

sectorMin

)

Setter for sectorMin.

Parameters

sectorMin

Min percentage of the width of the transducers used to acquire an image.

Definition at line 214 of file usAcquisitionParameters.cpp.

Referenced by usNetworkGrabber::readAcquisitionParameters().

setSepsPerFrame()

void usAcquisitionParameters::setSepsPerFrame

(

usMotorStep

anglePerFrame

)

Setter for angle step per frame.

Parameters

anglePerFrame

Angle in degrees between 2 sucessive frames. See usAcquisitionParameters::us4DC7Angles

Definition at line 64 of file usAcquisitionParameters.cpp.

Referenced by usNetworkGrabber::readAcquisitionParameters(), and usNetworkGrabber::setStepsPerFrame().

setSepsPerFrameMax()

void usAcquisitionParameters::setSepsPerFrameMax

(

usMotorStep

anglePerFrameMax

)

Setter for angle step per frame max.

Parameters

anglePerFrameMax

Max angle in degrees between 2 sucessive frames. See usAcquisitionParameters::us4DC7Angles

Definition at line 70 of file usAcquisitionParameters.cpp.

Referenced by usNetworkGrabber::readAcquisitionParameters().

setSepsPerFrameMin()

void usAcquisitionParameters::setSepsPerFrameMin

(

usMotorStep

anglePerFrameMin

)

Setter for angle step per frame min.

Parameters

anglePerFrameMin

Min angle in degrees between 2 sucessive frames. See usAcquisitionParameters::us4DC7Angles

Definition at line 76 of file usAcquisitionParameters.cpp.

Referenced by usNetworkGrabber::readAcquisitionParameters().

setTransmitFrequency()

void usAcquisitionParameters::setTransmitFrequency

(

int

transmitFrequency

)

Setter for transmitFrequency.

Parameters

transmitFrequency

Acoustic frequency sent with the transducers (Hz).

Definition at line 220 of file usAcquisitionParameters.cpp.

Referenced by usNetworkGrabber::readAcquisitionParameters(), and usNetworkGrabber::setTransmitFrequency().

setTransmitFrequencyMax()

void usAcquisitionParameters::setTransmitFrequencyMax

(

int

transmitFrequencyMax

)

Setter for transmitFrequencyMax.

Parameters

transmitFrequencyMax

Max acoustic frequency sent with the transducers (Hz).

Definition at line 226 of file usAcquisitionParameters.cpp.

Referenced by usNetworkGrabber::readAcquisitionParameters().

setTransmitFrequencyMin()

void usAcquisitionParameters::setTransmitFrequencyMin

(

int

transmitFrequencyMin

)

Setter for transmitFrequencyMin.

Parameters

transmitFrequencyMin

Min acoustic frequency sent with the transducers (Hz).

Definition at line 235 of file usAcquisitionParameters.cpp.

Referenced by usNetworkGrabber::readAcquisitionParameters().