org.lcsim.geometry.compact.converter.lcdd

Class Hodoscope_v1

java.lang.Object

org.lcsim.geometry.compact.Subdetector

org.lcsim.geometry.compact.converter.lcdd.LCDDSubdetector

org.lcsim.geometry.compact.converter.lcdd.Hodoscope_v1

All Implemented Interfaces:

org.lcsim.geometry.Subdetector

public class Hodoscope_v1
extends org.lcsim.geometry.compact.converter.lcdd.LCDDSubdetector

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	Hodoscope_v1.PixelParameters

Field Summary

Fields

Modifier and Type	Field and Description
private static int	BOTTOM Specifies the bottom portion hodoscope layers.
private static double	BUFFER_DEPTH Defines the distance between the forward and rear layers that is to be left open in order to allow for a buffer material.
private static double	BUFFER_WIDTH
private static double	BUFFER_X
private static double	COVER_DEPTH Specifies the default size in the z-direction of the hodoscope scintillator cover material.
private static int	LAYER1 Specifies the front (closest to the SVT) hodoscope layer.
private static int	LAYER2 Specifies the rear (closest to the calorimeter) hodoscope layer.
private static double	PIXEL_DEPTH Specifies the default size in the z-direction of the hodoscope scintillators.
private static double	PIXEL_HEIGHT Specifies the default size in the y-direction of the hodoscope scintillators.
private static org.lcsim.geometry.compact.converter.lcdd.util.Rotation	PIXEL_ROTATION Defines the rotation used by all hodoscope pixels.
private double[][][]	positionValues Specifies the displacements for each element of the hodoscope.
private static double	REFLECTOR_DEPTH Specifies the default thickness of the hodoscope scintillator reflector material.
private static int	TOP Specifies the top portion hodoscope layers.
private double[][]	widths Specifies for the widths for each pixel of the hodoscope layers.
private static int	X Specifies the displacement of an element in the x-axis.
private static double	X_SHIFT Specifies the global shift needed to align geometry with the calorimeter face in the x-direction, as the calorimeter center does not occur at x = 0 mm.
private static int	Y Specifies the displacement of an element in the y-axis.
private static int	Z Specifies the displacement of an element in the z-axis.

Fields inherited from class org.lcsim.geometry.compact.converter.lcdd.LCDDSubdetector

layers, node

Constructor Summary

Constructors

Constructor and Description
Hodoscope_v1(org.jdom.Element node)

Method Summary

Modifier and Type	Method and Description
(package private) void	addToLCDD(org.lcsim.geometry.compact.converter.lcdd.util.LCDD lcdd, org.lcsim.geometry.compact.converter.lcdd.util.SensitiveDetector sens)
private static double[]	getDoubleArrayVariable(org.jdom.Element root, String varName)
private static double	getDoubleVariable(org.jdom.Element root, String varName) Gets the value specified from the variable element of the detector compact.xml description.
private static org.lcsim.geometry.compact.converter.lcdd.util.Material	getMaterialVariable(org.lcsim.geometry.compact.converter.lcdd.util.LCDD lcdd, org.jdom.Element root, String varName) Reads the name of a material from the specified variable node in the parent node root and attempts to obtain the material definition from the LCDD file lcdd.
private static String	getName(int layer, int topBot, int ix) Defines a unique name for a hodoscope pixel based on its layer, whether it is a top or bottom pixel, and its x-index.
boolean	isCalorimeter()
private void	makePixel(org.lcsim.geometry.compact.converter.lcdd.util.LCDD lcdd, org.lcsim.geometry.compact.converter.lcdd.util.SensitiveDetector sens, Hodoscope_v1.PixelParameters params, int layer, int topBot, int ix, double pixelWidth, double xShift)

Methods inherited from class org.lcsim.geometry.compact.converter.lcdd.LCDDSubdetector

getElement, setAttributes, setCombineHits, setLimitSet, setRegion, setVisAttributes

