Print

Print


Author: [log in to unmask]
Date: Tue May 17 17:47:24 2016
New Revision: 4360

Log:
Minor cleanup.

Modified:
    java/branches/HPSJAVA-409/detector-model/src/main/java/org/hps/detector/ecal/CrystalRange.java
    java/branches/HPSJAVA-409/detector-model/src/main/java/org/hps/detector/ecal/CrystalTaitBryanAngleCalculator.java
    java/branches/HPSJAVA-409/detector-model/src/main/java/org/hps/detector/ecal/EcalCrystal.java
    java/branches/HPSJAVA-409/detector-model/src/main/java/org/hps/detector/ecal/GVector.java
    java/branches/HPSJAVA-409/detector-model/src/main/java/org/hps/detector/ecal/Geant4Position.java
    java/branches/HPSJAVA-409/detector-model/src/main/java/org/hps/detector/ecal/HPSEcalDetectorElement.java
    java/branches/HPSJAVA-409/detector-model/src/main/java/org/hps/detector/ecal/StatFunUtils.java

Modified: java/branches/HPSJAVA-409/detector-model/src/main/java/org/hps/detector/ecal/CrystalRange.java
 =============================================================================
--- java/branches/HPSJAVA-409/detector-model/src/main/java/org/hps/detector/ecal/CrystalRange.java	(original)
+++ java/branches/HPSJAVA-409/detector-model/src/main/java/org/hps/detector/ecal/CrystalRange.java	Tue May 17 17:47:24 2016
@@ -2,6 +2,11 @@
 
 import org.jdom.Element;
 
+/**
+ * Simplistic representation of a range of ECal XY crystal indices.
+ * 
+ * @author Jeremy McCormick
+ */
 public class CrystalRange {
 
     int xIndexMax;

Modified: java/branches/HPSJAVA-409/detector-model/src/main/java/org/hps/detector/ecal/CrystalTaitBryanAngleCalculator.java
 =============================================================================
--- java/branches/HPSJAVA-409/detector-model/src/main/java/org/hps/detector/ecal/CrystalTaitBryanAngleCalculator.java	(original)
+++ java/branches/HPSJAVA-409/detector-model/src/main/java/org/hps/detector/ecal/CrystalTaitBryanAngleCalculator.java	Tue May 17 17:47:24 2016
@@ -6,15 +6,12 @@
 
 
 /**
- * Calculates Euler(actually Tait-Bryan) angles for a rotation, that transfers the crystal from it's initial
- * state-parallel to Z axis To final state-defined by 2 center points in front and back faces of the crystal.
- * for information about Tait-Bryan angles look here: http://sedris.org/wg8home/Documents/WG80485.pdf
+ * Calculates Euler (actually Tait-Bryan) angles for a rotation which transfers the crystal from it's initial
+ * state parallel to the Z axis into the center position defined by the center points of the front and back faces.
+ * <p>
+ * For information about Tait-Bryan angles <a href="http://sedris.org/wg8home/Documents/WG80485.pdf">look here</a>. 
  * 
- * phi - rotation angle around x
- * theta - rotation angle around y
- * psi - rotation angle around z
- * 
- * @author Annie Simonyan [log in to unmask]
+ * @author Annie Simonyan
  */
 class CrystalTaitBryanAngleCalculator {
     
@@ -22,7 +19,7 @@
     private double theta = 0;
     private final double psi = 0;
 
-    // final state vector
+    /* Vector representing final position. */
     private GVector fin; 
 
     private double sinTheta = 0;

Modified: java/branches/HPSJAVA-409/detector-model/src/main/java/org/hps/detector/ecal/EcalCrystal.java
 =============================================================================
--- java/branches/HPSJAVA-409/detector-model/src/main/java/org/hps/detector/ecal/EcalCrystal.java	(original)
+++ java/branches/HPSJAVA-409/detector-model/src/main/java/org/hps/detector/ecal/EcalCrystal.java	Tue May 17 17:47:24 2016
@@ -12,7 +12,8 @@
 
 /**
  * This class implements the geometry API for ECal crystals in the HPS experiment. 
- * @author Jeremy McCormick <[log in to unmask]>
+ * 
+ * @author Jeremy McCormick
  */
 public class EcalCrystal extends DetectorElement {
     

Modified: java/branches/HPSJAVA-409/detector-model/src/main/java/org/hps/detector/ecal/GVector.java
 =============================================================================
--- java/branches/HPSJAVA-409/detector-model/src/main/java/org/hps/detector/ecal/GVector.java	(original)
+++ java/branches/HPSJAVA-409/detector-model/src/main/java/org/hps/detector/ecal/GVector.java	Tue May 17 17:47:24 2016
@@ -6,7 +6,7 @@
  * Defines a vector in (XYZ) coordinate system as a geometrical object.
  * This class is similar to HepVector 
  * 
- * CrystalTaitBryanAngleCalculator.java
+ * @author Annie Simonyan
  */
 public class GVector {
 

Modified: java/branches/HPSJAVA-409/detector-model/src/main/java/org/hps/detector/ecal/Geant4Position.java
 =============================================================================
--- java/branches/HPSJAVA-409/detector-model/src/main/java/org/hps/detector/ecal/Geant4Position.java	(original)
+++ java/branches/HPSJAVA-409/detector-model/src/main/java/org/hps/detector/ecal/Geant4Position.java	Tue May 17 17:47:24 2016
@@ -12,7 +12,7 @@
  * theta-rotation around Y
  * psi-rotation around Z
  * 
- * @author Annie Simonyan [log in to unmask]
+ * @author Annie Simonyan
  */
 public class Geant4Position {
     

Modified: java/branches/HPSJAVA-409/detector-model/src/main/java/org/hps/detector/ecal/HPSEcalDetectorElement.java
 =============================================================================
--- java/branches/HPSJAVA-409/detector-model/src/main/java/org/hps/detector/ecal/HPSEcalDetectorElement.java	(original)
+++ java/branches/HPSJAVA-409/detector-model/src/main/java/org/hps/detector/ecal/HPSEcalDetectorElement.java	Tue May 17 17:47:24 2016
@@ -16,7 +16,6 @@
 import org.lcsim.detector.identifier.IIdentifierHelper;
 
 /**
- * <p>
  * This is an implementation of a basic geometry API for the HPS ECAL.
  * <p>
  * The neighboring API and conventions are based on the page 7 diagram from the 

Modified: java/branches/HPSJAVA-409/detector-model/src/main/java/org/hps/detector/ecal/StatFunUtils.java
 =============================================================================
--- java/branches/HPSJAVA-409/detector-model/src/main/java/org/hps/detector/ecal/StatFunUtils.java	(original)
+++ java/branches/HPSJAVA-409/detector-model/src/main/java/org/hps/detector/ecal/StatFunUtils.java	Tue May 17 17:47:24 2016
@@ -7,9 +7,9 @@
  */
 class StatFunUtils {
 
-    /*****
+    /**
      * Function for double to round up the arg. value to 'places' digits after the semicolon 
-     ******/
+     */
     public static double round(double value, int places) {
         if (places < 0 || places > 16) {
             throw new IllegalArgumentException();