us::usImageHeader Struct Reference

#include <visp3/ustk_core/us.h>

Public Member Functions
	usImageHeader ()

Public Attributes
int	headerId
uint32_t	frameCount
uint64_t	timeStamp
double	dataRate
int	dataLength
int	ss
int	imageType
int	frameWidth
int	frameHeight
double	pixelWidth
double	pixelHeight
int	transmitFrequency
int	samplingFrequency
transducer settings
double	transducerRadius
double	scanLinePitch
unsigned int	scanLineNumber
int	imageDepth
motor settings
double	anglePerFr
int	framesPerVolume
double	motorRadius
int	motorType

Detailed Description

Header coming before every frame

Definition at line 79 of file us.h.

Constructor & Destructor Documentation

usImageHeader()

us::usImageHeader::usImageHeader ( )

inline

Definition at line 80 of file us.h.

Member Data Documentation

anglePerFr

double us::usImageHeader::anglePerFr

angular step between frames, in degrees

Definition at line 117 of file us.h.

Referenced by usNetworkGrabberPostScan2D::dataArrived(), usNetworkGrabberPostScanBiPlan::dataArrived(), usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), usNetworkGrabberRF2D::dataArrived(), usNetworkGrabberRF3D::dataArrived(), usImageHeaderXmlParser::readMainClass(), and usImageHeaderXmlParser::writeMainClass().

dataLength

int us::usImageHeader::dataLength

frame size in bytes, used to read on the network

Definition at line 89 of file us.h.

Referenced by usNetworkGrabberPostScan2D::dataArrived(), usNetworkGrabberPostScanBiPlan::dataArrived(), usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), usNetworkGrabberRF2D::dataArrived(), usNetworkGrabberRF3D::dataArrived(), usImageHeaderXmlParser::readMainClass(), and usImageHeaderXmlParser::writeMainClass().

dataRate

double us::usImageHeader::dataRate

in FPS

Definition at line 87 of file us.h.

Referenced by usNetworkGrabberPostScan2D::dataArrived(), usNetworkGrabberPostScanBiPlan::dataArrived(), usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), usNetworkGrabberRF2D::dataArrived(), usNetworkGrabberRF3D::dataArrived(), usImageHeaderXmlParser::readMainClass(), and usImageHeaderXmlParser::writeMainClass().

frameCount

uint32_t us::usImageHeader::frameCount

from the beginning of last acquisition

Definition at line 84 of file us.h.

Referenced by usNetworkGrabberPostScan2D::dataArrived(), usNetworkGrabberPostScanBiPlan::dataArrived(), usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), usNetworkGrabberRF2D::dataArrived(), usNetworkGrabberRF3D::dataArrived(), usImageHeaderXmlParser::readMainClass(), and usImageHeaderXmlParser::writeMainClass().

frameHeight

int us::usImageHeader::frameHeight

height of frame (pixels for post-scan, samples for pre-scan or rf data)

Definition at line 95 of file us.h.

Referenced by usNetworkGrabberPostScan2D::dataArrived(), usNetworkGrabberPostScanBiPlan::dataArrived(), usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), usNetworkGrabberRF2D::dataArrived(), usNetworkGrabberRF3D::dataArrived(), usImageHeaderXmlParser::readMainClass(), and usImageHeaderXmlParser::writeMainClass().

framesPerVolume

int us::usImageHeader::framesPerVolume

number of frames in a volume

Definition at line 118 of file us.h.

Referenced by usNetworkGrabberPostScan2D::dataArrived(), usNetworkGrabberPostScanBiPlan::dataArrived(), usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), usNetworkGrabberRF2D::dataArrived(), usNetworkGrabberRF3D::dataArrived(), usImageHeaderXmlParser::readMainClass(), and usImageHeaderXmlParser::writeMainClass().

frameWidth

int us::usImageHeader::frameWidth

width of a frame (pixels for post-scan, scanlines for pre-scan or rf data)

Definition at line 94 of file us.h.

Referenced by usNetworkGrabberPostScan2D::dataArrived(), usNetworkGrabberPostScanBiPlan::dataArrived(), usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), usNetworkGrabberRF2D::dataArrived(), usNetworkGrabberRF3D::dataArrived(), usImageHeaderXmlParser::readMainClass(), and usImageHeaderXmlParser::writeMainClass().

headerId

int us::usImageHeader::headerId

Never change this value ! It is used to differenciate usInitHeaderConfirmation (=1) / usImageHeader (=2)

Definition at line 81 of file us.h.

Referenced by usNetworkGrabberPostScan2D::dataArrived(), usNetworkGrabberPostScanBiPlan::dataArrived(), usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), usNetworkGrabberRF2D::dataArrived(), and usNetworkGrabberRF3D::dataArrived().

imageDepth

int us::usImageHeader::imageDepth

depth of the image, in mm

Definition at line 110 of file us.h.

Referenced by usNetworkGrabberPostScan2D::dataArrived(), usNetworkGrabberPostScanBiPlan::dataArrived(), usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), usNetworkGrabberRF2D::dataArrived(), usNetworkGrabberRF3D::dataArrived(), usImageHeaderXmlParser::readMainClass(), and usImageHeaderXmlParser::writeMainClass().

imageType

int us::usImageHeader::imageType

type of data (0 = pre-scan, 1 = post-scan, 2 = rf)

Definition at line 92 of file us.h.