Methods inherited from class org.lcsim.geometry.compact.Subdetector

getDetectorElement, getDigiHitsCollectionName, getHitsCollectionName, getIDDecoder, getLayering, getName, getNode, getReadout, getReflect, getSystemID, getVisAttributes, isBarrel, isEndcap, isInsideTrackingVolume, isLayered, isTracker, setDetectorElement, setDigiHitsCollectionName, setReadout, setVisAttributes, transformLocalToGlobal

Methods inherited from class java.lang.Object

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

Field Detail

BUFFER_DEPTH

private static final double BUFFER_DEPTH

Defines the distance between the forward and rear layers that is to be left open in order to allow for a buffer material. The rear layer will start at a position zLayer1 + depthLayer1 + layerBuffer.

See Also:

Constant Field Values

BUFFER_WIDTH

private static final double BUFFER_WIDTH

See Also:

Constant Field Values

BUFFER_X

private static final double BUFFER_X

See Also:

Constant Field Values

positionValues

private double[][][] positionValues

Specifies the displacements for each element of the hodoscope. It is possible to specify displacements for each layer, further sub-divided into the top and bottom portions. All of the units are millimeters.

The first array index specifies the layer, and can be accessed via the static class variables LAYER1 or LAYER2. The second index specifies the half of the detector, top or bottom, to which the displacement refers. This can be defined using the static class variables TOP or BOTTOM. Lastly, the third index specifies the coordinate axis in which the displacement applies. This can be defined by the static class variables X, Y, or Z.

LAYER1

private static final int LAYER1

Specifies the front (closest to the SVT) hodoscope layer.

See Also:

Constant Field Values

LAYER2

private static final int LAYER2

Specifies the rear (closest to the calorimeter) hodoscope layer.

See Also:

Constant Field Values

TOP

private static final int TOP

Specifies the top portion hodoscope layers.

See Also:

Constant Field Values

BOTTOM

private static final int BOTTOM

Specifies the bottom portion hodoscope layers.

See Also:

Constant Field Values

X

private static final int X

Specifies the displacement of an element in the x-axis. This defines the point where the edge of the element closest to the calorimeter center begins.

See Also:

Constant Field Values

Y

private static final int Y

Specifies the displacement of an element in the y-axis. This defines the point where the edge of the element closest to the beam gap center begins.

See Also:

Constant Field Values

Z

private static final int Z

Specifies the displacement of an element in the z-axis. This defines the point where the forward (SVT-facing) edge of the element begins.

See Also:

Constant Field Values

PIXEL_HEIGHT

private static final double PIXEL_HEIGHT

Specifies the default size in the y-direction of the hodoscope scintillators. Units are in millimeters.

See Also:

Constant Field Values

PIXEL_DEPTH

private static final double PIXEL_DEPTH

Specifies the default size in the z-direction of the hodoscope scintillators. Units are in millimeters.

See Also:

Constant Field Values

COVER_DEPTH

private static final double COVER_DEPTH

Specifies the default size in the z-direction of the hodoscope scintillator cover material. Units are in millimeters.

See Also:

Constant Field Values

REFLECTOR_DEPTH

private static final double REFLECTOR_DEPTH

Specifies the default thickness of the hodoscope scintillator reflector material. Units are in millimeters.

See Also:

Constant Field Values

widths

private double[][] widths

Specifies for the widths for each pixel of the hodoscope layers. The top and bottom layers are taken to have the same number of pixels of the same widths.

X_SHIFT

private static final double X_SHIFT

Specifies the global shift needed to align geometry with the calorimeter face in the x-direction, as the calorimeter center does not occur at x = 0 mm.

See Also:

Constant Field Values

PIXEL_ROTATION

private static final org.lcsim.geometry.compact.converter.lcdd.util.Rotation PIXEL_ROTATION

Defines the rotation used by all hodoscope pixels.

