Author: [log in to unmask] Date: Thu Mar 10 17:32:07 2016 New Revision: 4286 Log: [HPSJAVA-621] Fix javadoc warnings in core modules. Modified: java/trunk/analysis/src/main/java/org/hps/analysis/ecal/cosmic/DualThresholdSignalFitDriver.java java/trunk/analysis/src/main/java/org/hps/analysis/ecal/cosmic/RawModeHitSelectionDriver.java java/trunk/analysis/src/main/java/org/hps/analysis/trigger/DataTriggerSimDriver.java java/trunk/analysis/src/main/java/org/hps/analysis/trigger/data/DiagnosticSnapshot.java java/trunk/analysis/src/main/java/org/hps/analysis/trigger/data/TriggerDiagStats.java java/trunk/analysis/src/main/java/org/hps/analysis/trigger/data/TriggerEvent.java java/trunk/analysis/src/main/java/org/hps/analysis/trigger/data/TriggerStatModule.java java/trunk/analysis/src/main/java/org/hps/analysis/trigger/util/Pair.java java/trunk/conditions/src/main/java/org/hps/conditions/ConditionsDriver.java java/trunk/conditions/src/main/java/org/hps/conditions/api/BaseConditionsObject.java java/trunk/conditions/src/main/java/org/hps/conditions/api/BaseConditionsObjectCollection.java java/trunk/conditions/src/main/java/org/hps/conditions/api/ConditionsObjectCollection.java java/trunk/conditions/src/main/java/org/hps/conditions/api/ConditionsObjectException.java java/trunk/conditions/src/main/java/org/hps/conditions/api/package-info.java java/trunk/conditions/src/main/java/org/hps/conditions/database/AbstractConditionsObjectConverter.java java/trunk/conditions/src/main/java/org/hps/conditions/database/ConditionsTagConverter.java java/trunk/conditions/src/main/java/org/hps/conditions/database/DatabaseConditionsManager.java java/trunk/conditions/src/main/java/org/hps/conditions/database/package-info.java java/trunk/conditions/src/main/java/org/hps/conditions/ecal/EcalConditions.java java/trunk/conditions/src/main/java/org/hps/conditions/ecal/EcalConditionsConverter.java java/trunk/conditions/src/main/java/org/hps/conditions/ecal/TestRunEcalConditionsConverter.java java/trunk/conditions/src/main/java/org/hps/conditions/package-info.java java/trunk/conditions/src/main/java/org/hps/conditions/svt/AbstractSvtDaqMapping.java java/trunk/conditions/src/main/java/org/hps/conditions/svt/DaqMapHandler.java java/trunk/conditions/src/main/java/org/hps/conditions/svt/OpeningAngleLoader.java java/trunk/conditions/src/main/java/org/hps/conditions/svt/SvtDaqMapping.java java/trunk/conditions/src/main/java/org/hps/conditions/svt/SvtT0Shift.java java/trunk/conditions/src/main/java/org/hps/conditions/svt/TestRunSvtChannel.java java/trunk/conditions/src/main/java/org/hps/conditions/svt/TestRunSvtConditions.java java/trunk/conditions/src/main/java/org/hps/conditions/svt/TestRunSvtT0Shift.java java/trunk/crawler/src/main/java/org/hps/crawler/FileMetadataReader.java java/trunk/detector-model/src/main/java/org/lcsim/detector/converter/compact/subdetector/HpsTracker2.java java/trunk/detector-model/src/main/java/org/lcsim/detector/converter/compact/subdetector/SvtStereoLayer.java java/trunk/detector-model/src/main/java/org/lcsim/detector/tracker/silicon/HpsSiSensor.java java/trunk/detector-model/src/main/java/org/lcsim/detector/tracker/silicon/HpsTestRunSiSensor.java java/trunk/detector-model/src/main/java/org/lcsim/geometry/compact/converter/HPSTestRunTracker2014LCDDBuilder.java java/trunk/detector-model/src/main/java/org/lcsim/geometry/compact/converter/HPSTracker2014GeometryDefinition.java java/trunk/detector-model/src/main/java/org/lcsim/geometry/compact/converter/HPSTracker2014v1GeometryDefinition.java java/trunk/detector-model/src/main/java/org/lcsim/geometry/compact/converter/HPSTrackerBuilder.java java/trunk/detector-model/src/main/java/org/lcsim/geometry/compact/converter/LCDDSurveyVolume.java java/trunk/detector-model/src/main/java/org/lcsim/geometry/subdetector/HPSEcal.java java/trunk/detector-model/src/main/java/org/lcsim/geometry/subdetector/HPSEcal3.java java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/io/TextManager.java java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/ui/ActiveViewer.java java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/ui/CalorimeterPanel.java java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/ui/PDataEventViewer.java java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/ui/PassiveViewer.java java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/ui/Viewer.java java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/EcalCalibrationsDriver.java java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/EcalRawConverterDriver.java java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/AbstractClusterer.java java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/ClusterDriver.java java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/ClusterPositionCorrection.java java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/ClusterUtilities.java java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/ClustererFactory.java java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/CopyClusterCollectionDriver.java java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/GTPClusterer.java java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/SimpleCosmicClusterer.java java/trunk/evio/src/main/java/org/hps/evio/AbstractSvtEvioReader.java java/trunk/evio/src/main/java/org/hps/evio/EvioReader.java java/trunk/evio/src/main/java/org/hps/evio/EvioToLcio.java java/trunk/evio/src/main/java/org/hps/evio/LCSimEngRunEventBuilder.java java/trunk/evio/src/main/java/org/hps/evio/SvtEvioReader.java java/trunk/evio/src/main/java/org/hps/evio/TestRunSvtEvioReader.java java/trunk/monitoring-drivers/src/main/java/org/hps/monitoring/ecal/plots/EcalDaqPlots.java java/trunk/monitoring-drivers/src/main/java/org/hps/monitoring/ecal/plots/EcalLedSequenceMonitor.java java/trunk/monitoring-drivers/src/main/java/org/hps/monitoring/ecal/plots/EcalMonitoringPlots.java java/trunk/monitoring-util/src/main/java/org/hps/monitoring/plotting/ExportPdf.java java/trunk/monitoring-util/src/main/java/org/hps/monitoring/subsys/et/package-info.java java/trunk/monitoring-util/src/main/java/org/hps/monitoring/trigger/DiagnosticUpdatable.java java/trunk/recon/src/main/java/org/hps/recon/particle/ReconParticleDriver.java java/trunk/recon/src/main/java/org/hps/recon/utils/TrackClusterMatcher.java java/trunk/record-util/src/main/java/org/hps/record/AbstractRecordQueue.java java/trunk/record-util/src/main/java/org/hps/record/composite/RecordProcessorAdapter.java java/trunk/record-util/src/main/java/org/hps/record/svt/SvtEvioUtils.java java/trunk/record-util/src/main/java/org/hps/record/triggerbank/AbstractIntData.java java/trunk/record-util/src/main/java/org/hps/record/triggerbank/TriggerConfigData.java java/trunk/run-database/src/main/java/org/hps/run/database/EpicsVariable.java java/trunk/tracking/src/main/java/org/hps/readout/svt/FpgaData.java java/trunk/tracking/src/main/java/org/hps/recon/tracking/StrategyType.java java/trunk/tracking/src/main/java/org/hps/recon/tracking/TrackDataDriver.java java/trunk/tracking/src/main/java/org/hps/recon/tracking/TrackQualityData.java java/trunk/tracking/src/main/java/org/hps/recon/tracking/TrackUtils.java java/trunk/tracking/src/main/java/org/hps/recon/tracking/WTrack.java java/trunk/tracking/src/main/java/org/hps/recon/tracking/axial/HelicalTrack2DHit.java java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/FittedGblTrajectory.java java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/GBLStripClusterData.java java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/GBLTrackData.java java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/GblUtils.java java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/HelicalTrackStripGbl.java java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/MakeGblTracks.java java/trunk/tracking/src/main/java/org/hps/recon/tracking/straight/STUtils.java java/trunk/tracking/src/main/java/org/hps/svt/alignment/BuildCompact.java java/trunk/tracking/src/main/java/org/hps/svt/alignment/HPSStrips.java java/trunk/util/src/main/java/org/hps/util/MergeBunches.java Modified: java/trunk/analysis/src/main/java/org/hps/analysis/ecal/cosmic/DualThresholdSignalFitDriver.java ============================================================================= --- java/trunk/analysis/src/main/java/org/hps/analysis/ecal/cosmic/DualThresholdSignalFitDriver.java (original) +++ java/trunk/analysis/src/main/java/org/hps/analysis/ecal/cosmic/DualThresholdSignalFitDriver.java Thu Mar 10 17:32:07 2016 @@ -182,7 +182,7 @@ * Process the event, performing a signal fit for every raw data hit in the input collection. * The hits that pass the sigma selection cut are added to a new hits collection, which can be * converted to a CalorimeterHit collection and then clustered. - * @throw NextEventException if there are not enough hits that pass the selection cut. + * @throws NextEventException if there are not enough hits that pass the selection cut. */ public void process(EventHeader event) { if (event.hasCollection(RawTrackerHit.class, inputHitsCollectionName)) { Modified: java/trunk/analysis/src/main/java/org/hps/analysis/ecal/cosmic/RawModeHitSelectionDriver.java ============================================================================= --- java/trunk/analysis/src/main/java/org/hps/analysis/ecal/cosmic/RawModeHitSelectionDriver.java (original) +++ java/trunk/analysis/src/main/java/org/hps/analysis/ecal/cosmic/RawModeHitSelectionDriver.java Thu Mar 10 17:32:07 2016 @@ -54,7 +54,7 @@ /** * Set the number of ADC samples in a row which must be above the threshold. - * @param selectedHits The minimum number of samples above threshold. + * @param minimumSelectedSamples The minimum number of samples above threshold. */ public void setMinimumSelectedSamples(int minimumSelectedSamples) { this.minimumSelectedSamples = minimumSelectedSamples; Modified: java/trunk/analysis/src/main/java/org/hps/analysis/trigger/DataTriggerSimDriver.java ============================================================================= --- java/trunk/analysis/src/main/java/org/hps/analysis/trigger/DataTriggerSimDriver.java (original) +++ java/trunk/analysis/src/main/java/org/hps/analysis/trigger/DataTriggerSimDriver.java Thu Mar 10 17:32:07 2016 @@ -48,9 +48,9 @@ * output object is not persisted into LCIO after runtime. * * @author Kyle McCarty <[log in to unmask]> - * @see DAQConfigDriver - * @see EcalOnlineRawConverterDriver - * @see GTPOnlineClusterDriver + * @see org.hps.record.daqconfig.DAQConfigDriver + * @see org.hps.recon.ecal.EcalOnlineRawConverterDriver + * @see org.hps.recon.ecal.cluster.GTPOnlineClusterDriver * @see SimTriggerData */ public class DataTriggerSimDriver extends Driver { Modified: java/trunk/analysis/src/main/java/org/hps/analysis/trigger/data/DiagnosticSnapshot.java ============================================================================= --- java/trunk/analysis/src/main/java/org/hps/analysis/trigger/data/DiagnosticSnapshot.java (original) +++ java/trunk/analysis/src/main/java/org/hps/analysis/trigger/data/DiagnosticSnapshot.java Thu Mar 10 17:32:07 2016 @@ -95,7 +95,7 @@ * Gets the total number of events where the TI reported a trigger * of the specified type. * @param triggerID - The identifier for the type of trigger. - * @param unique - <code>true</code> returns only the number of + * @param hierarchical - <code>true</code> returns only the number of * events where this trigger type was the <i>only</i> type seen by * the TI while <code>false</code> returns the number of events * that saw this trigger type without regards for other trigger Modified: java/trunk/analysis/src/main/java/org/hps/analysis/trigger/data/TriggerDiagStats.java ============================================================================= --- java/trunk/analysis/src/main/java/org/hps/analysis/trigger/data/TriggerDiagStats.java (original) +++ java/trunk/analysis/src/main/java/org/hps/analysis/trigger/data/TriggerDiagStats.java Thu Mar 10 17:32:07 2016 @@ -89,7 +89,7 @@ * Gets the total number of events where the TI reported a trigger * of the specified type. * @param triggerID - The identifier for the type of trigger. - * @param unique - <code>true</code> returns only the number of + * @param hierarchical - <code>true</code> returns only the number of * events where this trigger type was the <i>only</i> type seen by * the TI while <code>false</code> returns the number of events * that saw this trigger type without regards for other trigger Modified: java/trunk/analysis/src/main/java/org/hps/analysis/trigger/data/TriggerEvent.java ============================================================================= --- java/trunk/analysis/src/main/java/org/hps/analysis/trigger/data/TriggerEvent.java (original) +++ java/trunk/analysis/src/main/java/org/hps/analysis/trigger/data/TriggerEvent.java Thu Mar 10 17:32:07 2016 @@ -57,8 +57,6 @@ * was successfully matched to a trigger in the SSP bank. * @param tiFlags - An array of size 6 indicating which TI bank * flags are active and which are not. - * @param triggerTypeID - An identifier indicating the type of - * trigger that was matched. */ public void matchedReconTrigger(boolean[] tiFlags) { matchedTriggers(tiFlags, RECON); @@ -70,8 +68,6 @@ * which cuts did and did not match. * @param tiFlags - An array of size 6 indicating which TI bank * flags are active and which are not. - * @param triggerTypeID - An identifier indicating the type of - * trigger that was matched. * @param matchedCuts - An array of size 3 or 4 indicating which * cuts did and did not align between the triggers. */ @@ -97,8 +93,6 @@ * cuts did and did not match. * @param tiFlags - An array of size 6 indicating which TI bank * flags are active and which are not. - * @param triggerTypeID - An identifier indicating the type of - * trigger that was matched. * @param matchedCuts - An array of size 3 or 4 indicating which * cuts did and did not align between the triggers. */ Modified: java/trunk/analysis/src/main/java/org/hps/analysis/trigger/data/TriggerStatModule.java ============================================================================= --- java/trunk/analysis/src/main/java/org/hps/analysis/trigger/data/TriggerStatModule.java (original) +++ java/trunk/analysis/src/main/java/org/hps/analysis/trigger/data/TriggerStatModule.java Thu Mar 10 17:32:07 2016 @@ -135,7 +135,6 @@ * bank flag was active. * @param tiTypeID - The identifier for the type of TI bank trigger * that should be active. - * @param triggerTypeID - The identifier for the type of trigger. * @return Returns the number of triggers as an <code>int</code>. */ public int getMatchedReconSimulatedTriggers(int tiTypeID) { @@ -157,7 +156,6 @@ * bank flag was active. * @param tiTypeID - The identifier for the type of TI bank trigger * that should be active. - * @param triggerTypeID - The identifier for the type of trigger. * @return Returns the number of triggers as an <code>int</code>. */ public int getMatchedSSPSimulatedTriggers(int tiTypeID) { @@ -208,7 +206,6 @@ * flag was active. * @param tiTypeID - The identifier for the type of TI bank trigger * that should be active. - * @param triggerTypeID - The identifier for the type of trigger. * @return Returns the number of triggers as an <code>int</code>. */ public int getReconSimulatedTriggers(int tiTypeID) { @@ -249,7 +246,6 @@ * flag was active. * @param tiTypeID - The identifier for the type of TI bank trigger * that should be active. - * @param triggerTypeID - The identifier for the type of trigger. * @return Returns the number of triggers as an <code>int</code>. */ public int getSSPSimulatedTriggers(int tiTypeID) { Modified: java/trunk/analysis/src/main/java/org/hps/analysis/trigger/util/Pair.java ============================================================================= --- java/trunk/analysis/src/main/java/org/hps/analysis/trigger/util/Pair.java (original) +++ java/trunk/analysis/src/main/java/org/hps/analysis/trigger/util/Pair.java Thu Mar 10 17:32:07 2016 @@ -13,8 +13,8 @@ /** * Creates a pair of the two indicated objects. - * @param firstObject - The first object. - * @param secondObject - The second object. + * @param firstElement - The first object. + * @param secondElement - The second object. */ public Pair(E firstElement, F secondElement) { this.firstObject = firstElement; Modified: java/trunk/conditions/src/main/java/org/hps/conditions/ConditionsDriver.java ============================================================================= --- java/trunk/conditions/src/main/java/org/hps/conditions/ConditionsDriver.java (original) +++ java/trunk/conditions/src/main/java/org/hps/conditions/ConditionsDriver.java Thu Mar 10 17:32:07 2016 @@ -28,8 +28,8 @@ * This is a "special" Driver which must have its initialization occur at the right time. It has a custom initialization * method {@link #initialize()} which should be called after all Driver setup has occurred, but before the job actually * begins. This is so the conditions system functions properly, including the activation of registered listeners. The - * setup is performed by in the class {@link org.hps.job.JobManager}, which is used in the default command line front - * end of the hps-distribution. If that class is not being used, then the method must be executed manually at the right + * setup is performed by the <code>JobManager</code>, which is used in the default command line front end of the + * hps-distribution. If that class is not being used, then the method must be executed manually at the right * time to achieve the proper behavior. * * @author Jeremy McCormick, SLAC Modified: java/trunk/conditions/src/main/java/org/hps/conditions/api/BaseConditionsObject.java ============================================================================= --- java/trunk/conditions/src/main/java/org/hps/conditions/api/BaseConditionsObject.java (original) +++ java/trunk/conditions/src/main/java/org/hps/conditions/api/BaseConditionsObject.java Thu Mar 10 17:32:07 2016 @@ -206,8 +206,8 @@ * Get a field value. * * @param name the field name - * @param T the field value - * @param <T> the implicit return return + * @param <T> the implicit return type + * @return the value of field cast to given type */ @Override public <T> T getFieldValue(final String name) { @@ -247,7 +247,7 @@ /** * Return <code>true</code> if collection ID is valid. * - * @param <code>true</code> if collection ID is valid + * @return <code>true</code> if collection ID is valid */ @Override public boolean hasValidCollectionId() { Modified: java/trunk/conditions/src/main/java/org/hps/conditions/api/BaseConditionsObjectCollection.java ============================================================================= --- java/trunk/conditions/src/main/java/org/hps/conditions/api/BaseConditionsObjectCollection.java (original) +++ java/trunk/conditions/src/main/java/org/hps/conditions/api/BaseConditionsObjectCollection.java Thu Mar 10 17:32:07 2016 @@ -609,7 +609,7 @@ /** * Set the table meta data of the collection. * - * @param the table meta data of the collection + * @param tableMetaData the table meta data of the collection * @see TableMetaData */ @Override Modified: java/trunk/conditions/src/main/java/org/hps/conditions/api/ConditionsObjectCollection.java ============================================================================= --- java/trunk/conditions/src/main/java/org/hps/conditions/api/ConditionsObjectCollection.java (original) +++ java/trunk/conditions/src/main/java/org/hps/conditions/api/ConditionsObjectCollection.java Thu Mar 10 17:32:07 2016 @@ -64,7 +64,6 @@ * Load collection from a CSV file. * * @param file the input CSV file - * @param delimiter the field delimiter (leave blank for default which is comma-delimited) * @throws IOException if there is an error closing the reader * @throws FileNotFoundException if the input file does not exist * @throws ConditionsObjectException if there is an error creating a conditions object @@ -104,7 +103,6 @@ * Write the collection contents to a text file. * * @param file the output text file - * @param delimiter the field delimiter (leave blank for default which is comma-delimited) */ void writeCsv(File file) throws IOException; } Modified: java/trunk/conditions/src/main/java/org/hps/conditions/api/ConditionsObjectException.java ============================================================================= --- java/trunk/conditions/src/main/java/org/hps/conditions/api/ConditionsObjectException.java (original) +++ java/trunk/conditions/src/main/java/org/hps/conditions/api/ConditionsObjectException.java Thu Mar 10 17:32:07 2016 @@ -16,7 +16,7 @@ /** * Error with a message. * - * @param message the error message + * @param e the original exception */ public ConditionsObjectException(Exception e) { super(e); Modified: java/trunk/conditions/src/main/java/org/hps/conditions/api/package-info.java ============================================================================= --- java/trunk/conditions/src/main/java/org/hps/conditions/api/package-info.java (original) +++ java/trunk/conditions/src/main/java/org/hps/conditions/api/package-info.java Thu Mar 10 17:32:07 2016 @@ -1,11 +1,13 @@ /** - * User interface to the database conditions system + * User API to the database conditions system * * @author Jeremy McCormick, SLAC - * @see ConditionsObject - * @see ConditionsObjectCollection - * @see ConditionsSeries - * @see ConditionsRecord + * + * @see org.hps.conditions.api.ConditionsObject + * @see org.hps.conditions.api.ConditionsObjectCollection + * @see org.hps.conditions.api.ConditionsSeries + * @see org.hps.conditions.api.ConditionsRecord + * @see org.hps.conditions.api.ConditionsTag */ package org.hps.conditions.api; Modified: java/trunk/conditions/src/main/java/org/hps/conditions/database/AbstractConditionsObjectConverter.java ============================================================================= --- java/trunk/conditions/src/main/java/org/hps/conditions/database/AbstractConditionsObjectConverter.java (original) +++ java/trunk/conditions/src/main/java/org/hps/conditions/database/AbstractConditionsObjectConverter.java Thu Mar 10 17:32:07 2016 @@ -14,12 +14,12 @@ import org.lcsim.conditions.ConditionsManager; /** - * Implementation of default conversion from database tables to a {@link ConditionsObject} class. - * <p> - * This class actually returns collections and not individual objects. + * Implementation of default conversion from database tables records to a + * {@link org.hps.conditions.api.ConditionsObjectCollection}. * * @author Jeremy McCormick, SLAC - * @param <T> The type of the returned data which should be a class extending {@link BaseConditionsObjectCollection}. + * @param <T> The type of the returned data which should be a class extending + * {@link org.hps.conditions.api.BaseConditionsObjectCollection}. */ public abstract class AbstractConditionsObjectConverter<T> implements ConditionsConverter<T> { Modified: java/trunk/conditions/src/main/java/org/hps/conditions/database/ConditionsTagConverter.java ============================================================================= --- java/trunk/conditions/src/main/java/org/hps/conditions/database/ConditionsTagConverter.java (original) +++ java/trunk/conditions/src/main/java/org/hps/conditions/database/ConditionsTagConverter.java Thu Mar 10 17:32:07 2016 @@ -23,14 +23,14 @@ private static final String SELECT_SQL = "SELECT conditions_id, tag from conditions_tags where tag = ?"; /** - * Get a {@link org.hps.conditions.api.ConditionsTagCollection} which specifies a group of collections + * Get a {@link org.hps.conditions.api.ConditionsTag#ConditionsTagCollection} which specifies a group of collections * that are tagged in the <i>conditions_tags</i> table in the database. * <p> * The run number is not used, and the <code>name</code> argument specifies the tag name. * - * @param manager The current conditions manager. - * @param name The name of the conditions set. - * @return The matching ConditionsRecords. + * @param manager the current conditions manager + * @param name the name of the conditions set + * @return the matching <code>ConditionsRecord</code> objects */ @Override public ConditionsTagCollection getData(final ConditionsManager manager, final String name) { Modified: java/trunk/conditions/src/main/java/org/hps/conditions/database/DatabaseConditionsManager.java ============================================================================= --- java/trunk/conditions/src/main/java/org/hps/conditions/database/DatabaseConditionsManager.java (original) +++ java/trunk/conditions/src/main/java/org/hps/conditions/database/DatabaseConditionsManager.java Thu Mar 10 17:32:07 2016 @@ -337,7 +337,7 @@ } /** - * Clear the tags used to filter the {@link org.hps.conditons.api.ConditionsRecord}s. + * Clear the tags used to filter the {@link org.hps.conditions.api.ConditionsRecord}s. */ public void clearTags() { this.tags.clear(); @@ -504,9 +504,8 @@ /** * Add a row for a new collection and return the new collection ID assigned to it. - * - * @param tableName the name of the table - * @param comment an optional comment about this new collection + * @param collection the conditions object collection + * @param description text description for the new collection ID record in the database * @return the collection's ID * @throws SQLException */ Modified: java/trunk/conditions/src/main/java/org/hps/conditions/database/package-info.java ============================================================================= --- java/trunk/conditions/src/main/java/org/hps/conditions/database/package-info.java (original) +++ java/trunk/conditions/src/main/java/org/hps/conditions/database/package-info.java Thu Mar 10 17:32:07 2016 @@ -1,5 +1,10 @@ /** - * Implementation of database API to detector conditions + * Implementation of database API for detector conditions + * <p> + * The {@link org.hps.conditions.database.DatabaseConditionsManager} has a set of converters for handling the + * conversion of conditions table data to typed collections. The converters are created automatically using + * introspection of {@link org.hps.conditions.api.ConditionsObject} classes that have the + * {@link org.hps.conditions.database.Table} and {@link org.hps.conditions.database.Field} annotations. * * @author Jeremy McCormick, SLAC */ Modified: java/trunk/conditions/src/main/java/org/hps/conditions/ecal/EcalConditions.java ============================================================================= --- java/trunk/conditions/src/main/java/org/hps/conditions/ecal/EcalConditions.java (original) +++ java/trunk/conditions/src/main/java/org/hps/conditions/ecal/EcalConditions.java Thu Mar 10 17:32:07 2016 @@ -11,7 +11,7 @@ * settings, per crystal. * <p> * Unlike most conditions data types, it does not extend {@link org.hps.conditions.api.ConditionsObject}, because it is - * a composite object containing data assembled from many other {@link org.hps.conditions.ConditionsObjects} and has a + * a composite object containing data assembled from many other {@link org.hps.conditions.api.ConditionsObject} and has a * special data converter {@link EcalConditionsConverter}. * * @author Jeremy McCormick, SLAC Modified: java/trunk/conditions/src/main/java/org/hps/conditions/ecal/EcalConditionsConverter.java ============================================================================= --- java/trunk/conditions/src/main/java/org/hps/conditions/ecal/EcalConditionsConverter.java (original) +++ java/trunk/conditions/src/main/java/org/hps/conditions/ecal/EcalConditionsConverter.java Thu Mar 10 17:32:07 2016 @@ -22,6 +22,7 @@ * * @author Jeremy McCormick, SLAC * @author Omar Moreno, UCSC + * * @see EcalConditions * @see EcalChannel * @see EcalGain @@ -38,8 +39,7 @@ /** * Create combined ECAL conditions object containing all data for the current run. - * - * @param manager the conditions manager + * * @param name the conditions set name (unused but must satisfy conditions API) */ @Override @@ -129,7 +129,6 @@ /** * Get the default collections of {@link EcalBadChannel} objects. * - * @param manager the conditions manager * @return the collections of ECAL bad channel objects */ protected ConditionsSeries<EcalBadChannel, EcalBadChannelCollection> getEcalBadChannelSeries() { @@ -139,7 +138,6 @@ /** * Get the default {@link EcalCalibration} collection. * - * @param manager the conditions manager * @return the collection of ECAL channel calibration objects */ protected EcalCalibrationCollection getEcalCalibrationCollection() { @@ -149,7 +147,6 @@ /** * Get the default {@link EcalChannel} collection. * - * @param manager the conditions manager * @return the default ECAL channel object collection */ protected EcalChannelCollection getEcalChannelCollection() { @@ -159,7 +156,6 @@ /** * Get the default {@link EcalGain} collection. * - * @param manager the conditions manager * @return the ECAL channel gain collection */ protected EcalGainCollection getEcalGainCollection() { @@ -169,7 +165,6 @@ /** * Get the default {@link EcalTimeShift} collection. * - * @param manager the conditions manager * @return the collection of ECAL time shift objects */ protected EcalTimeShiftCollection getEcalTimeShiftCollection() { @@ -177,9 +172,8 @@ } /** - * Get the default {@link EcalPulseWith} collection. - * - * @param manager the conditions manager + * Get the default {@link EcalPulseWidth} collection. + * * @return the collection of ECAL pulse widths */ protected EcalPulseWidthCollection getEcalPulseWidthCollection() { Modified: java/trunk/conditions/src/main/java/org/hps/conditions/ecal/TestRunEcalConditionsConverter.java ============================================================================= --- java/trunk/conditions/src/main/java/org/hps/conditions/ecal/TestRunEcalConditionsConverter.java (original) +++ java/trunk/conditions/src/main/java/org/hps/conditions/ecal/TestRunEcalConditionsConverter.java Thu Mar 10 17:32:07 2016 @@ -20,7 +20,6 @@ /** * Get the collections of {@link EcalBadChannel} objects for Test Run. * - * @param manager the conditions manager * @return the Test Run bad channel collections */ @Override @@ -31,7 +30,6 @@ /** * Get the {@link EcalCalibration} collection for Test Run. * - * @param manager the conditions manager * @return the Test Run ECAL calibration collection */ @Override @@ -43,7 +41,6 @@ /** * Get the {@link EcalChannel} collection for Test Run. * - * @param manager the conditions manager * @return the Test Run ECAL channel collection */ @Override @@ -54,7 +51,6 @@ /** * Get the {@link EcalGain} collection for Test Run. * - * @param manager the conditions manager * @return the Test Run ECAL gain collection */ @Override @@ -65,7 +61,6 @@ /** * Get the {@link EcalTimeShift} collection for Test Run. * - * @param manager the conditions manager * @return the Test Run ECAL time shift collection */ @Override Modified: java/trunk/conditions/src/main/java/org/hps/conditions/package-info.java ============================================================================= --- java/trunk/conditions/src/main/java/org/hps/conditions/package-info.java (original) +++ java/trunk/conditions/src/main/java/org/hps/conditions/package-info.java Thu Mar 10 17:32:07 2016 @@ -2,8 +2,7 @@ * Database conditions system * <p> * The HPS conditions module provides facilities for accessing time dependent conditions for a detector at runtime using - * a framework built on the LCSim conditions system. The {@link DatabaseConditionsReader} has a set of converters for - * reading data from tables using SQL queries and creating appropriate, typed objects for them. + * a framework built on the LCSim conditions system. * * @author Jeremy McCormick, SLAC * @see org.hps.conditions.api Modified: java/trunk/conditions/src/main/java/org/hps/conditions/svt/AbstractSvtDaqMapping.java ============================================================================= --- java/trunk/conditions/src/main/java/org/hps/conditions/svt/AbstractSvtDaqMapping.java (original) +++ java/trunk/conditions/src/main/java/org/hps/conditions/svt/AbstractSvtDaqMapping.java Thu Mar 10 17:32:07 2016 @@ -20,7 +20,7 @@ @SuppressWarnings("serial") public static abstract class AbstractSvtDaqMappingCollection<T extends AbstractSvtDaqMapping> extends BaseConditionsObjectCollection<T> { - + /** * Get the orientation of a sensor. * @@ -65,8 +65,8 @@ /** * Get the orientation of an SVT sensor (AXIAL or STEREO). * - * @see AXIAL - * @see STEREO + * @see #AXIAL + * @see #STEREO * @return the orientation of the SVT sensor */ @Field(names = {"orientation"}) @@ -87,7 +87,7 @@ /** * Set the SVT sensor layer number (1-10 for test run and 1-12 for engineering run). * - * @param layer : SVT sensor layer number + * @param layer SVT sensor layer number */ public final void setLayerNumber(final int layer) { this.setFieldValue("layer", layer); @@ -109,8 +109,8 @@ * Set the SVT half that the sensor belongs to. * * @param svtHalf the SVT half (TOP or BOTTOM) - * @see TOP_HALF - * @see BOTTOM_HALF + * @see #TOP_HALF + * @see #BOTTOM_HALF */ public final void setSvtHalf(final String svtHalf) { if (!svtHalf.equals(AbstractSvtDaqMapping.TOP_HALF) && !svtHalf.equals(AbstractSvtDaqMapping.BOTTOM_HALF)) { Modified: java/trunk/conditions/src/main/java/org/hps/conditions/svt/DaqMapHandler.java ============================================================================= --- java/trunk/conditions/src/main/java/org/hps/conditions/svt/DaqMapHandler.java (original) +++ java/trunk/conditions/src/main/java/org/hps/conditions/svt/DaqMapHandler.java Thu Mar 10 17:32:07 2016 @@ -96,7 +96,7 @@ * Method that is triggered when the end of a tag is encountered. * * @param uri the Namespace URI. - * @param locaName the local name (without prefix) + * @param localName the local name (without prefix) * @param qName the qualified name (with prefix) * @throws SAXException if there is an error processing the element */ Modified: java/trunk/conditions/src/main/java/org/hps/conditions/svt/OpeningAngleLoader.java ============================================================================= --- java/trunk/conditions/src/main/java/org/hps/conditions/svt/OpeningAngleLoader.java (original) +++ java/trunk/conditions/src/main/java/org/hps/conditions/svt/OpeningAngleLoader.java Thu Mar 10 17:32:07 2016 @@ -30,7 +30,7 @@ * Check if the run record looks good. * * @param data - * @return + * @return whether to accept the run or not */ private static boolean acceptRun(final RunData data) { return !data.getRecord().get("to_tape").equals("JUNK") Modified: java/trunk/conditions/src/main/java/org/hps/conditions/svt/SvtDaqMapping.java ============================================================================= --- java/trunk/conditions/src/main/java/org/hps/conditions/svt/SvtDaqMapping.java (original) +++ java/trunk/conditions/src/main/java/org/hps/conditions/svt/SvtDaqMapping.java Thu Mar 10 17:32:07 2016 @@ -129,8 +129,8 @@ /** * Get the side of the sensor (ELECTRON or POSITRON). * - * @see ELECTRON - * @see POSITRON + * @see #ELECTRON + * @see #POSITRON * @return sensor side (ELECTRON or POSITRON) */ @Field(names = {"side"}) @@ -160,8 +160,8 @@ * Set the side of the sensor (ELECTRON or POSITRON). * * @param side the sensor side (ELECTRON or POSITRON) - * @see {@link #ELECTRON} - * @see {@link #POSITRON} + * @see #ELECTRON + * @see #POSITRON */ public final void setSide(final String side) { if (!side.equals(SvtDaqMapping.ELECTRON) && !side.equals(SvtDaqMapping.POSITRON)) { Modified: java/trunk/conditions/src/main/java/org/hps/conditions/svt/SvtT0Shift.java ============================================================================= --- java/trunk/conditions/src/main/java/org/hps/conditions/svt/SvtT0Shift.java (original) +++ java/trunk/conditions/src/main/java/org/hps/conditions/svt/SvtT0Shift.java Thu Mar 10 17:32:07 2016 @@ -23,7 +23,7 @@ /** * Get the {@link SvtT0Shift} associated with a given DAQ pair. * - * @param DAQ pair for a given sensor + * @param pair DAQ pair for a given sensor * @return the {@link SvtT0Shift} associated with the DAQ pair or null if does not exist */ @Override Modified: java/trunk/conditions/src/main/java/org/hps/conditions/svt/TestRunSvtChannel.java ============================================================================= --- java/trunk/conditions/src/main/java/org/hps/conditions/svt/TestRunSvtChannel.java (original) +++ java/trunk/conditions/src/main/java/org/hps/conditions/svt/TestRunSvtChannel.java Thu Mar 10 17:32:07 2016 @@ -26,7 +26,7 @@ /** * Find a collection of channels by their DAQ pair assignment. * - * @param the DAQ pair (FEB ID and FEB Hybrid ID) + * @param pair the DAQ pair (FEB ID and FEB Hybrid ID) * @return the collection of channels */ @Override Modified: java/trunk/conditions/src/main/java/org/hps/conditions/svt/TestRunSvtConditions.java ============================================================================= --- java/trunk/conditions/src/main/java/org/hps/conditions/svt/TestRunSvtConditions.java (original) +++ java/trunk/conditions/src/main/java/org/hps/conditions/svt/TestRunSvtConditions.java Thu Mar 10 17:32:07 2016 @@ -10,7 +10,7 @@ /** * This class contains all test run SVT conditions data by readout channel. {@link TestRunSvtChannel} objects from the - * SVT channel map should be used to lookup the conditions using the {@link #getChannelConstants(TestRunSvtChannel)} + * SVT channel map should be used to lookup the conditions using the {@link #getChannelConstants(AbstractSvtChannel)} * method. * * @author Jeremy McCormick, SLAC Modified: java/trunk/conditions/src/main/java/org/hps/conditions/svt/TestRunSvtT0Shift.java ============================================================================= --- java/trunk/conditions/src/main/java/org/hps/conditions/svt/TestRunSvtT0Shift.java (original) +++ java/trunk/conditions/src/main/java/org/hps/conditions/svt/TestRunSvtT0Shift.java Thu Mar 10 17:32:07 2016 @@ -22,7 +22,7 @@ /** * Get the {@link TestRunSvtT0Shift} associated with a given DAQ pair * - * @param DAQ pair for a given sensor + * @param pair DAQ pair for a given sensor * @return the {@link TestRunSvtT0Shift} associated with the DAQ pair or null if does not exist */ @Override Modified: java/trunk/crawler/src/main/java/org/hps/crawler/FileMetadataReader.java ============================================================================= --- java/trunk/crawler/src/main/java/org/hps/crawler/FileMetadataReader.java (original) +++ java/trunk/crawler/src/main/java/org/hps/crawler/FileMetadataReader.java Thu Mar 10 17:32:07 2016 @@ -14,8 +14,8 @@ /** * Create a metadata map with keys and values from the contents of a file. * - * @param the input file for extracting metadata - * @return the metadata map + * @param file the input file from which to extract metadata + * @return the metadata map of field names to values * @throws IOException if there is an error reading the file */ Map<String, Object> getMetadata(File file) throws IOException; Modified: java/trunk/detector-model/src/main/java/org/lcsim/detector/converter/compact/subdetector/HpsTracker2.java ============================================================================= --- java/trunk/detector-model/src/main/java/org/lcsim/detector/converter/compact/subdetector/HpsTracker2.java (original) +++ java/trunk/detector-model/src/main/java/org/lcsim/detector/converter/compact/subdetector/HpsTracker2.java Thu Mar 10 17:32:07 2016 @@ -8,7 +8,7 @@ import org.lcsim.detector.converter.compact.SubdetectorDetectorElement; import org.lcsim.detector.tracker.silicon.HpsSiSensor; /** - * Class describing an {@link HPSTracker2} subdetector. + * Detector element for <code>HPSTracker2</code> type. * * @author Omar Moreno <[log in to unmask]> * @author Jeremy McCormick <[log in to unmask]> Modified: java/trunk/detector-model/src/main/java/org/lcsim/detector/converter/compact/subdetector/SvtStereoLayer.java ============================================================================= --- java/trunk/detector-model/src/main/java/org/lcsim/detector/converter/compact/subdetector/SvtStereoLayer.java (original) +++ java/trunk/detector-model/src/main/java/org/lcsim/detector/converter/compact/subdetector/SvtStereoLayer.java Thu Mar 10 17:32:07 2016 @@ -21,7 +21,7 @@ /** * Ctor * - * @param layerNumber Layer number to which the stereo pair belongs to + * @param stereoLayerNumber Layer number to which the stereo pair belongs * @param firstSensor The first sensor in the stereo layer * @param secondSensor The second sensor in the stereo layer */ Modified: java/trunk/detector-model/src/main/java/org/lcsim/detector/tracker/silicon/HpsSiSensor.java ============================================================================= --- java/trunk/detector-model/src/main/java/org/lcsim/detector/tracker/silicon/HpsSiSensor.java (original) +++ java/trunk/detector-model/src/main/java/org/lcsim/detector/tracker/silicon/HpsSiSensor.java Thu Mar 10 17:32:07 2016 @@ -303,9 +303,8 @@ /** * Generate an ID for a channel (strip) on a sensor. * - * @param sensor * @param channel : Physical channel number - * @return ID + * @return the channel ID */ public long makeChannelID(final int channel) { final int sideNumber = this.hasElectrodesOnSide(ChargeCarrier.HOLE) ? ChargeCarrier.HOLE.charge() @@ -385,7 +384,7 @@ /** * Set the front end board (FEB) ID of the sensor. * - * @param FEB ID The FEB ID of the sensor. + * @param febID FEB ID The FEB ID of the sensor. */ public void setFebID(final int febID) { this.febID = febID; @@ -394,7 +393,7 @@ /** * Set the FEB hybrid ID of the sensor. * - * @param FEB hybrid ID The FEB hybrid ID. + * @param febHybridID FEB hybrid ID The FEB hybrid ID. */ public void setFebHybridID(final int febHybridID) { this.febHybridID = febHybridID; @@ -412,7 +411,7 @@ /** * Flag the sensor as being axial. * - * @param true if the sensor is Axial, false otherwise + * @param isAxial true if the sensor is Axial, false otherwise */ public void setAxial(final boolean isAxial) { this.isAxial = isAxial; @@ -421,7 +420,7 @@ /** * Flag the sensor as being stereo * - * @param true is the sensor is stereo, false otherwise + * @param isStereo true is the sensor is stereo, false otherwise */ public void setStereo(final boolean isStereo) { this.isStereo = isStereo; Modified: java/trunk/detector-model/src/main/java/org/lcsim/detector/tracker/silicon/HpsTestRunSiSensor.java ============================================================================= --- java/trunk/detector-model/src/main/java/org/lcsim/detector/tracker/silicon/HpsTestRunSiSensor.java (original) +++ java/trunk/detector-model/src/main/java/org/lcsim/detector/tracker/silicon/HpsTestRunSiSensor.java Thu Mar 10 17:32:07 2016 @@ -71,7 +71,7 @@ /** * Set the FPGA ID associated with this sensor. * - * @param The FPGA ID + * @param fpgaID The FPGA ID */ public void setFpgaID(int fpgaID) { this.fpgaID = fpgaID; @@ -80,7 +80,7 @@ /** * Set the hybrid ID associated with this sensor. * - * @param The hybrid ID. + * @param hybridID The hybrid ID. */ public void setHybridID(int hybridID) { this.hybridID = hybridID; Modified: java/trunk/detector-model/src/main/java/org/lcsim/geometry/compact/converter/HPSTestRunTracker2014LCDDBuilder.java ============================================================================= --- java/trunk/detector-model/src/main/java/org/lcsim/geometry/compact/converter/HPSTestRunTracker2014LCDDBuilder.java (original) +++ java/trunk/detector-model/src/main/java/org/lcsim/geometry/compact/converter/HPSTestRunTracker2014LCDDBuilder.java Thu Mar 10 17:32:07 2016 @@ -143,7 +143,7 @@ /** * Rules for adding the LCDD half module geometry. - * @param bundle - module to be added + * @param bundle2 - module to be added * @param mother - mother LCDD geometry object */ protected void addTestRunHalfModule(HalfModuleBundle bundle2, LCDDSurveyVolume mother) { Modified: java/trunk/detector-model/src/main/java/org/lcsim/geometry/compact/converter/HPSTracker2014GeometryDefinition.java ============================================================================= --- java/trunk/detector-model/src/main/java/org/lcsim/geometry/compact/converter/HPSTracker2014GeometryDefinition.java (original) +++ java/trunk/detector-model/src/main/java/org/lcsim/geometry/compact/converter/HPSTracker2014GeometryDefinition.java Thu Mar 10 17:32:07 2016 @@ -27,8 +27,8 @@ * */ public class HPSTracker2014GeometryDefinition extends HPSTrackerGeometryDefinition { - - private static final Logger LOGGER = Logger.getLogger(HPSTracker2014GeometryDefinition.class.getPackage().getName()); + + private static final Logger LOGGER = Logger.getLogger(HPSTracker2014GeometryDefinition.class.getPackage().getName()); public HPSTracker2014GeometryDefinition(boolean debug, Element node) { super(debug, node); @@ -38,8 +38,7 @@ doBottom = true; doTop = true; layerBitMask = 0x3F; - } - + } /* (non-Javadoc) * @see org.lcsim.geometry.compact.converter.HPSTrackerBuilder#build() @@ -47,12 +46,11 @@ public void build() { if(isDebug()) System.out.printf("%s: constructing the geometry objects\n", this.getClass().getSimpleName()); - // Create alignment correction objects // THis is really a ugly approach with MP corrections initialized before and // the survey corrections based on the XML node - // FIX THIS! //TODO + // TODO: FIX THIS! AlignmentCorrection alignmentCorrections = new AlignmentCorrection(); alignmentCorrections.setNode(node); AlignmentCorrection supBotCorr = getL13UChannelAlignmentCorrection(false); @@ -74,25 +72,19 @@ SvtBoxBasePlate svtBoxBasePlate = new SvtBoxBasePlate("base_plate",svtBox,null); surveyVolumes.add(svtBoxBasePlate); - - - + SupportRingL13BottomKinMount supportRingKinL13Bottom = new SupportRingL13BottomKinMount("c_support_kin_L13b", svtBox, supBotCorr); - surveyVolumes.add(supportRingKinL13Bottom); - + surveyVolumes.add(supportRingKinL13Bottom); UChannelL13 uChannelL13Bottom = new UChannelL13Bottom("support_bottom_L13", svtBox, alignmentCorrections, supportRingKinL13Bottom); surveyVolumes.add(uChannelL13Bottom); UChannelL13Plate uChannelL13BottomPlate = new UChannelL13BottomPlate("support_plate_bottom_L13", svtBox, null, uChannelL13Bottom); surveyVolumes.add(uChannelL13BottomPlate); - SupportRingL13TopKinMount supportRingKinL13Top = new SupportRingL13TopKinMount("c_support_kin_L13t", svtBox, supTopCorr); surveyVolumes.add(supportRingKinL13Top); - - - + UChannelL13Top uChannelL13Top = new UChannelL13Top("support_top_L13", svtBox, alignmentCorrections, supportRingKinL13Top); surveyVolumes.add(uChannelL13Top); @@ -110,7 +102,6 @@ UChannelL46Plate uChannelL46TopPlate = new UChannelL46TopPlate("support_plate_top_L46", svtBox, null, uChannelL46Top); surveyVolumes.add(uChannelL46TopPlate); - for(int l=1; l<=6;++l) { if(doLayer(l)) { @@ -135,30 +126,20 @@ bundle.print(); } } - - - - - - } - + } /** * {@link SurveyVolume} volume defining the pair spectrometer (PS) vacuum chamber * Reference: tracking volume coordinate system * Origin: same as reference * Orientation: u - points in x direction (towards positron side), v - points upstream - * - * @author Per Hansson Adrian <[log in to unmask]> - * */ public static class PSVacuumChamber extends SurveyVolume { + public static final double height = PS_vac_box_inner_height; public static final double width = PS_vac_box_inner_width; public static final double length = PS_vac_box_inner_length; - - - + public PSVacuumChamber(String name, SurveyVolume mother, AlignmentCorrection alignmentCorrection) { super(name, mother, alignmentCorrection); init(); @@ -184,9 +165,6 @@ * Reference: PS vacuum chamber coordinate system. Note that the PS vacuum chamber box is placed w.r.t. this box and the target positions. * Origin: intersection of midplanes vertically and horizontally * Orientation: same as reference - * - * @author Per Hansson Adrian <[log in to unmask]> - * */ public static class SvtBox extends SurveyVolume { public static final double height = 6.740*inch; @@ -198,10 +176,7 @@ public static final double center_to_target_z = 13.777*inch; public static final double center_to_target_x = 0.84*inch; public static final double center_to_target_y = 0.0; - - - - + public SvtBox(String name, SurveyVolume mother, AlignmentCorrection alignmentCorrection) { super(name, mother, alignmentCorrection); init(); @@ -217,8 +192,7 @@ ballPos = new BasicHep3Vector(0, 0, 0); veePos = new BasicHep3Vector(ballPos.x()+1, ballPos.y(), ballPos.z()); - flatPos = new BasicHep3Vector(ballPos.x(), ballPos.y()+1, ballPos.z()); - + flatPos = new BasicHep3Vector(ballPos.x(), ballPos.y()+1, ballPos.z()); } } @@ -228,9 +202,6 @@ * Reference: {@link SvtBox} coordinate system. * Origin: surface of base plate intersection with center of hole for adjustment screw on positron side * Orientation: same as reference - * - * @author Per Hansson Adrian <[log in to unmask]> - * */ public static class SvtBoxBasePlate extends SurveyVolume { public static final double length = 50.5*inch; @@ -268,16 +239,11 @@ } - - - /** * {@link SurveyVolume} volume defining the coordinate system of the support ring * Reference: @SvtBoxBasePlate * Origin: pin position of support ring (electron side) * Orientation: slot position is vee position (positron side) i.e u points towards the positron side and v in the upstream beam direction - * - * @author Per Hansson Adrian <[log in to unmask]> * */ public static class SupportRing extends SurveyVolume { @@ -315,14 +281,9 @@ flatPos = VecOp.add(ballPos, vPrime); } } - - - + /** * Abstract {@link SurveyVolume} volume defining a coordinate system from the kinematic mount positions for support channels - * - * @author Per Hansson Adrian <[log in to unmask]> - * */ public abstract static class SupportRingL13KinMount extends SurveyVolume { @@ -360,9 +321,6 @@ * Reference: {@link SvtBox} coordinate system * Origin: cone mount (it's on the electron side) * Orientation: ball is cone mount, slot mount is vee position and flat is along beam line pointing upstream - * - * @author Per Hansson Adrian <[log in to unmask]> - * */ public static class SupportRingL13BottomKinMount extends SupportRingL13KinMount { @@ -385,9 +343,6 @@ * Reference: @SupportRing coordinate system * Origin: cone mount (it's on the electron side) * Orientation: ball is cone mount, slot mount is vee position and flat is along beamline pointing upstream - * - * @author Per Hansson Adrian <[log in to unmask]> - * */ public static class SupportRingL13TopKinMount extends SupportRingL13KinMount { //public static final double mount_surface_wrt_baseplate_vertically = 5.388*inch; @@ -420,12 +375,9 @@ // flatPos = new BasicHep3Vector(flat_pos_x,flat_pos_y,flat_pos_z); // } } - - - /** - * Abstract {@link SurveyVolume} volume defining the coordinate system of the L1-3 u-channels - * - * @author Per Hansson Adrian <[log in to unmask]> + + /** + * Abstract {@link SurveyVolume} volume defining the coordinate system of the L1-3 u-channels */ public abstract static class UChannelL13 extends SurveyVolume { public final static double length = UChannelL13Plate.length; @@ -457,9 +409,6 @@ * Reference: {@link SupportRingL13BottomKinMount} coordinate system * Origin: midpoint between upstream survey cones * Orientation: u - width pointing towards electron side, v - pointing along the U-channel in the beam direction - * - * @author Per Hansson Adrian <[log in to unmask]> - * */ public static class UChannelL13Bottom extends UChannelL13 { private final static double cone_to_edge_of_plate_y = 12.25*inch; @@ -489,14 +438,9 @@ } } - - /** * Position of the center of the survey balls when engaging the cones in the side plates of the U-channel. * This is at nominal position. - * - * @author Per Hansson Adrian <[log in to unmask]> - * */ private static class UChannelL13BottomSurveyBalls { @@ -523,18 +467,12 @@ } } - - - /** * {@link SurveyVolume} volume defining the coordinate system of the top L1-3 u-channel * Reference: SupportRingL13TopKinMount coordinate system * Origin: midpoint between upstream survey cones * Orientation: u - width pointing towards positron side, v - pointing along the U-channel in the beam direction * Note that this is flipped w.r.t. bottom support. - * - * @author Per Hansson Adrian <[log in to unmask]> - * */ public static class UChannelL13Top extends UChannelL13 { private final static Hep3Vector ball_kinMount = new BasicHep3Vector(SupportRingL13TopKinMount.kin_mount_pos_x,SupportRingL13TopKinMount.kin_mount_pos_y,SupportRingL13TopKinMount.kin_mount_pos_z); @@ -567,15 +505,10 @@ return length; } } - - - + /** * Position of the center of the survey balls when engaging the cones in the side plates of the U-channel. * This is at nominal position. - * - * @author Per Hansson Adrian <[log in to unmask]> - * */ private static class UChannelL13TopSurveyBalls { @@ -602,16 +535,8 @@ } } - - - - - /** * Abstract {@link SurveyVolume} volume defining the coordinate system of the u-channel plate - - * @author Per Hansson Adrian <[log in to unmask]> - * */ public abstract static class UChannelPlate extends SurveyVolume { public UChannelPlate(String name, SurveyVolume m, @@ -626,9 +551,6 @@ /** * Abstract {@link SurveyVolume} volume defining the coordinate system of the u-channel plate - - * @author Per Hansson Adrian <[log in to unmask]> - * */ public abstract static class UChannelL13Plate extends UChannelPlate { private final static double pocket_depth_L1 = 0.025; @@ -689,9 +611,6 @@ * Reference: @UChannelL13Bottom coordinate system * Origin: same as reference * Orientation: same as reference - * - * @author Per Hansson Adrian <[log in to unmask]> - * */ public static class UChannelL13BottomPlate extends UChannelL13Plate { protected final static double L1_module_pin_to_edge_of_plate = (16.0-4.126)*inch; @@ -715,10 +634,7 @@ * {@link SurveyVolume} volume defining the coordinate system of the bottom u-channel plate * Reference: @UChannelL13Bottom coordinate system * Origin: same as reference - * Orientation: same as reference - * - * @author Per Hansson Adrian <[log in to unmask]> - * + * Orientation: same as reference */ public static class UChannelL13TopPlate extends UChannelL13Plate { protected final static double L1_module_pin_to_edge_of_plate = (16.0-2.75)*inch; @@ -737,12 +653,9 @@ } } - - + /** * Abstract {@link SurveyVolume} volume defining the L4-6 u-channel volume - * - * @author Per Hansson Adrian <[log in to unmask]> */ public abstract static class UChannelL46 extends SurveyVolume { @@ -760,26 +673,18 @@ protected void setBoxDim() { setBoxDim(width,length,height); - } - - } - - - - - + } + } + /** * {@link SurveyVolume} volume defining the coordinate system of the u-channel * Reference: SVTBox coordinate system * Origin: midpoint between upstream survey cones * Orientation: u - width pointing towards electron side, v - pointing along the U-channel in the beam direction - * - * @author Per Hansson Adrian <[log in to unmask]> * */ public static class UChannelL46Bottom extends UChannelL46 { - - + protected static final double cone_to_edge_of_plate_y = 2.75*inch; public UChannelL46Bottom(String name, SurveyVolume m, AlignmentCorrection alignmentCorrection) { @@ -803,15 +708,12 @@ /** * Position of the center of the survey balls when engaging the cones in the side plates of the U-channel. - * - * @author Per Hansson Adrian <[log in to unmask]> * */ private static class UChannelL46BottomSurveyBalls { - // Shawn's calculated point at midpoint between two forward survey balls + // Shawn's calculated point at midpoint between two forward survey balls protected final static Hep3Vector ball_pos = new BasicHep3Vector(-5.857, -157.776, -8.423); - private static final double cone_fwd_right_x = -7.019*inch; private static final double cone_fwd_right_y = -6.419*inch; @@ -841,22 +743,14 @@ return VecOp.sub(bwd_left, fwd_left); } } - - - - /** * {@link SurveyVolume} volume defining the coordinate system of the u-channel - * Reference: {@link SVTBox} coordinate system - * Origin: midpoint between upstream survey cones - * Orientation: u - width pointing towards electron side, v - pointing along the U-channel in the beam direction - * - * @author Per Hansson Adrian <[log in to unmask]> - * + * Reference: {@link #SVTBox} coordinate system + * Origin: midpoint between upstream survey cones + * Orientation: u - width pointing towards electron side, v - pointing along the U-channel in the beam direction */ public static class UChannelL46Top extends UChannelL46 { - private static final double cone_to_side_plate_pin_y = (0.875-0.25)*inch; private static final double side_plate_pin_to_edge_of_plate_y = 1.5*inch; @@ -886,8 +780,7 @@ //flatPos = new BasicHep3Vector(ballPos.x(), ballPos.y()-1, ballPos.z()); // random offset } } - - + /** * Position of the center of the survey balls when engaging the cones in the side plates of the U-channel. * @@ -899,7 +792,6 @@ // Shawn's calculated point at midpoint between two forward survey balls protected final static Hep3Vector ball_pos = new BasicHep3Vector(-6.341, -141.909, 8.423); - protected static final double cone_fwd_right_x = -7.038*inch; protected static final double cone_fwd_right_y = -5.794*inch; protected static final double cone_fwd_right_z = 0.332*inch; @@ -928,14 +820,9 @@ return VecOp.sub(bwd_right, fwd_right); } } - - - - /** - * Abstract {@link SurveyVolume} defining the coordinate system of the u-channel plates - - * @author Per Hansson Adrian <[log in to unmask]> - * + + /** + * Abstract {@link SurveyVolume} defining the coordinate system of the u-channel plates */ public abstract static class UChannelL46Plate extends UChannelPlate { public final static double pocket_depth_L4 = 0.1; @@ -1043,16 +930,12 @@ } } - - - + /** * {@link SurveyVolume} volume defining the coordinate system of module L1-3 * Reference: @UChannelL13Bottom coordinate system * Origin: hole position on mounting surface (on electron side) * Orientation: u - is normal to the surface pointing vertically down, v - points along module away from hybrid side (i.e. positron direction). - * - * @author Per Hansson Adrian <[log in to unmask]> * */ public abstract static class ModuleL13 extends BaseModule { @@ -1119,8 +1002,7 @@ protected double getHoleModuleCenterOffset() { return UChannelL13Bottom.cone_to_edge_of_plate_y - UChannelL13BottomPlate.L1_module_pin_to_edge_of_plate; } - } - + } public static class ModuleL1Bot extends ModuleL13Bot { @@ -1136,8 +1018,7 @@ return new BasicHep3Vector(x, y, z); } - } - + } public static class ModuleL1Top extends ModuleL13Top { @@ -1155,9 +1036,7 @@ } } - - - + public static class ModuleL2Bot extends ModuleL13Bot { public ModuleL2Bot(String name, SurveyVolume mother, @@ -1190,10 +1069,7 @@ } } - - - - + public static class ModuleL3Bot extends ModuleL13Bot { public ModuleL3Bot(String name, SurveyVolume mother, @@ -1226,11 +1102,7 @@ } } - - - - - + /** * Abstract {@link SurveyVolume} volume defining the coordinate system of module L4-6 * @@ -1628,8 +1500,6 @@ * Reference: @ModuleL13Bot coordinate system * Origin: sensor center * Orientation: w - is normal to the surface pointing from p-side to n-side, v - points along strips away from signal bond pads - * - * @author Per Hansson Adrian <[log in to unmask]> * */ public static class HalfModuleAxial extends HPSTestRunTracker2014GeometryDefinition.TestRunHalfModule { @@ -1668,8 +1538,6 @@ * Reference: @ModuleL13Bot coordinate system * Origin: sensor center * Orientation: same as axial - the module is rotated later. - * - * @author Per Hansson Adrian <[log in to unmask]> * */ public static class HalfModuleStereo extends HPSTestRunTracker2014GeometryDefinition.TestRunHalfModule { @@ -1873,23 +1741,21 @@ } - - - - - /** - * @author Per Hansson Adrian <[log in to unmask]> - * + /** + * */ public static class LongModuleBundle extends BaseModuleBundle { + public HalfModuleBundle halfModuleAxialHole = null; public HalfModuleBundle halfModuleStereoHole = null; public HalfModuleBundle halfModuleAxialSlot = null; public HalfModuleBundle halfModuleStereoSlot = null; protected SurveyVolume coldBlock = null; + public LongModuleBundle(BaseModule m) { super(m); } + public void print() { if(module!=null) System.out.printf("%s: %s\n", this.getClass().getSimpleName(),module.toString()); if(halfModuleAxialHole!=null) halfModuleAxialHole.print(); @@ -1897,13 +1763,11 @@ if(coldBlock!=null)System.out.printf("%s: %s\n", this.getClass().getSimpleName(),coldBlock.getName()); if(halfModuleStereoHole!=null) halfModuleStereoHole.print(); if(halfModuleStereoSlot!=null) halfModuleStereoSlot.print(); - } - } - - - /** - * @author Per Hansson Adrian <[log in to unmask]> - * + } + } + + /** + * */ public static class LongHalfModuleBundle extends HalfModuleBundle { public LongHalfModuleBundle() { @@ -1913,9 +1777,7 @@ super(hm); } } - - - + /** * Create the half-module. * @param side - stereo or axial @@ -1955,9 +1817,6 @@ //TestRunModuleBundle bundle = (TestRunModuleBundle)getModuleBundle(mother); //TestRunHalfModuleBundle halfModuleBundle; LongModuleBundle bundle = (LongModuleBundle)getModuleBundle(mother); - - - // Build the half-module bundle and half-module //TODO clean this up to a separate method @@ -1983,9 +1842,6 @@ } } halfModuleBundle.halfModule = halfModule; - - - // create the half module components makeHalfModuleComponentSensor(halfModule); @@ -1994,13 +1850,8 @@ //makeHalfModuleComponentCF(halfModule); - //makeHalfModuleComponentHybrid(halfModule); - - - - - } - + //makeHalfModuleComponentHybrid(halfModule); + } protected void makeLongHalfModuleComponentKapton(BaseModule mother) { @@ -2022,10 +1873,6 @@ } - - - - protected HPSTestRunTracker2014GeometryDefinition.TestRunHalfModule createTestRunHalfModuleAxial(String volName, BaseModule mother, AlignmentCorrection alignmentCorrection, int layer, String half) { @@ -2047,7 +1894,6 @@ * @param alignmentCorrection * @param layer * @param half - * @return */ protected LongHalfModule createLongAxialSlotHalfModule(String name, SurveyVolume mother, AlignmentCorrection alignmentCorrection, int layer, @@ -2062,16 +1908,13 @@ * @param alignmentCorrection * @param layer * @param half - * @return */ protected LongHalfModule createLongStereoSlotHalfModule(String name, SurveyVolume mother, AlignmentCorrection alignmentCorrection, int layer, String half) { return new LongStereoSlotHalfModule(name, mother, alignmentCorrection, layer, half); } - - - + /* (non-Javadoc) * @see org.lcsim.geometry.compact.converter.HPSTrackerGeometryDefinition#getHalfModuleBundle(org.lcsim.geometry.compact.converter.HPSTestRunTracker2014GeometryDefinition.BaseModule, java.lang.String) */ @@ -2121,9 +1964,6 @@ } return hm; } - - - /* (non-Javadoc) * @see org.lcsim.geometry.compact.converter.HPSTrackerBuilder#getMillepedeLayer(java.lang.String) @@ -2149,8 +1989,6 @@ return getMillepedeLayer(isTopLayer, layer, isAxial, isHole); } - - /** * Definition relating the sensors and layer number used in millepede for this detector. @@ -2158,7 +1996,6 @@ * @param layer * @param isAxial * @param isHole - * @return */ public int getMillepedeLayer(boolean isTopLayer, int layer, boolean isAxial, boolean isHole) { int l = -1; @@ -2208,16 +2045,7 @@ if(l<0) throw new RuntimeException("Error getting the millepede layer."); if(isDebug()) System.out.printf("%s: %s %d %s %s -> MP layer %d\n",getClass().getSimpleName(),isTopLayer?"top":"bottom", layer, isAxial?"axial":"stereo", isHole?"hole":"slot", l); - return l; } - - - - } - - - - Modified: java/trunk/detector-model/src/main/java/org/lcsim/geometry/compact/converter/HPSTracker2014v1GeometryDefinition.java ============================================================================= --- java/trunk/detector-model/src/main/java/org/lcsim/geometry/compact/converter/HPSTracker2014v1GeometryDefinition.java (original) +++ java/trunk/detector-model/src/main/java/org/lcsim/geometry/compact/converter/HPSTracker2014v1GeometryDefinition.java Thu Mar 10 17:32:07 2016 @@ -7,7 +7,7 @@ /** * * Updated geometry information for the HPS tracker 2014 - + * * @author Per Hansson Adrian <[log in to unmask]> * */ @@ -93,8 +93,7 @@ /** - * PI rotation around generic z-axis - * @return + * PI rotation around generic z-axis */ private static Rotation getSlotRotation() { return new Rotation(new Vector3D(0,0,1),Math.PI); Modified: java/trunk/detector-model/src/main/java/org/lcsim/geometry/compact/converter/HPSTrackerBuilder.java ============================================================================= --- java/trunk/detector-model/src/main/java/org/lcsim/geometry/compact/converter/HPSTrackerBuilder.java (original) +++ java/trunk/detector-model/src/main/java/org/lcsim/geometry/compact/converter/HPSTrackerBuilder.java Thu Mar 10 17:32:07 2016 @@ -632,7 +632,7 @@ /** * Get hole or slot key name from string * - * @param name. + * @param name "hole" or "slot" * @return hole or not boolean */ public static boolean isHoleFromName(String name) { @@ -649,10 +649,7 @@ /** * Extract old definition of Test Run sensor number. * - * @param isTopLayer - top or bottom layer - * @param l - layer - * @param isAxial - axial or stereo sensor - * @return + * @return the geometric layer according to Test Run definition */ public int getOldGeomDefLayerFromVolumeName(String name) { @@ -672,8 +669,7 @@ /** * Get the layer number consistent with the old geometry definition. * - * @param module name that contains layer and half information. - * @return the layer. + * @return the older layer definition */ public int getOldLayerDefinition(boolean isTopLayer, int l, boolean isAxial) { int layer = -1; Modified: java/trunk/detector-model/src/main/java/org/lcsim/geometry/compact/converter/LCDDSurveyVolume.java ============================================================================= --- java/trunk/detector-model/src/main/java/org/lcsim/geometry/compact/converter/LCDDSurveyVolume.java (original) +++ java/trunk/detector-model/src/main/java/org/lcsim/geometry/compact/converter/LCDDSurveyVolume.java Thu Mar 10 17:32:07 2016 @@ -45,7 +45,7 @@ /** * Initialize this object with a known volume and no mother. Typically the world volume would use this. * @param surveyVolume - core geometry definitions - * @param vol - given volume + * @param volume - given volume */ public LCDDSurveyVolume(SurveyVolume surveyVolume, Volume volume) { super(surveyVolume); Modified: java/trunk/detector-model/src/main/java/org/lcsim/geometry/subdetector/HPSEcal.java ============================================================================= --- java/trunk/detector-model/src/main/java/org/lcsim/geometry/subdetector/HPSEcal.java (original) +++ java/trunk/detector-model/src/main/java/org/lcsim/geometry/subdetector/HPSEcal.java Thu Mar 10 17:32:07 2016 @@ -15,39 +15,33 @@ /** * Reconstruction version of HPS ECal with crystal array. * - * @author Jeremy McCormick <[log in to unmask]> - * @author Timothy Nelson <[log in to unmask]> - * @version $Id: HPSEcal.java,v 1.6 2011/07/28 20:20:18 jeremy Exp $ + * @author Jeremy McCormick, SLAC + * @author Timothy Nelson, SLAC */ -public class HPSEcal extends AbstractSubdetector -{ +public class HPSEcal extends AbstractSubdetector { + private int nx; private int ny; private double beamgap; private double dface; private boolean oddX; - public static class NeighborMap extends HashMap<Long,Set<Long>> - { + public static class NeighborMap extends HashMap<Long, Set<Long>> { + IIdentifierHelper helper; - public NeighborMap(IIdentifierHelper helper) - { + + public NeighborMap(IIdentifierHelper helper) { this.helper = helper; } - - public String toString() - { + + public String toString() { System.out.println("NeighborMap has " + this.size() + " entries."); StringBuffer buff = new StringBuffer(); - for (long id : this.keySet()) - { - buff.append(helper.unpack(new Identifier(id))) - .append("\n"); - Set<Long> nei = this.get(id); - for (long nid : nei) - { - buff.append(" " + helper.unpack(new Identifier(nid))) - .append("\n"); + for (long id : this.keySet()) { + buff.append(helper.unpack(new Identifier(id))).append("\n"); + Set<Long> nei = this.get(id); + for (long nid : nei) { + buff.append(" " + helper.unpack(new Identifier(nid))).append("\n"); } } return buff.toString(); @@ -56,308 +50,270 @@ private NeighborMap neighborMap = null; - HPSEcal(Element node) throws JDOMException - { + HPSEcal(Element node) throws JDOMException { super(node); - + Element layout = node.getChild("layout"); - + nx = layout.getAttribute("nx").getIntValue(); ny = layout.getAttribute("ny").getIntValue(); beamgap = layout.getAttribute("beamgap").getDoubleValue(); dface = layout.getAttribute("dface").getDoubleValue(); - - if (nx % 2 != 0) + + if (nx % 2 != 0) { oddX = true; - } - - public double distanceToFace() - { + } + } + + public double distanceToFace() { return dface; } - - public double beamGap() - { + + public double beamGap() { return beamgap; } - + /** * The number of crystals in X in one section. - * @return + * + * @return the number of crystals in X in one section */ - public double nx() - { + public double nx() { return nx; } - + /** * The number of crystals in y in one section. - * @return + * + * @return the number of crystals in Y in one section */ - public double ny() - { + public double ny() { return ny; - } - + } + // Class for storing neighbor incides in XY and side. - static class XYSide implements Comparator<XYSide> - { + static class XYSide implements Comparator<XYSide> { + int x; int y; int side; - - public XYSide(int x, int y, int side) - { + + public XYSide(int x, int y, int side) { this.x = x; this.y = y; this.side = side; } - - public int x() - { + + public int x() { return x; } - - public int y() - { + + public int y() { return y; } - - public int side() - { + + public int side() { return side; } - - public boolean equals(Object o) - { - XYSide xy = (XYSide)o; - return xy.x() == x && xy.y() == y && xy.side() == side; - } - - public int compare(XYSide o1, XYSide o2) - { - if (o1.equals(o2)) - { + + public boolean equals(Object o) { + XYSide xy = (XYSide) o; + return xy.x() == x && xy.y() == y && xy.side() == side; + } + + public int compare(XYSide o1, XYSide o2) { + if (o1.equals(o2)) { return 0; - } - else - { + } else { return -1; } } } - + /** - * Get the neighbors for a given cell ID. Each crystal not on an edge - * has 8 neighbors. Edge crystals have fewer. + * Get the neighbors for a given cell ID. Each crystal not on an edge has 8 neighbors. Edge crystals have fewer. + * * @param id The cell ID. * @return A <code>Set</code> containing the cell's neighbors. */ - Set<Long> getNeighbors(Long id) - { + Set<Long> getNeighbors(Long id) { // Get the IDDecoder. - IDDecoder dec = getIDDecoder(); - + IDDecoder dec = getIDDecoder(); + // Set the ID. dec.setID(id); - + // Get ID field values. int x = dec.getValue("ix"); int y = dec.getValue("iy"); int side = dec.getValue("side"); - + // Get field indices. int ix = dec.getFieldIndex("ix"); int iy = dec.getFieldIndex("iy"); int iside = dec.getFieldIndex("side"); - + // Get X, Y, & side neighbor data for this crystal. Set<XYSide> neighbors = getNeighbors(x, y, side); // Get buffer with values from current ID. int[] buffer = new int[dec.getFieldCount()]; - dec.getValues(buffer); - + dec.getValues(buffer); + // Create an encoder to make neighbor IDs. IDEncoder enc = new IDEncoder(dec.getIDDescription()); - + // Set to hold neighbor IDs. Set<Long> ids = new HashSet<Long>(); - + // Loop over neighbor objects to make IDs. - for (XYSide xyside : neighbors) - { + for (XYSide xyside : neighbors) { buffer[ix] = xyside.x; buffer[iy] = xyside.y; buffer[iside] = xyside.side; long nId = enc.setValues(buffer); ids.add(nId); } - + return ids; } - - Set<XYSide> getNeighbors(int ix, int iy, int side) - { + + Set<XYSide> getNeighbors(int ix, int iy, int side) { Set<Integer> xneighbors = getXNeighbors(ix); Set<Integer> yneighbors = getYNeighbors(iy); - + Set<XYSide> neighbors = new HashSet<XYSide>(); - - for (Integer jx : xneighbors) - { - for (Integer jy : yneighbors) - { + + for (Integer jx : xneighbors) { + for (Integer jy : yneighbors) { // Filter out self. - if (jx == ix && jy == iy) - { + if (jx == ix && jy == iy) { continue; } - - neighbors.add(new XYSide(jx,jy,side)); + + neighbors.add(new XYSide(jx, jy, side)); } } - + return neighbors; } - - Set<Integer> getXNeighbors(int ix) - { + + Set<Integer> getXNeighbors(int ix) { Set<Integer> neighbors = new HashSet<Integer>(); - + // Add self. neighbors.add(ix); - + // Left neighbor. - if (isValidX(ix - 1)) - { + if (isValidX(ix - 1)) { neighbors.add(ix - 1); - } - else if (isValidX(ix - 2)) - { + } else if (isValidX(ix - 2)) { neighbors.add(ix - 2); } - + // Right neighbor. - if (isValidX(ix + 1)) - { + if (isValidX(ix + 1)) { neighbors.add(ix + 1); - } - else if (isValidX(ix + 2)) - { + } else if (isValidX(ix + 2)) { neighbors.add(ix + 2); - } - + } + return neighbors; } - - Set<Integer> getYNeighbors(int iy) - { + + Set<Integer> getYNeighbors(int iy) { Set<Integer> neighbors = new HashSet<Integer>(); - + // Add self. neighbors.add(iy); - + // Lower neighbor. - if (isValidY(iy - 1)) - { + if (isValidY(iy - 1)) { neighbors.add(iy - 1); } // Upper neighbor. - if (isValidY(iy + 1)) - { + if (isValidY(iy + 1)) { neighbors.add(iy + 1); } - + return neighbors; } - - boolean isValidY(int iy) - { + + boolean isValidY(int iy) { // Zero is not valid because ID scheme goes from 1. return iy > 0 && iy <= ny; } - - boolean isValidX(int ix) - { + + boolean isValidX(int ix) { // Even case. - if (!oddX) - { - return ix >= -nx/2 && ix <= nx/2 && ix != 0; + if (!oddX) { + return ix >= -nx / 2 && ix <= nx / 2 && ix != 0; } // Odd case. - else - { - return ix >= (-nx-1)/2 && ix <= (nx+1)/2; - } - } - + else { + return ix >= (-nx - 1) / 2 && ix <= (nx + 1) / 2; + } + } + /** * Create a map of crystal IDs to the <code>Set</code> of neighbor crystal IDs. + * * @return A map of neighbors for each crystal ID. */ - public NeighborMap getNeighborMap() - { - if (neighborMap != null) - { + public NeighborMap getNeighborMap() { + if (neighborMap != null) { return neighborMap; } - - // Setup the private instance of the map. + + // Setup the private instance of the map. neighborMap = new NeighborMap(this.getDetectorElement().getIdentifierHelper()); - + IDDecoder dec = getIDDecoder(); IDEncoder enc = new IDEncoder(dec.getIDDescription()); - + int nfields = dec.getFieldCount(); int[] vals = new int[nfields]; vals[dec.getFieldIndex("system")] = getSystemID(); - + int idxx = dec.getFieldIndex("ix"); int idxy = dec.getFieldIndex("iy"); - - int hnx = nx; - - // Calculate number of X for loop. (from LCDD conv) - if (oddX) - { + + int hnx = nx; + + // Calculate number of X for loop. (from LCDD conv) + if (oddX) { hnx -= 1; hnx /= 2; - } - else - { + } else { hnx /= 2; } - - for (int side=-1; side <=1; side++) - { - if (side == 0) continue; + + for (int side = -1; side <= 1; side++) { + if (side == 0) + continue; vals[dec.getFieldIndex("side")] = side; // Loop over y. - for (int iy=1; iy<=ny; iy++) - { + for (int iy = 1; iy <= ny; iy++) { // Loop over x. - for (int ix=0; ix<=hnx; ix++) - { + for (int ix = 0; ix <= hnx; ix++) { // Loop for positive and negative x. - for (int j=-1; j<=1; j++) - { + for (int j = -1; j <= 1; j++) { if (j == 0) continue; - - vals[idxx] = ix*j; + + vals[idxx] = ix * j; vals[idxy] = iy; - + Long id = enc.setValues(vals); Set<Long> neighbors = getNeighbors(id); - + neighborMap.put(id, neighbors); } } } } - + return neighborMap; - } + } } Modified: java/trunk/detector-model/src/main/java/org/lcsim/geometry/subdetector/HPSEcal3.java ============================================================================= --- java/trunk/detector-model/src/main/java/org/lcsim/geometry/subdetector/HPSEcal3.java (original) +++ java/trunk/detector-model/src/main/java/org/lcsim/geometry/subdetector/HPSEcal3.java Thu Mar 10 17:32:07 2016 @@ -150,7 +150,7 @@ /** * The number of crystals in X in one section. * - * @return + * @return the number of crystals in X in one section */ public double nx() { return nx; @@ -159,7 +159,7 @@ /** * The number of crystals in y in one section. * - * @return + * @return the number of crystals in Y in one section */ public double ny() { return ny; Modified: java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/io/TextManager.java ============================================================================= --- java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/io/TextManager.java (original) +++ java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/io/TextManager.java Thu Mar 10 17:32:07 2016 @@ -53,7 +53,7 @@ /** * Initializes an event manager that will read from the indicated file. - * @param filename - The path to the file containing hit information. + * @param file - The path to the file containing hit information. */ public TextManager(File file) throws IOException { reader = new AdvancedReader(file); Modified: java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/ui/ActiveViewer.java ============================================================================= --- java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/ui/ActiveViewer.java (original) +++ java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/ui/ActiveViewer.java Thu Mar 10 17:32:07 2016 @@ -34,8 +34,6 @@ * events from the indicated data source with additional status * fields defined by the <code>fieldNames</code> argument. * @param em - The data source event manager. - * @param fieldNames - An array of additional status fields - * that should be displayed. */ public ActiveViewer(EventManager em) { // Pass any additional field values to the super class. Modified: java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/ui/CalorimeterPanel.java ============================================================================= --- java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/ui/CalorimeterPanel.java (original) +++ java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/ui/CalorimeterPanel.java Thu Mar 10 17:32:07 2016 @@ -503,8 +503,8 @@ /** * Determines if the crystal at the given coordinates is a active * or not. - * @param xCoor - The x-index of the crystal. - * @param yCoor - The y-index of the crystal. + * @param ix - The x-index of the crystal. + * @param iy - The y-index of the crystal. * @return Returns <code>true</code> if the crystal is active * and <code>false</code> if it is not. * @throws IndexOutOfBoundsException Occurs when either of the given @@ -740,28 +740,28 @@ /** * Sets whether to mirror the x-axis on the calorimeter display. - * @param state - <code>true</code> indicates that the axis should + * @param mirrorX - <code>true</code> indicates that the axis should * be mirrored and <code>false</code> that it should not. */ public void setMirrorX(boolean mirrorX) { - // Process the change. - setMirror(mirrorX, mirrorY); - - // Throw an event. - throwSettingsEvent(SettingsEvent.PROPERTY_X_ORIENTATION); + // Process the change. + setMirror(mirrorX, mirrorY); + + // Throw an event. + throwSettingsEvent(SettingsEvent.PROPERTY_X_ORIENTATION); } /** * Sets whether to mirror the y-axis on the calorimeter display. - * @param state - <code>true</code> indicates that the axis should + * @param mirrorY - <code>true</code> indicates that the axis should * be mirrored and <code>false</code> that it should not. */ public void setMirrorY(boolean mirrorY) { - // Process the change. - setMirror(mirrorX, mirrorY); - - // Throw an event. - throwSettingsEvent(SettingsEvent.PROPERTY_Y_ORIENTATION); + // Process the change. + setMirror(mirrorX, mirrorY); + + // Throw an event. + throwSettingsEvent(SettingsEvent.PROPERTY_Y_ORIENTATION); } /** Modified: java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/ui/PDataEventViewer.java ============================================================================= --- java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/ui/PDataEventViewer.java (original) +++ java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/ui/PDataEventViewer.java Thu Mar 10 17:32:07 2016 @@ -57,7 +57,6 @@ * Initializes a new <code>DataFileViewer</code> that reads from * the given event manager for event data and the given hardware * data file for crystal hardware data readout. - * @param dataSource - The manager for event data. * @param crystalDataFilePath - The data file for crystal hardware * information. * @throws IOException Occurs if there is an error reading from Modified: java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/ui/PassiveViewer.java ============================================================================= --- java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/ui/PassiveViewer.java (original) +++ java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/ui/PassiveViewer.java Thu Mar 10 17:32:07 2016 @@ -16,7 +16,7 @@ /** * Adds a new hit to the display. - * @param hit - The hit to be added. + * @param lcioHit - The hit to be added. */ public abstract void addHit(CalorimeterHit lcioHit); Modified: java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/ui/Viewer.java ============================================================================= --- java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/ui/Viewer.java (original) +++ java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/ui/Viewer.java Thu Mar 10 17:32:07 2016 @@ -122,8 +122,6 @@ /** * Initializes the viewer window and calorimeter panel. - * @param statusFields - Additional fields to display in the status - * panel. This can not be <code>null</code>. * @throws NullPointerException Occurs if any of the additional field * arguments are <code>null</code>. **/ Modified: java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/EcalCalibrationsDriver.java ============================================================================= --- java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/EcalCalibrationsDriver.java (original) +++ java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/EcalCalibrationsDriver.java Thu Mar 10 17:32:07 2016 @@ -35,7 +35,7 @@ import org.lcsim.util.aida.AIDA; /** - * This Driver will generate a {@link org.hps.conditions.EcalCalibration} collection + * This Driver will generate a {@link org.hps.conditions.ecal.EcalCalibration} collection * from the ADC value distributions of raw ECAL data. It may optionally insert this * information into the conditions database using the file's run number. * @@ -46,20 +46,20 @@ */ public class EcalCalibrationsDriver extends Driver { - EcalConditions ecalConditions = null; - DatabaseConditionsManager conditionsManager = null; - AIDA aida = AIDA.defaultInstance(); - IFunctionFactory functionFactory = aida.analysisFactory().createFunctionFactory(null); - IFitFactory fitFactory = aida.analysisFactory().createFitFactory(); - boolean loadCalibrations = false; - boolean performFit = true; - Integer runStart = null; - Integer runEnd = null; - File outputFile = null; - Set<Integer> runs = new HashSet<Integer>(); - static DecimalFormat decimalFormat = new DecimalFormat("#.####"); - String inputHitsCollectionName = "EcalReadoutHits"; - static String ECAL_CALIBRATIONS = "ecal_calibrations"; + private EcalConditions ecalConditions = null; + private DatabaseConditionsManager conditionsManager = null; + private AIDA aida = AIDA.defaultInstance(); + private IFunctionFactory functionFactory = aida.analysisFactory().createFunctionFactory(null); + private IFitFactory fitFactory = aida.analysisFactory().createFitFactory(); + private boolean loadCalibrations = false; + private boolean performFit = true; + private Integer runStart = null; + private Integer runEnd = null; + private File outputFile = null; + private Set<Integer> runs = new HashSet<Integer>(); + private static DecimalFormat DECIMAL_FORMAT = new DecimalFormat("#.####"); + private String inputHitsCollectionName = "EcalReadoutHits"; + private static String ECAL_CALIBRATIONS = "ecal_calibrations"; /** * Set the RawTrackerHit collection of hits to be used for the calibration. @@ -216,8 +216,8 @@ } // Truncate to 4 decimal places. - mean = Double.valueOf(decimalFormat.format(mean)); - sigma = Double.valueOf(decimalFormat.format(sigma)); + mean = Double.valueOf(DECIMAL_FORMAT.format(mean)); + sigma = Double.valueOf(DECIMAL_FORMAT.format(sigma)); // Create a new calibration object and add it to the collection, using mean for pedestal // and sigma for noise. Modified: java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/EcalRawConverterDriver.java ============================================================================= --- java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/EcalRawConverterDriver.java (original) +++ java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/EcalRawConverterDriver.java Thu Mar 10 17:32:07 2016 @@ -404,18 +404,17 @@ /** * @return false if the channel is a good one, true if it is a bad one - * @param CalorimeterHit + * @param hit the <code>CalorimeterHit</code> pointing to the channel */ public boolean isBadCrystal(CalorimeterHit hit) { // Get the channel data. EcalChannelConstants channelData = findChannel(hit.getCellID()); - return channelData.isBadChannel(); } /** * @return false if the ADC is a good one, true if it is a bad one - * @param CalorimeterHit + * @param hit the <code>CalorimeterHit</code> pointing to the FADC */ public boolean isBadFADC(CalorimeterHit hit) { return (getCrate(hit.getCellID()) == 1 && getSlot(hit.getCellID()) == 3); Modified: java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/AbstractClusterer.java ============================================================================= --- java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/AbstractClusterer.java (original) +++ java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/AbstractClusterer.java Thu Mar 10 17:32:07 2016 @@ -16,7 +16,7 @@ /** * This is an abstract class that {@link Clusterer} classes should implement * to perform a clustering algorithm on a <code>CalorimeterHit</code> collection. - * The sub-class should implement {@link #createClusters(List)} which is + * The sub-class should implement {@link #createClusters(EventHeader, List)} which is * the method that should perform the clustering algorithm. * * @see Clusterer @@ -69,8 +69,8 @@ /** * This is the primary method for sub-classes to implement their clustering algorithm. - * @param hits - * @return + * @param hits the list of hits + * @return the list of created clusters */ public abstract List<Cluster> createClusters(EventHeader event, List<CalorimeterHit> hits); Modified: java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/ClusterDriver.java ============================================================================= --- java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/ClusterDriver.java (original) +++ java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/ClusterDriver.java Thu Mar 10 17:32:07 2016 @@ -73,7 +73,7 @@ /** * Set the name of the input CalorimeterHit collection to use for clustering. - * @param inputHitcollectionName The name of the input hit collection. + * @param inputHitCollectionName The name of the input hit collection. */ public void setInputHitCollectionName(String inputHitCollectionName) { this.inputHitCollectionName = inputHitCollectionName; @@ -128,7 +128,7 @@ * This will use a factory method which first tries to use some hard-coded names from * the cluster package. As a last resort, it will interpret the name as a canonical * class name and try to instantiate it using the Class API. - * @param The name or canonical class name of the Clusterer. + * @param name The name or canonical class name of the Clusterer. */ public void setClustererName(String name) { clusterer = ClustererFactory.create(name); Modified: java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/ClusterPositionCorrection.java ============================================================================= --- java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/ClusterPositionCorrection.java (original) +++ java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/ClusterPositionCorrection.java Thu Mar 10 17:32:07 2016 @@ -58,7 +58,7 @@ * @param pdg Particle id as per PDG * @param xCl Calculated x centroid position of the cluster, uncorrected, at face * @param rawEnergy Raw energy of the cluster (sum of hits with shared hit distribution) - * @return Corrected x position + * @return the corrected x position */ private static double computeCorrectedPosition(int pdg, double xPos, double rawEnergy) { //double xCl = xPos / 10.0;//convert to cm @@ -91,7 +91,7 @@ * @param varB1 * @param varB2 * @param varB3 - * @return + * @return the cluster position correction */ private static double positionCorrection(double xCl, double rawEnergy, double varA1, double varA2, double varB1, double varB2, double varB3) { //return ((xCl - (varB1 * rawEnergy + varB2 / Math.sqrt(rawEnergy) + varB3))/(varA1 / Math.sqrt(rawEnergy) + varA2 + 1)); Modified: java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/ClusterUtilities.java ============================================================================= --- java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/ClusterUtilities.java (original) +++ java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/ClusterUtilities.java Thu Mar 10 17:32:07 2016 @@ -199,7 +199,7 @@ /** * Find the unique set of MCParticles that are referenced by the hits of the Cluster. - * @param clusters The input Cluster. + * @param cluster The input Cluster. * @return The set of unique MCParticles. */ public static Set<MCParticle> findMCParticles(Cluster cluster) { @@ -428,7 +428,7 @@ /** * Get the set of hits from a list of clusters. - * @param The input cluster list. + * @param clusters The input cluster list. * @return The list of hits from all the clusters. */ public static Set<CalorimeterHit> getHits(List<Cluster> clusters) { Modified: java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/ClustererFactory.java ============================================================================= --- java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/ClustererFactory.java (original) +++ java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/ClustererFactory.java Thu Mar 10 17:32:07 2016 @@ -38,7 +38,7 @@ * @param name The name of the clustering algorithm. * @param cuts The set of cuts (can be null). * @return The clustering algorithm. - * @throw IllegalArgumentException if there is no Clusterer found with name. + * @throws IllegalArgumentException if there is no Clusterer found with name. */ public static Clusterer create(String name, double[] cuts) { Clusterer clusterer; Modified: java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/CopyClusterCollectionDriver.java ============================================================================= --- java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/CopyClusterCollectionDriver.java (original) +++ java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/CopyClusterCollectionDriver.java Thu Mar 10 17:32:07 2016 @@ -111,8 +111,8 @@ /** * Set to <code>true</code> to store hits in the output clusters. - * - * @return <code>true</code> to store hits in the output clusters + * + * @param store <code>true</code> to store hits; <code>false</code> to not store hits */ public void setStoreHits(final boolean storeHits) { this.storeHits = storeHits; Modified: java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/GTPClusterer.java ============================================================================= --- java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/GTPClusterer.java (original) +++ java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/GTPClusterer.java Thu Mar 10 17:32:07 2016 @@ -124,7 +124,7 @@ * forms a collection of <code>Cluster</code> objects according to * the GTP clustering algorithm. * @param event - The object containing event data. - * @param hitList - A list of <code>CalorimeterHit</code> objects + * @param hits - A list of <code>CalorimeterHit</code> objects * from which clusters should be formed. */ public List<Cluster> createClusters(EventHeader event, List<CalorimeterHit> hits) { Modified: java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/SimpleCosmicClusterer.java ============================================================================= --- java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/SimpleCosmicClusterer.java (original) +++ java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/SimpleCosmicClusterer.java Thu Mar 10 17:32:07 2016 @@ -125,9 +125,8 @@ } /** - * This method takes a list of potential cluster hits and applies selection cuts, - * returning a new list that has the hit lists which did not pass the cuts removed. - * @param clusteredHitLists The input hit lists. + * Apply selection cuts to cluster list and return filtered list. + * @param clusterList The input hit lists. * @return The hit lists that passed the cuts. */ protected List<Cluster> applyCuts(List<Cluster> clusterList) { Modified: java/trunk/evio/src/main/java/org/hps/evio/AbstractSvtEvioReader.java ============================================================================= --- java/trunk/evio/src/main/java/org/hps/evio/AbstractSvtEvioReader.java (original) +++ java/trunk/evio/src/main/java/org/hps/evio/AbstractSvtEvioReader.java Thu Mar 10 17:32:07 2016 @@ -31,7 +31,6 @@ * * @author Omar Moreno <[log in to unmask]> * @author Per Hansson Adrian <[log in to unmask]> - * @date November 20, 2014 * */ public abstract class AbstractSvtEvioReader extends EvioReader { @@ -322,7 +321,7 @@ * @param samples * @param index * @param multisampleHeaderData - * @return + * @return the length of the extracted samples or 0 if not a multisample header */ protected int extractMultisampleHeaderData(int[] samples, int index, int[] multisampleHeaderData) { LOGGER.finest("extractMultisampleHeaderData: index " + index); Modified: java/trunk/evio/src/main/java/org/hps/evio/EvioReader.java ============================================================================= --- java/trunk/evio/src/main/java/org/hps/evio/EvioReader.java (original) +++ java/trunk/evio/src/main/java/org/hps/evio/EvioReader.java Thu Mar 10 17:32:07 2016 @@ -18,8 +18,8 @@ protected String hitCollectionName = null; /** - * Make a LCIO hit collection (e.g. {@link RawTrackerHit}, - * {@link CalorimeterHit} from raw EVIO data. + * Make a LCIO hit collection (e.g. {@link org.lcsim.event.RawTrackerHit}, + * {@link org.lcsim.event.CalorimeterHit} from raw EVIO data. * * @param event : The EVIO event to read the raw data from * @param lcsimEvent : The LCSim event to write the collections to Modified: java/trunk/evio/src/main/java/org/hps/evio/EvioToLcio.java ============================================================================= --- java/trunk/evio/src/main/java/org/hps/evio/EvioToLcio.java (original) +++ java/trunk/evio/src/main/java/org/hps/evio/EvioToLcio.java Thu Mar 10 17:32:07 2016 @@ -463,8 +463,6 @@ * This method will execute the EVIO to LCIO conversion and optionally process the events with LCSim Drivers from a * steering file. Then the resultant LCIO events will be written to disk if this option is enabled in the command * line arguments. - * - * @param args The command line arguments. */ public void run() { Modified: java/trunk/evio/src/main/java/org/hps/evio/LCSimEngRunEventBuilder.java ============================================================================= --- java/trunk/evio/src/main/java/org/hps/evio/LCSimEngRunEventBuilder.java (original) +++ java/trunk/evio/src/main/java/org/hps/evio/LCSimEngRunEventBuilder.java Thu Mar 10 17:32:07 2016 @@ -121,10 +121,6 @@ } else { LOGGER.info("Run manager is not initialized; TI time offset not available."); } - try { - RunManager.getRunManager().closeConnection(); - } catch (Exception e) { - } } /** Modified: java/trunk/evio/src/main/java/org/hps/evio/SvtEvioReader.java ============================================================================= --- java/trunk/evio/src/main/java/org/hps/evio/SvtEvioReader.java (original) +++ java/trunk/evio/src/main/java/org/hps/evio/SvtEvioReader.java Thu Mar 10 17:32:07 2016 @@ -18,8 +18,6 @@ * SVT EVIO reader used to convert SVT bank integer data to LCIO objects. * * @author Omar Moreno <[log in to unmask]> - * @data February 03, 2015 - * */ public class SvtEvioReader extends AbstractSvtEvioReader { Modified: java/trunk/evio/src/main/java/org/hps/evio/TestRunSvtEvioReader.java ============================================================================= --- java/trunk/evio/src/main/java/org/hps/evio/TestRunSvtEvioReader.java (original) +++ java/trunk/evio/src/main/java/org/hps/evio/TestRunSvtEvioReader.java Thu Mar 10 17:32:07 2016 @@ -18,8 +18,6 @@ * objects. * * @author Omar Moreno <[log in to unmask]> - * @date November 20, 2014 - * */ public class TestRunSvtEvioReader extends AbstractSvtEvioReader { Modified: java/trunk/monitoring-drivers/src/main/java/org/hps/monitoring/ecal/plots/EcalDaqPlots.java ============================================================================= --- java/trunk/monitoring-drivers/src/main/java/org/hps/monitoring/ecal/plots/EcalDaqPlots.java (original) +++ java/trunk/monitoring-drivers/src/main/java/org/hps/monitoring/ecal/plots/EcalDaqPlots.java Thu Mar 10 17:32:07 2016 @@ -18,11 +18,12 @@ import org.lcsim.util.aida.AIDA; /** - * The driver <code>EcalDaqPlots</code> implements the histogram shown to the user in the fourth tab of the Monitoring Application, when using the Ecal monitoring lcsim file. It contains only a - * sub-tab, showing the number of hits recorded by the different FADC channels. It is a very preliminary driver to monitor the DAQ status. These plots are updated continuosly. + * The driver <code>EcalDaqPlots</code> implements the histogram shown to the user in the fourth tab of the + * Monitoring Application, when using the Ecal monitoring lcsim file. It contains only a sub-tab, showing + * the number of hits recorded by the different FADC channels. It is a very preliminary driver to monitor + * the DAQ status. These plots are updated continuously. + * * @author Andrea Celentano - * @TODO: integrate with the new conditions system. - * */ public class EcalDaqPlots extends Driver { Modified: java/trunk/monitoring-drivers/src/main/java/org/hps/monitoring/ecal/plots/EcalLedSequenceMonitor.java ============================================================================= --- java/trunk/monitoring-drivers/src/main/java/org/hps/monitoring/ecal/plots/EcalLedSequenceMonitor.java (original) +++ java/trunk/monitoring-drivers/src/main/java/org/hps/monitoring/ecal/plots/EcalLedSequenceMonitor.java Thu Mar 10 17:32:07 2016 @@ -707,7 +707,7 @@ /** * This function returns the driver number (from 0 to 3) given the LED id. * @param led - * @return + * @return the driver number from the LED id */ public int getDriver(int led){ int ret=-1; @@ -723,7 +723,7 @@ * If the gain changes (because we do a re-calibration), I do not want to include this in the LED analysis * @param energy * @param cellID - * @return + * @return the pedestal-subtracted raw energy */ public double getRawADCSum(double energy,long cellID){ EcalChannelConstants channelData = ecalConditions.getChannelConstants(ecalConditions.getChannelCollection().findGeometric(cellID)); Modified: java/trunk/monitoring-drivers/src/main/java/org/hps/monitoring/ecal/plots/EcalMonitoringPlots.java ============================================================================= --- java/trunk/monitoring-drivers/src/main/java/org/hps/monitoring/ecal/plots/EcalMonitoringPlots.java (original) +++ java/trunk/monitoring-drivers/src/main/java/org/hps/monitoring/ecal/plots/EcalMonitoringPlots.java Thu Mar 10 17:32:07 2016 @@ -59,7 +59,7 @@ /** * Set the refresh rate for histograms in this driver - * @param eventRefreshRate: the refresh rate, defined as number of events to accumulate before + * @param eventRefreshRate the refresh rate, defined as number of events to accumulate before * refreshing the plot */ public void setEventRefreshRate(int eventRefreshRate) { Modified: java/trunk/monitoring-util/src/main/java/org/hps/monitoring/plotting/ExportPdf.java ============================================================================= --- java/trunk/monitoring-util/src/main/java/org/hps/monitoring/plotting/ExportPdf.java (original) +++ java/trunk/monitoring-util/src/main/java/org/hps/monitoring/plotting/ExportPdf.java Thu Mar 10 17:32:07 2016 @@ -45,12 +45,10 @@ /** * Save a set of tabs containing plots to a file. * - * @param plotTabs the top level tab component (plots are actually in a set - * of tabs without these tabs) + * @param plotters the list of plotters to save (from plots in the regions) * @param fileName the file name * @param runData the list of run data to save on the cover page - * @throws IOException if there is a problem with the IO (e.g. writing to - * PDF file) + * @throws IOException if there is a problem with the IO (e.g. writing to PDF file) */ public static void write(List<IPlotter> plotters, String fileName, List<String> runData) throws IOException { Modified: java/trunk/monitoring-util/src/main/java/org/hps/monitoring/subsys/et/package-info.java ============================================================================= --- java/trunk/monitoring-util/src/main/java/org/hps/monitoring/subsys/et/package-info.java (original) +++ java/trunk/monitoring-util/src/main/java/org/hps/monitoring/subsys/et/package-info.java Thu Mar 10 17:32:07 2016 @@ -1,8 +1,7 @@ /** * ET subsystem monitoring - * <p> - * {@link EtSystemMonitor} implements basic status checks of the ET system. * * @author Jeremy McCormick, SLAC + * @see EtSystemMonitor */ package org.hps.monitoring.subsys.et; Modified: java/trunk/monitoring-util/src/main/java/org/hps/monitoring/trigger/DiagnosticUpdatable.java ============================================================================= --- java/trunk/monitoring-util/src/main/java/org/hps/monitoring/trigger/DiagnosticUpdatable.java (original) +++ java/trunk/monitoring-util/src/main/java/org/hps/monitoring/trigger/DiagnosticUpdatable.java Thu Mar 10 17:32:07 2016 @@ -9,14 +9,15 @@ * alter their displayed or constituent values. * * @author Kyle McCarty <[log in to unmask]> - * @see DiagSnapshot + * @see org.hps.analysis.trigger.data.DiagnosticSnapshot */ public interface DiagnosticUpdatable { /** * Updates the object with information from the trigger diagnostic * snapshot in the argument. - * @param snapshot - The snapshot containing information with which - * to update the object. + * @param runSnapshot the accumulated snapshot + * @param localSnapshot The snapshot containing information with which + * to update the object. */ public void updatePanel(DiagnosticSnapshot runSnapshot, DiagnosticSnapshot localSnapshot); } Modified: java/trunk/recon/src/main/java/org/hps/recon/particle/ReconParticleDriver.java ============================================================================= --- java/trunk/recon/src/main/java/org/hps/recon/particle/ReconParticleDriver.java (original) +++ java/trunk/recon/src/main/java/org/hps/recon/particle/ReconParticleDriver.java Thu Mar 10 17:32:07 2016 @@ -230,7 +230,7 @@ * clusters. Clusters will be matched with tracks when this is possible. * * @param clusters - The list of event clusters. - * @param tracks - The list of event tracks. + * @param trackCollections - The list of event tracks. * @return Returns a <code>List</code> collection containing all of the * <code>ReconstructedParticle</code> objects generated from the argument * data. Modified: java/trunk/recon/src/main/java/org/hps/recon/utils/TrackClusterMatcher.java ============================================================================= --- java/trunk/recon/src/main/java/org/hps/recon/utils/TrackClusterMatcher.java (original) +++ java/trunk/recon/src/main/java/org/hps/recon/utils/TrackClusterMatcher.java Thu Mar 10 17:32:07 2016 @@ -253,11 +253,11 @@ * and uncorrected cluster positions. * * @param cluster = position-uncorrected cluster - * @param track + * @param particle recon particle with tracks * * @return #sigma between cluster and track positions */ - public double getNSigmaPosition(Cluster cluster,ReconstructedParticle particle) { + public double getNSigmaPosition(Cluster cluster, ReconstructedParticle particle) { if (particle.getTracks().size()<1) return Double.MAX_VALUE; Track track=particle.getTracks().get(0); Modified: java/trunk/record-util/src/main/java/org/hps/record/AbstractRecordQueue.java ============================================================================= --- java/trunk/record-util/src/main/java/org/hps/record/AbstractRecordQueue.java (original) +++ java/trunk/record-util/src/main/java/org/hps/record/AbstractRecordQueue.java Thu Mar 10 17:32:07 2016 @@ -45,7 +45,8 @@ /** * Class constructor with the timeout in seconds. * - * @param timeoutSeconds the timeout in seconds + * @param timeOutMillis the timeout in seconds + * @param maxSize the maximum size of the queue */ public AbstractRecordQueue(final long timeOutMillis, final int maxSize) { this.timeOutMillis = timeOutMillis; @@ -55,7 +56,7 @@ /** * Add a record to the queue if there is space. * - * @param event the LCIO event to add + * @param record the LCIO event to add */ // FIXME: Should drain queue if over capacity. public void addRecord(final RecordType record) { Modified: java/trunk/record-util/src/main/java/org/hps/record/composite/RecordProcessorAdapter.java ============================================================================= --- java/trunk/record-util/src/main/java/org/hps/record/composite/RecordProcessorAdapter.java (original) +++ java/trunk/record-util/src/main/java/org/hps/record/composite/RecordProcessorAdapter.java Thu Mar 10 17:32:07 2016 @@ -44,7 +44,7 @@ /** * Activate the <code>endJob</code> methods of the registered processors. * - * @param the <code>LoopEvent</code> which activated <code>finish</code> + * @param loopEvent the <code>LoopEvent</code> which activated <code>finish</code> */ @Override public void finish(final LoopEvent loopEvent) { @@ -80,7 +80,7 @@ /** * Activate the <code>startJob</code> methods of the registered processors. * - * @param the <code>LoopEvent</code> which activated the start + * @param loopEvent the <code>LoopEvent</code> which activated the start */ @Override public void start(final LoopEvent loopEvent) { @@ -103,7 +103,7 @@ /** * Activate the <code>suspend</code> methods of the registered processors. * - * @param the <code>LoopEvent</code> which activated <code>suspend</code>. + * @param loopEvent the <code>LoopEvent</code> which activated <code>suspend</code>. */ @Override public void suspend(final LoopEvent loopEvent) { Modified: java/trunk/record-util/src/main/java/org/hps/record/svt/SvtEvioUtils.java ============================================================================= --- java/trunk/record-util/src/main/java/org/hps/record/svt/SvtEvioUtils.java (original) +++ java/trunk/record-util/src/main/java/org/hps/record/svt/SvtEvioUtils.java Thu Mar 10 17:32:07 2016 @@ -5,7 +5,6 @@ * A set of static utility methods used to decode SVT data. * * @author Omar Moreno <[log in to unmask]> - * @date November 20, 2014 */ public class SvtEvioUtils { @@ -19,9 +18,7 @@ private static final int APV_HEADER_BUFFER_ADDRESS_MASK = 0xFF; //[8:1] private static final int APV_HEADER_DATA_FRAME_COUNT_MASK = 0xF; //[12:9] private static final int APV_HEADER_DATA_APV_NR_MASK = 0x3; //[15:13] - - - + // TODO: Move these to constants class public static final int APV25_PER_HYBRID = 5; public static final int CHANNELS_PER_APV25 = 128; @@ -90,13 +87,12 @@ * Extract and return the front end board (FEB) ID associated with the * multisample tail * - * @param data : a multisample header + * @param multisampleTail : a multisample header * @return A FEB ID in the range 0-10 */ public static int getFebIDFromMultisampleTail(int multisampleTail) { return (multisampleTail >>> 8) & FEB_MASK; } - /** * Extract and return the front end board (FEB) hybrid ID associated with @@ -113,7 +109,7 @@ * Extract and return the front end board (FEB) hybrid ID associated with * the multisample tail * - * @param multisample : a multisample tail + * @param multisampleTail : a multisample tail * @return A FEB hybrid ID in the range 0-3 */ public static int getFebHybridIDFromMultisampleTail(int multisampleTail) { @@ -258,7 +254,7 @@ /** * Extract the error bit from the multisample header. * - * @param data : multisample of data + * @param multisampleHeader : multisample of data * @return value of the error bit. This is non-zero if there is an error. */ public static int getErrorBitFromMultisampleHeader(int multisampleHeader) { Modified: java/trunk/record-util/src/main/java/org/hps/record/triggerbank/AbstractIntData.java ============================================================================= --- java/trunk/record-util/src/main/java/org/hps/record/triggerbank/AbstractIntData.java (original) +++ java/trunk/record-util/src/main/java/org/hps/record/triggerbank/AbstractIntData.java Thu Mar 10 17:32:07 2016 @@ -74,7 +74,6 @@ * Return the int bank of an AbstractIntData read from LCIO. * * @param object - * @return */ public static int[] getBank(GenericObject object) { int N = object.getNInt() - 1; Modified: java/trunk/record-util/src/main/java/org/hps/record/triggerbank/TriggerConfigData.java ============================================================================= --- java/trunk/record-util/src/main/java/org/hps/record/triggerbank/TriggerConfigData.java (original) +++ java/trunk/record-util/src/main/java/org/hps/record/triggerbank/TriggerConfigData.java Thu Mar 10 17:32:07 2016 @@ -93,7 +93,7 @@ /** * Load DAQ config object from trigger config string data. * - * @param the run number (needed by configuration manager) + * @param run the run number (needed by configuration manager) * @return the DAQ config object */ public DAQConfig loadDAQConfig(int run) { Modified: java/trunk/run-database/src/main/java/org/hps/run/database/EpicsVariable.java ============================================================================= --- java/trunk/run-database/src/main/java/org/hps/run/database/EpicsVariable.java (original) +++ java/trunk/run-database/src/main/java/org/hps/run/database/EpicsVariable.java Thu Mar 10 17:32:07 2016 @@ -53,9 +53,9 @@ * Create an EPICs variable. * * @param variableName the name of the variable - * @param columnName the column name in the run db + * @param columnName the column name in the run database * @param description the variable's description - * @param variableType the type of the variable + * @param type the integer encoding of the type */ public EpicsVariable(final String variableName, final String columnName, final String description, final int type) { this.variableName = variableName; Modified: java/trunk/tracking/src/main/java/org/hps/readout/svt/FpgaData.java ============================================================================= --- java/trunk/tracking/src/main/java/org/hps/readout/svt/FpgaData.java (original) +++ java/trunk/tracking/src/main/java/org/hps/readout/svt/FpgaData.java Thu Mar 10 17:32:07 2016 @@ -39,8 +39,9 @@ /** * - * @param temperature : array containing hybrid temperatures - * @param tail : word present at the end of a FPGA data set + * @param fpgaID FPGA ID + * @param data : array containing hybrid temperatures + * @param tail : word present at the end of a FPGA data set */ public FpgaData(int fpgaID, int[] data, int tail) { this.fpgaID = fpgaID; Modified: java/trunk/tracking/src/main/java/org/hps/recon/tracking/StrategyType.java ============================================================================= --- java/trunk/tracking/src/main/java/org/hps/recon/tracking/StrategyType.java (original) +++ java/trunk/tracking/src/main/java/org/hps/recon/tracking/StrategyType.java Thu Mar 10 17:32:07 2016 @@ -4,7 +4,7 @@ import java.util.Map; /** - * Enum constants for different {@link Track}s based on what tracking + * Enum constants for different {@link org.lcsim.event.Track} objects based on what tracking * strategy was used. The type is defined by comparing the tracking strategy * name to the name of all the enum constants. * Modified: java/trunk/tracking/src/main/java/org/hps/recon/tracking/TrackDataDriver.java ============================================================================= --- java/trunk/tracking/src/main/java/org/hps/recon/tracking/TrackDataDriver.java (original) +++ java/trunk/tracking/src/main/java/org/hps/recon/tracking/TrackDataDriver.java Thu Mar 10 17:32:07 2016 @@ -23,8 +23,8 @@ import org.lcsim.util.Driver; /** - * Driver used to persist additional {@link Track} information via a - * {@link GenericObject}. + * Driver used to persist additional {@link org.lcsim.event.Track} information via a + * {@link org.lcsim.event.GenericObject} collection. * * @author Omar Moreno, UCSC * @author Sho Uemura, SLAC Modified: java/trunk/tracking/src/main/java/org/hps/recon/tracking/TrackQualityData.java ============================================================================= --- java/trunk/tracking/src/main/java/org/hps/recon/tracking/TrackQualityData.java (original) +++ java/trunk/tracking/src/main/java/org/hps/recon/tracking/TrackQualityData.java Thu Mar 10 17:32:07 2016 @@ -17,10 +17,7 @@ private final double[] doubles; /** - * Default Ctor - * - * @param trackerVolume : The SVT volume to which the track used to - * calculate the residuals corresponds to. + * Default Ctor */ public TrackQualityData() { doubles = new double[2]; Modified: java/trunk/tracking/src/main/java/org/hps/recon/tracking/TrackUtils.java ============================================================================= --- java/trunk/tracking/src/main/java/org/hps/recon/tracking/TrackUtils.java (original) +++ java/trunk/tracking/src/main/java/org/hps/recon/tracking/TrackUtils.java Thu Mar 10 17:32:07 2016 @@ -78,7 +78,7 @@ * * @param track * @param x - * @return + * @return the position along the x-axis */ public static Hep3Vector extrapolateHelixToXPlane(Track track, double x) { return extrapolateHelixToXPlane(getHTF(track), x); @@ -153,9 +153,9 @@ /** * Extrapolate helix to a position along the x-axis. Re-use HelixUtils. * - * @param track + * @param htf * @param x - * @return + * @return the position along the x-axis */ public static Hep3Vector extrapolateHelixToXPlane(HelicalTrackFit htf, double x) { double s = HelixUtils.PathToXPlane(htf, x, 0., 0).get(0); @@ -346,7 +346,7 @@ * * @param track - to be extrapolated * @param z - * @return + * @return extrapolated position */ public static Hep3Vector extrapolateTrack(Track track, double z) { return extrapolateTrack(track.getTrackStates().get(0),z); @@ -357,7 +357,7 @@ * * @param track - to be extrapolated * @param z - * @return + * @return extrapolated position */ public static Hep3Vector extrapolateTrack(TrackState track, double z) { @@ -393,10 +393,8 @@ /** * Extrapolate track to given position, using dipole position from geometry. * - * @param helix - to be extrapolated - * @param track - position along the x-axis of the helix in lcsim - * coordiantes - * @return + * @param track - position along the x-axis of the helix in lcsim coordinates + * @return extrapolated position */ public static Hep3Vector extrapolateTrack(Track track, double z, Detector detector) { @@ -439,7 +437,7 @@ * * @param helix - to be extrapolated * @param z - position along the x-axis of the helix in lcsim coordiantes - * @return + * @return the extrapolated position */ public static Hep3Vector extrapolateTrack(HelicalTrackFit helix, double z) { SeedTrack trk = new SeedTrack(); @@ -1161,7 +1159,7 @@ * @param trk * @param hitToStrips * @param hitToRotated - * @return + * @return isolations for all 12 strip layers */ public static Double[] getIsolations(Track trk, RelationalTable hitToStrips, RelationalTable hitToRotated) { Double[] isolations = new Double[12]; @@ -1333,7 +1331,7 @@ * @param r0 * @param q * @param B - * @return + * @return the created trajectory */ public static Trajectory getTrajectory(Hep3Vector p0, org.lcsim.spacegeom.SpacePoint r0, double q, double B) { SpaceVector p = new CartesianVector(p0.v()); Modified: java/trunk/tracking/src/main/java/org/hps/recon/tracking/WTrack.java ============================================================================= --- java/trunk/tracking/src/main/java/org/hps/recon/tracking/WTrack.java (original) +++ java/trunk/tracking/src/main/java/org/hps/recon/tracking/WTrack.java Thu Mar 10 17:32:07 2016 @@ -15,10 +15,9 @@ * Track representation based on paper * Paul Avery, CBX 98-39, June 9, 1998 * - * Used primarily for the algorithm to intersect a helix with a generic plane in space. + * Used primarily for the algorithm to intersect a helix with a generic plane in space. * * @author phansson <[log in to unmask]> - */ public class WTrack { @@ -29,7 +28,6 @@ private boolean _debug = false; private final int max_iterations_intercept = 10; private final double epsilon_intercept = 1e-4; - /** * Constructor. Assumes that b-field is in detector z direction. @@ -189,7 +187,7 @@ * Get point on helix at path length s in arbitrary oriented, constant magnetic field with unit vector h * @param s - path length * @param h - magnetic field unit vector - * @return + * @return get a 3D point along the helix */ private Hep3Vector getPointOnHelix(double s, Hep3Vector h) { WTrack track = this; @@ -266,11 +264,9 @@ * @param xp point on the plane * @param eta unit vector of the plane * @param h unit vector of magnetic field - * @return + * @return the intersection point of the helix with the plane */ public Hep3Vector getHelixAndPlaneIntercept(Hep3Vector xp, Hep3Vector eta, Hep3Vector h) { - - int iteration = 1; double s_total = 0.; Modified: java/trunk/tracking/src/main/java/org/hps/recon/tracking/axial/HelicalTrack2DHit.java ============================================================================= --- java/trunk/tracking/src/main/java/org/hps/recon/tracking/axial/HelicalTrack2DHit.java (original) +++ java/trunk/tracking/src/main/java/org/hps/recon/tracking/axial/HelicalTrack2DHit.java Thu Mar 10 17:32:07 2016 @@ -11,8 +11,8 @@ * This class is explicitly for HPS where the length of the * sensors are (mostly) along the detector * y-dimension ( == HelicalTrackFit x-dimension); + * Copied/Modified from org.lcsim.recon.tracking.helicaltrack.HelicalTrack2DHit.java * @author Matt Graham <[log in to unmask]> - * Copied/Modified from org.lcsim.recon.tracking.helicaltrack.HelicalTrack2DHit.java */ public class HelicalTrack2DHit extends HelicalTrackHit { private double _axmin;//min value along the bend-direction.. @@ -27,8 +27,6 @@ * @param dEdx deposited energy * @param time hit time * @param rawhits list of raw hits - * @param axmin minimum z for the strip - * @param axmax maximum z for the strip * @param detname detector name * @param layer layer number * @param beflag Modified: java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/FittedGblTrajectory.java ============================================================================= --- java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/FittedGblTrajectory.java (original) +++ java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/FittedGblTrajectory.java Thu Mar 10 17:32:07 2016 @@ -88,7 +88,7 @@ /** * Find the index (or label) of the GBL point on the trajectory from the {@link GBLPOINT}. * @param point - * @return + * @return the index of the GBL point on the trajectory from the enum */ public int getPointIndex(GBLPOINT point) { int gblPointIndex; Modified: java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/GBLStripClusterData.java ============================================================================= --- java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/GBLStripClusterData.java (original) +++ java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/GBLStripClusterData.java Thu Mar 10 17:32:07 2016 @@ -81,7 +81,7 @@ } /** - * @param set track id to val + * @param val set track id to val */ public void setId(int val) { bank_int[GBLINT.ID] = val; @@ -193,7 +193,7 @@ /** * Set track direction at this cluster * - * @param tDir + * @param v the track direction */ public void setTrackDir(Hep3Vector v) { bank_double[GBLDOUBLE.TDIRX] = v.x(); Modified: java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/GBLTrackData.java ============================================================================= --- java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/GBLTrackData.java (original) +++ java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/GBLTrackData.java Thu Mar 10 17:32:07 2016 @@ -60,7 +60,7 @@ } /** - * @param set track id to val + * @param val track ID value */ public void setTrackId(int val) { bank_int[GBLINT.ID] = val; Modified: java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/GblUtils.java ============================================================================= --- java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/GblUtils.java (original) +++ java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/GblUtils.java Thu Mar 10 17:32:07 2016 @@ -316,17 +316,13 @@ throw new UnsupportedOperationException("Should not happen. This problem is only solved with the MaterialSupervisor."); } } - - - - /** * Calculate the Jacobian from Curvilinear to Perigee frame. * @param helicalTrackFit - original helix * @param helicalTrackFitAtIPCorrected - corrected helix at this point * @param bfield - magnitude of B-field - * @return + * @return the Jacobian matrix from Curvilinear to Perigee frame */ public static Matrix getCLToPerigeeJacobian(HelicalTrackFit helicalTrackFit, HpsHelicalTrackFit helicalTrackFitAtIPCorrected, double bfield) { Modified: java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/HelicalTrackStripGbl.java ============================================================================= --- java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/HelicalTrackStripGbl.java (original) +++ java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/HelicalTrackStripGbl.java Thu Mar 10 17:32:07 2016 @@ -13,10 +13,8 @@ import org.lcsim.fit.helicaltrack.HelicalTrackStrip; /** - * Encapsulates the {@HelicalTrackStrip} to make sure that the local unit vectors are + * Encapsulates the {@link org.lcsim.fit.helicaltrack.HelicalTrackStrip} to make sure that the local unit vectors are * coming from the underlying geometry. - * - * I think the base calss should change but whatever. * * @author Per Hansson Adrian <[log in to unmask]> * Modified: java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/MakeGblTracks.java ============================================================================= --- java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/MakeGblTracks.java (original) +++ java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/MakeGblTracks.java Thu Mar 10 17:32:07 2016 @@ -148,7 +148,7 @@ * @param _scattering - estimation of the multiple scattering {@link MultipleScattering}. * @param bfield - magnitude of B-field. * @param debug - debug flag. - * @return + * @return the fitted GBL trajectory */ public static FittedGblTrajectory doGBLFit(HelicalTrackFit htf, List<TrackerHit> stripHits, MultipleScattering _scattering, double bfield, int debug) { List<GBLStripClusterData> stripData = makeStripData(htf, stripHits, _scattering, bfield, debug); @@ -165,7 +165,7 @@ * @param _scattering * @param _B * @param _debug - * @return + * @return the list of GBL strip cluster data */ public static List<GBLStripClusterData> makeStripData(HelicalTrackFit htf, List<TrackerHit> stripHits, MultipleScattering _scattering, double _B, int _debug) { List<GBLStripClusterData> stripClusterDataList = new ArrayList<GBLStripClusterData>(); Modified: java/trunk/tracking/src/main/java/org/hps/recon/tracking/straight/STUtils.java ============================================================================= --- java/trunk/tracking/src/main/java/org/hps/recon/tracking/straight/STUtils.java (original) +++ java/trunk/tracking/src/main/java/org/hps/recon/tracking/straight/STUtils.java Thu Mar 10 17:32:07 2016 @@ -406,7 +406,7 @@ * @param origin * @param strip1 * @param strip2 - * @return + * @return the stereo hit position */ static Hep3Vector getStereoHitPositionFromReference(Hep3Vector origin, SiTrackerHitStrip1D strip1, SiTrackerHitStrip1D strip2) { SiTrackerHitStrip1D s1 = strip1; @@ -499,7 +499,6 @@ * @param origin * @param strip1 * @param strip2 - * @return */ static Hep3Vector getPosition(Hep3Vector t, SiTrackerHitStrip1D strip1, SiTrackerHitStrip1D strip2) { SiTrackerHitStrip1D s1 = strip1; @@ -592,7 +591,8 @@ } /** - * Fit the {@link STStereoTrack} track with the supplied {@link STTrackFitter} and add the fit to the track. + * Fit the {@link STUtils.STStereoTrack} track with the supplied {@link STUtils.STTrackFitter} + * and add the fit to the track. * @param regressionFitter * @param track */ @@ -741,7 +741,7 @@ * Calculate the multiple scattering angle for a given momentum and thickness * @param p * @param radlength - * @return + * @return the multiple scattering angle for a given momentum and thickness */ public static double msangle(double p, double radlength) { double angle = (0.0136 / p) * Math.sqrt(radlength) * (1.0 + 0.038 * Math.log(radlength)); @@ -781,10 +781,11 @@ } /** - * Finds point of intercept between a {@link STStereoTrack} and a sensor obtained from a {@link SiTrackerHitStrip1D}. + * Finds point of intercept between a {@link STUtils.STStereoTrack} and a sensor obtained from a + * {@link org.lcsim.recon.tracking.digitization.sisim.SiTrackerHitStrip1D}. * @param strip * @param track - * @return point of intercept. + * @return the point of intercept */ private static Hep3Vector getLinePlaneIntercept(SiTrackerHitStrip1D strip, STStereoTrack track) { // line description @@ -797,14 +798,13 @@ Hep3Vector trkpos = getLinePlaneIntercept(l, l0, p0, n); logger.finest("\ntrkpos " + trkpos.toString() + "\n l " + l.toString() + "\n l0 " + l0.toString() + "\n p0 " + p0.toString() + "\n n " + n.toString()); return trkpos; - } - + } /** * Calculate the residual (measured - predicted) for this hit in the measurement frame. * @param strip * @param track - * @return + * @return the residual (measured - predicted) for the hit */ protected static double getUResidual(SiTrackerHitStrip1D strip, STStereoTrack track) { @@ -864,7 +864,7 @@ * Path length to this point along the {@link STStereoTrack}. * @param z * @param track - * @return + * @return path length to the point along the track */ private static double getPathLength(double z, STStereoTrack track) { final double C = z / track.getDirection().z(); @@ -876,7 +876,7 @@ /** - * Get a vector of track parameters for a {@link STStereoTrack} in the tracking frame. + * Get a vector of track parameters for a {@link STUtils.STStereoTrack} in the tracking frame. * @param track * @return array of intercept YX, intercept ZX, slope YX and slope ZX. */ @@ -1037,7 +1037,7 @@ } /** - * Get curvilinear track parameters for this {@link STStereoTrack}. + * Get curvilinear track parameters for this {@link STUtils.STStereoTrack}. * @param track * @return array of track parameters */ @@ -1089,14 +1089,5 @@ double clPars[] = new double[]{1.0/p, lambda, phi, xT, yT,}; return clPars; - } - - - - - - - - - + } } Modified: java/trunk/tracking/src/main/java/org/hps/svt/alignment/BuildCompact.java ============================================================================= --- java/trunk/tracking/src/main/java/org/hps/svt/alignment/BuildCompact.java (original) +++ java/trunk/tracking/src/main/java/org/hps/svt/alignment/BuildCompact.java Thu Mar 10 17:32:07 2016 @@ -49,8 +49,7 @@ * Class building a new compact.xml detector based on MillepedeII input * corrections. * - * @author Per Ola Hansson Adrian <[log in to unmask]> - * @date January 15, 2014 + * @author Per Ola Hansson Adrian <[log in to unmask]> */ public class BuildCompact { Modified: java/trunk/tracking/src/main/java/org/hps/svt/alignment/HPSStrips.java ============================================================================= --- java/trunk/tracking/src/main/java/org/hps/svt/alignment/HPSStrips.java (original) +++ java/trunk/tracking/src/main/java/org/hps/svt/alignment/HPSStrips.java Thu Mar 10 17:32:07 2016 @@ -255,7 +255,7 @@ * Capacitance for a particular cell. Units are pF. * * @param cell_id - * @return + * @return the capacitance for the cell (pF) */ public double getCapacitance(int cell_id) // capacitance in pF { @@ -266,7 +266,7 @@ * Nominal capacitance used for throwing random noise in the sensor. * Calculated using middle strip. Units are pF. * - * @return + * @return the nominal capacitance used for noise generation in the sensor (pF) */ public double getCapacitance() { return getCapacitance(getNCells(0) / 2); Modified: java/trunk/util/src/main/java/org/hps/util/MergeBunches.java ============================================================================= --- java/trunk/util/src/main/java/org/hps/util/MergeBunches.java (original) +++ java/trunk/util/src/main/java/org/hps/util/MergeBunches.java Thu Mar 10 17:32:07 2016 @@ -454,7 +454,6 @@ * Copies an mc particle and stores it together with the copy in a map. * Adds it to the list of mc particles as well as the overlay mc particles. * Also copies and keeps all ancestors. - * @param event * @param particle */ protected void addOverlayMcParticle(MCParticle particle) {