#include <svkSatBandsXML.h>

Inheritance diagram for svkSatBandsXML:

Public Member Functions
	vtkTypeMacro (svkSatBandsXML, vtkObject)

int	SetXMLFileName (vtkstd::string xmlFileName)

int	ParseXML (vtkXMLDataElement *satBandsElement)

vtkstd::string	GetXMLFileName ()

void	ClearXMLFile ()

void	SetVerbose (bool isVerbose)

int	GetNumberOfPressBoxSats ()

int	GetNumberOfAutoSats ()

int	GetXMLVersion ()

void	GetPressBoxSat (int satNumber, string label, float normalX, float normalY, float normalZ, float thickness, float distance)

int	GetAutoSat (int satNumber, string label, float normal[3], float thickness, float *distance)

int	GetAutoSat (int satNumber, string label, float normalX, float normalY, float normalZ, float thickness, float distance)

void	GetPRESSBoxParameters (float pressOrigin[3], float pressThickness[3], float pressAngles[3])

int	GetAutoSatParameters (int satNumber, float normal[3], float thickness, float distance)

int	ConvertDatToXML (string rootName)

int	ConvertDatToXML2 (string rootName)

vtkXMLDataElement *	GetXMLDataElement ()

void	WriteXMLFile (string xmlFileName)

Static Public Member Functions
static svkSatBandsXML *	New ()

Protected Member Functions
	svkSatBandsXML ()

	~svkSatBandsXML ()

Detailed Description

Class to manage IO to/from XML representation of sat bands.

The sat band file contains 2 elements, 1 for PRESS, one for auto-sats. Each of these is comprised of a sat band definition:

normal_x normal_y normal_z thickness distance_from_origin

the normal is defined as the normal from the origin to the center of the band
the thickness is the thicness of the band
the distance from the origin defined how far along the normal vector the center of the band is.

Constructor & Destructor Documentation

svkSatBandsXML ( )

protected

~svkSatBandsXML ( )

protected

Member Function Documentation

void ClearXMLFile ( )

Sets the current XML data to NULL so the file will be re-read.

Referenced by svkSatBandsXML::ParseXML().

int ConvertDatToXML ( string rootName )

Referenced by svkGEPFileMapperUCSF::InitSatBandsFromXML().

int ConvertDatToXML2 ( string rootName )

int GetAutoSat	(	int	satNumber,
		string *	label,
		float	normal[3],
		float *	thickness,
		float *	distance
	)

Get the specified sat band definition:

Referenced by svkSatBandsXML::GetAutoSatParameters(), and svkGEPFileMapperUCSF::InitSatBandsFromXML().

int GetAutoSat	(	int	satNumber,
		string *	label,
		float *	normalX,
		float *	normalY,
		float *	normalZ,
		float *	thickness,
		float *	distance
	)

Get the specified sat band definition: Normal thickness of band distance along normal from origin to center of plane SatNumber starts at 1 (element ID)

References svkSatBandsXML::GetNumberOfAutoSats(), and svkTypeUtils::IntToString().

int GetAutoSatParameters	(	int	satNumber,
		float	normal[3],
		float *	thickness,
		float *	distance
	)

References svkSatBandsXML::GetAutoSat().

int GetNumberOfAutoSats ( )

Referenced by svkSatBandsXML::GetAutoSat(), and svkGEPFileMapperUCSF::InitSatBandsFromXML().

int GetNumberOfPressBoxSats ( )

void GetPRESSBoxParameters	(	float	pressOrigin[3],
		float	pressThickness[3],
		float	pressAngles[3]
	)

Given the xml press box definition, extract the location, thickness and orientation of the box for use by the PSD. Since this is the only difference between the versions, no new classes are used.