usImageHeaderXmlParser Class Reference

#include <visp3/ustk_core/usImageHeaderXmlParser.h>

Inheritance diagram for usImageHeaderXmlParser:

Public Types
enum	vpXmlCodeType {   CODE_XML_BAD = -1 , CODE_XML_FRAME_COUNT , CODE_XML_TIME_STAMP , CODE_XML_DATA_RATE ,   CODE_XML_DATA_LENGTH , CODE_XML_SAMPLE_SIZE , CODE_XML_IMAGE_TYPE , CODE_XML_FRAME_WITH ,   CODE_XML_FRAME_HEIGHT , CODE_XML_PIXEL_WIDTH , CODE_XML_PIXEL_HEIGHT , CODE_XML_TRANSMIT_FRQUENCY ,   CODE_XML_SAMPLING_FREQUENCY , CODE_XML_TRANSDUCER_RADIUS , CODE_XML_SCANLINE_PITCH , CODE_XML_SCANLINE_NUMBER ,   CODE_XML_IMAGE_DEPTH , CODE_XML_ANGLE_PER_FRAME , CODE_XML_FRAME_PER_VOLUME , CODE_XML_MOTOR_RADIUS ,   CODE_XML_MOTOR_TYPE , CODE_XML_SEQUENCE_NAME }
enum	vpXmlCodeSequenceType { SEQUENCE_OK , SEQUENCE_ERROR }

Public Member Functions
	usImageHeaderXmlParser ()
virtual	~usImageHeaderXmlParser ()
us::usImageHeader const	getImageHeader ()
std::string	getSequenceFileName () const
void	setImageHeader (const us::usImageHeader imageHeader)
void	setSequenceFileName (const std::string sequence_name)

Protected Member Functions
void	readMainClass (xmlDocPtr doc, xmlNodePtr node)
void	writeMainClass (xmlNodePtr node)

Detailed Description

Input/output operations between ultrasound image header and the associated xml files. Used for virtual server.

Definition at line 58 of file usImageHeaderXmlParser.h.

Member Enumeration Documentation

vpXmlCodeSequenceType

enum usImageHeaderXmlParser::vpXmlCodeSequenceType

Enumerator
SEQUENCE_OK
SEQUENCE_ERROR

Definition at line 90 of file usImageHeaderXmlParser.h.

vpXmlCodeType

enum usImageHeaderXmlParser::vpXmlCodeType

Enumerator
CODE_XML_BAD
CODE_XML_FRAME_COUNT
CODE_XML_TIME_STAMP
CODE_XML_DATA_RATE
CODE_XML_DATA_LENGTH
CODE_XML_SAMPLE_SIZE
CODE_XML_IMAGE_TYPE
CODE_XML_FRAME_WITH
CODE_XML_FRAME_HEIGHT
CODE_XML_PIXEL_WIDTH
CODE_XML_PIXEL_HEIGHT
CODE_XML_TRANSMIT_FRQUENCY
CODE_XML_SAMPLING_FREQUENCY
CODE_XML_TRANSDUCER_RADIUS
CODE_XML_SCANLINE_PITCH
CODE_XML_SCANLINE_NUMBER
CODE_XML_IMAGE_DEPTH
CODE_XML_ANGLE_PER_FRAME
CODE_XML_FRAME_PER_VOLUME
CODE_XML_MOTOR_RADIUS
CODE_XML_MOTOR_TYPE
CODE_XML_SEQUENCE_NAME

Definition at line 64 of file usImageHeaderXmlParser.h.

Constructor & Destructor Documentation

usImageHeaderXmlParser()

usImageHeaderXmlParser::usImageHeaderXmlParser

(

)

Default constructor.

Definition at line 45 of file usImageHeaderXmlParser.cpp.

References CODE_XML_ANGLE_PER_FRAME, CODE_XML_DATA_LENGTH, CODE_XML_DATA_RATE, CODE_XML_FRAME_COUNT, CODE_XML_FRAME_HEIGHT, CODE_XML_FRAME_PER_VOLUME, CODE_XML_FRAME_WITH, CODE_XML_IMAGE_DEPTH, CODE_XML_IMAGE_TYPE, CODE_XML_MOTOR_RADIUS, CODE_XML_MOTOR_TYPE, CODE_XML_PIXEL_HEIGHT, CODE_XML_PIXEL_WIDTH, CODE_XML_SAMPLE_SIZE, CODE_XML_SAMPLING_FREQUENCY, CODE_XML_SCANLINE_NUMBER, CODE_XML_SCANLINE_PITCH, CODE_XML_SEQUENCE_NAME, CODE_XML_TIME_STAMP, CODE_XML_TRANSDUCER_RADIUS, and CODE_XML_TRANSMIT_FRQUENCY.

