include/Geant4/G4CellScoreComposer.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 // G4CellScoreComposer
0027 //
0028 // Class description:
0029 // This class will be created for every cell standard
0030 // scoring should be applied. It does the actual scoring.
0031 // GetStandardCellScoreValues() delivers the struct
0032 // G4CellScoreValues  does calculations based on the
0033 // sums of scores and delivers the results in
0034 // G4CellScoreValues.
0035 //
0036 // Author: Michael Dressel, CERN
0037 // --------------------------------------------------------------------
0038 #ifndef G4CellScoreComposer_hh
0039 #define G4CellScoreComposer_hh 1
0040
0041 #include "G4CellScoreValues.hh"
0042
0043 class G4Step;
0044
0045 class G4CellScoreComposer
0046 {
0047  public:
0048   // get values for estimators based on track length
0049   void EstimatorCalculation(const G4Step& step);
0050
0051   // Called when a track enters the cell
0052   void TrackEnters();
0053
0054   // Called if the cell population is increased
0055   void NewTrackPopedUp();
0056
0057   // Called for every collision in the cell, taking weight of the colliding particle
0058   void SetCollisionWeight(G4double weight);
0059
0060   // Set the importance of the cell
0061   void SetImportnace(G4double importance);
0062
0063   // Return scores stored in G4CellScoreValues
0064   const G4CellScoreValues& GetStandardCellScoreValues() const;
0065
0066  private:
0067   mutable G4CellScoreValues fSCScoreValues;
0068 };
0069
0070 std::ostream& operator<<(std::ostream& out, const G4CellScoreComposer& ps);
0071
0072 #endif