org.lcsim.geometry.compact.converter

Class SurveyVolume

java.lang.Object

org.lcsim.geometry.compact.converter.SurveyVolume

Direct Known Subclasses:

CompactSurveyVolume, HPSTestRunTracker2014GeometryDefinition.ActiveSensor, HPSTestRunTracker2014GeometryDefinition.BaseModule, HPSTestRunTracker2014GeometryDefinition.BasePlate, HPSTestRunTracker2014GeometryDefinition.CSupport, HPSTestRunTracker2014GeometryDefinition.HalfModuleComponent, HPSTestRunTracker2014GeometryDefinition.SupportBottom, HPSTestRunTracker2014GeometryDefinition.SupportPlate, HPSTestRunTracker2014GeometryDefinition.SupportTop, HPSTestRunTracker2014GeometryDefinition.TestRunColdBlock, HPSTestRunTracker2014GeometryDefinition.TrackerEnvelope, HPSTracker2014GeometryDefinition.PSVacuumChamber, HPSTracker2014GeometryDefinition.SupportRing, HPSTracker2014GeometryDefinition.SupportRingL13KinMount, HPSTracker2014GeometryDefinition.SvtBox, HPSTracker2014GeometryDefinition.SvtBoxBasePlate, HPSTracker2014GeometryDefinition.UChannelL13, HPSTracker2014GeometryDefinition.UChannelL46, HPSTracker2014GeometryDefinition.UChannelPlate, HPSTracker2017GeometryDefinition.ActiveShortSensor, HPSTracker2019GeometryDefinition.ActiveShortSensor, HPSTrackerGeometryDefinition.TrackingVolume

public abstract class SurveyVolume
extends Object

Contains the geometry information that is used to build any volume.

Field Summary

Fields

Modifier and Type	Field and Description
private AlignmentCorrection	alignmentCorrections
protected Hep3Vector	ballPos
private Hep3Vector	boxDim
private Hep3Vector	center
private SurveyCoordinateSystem	coord
protected boolean	debug
protected Hep3Vector	flatPos
private String	material
private SurveyVolume	mother
private String	name
protected List<SurveyVolume>	referenceGeom
protected Hep3Vector	veePos

Constructor Summary

Constructors

Constructor and Description
SurveyVolume(String name, SurveyVolume m, AlignmentCorrection alignmentCorrection)
SurveyVolume(String name, SurveyVolume m, AlignmentCorrection alignmentCorrection, List<SurveyVolume> ref)
SurveyVolume(String name, SurveyVolume m, AlignmentCorrection alignmentCorrection, SurveyVolume ref)

Method Summary

Modifier and Type	Method and Description
void	addReferenceGeom(List<SurveyVolume> refGeomList)
void	addReferenceGeom(SurveyVolume refGeom)
protected void	applyGenericCoordinateSystemCorrections() Apply a generic correction to the coordinate system of this volume.
private void	applyLocalAlignmentCorrections() Apply @link AlignmentCorrection to the volume if they are supplied.
protected void	applyReferenceTransformation() Applies a user supplied reference transformation to the module.
private void	applySurvey(org.jdom.Element node)
Hep3Vector	getBallPos()
Hep3Vector	getBoxDim()
Hep3Vector	getCenter()
SurveyCoordinateSystem	getCoord()
Hep3Vector	getFlatPos()
String	getMaterial()
SurveyVolume	getMother()
String	getName()
Hep3Vector	getVeePos()
protected void	init() Initialize the volume.
void	printSurveyPos()
private void	setAlignmentCorrection(AlignmentCorrection alignmentCorrection)
void	setBallPos(double x, double y, double z)
protected abstract void	setBoxDim()
void	setBoxDim(double x, double y, double z)
protected abstract void	setCenter()
void	setCenter(double x, double y, double z)
void	setCenter(Hep3Vector center)
void	setCoord()
void	setFlatPos(double x, double y, double z)
void	setMaterial(String material)
void	setMother(SurveyVolume mother)
void	setName(String name)
protected abstract void	setPos()
void	setVeePos(double x, double y, double z)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

debug

protected boolean debug

name

private String name

material

private String material

mother

private SurveyVolume mother

referenceGeom

protected List<SurveyVolume> referenceGeom

coord

private SurveyCoordinateSystem coord

ballPos

protected Hep3Vector ballPos

veePos

protected Hep3Vector veePos

flatPos

protected Hep3Vector flatPos

center

private Hep3Vector center

boxDim

private Hep3Vector boxDim

alignmentCorrections

private AlignmentCorrection alignmentCorrections

Constructor Detail

SurveyVolume

public SurveyVolume(String name,
                    SurveyVolume m,
                    AlignmentCorrection alignmentCorrection)

SurveyVolume

public SurveyVolume(String name,
                    SurveyVolume m,
                    AlignmentCorrection alignmentCorrection,
                    SurveyVolume ref)

SurveyVolume

public SurveyVolume(String name,
                    SurveyVolume m,
                    AlignmentCorrection alignmentCorrection,
                    List<SurveyVolume> ref)

Method Detail

setPos

protected abstract void setPos()

setCenter

protected abstract void setCenter()

setBoxDim

protected abstract void setBoxDim()

init

protected void init()

Initialize the volume. This needs to be called at the top level implementation of the SurveyVolume to properly setup the coordinate systems. It takes care of applying user supplied custom transformations and alignment corrections in the order given in the function below. That order must be preserved to get a uniform behavior.

applySurvey

private void applySurvey(org.jdom.Element node)

applyGenericCoordinateSystemCorrections

protected void applyGenericCoordinateSystemCorrections()

Apply a generic correction to the coordinate system of this volume.

applyReferenceTransformation

protected void applyReferenceTransformation()

Applies a user supplied reference transformation to the module. This is convenient as it allows for intermediary "virtual" mother volumes to be used in referencing a volume to it's physcial mother volume.

applyLocalAlignmentCorrections

private void applyLocalAlignmentCorrections()

Apply @link AlignmentCorrection to the volume if they are supplied.

setAlignmentCorrection

private void setAlignmentCorrection(AlignmentCorrection alignmentCorrection)

setBallPos

public void setBallPos(double x,
                       double y,
                       double z)

setVeePos

public void setVeePos(double x,
                      double y,
                      double z)

setFlatPos

public void setFlatPos(double x,
                       double y,
                       double z)

getBallPos

public Hep3Vector getBallPos()

getVeePos

public Hep3Vector getVeePos()

getFlatPos

public Hep3Vector getFlatPos()

setCoord

public void setCoord()

getCoord

public SurveyCoordinateSystem getCoord()

getName

public String getName()

setName

public void setName(String name)

getCenter

public Hep3Vector getCenter()

setCenter

public void setCenter(Hep3Vector center)

setCenter

public void setCenter(double x,
                      double y,
                      double z)

getBoxDim

public Hep3Vector getBoxDim()

setBoxDim

public void setBoxDim(double x,
                      double y,
                      double z)

getMother

public SurveyVolume getMother()

setMother

public void setMother(SurveyVolume mother)

addReferenceGeom

public void addReferenceGeom(SurveyVolume refGeom)

addReferenceGeom

public void addReferenceGeom(List<SurveyVolume> refGeomList)

printSurveyPos

public void printSurveyPos()

getMaterial

public String getMaterial()

setMaterial

public void setMaterial(String material)

toString

public String toString()

Overrides:

toString in class Object