~usImageHeaderXmlParser()

usImageHeaderXmlParser::~usImageHeaderXmlParser ( )

virtual

Destructor.

Definition at line 73 of file usImageHeaderXmlParser.cpp.

Member Function Documentation

getImageHeader()

us::usImageHeader const usImageHeaderXmlParser::getImageHeader ( )

inline

Definition at line 93 of file usImageHeaderXmlParser.h.

getSequenceFileName()

std::string usImageHeaderXmlParser::getSequenceFileName ( ) const

inline

Definition at line 94 of file usImageHeaderXmlParser.h.

readMainClass()

void usImageHeaderXmlParser::readMainClass ( xmlDocPtr  doc, xmlNodePtr  node  )

protected

Reading method, called by vpXmlParser::parse().

Parameters

doc	a pointer representing the document
node	: the root node of the document

Definition at line 80 of file usImageHeaderXmlParser.cpp.

References us::usImageHeader::anglePerFr, CODE_XML_ANGLE_PER_FRAME, CODE_XML_DATA_LENGTH, CODE_XML_DATA_RATE, CODE_XML_FRAME_COUNT, CODE_XML_FRAME_HEIGHT, CODE_XML_FRAME_PER_VOLUME, CODE_XML_FRAME_WITH, CODE_XML_IMAGE_DEPTH, CODE_XML_IMAGE_TYPE, CODE_XML_MOTOR_RADIUS, CODE_XML_MOTOR_TYPE, CODE_XML_PIXEL_HEIGHT, CODE_XML_PIXEL_WIDTH, CODE_XML_SAMPLE_SIZE, CODE_XML_SAMPLING_FREQUENCY, CODE_XML_SCANLINE_NUMBER, CODE_XML_SCANLINE_PITCH, CODE_XML_SEQUENCE_NAME, CODE_XML_TIME_STAMP, CODE_XML_TRANSDUCER_RADIUS, CODE_XML_TRANSMIT_FRQUENCY, us::usImageHeader::dataLength, us::usImageHeader::dataRate, us::usImageHeader::frameCount, us::usImageHeader::frameHeight, us::usImageHeader::framesPerVolume, us::usImageHeader::frameWidth, us::usImageHeader::imageDepth, us::usImageHeader::imageType, us::usImageHeader::motorRadius, us::usImageHeader::motorType, us::usImageHeader::pixelHeight, us::usImageHeader::pixelWidth, us::usImageHeader::samplingFrequency, us::usImageHeader::scanLineNumber, us::usImageHeader::scanLinePitch, us::usImageHeader::ss, us::usImageHeader::timeStamp, us::usImageHeader::transducerRadius, and us::usImageHeader::transmitFrequency.

setImageHeader()

void usImageHeaderXmlParser::setImageHeader ( const us::usImageHeader  imageHeader )

inline

Definition at line 97 of file usImageHeaderXmlParser.h.

setSequenceFileName()

void usImageHeaderXmlParser::setSequenceFileName ( const std::string  sequence_name )

inline

Definition at line 98 of file usImageHeaderXmlParser.h.

writeMainClass()

void usImageHeaderXmlParser::writeMainClass ( xmlNodePtr  node )

protected

Writing method, called by vpXmlParser::save().

Parameters

node	: the root node of the document

Definition at line 163 of file usImageHeaderXmlParser.cpp.

References us::usImageHeader::anglePerFr, us::usImageHeader::dataLength, us::usImageHeader::dataRate, us::usImageHeader::frameCount, us::usImageHeader::frameHeight, us::usImageHeader::framesPerVolume, us::usImageHeader::frameWidth, us::usImageHeader::imageDepth, us::usImageHeader::imageType, us::usImageHeader::motorRadius, us::usImageHeader::motorType, us::usImageHeader::pixelHeight, us::usImageHeader::pixelWidth, us::usImageHeader::samplingFrequency, us::usImageHeader::scanLineNumber, us::usImageHeader::scanLinePitch, us::usImageHeader::ss, us::usImageHeader::timeStamp, us::usImageHeader::transducerRadius, and us::usImageHeader::transmitFrequency.