Constructor Detail

Hodoscope_v1

Hodoscope_v1(org.jdom.Element node)
      throws org.jdom.JDOMException

Throws:

org.jdom.JDOMException

Method Detail

addToLCDD

void addToLCDD(org.lcsim.geometry.compact.converter.lcdd.util.LCDD lcdd,
               org.lcsim.geometry.compact.converter.lcdd.util.SensitiveDetector sens)
        throws org.jdom.JDOMException

Specified by:

addToLCDD in class org.lcsim.geometry.compact.converter.lcdd.LCDDSubdetector

Throws:

org.jdom.JDOMException

getDoubleVariable

private static final double getDoubleVariable(org.jdom.Element root,
                                              String varName)
                                       throws org.jdom.DataConversionException,
                                              RuntimeException

Gets the value specified from the variable element of the detector compact.xml description. Note that it is required for the variable to declared in the format

<VAR_NAME value="DOUBLE_VALUE"/>

If the specified variable node does not exist as a child of the parent node root, a value of Double.NaN is returned instead.

Parameters:

root - - The detector XML node which serves as a parent to the variable nodes.

varName - - The String name of the variables.

Returns:

Returns the variable, if the node exists. Otherwise, a value of Double.NaN is returned.

Throws:

org.jdom.DataConversionException - Occurs if the value defined is not convertible to a double primitive.

RuntimeException - Occurs if the variable node exists, but is missing the necessary value attribute.

getDoubleArrayVariable

private static final double[] getDoubleArrayVariable(org.jdom.Element root,
                                                     String varName)
                                              throws IllegalArgumentException,
                                                     NumberFormatException

Throws:

IllegalArgumentException

NumberFormatException

getMaterialVariable

private static final org.lcsim.geometry.compact.converter.lcdd.util.Material getMaterialVariable(org.lcsim.geometry.compact.converter.lcdd.util.LCDD lcdd,
                                                                                                 org.jdom.Element root,
                                                                                                 String varName)
                                                                                          throws org.jdom.JDOMException,
                                                                                                 RuntimeException

Reads the name of a material from the specified variable node in the parent node root and attempts to obtain the material definition from the LCDD file lcdd. If it exists, the material object is returned. Otherwise, a value of null is returned.

Parameters:

lcdd - - The LCDD file object, in which the material data definition may be found.

root - - The detector XML node which serves as a parent to the variable nodes.

varName - - The String name of the variables.

Returns:

Returns a Material object if the variable requested exists. Otherwise, null will be returned.

Throws:

org.jdom.JDOMException - Occurs if there is an error accessing the material definition from the LCDD file.

RuntimeException - Occurs if the material declaration attribute in the XML is missing.

getName

private static final String getName(int layer,
                                    int topBot,
                                    int ix)

Defines a unique name for a hodoscope pixel based on its layer, whether it is a top or bottom pixel, and its x-index.

Parameters:

layer - - The layer of the hodoscope for which this UID is to correspond. This can only be defined as either of the values LAYER1 or LAYER2.

topBottom - - Whether this UID corresponds to the top or the bottom section of the hodoscope. This can only be defined as one of the two variables TOP or BOTTOM.

ix - - The x-index for the pixel. This must be an integer value that is non-negative.

Returns:

Returns a unique identifier string.

makePixel

private final void makePixel(org.lcsim.geometry.compact.converter.lcdd.util.LCDD lcdd,
                             org.lcsim.geometry.compact.converter.lcdd.util.SensitiveDetector sens,
                             Hodoscope_v1.PixelParameters params,
                             int layer,
                             int topBot,
                             int ix,
                             double pixelWidth,
                             double xShift)

isCalorimeter

public boolean isCalorimeter()

Specified by:

isCalorimeter in interface org.lcsim.geometry.Subdetector

Overrides:

isCalorimeter in class org.lcsim.geometry.compact.Subdetector