Referenced by usNetworkGrabberPostScan2D::dataArrived(), usNetworkGrabberPostScanBiPlan::dataArrived(), usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), usNetworkGrabberRF2D::dataArrived(), usNetworkGrabberRF3D::dataArrived(), usImageHeaderXmlParser::readMainClass(), and usImageHeaderXmlParser::writeMainClass().

motorRadius

double us::usImageHeader::motorRadius

Radius of the motor, in degrees

Definition at line 119 of file us.h.

Referenced by usNetworkGrabberPostScan2D::dataArrived(), usNetworkGrabberPostScanBiPlan::dataArrived(), usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), usNetworkGrabberRF2D::dataArrived(), usNetworkGrabberRF3D::dataArrived(), usImageHeaderXmlParser::readMainClass(), and usImageHeaderXmlParser::writeMainClass().

motorType

int us::usImageHeader::motorType

Type of the motor (see usMotorType)

Definition at line 120 of file us.h.

Referenced by usNetworkGrabberPostScan2D::dataArrived(), usNetworkGrabberPostScanBiPlan::dataArrived(), usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), usNetworkGrabberRF2D::dataArrived(), usNetworkGrabberRF3D::dataArrived(), usImageHeaderXmlParser::readMainClass(), and usImageHeaderXmlParser::writeMainClass().

pixelHeight

double us::usImageHeader::pixelHeight

height of post-scan pixel

Definition at line 98 of file us.h.

Referenced by usNetworkGrabberPostScan2D::dataArrived(), usNetworkGrabberPostScanBiPlan::dataArrived(), usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), usNetworkGrabberRF2D::dataArrived(), usNetworkGrabberRF3D::dataArrived(), usImageHeaderXmlParser::readMainClass(), and usImageHeaderXmlParser::writeMainClass().

pixelWidth

double us::usImageHeader::pixelWidth

width of post-scan pixel

Definition at line 97 of file us.h.

Referenced by usNetworkGrabberPostScan2D::dataArrived(), usNetworkGrabberPostScanBiPlan::dataArrived(), usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), usNetworkGrabberRF2D::dataArrived(), usNetworkGrabberRF3D::dataArrived(), usImageHeaderXmlParser::readMainClass(), and usImageHeaderXmlParser::writeMainClass().

samplingFrequency

int us::usImageHeader::samplingFrequency

in Hz

Definition at line 101 of file us.h.

Referenced by usNetworkGrabberPostScan2D::dataArrived(), usNetworkGrabberPostScanBiPlan::dataArrived(), usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), usNetworkGrabberRF2D::dataArrived(), usNetworkGrabberRF3D::dataArrived(), usImageHeaderXmlParser::readMainClass(), and usImageHeaderXmlParser::writeMainClass().

scanLineNumber

unsigned int us::usImageHeader::scanLineNumber

number of scanLines used for acquisition

Definition at line 109 of file us.h.

Referenced by usNetworkGrabberPostScan2D::dataArrived(), usNetworkGrabberPostScanBiPlan::dataArrived(), usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), usNetworkGrabberRF2D::dataArrived(), usNetworkGrabberRF3D::dataArrived(), usImageHeaderXmlParser::readMainClass(), and usImageHeaderXmlParser::writeMainClass().

scanLinePitch

double us::usImageHeader::scanLinePitch

Angle (rad) between two scan-lines (if convex))

Definition at line 108 of file us.h.

Referenced by usNetworkGrabberPostScan2D::dataArrived(), usNetworkGrabberPostScanBiPlan::dataArrived(), usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), usNetworkGrabberRF2D::dataArrived(), usNetworkGrabberRF3D::dataArrived(), usImageHeaderXmlParser::readMainClass(), and usImageHeaderXmlParser::writeMainClass().

ss

int us::usImageHeader::ss

sample size in bits

Definition at line 90 of file us.h.

Referenced by usNetworkGrabberPostScan2D::dataArrived(), usNetworkGrabberPostScanBiPlan::dataArrived(), usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), usNetworkGrabberRF2D::dataArrived(), usNetworkGrabberRF3D::dataArrived(), usImageHeaderXmlParser::readMainClass(), and usImageHeaderXmlParser::writeMainClass().

timeStamp

uint64_t us::usImageHeader::timeStamp

msecs since epoch (on ultrasond machine)

Definition at line 85 of file us.h.

Referenced by usNetworkGrabberPostScan2D::dataArrived(), usNetworkGrabberPostScanBiPlan::dataArrived(), usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), usNetworkGrabberRF2D::dataArrived(), usNetworkGrabberRF3D::dataArrived(), usImageHeaderXmlParser::readMainClass(), and usImageHeaderXmlParser::writeMainClass().

transducerRadius

double us::usImageHeader::transducerRadius

radius of the probe (for convex ones), in meters (0 if linear)

Definition at line 107 of file us.h.

Referenced by usNetworkGrabberPostScan2D::dataArrived(), usNetworkGrabberPostScanBiPlan::dataArrived(), usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), usNetworkGrabberRF2D::dataArrived(), usNetworkGrabberRF3D::dataArrived(), usImageHeaderXmlParser::readMainClass(), and usImageHeaderXmlParser::writeMainClass().

transmitFrequency

int us::usImageHeader::transmitFrequency

in Hz

Definition at line 100 of file us.h.

Referenced by usNetworkGrabberPostScan2D::dataArrived(), usNetworkGrabberPostScanBiPlan::dataArrived(), usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), usNetworkGrabberRF2D::dataArrived(), usNetworkGrabberRF3D::dataArrived(), usImageHeaderXmlParser::readMainClass(), and usImageHeaderXmlParser::writeMainClass().