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 //
0027 //
0028 // ----------------------------------------------------------------------
0029 // Class G4CellScoreComposer
0030 //
0031 // Class description:
0032 // This class will be created for every cell standard
0033 // scoring should be applied. It does the actual scoring.
0034 // GetStandardCellScoreValues() delivers the struct
0035 // G4CellScoreValues  does calculations based on the
0036 // sums of scores and delivers the results in
0037 // G4CellScoreValues.
0038 //
0039
0040 // Author: Michael Dressel (Michael.Dressel@cern.ch)
0041 // ----------------------------------------------------------------------
0042
0043 #ifndef G4CellScoreComposer_hh
0044 #define G4CellScoreComposer_hh G4CellScoreComposer_hh
0045
0046 #include "G4CellScoreValues.hh"
0047
0048 class G4Step;
0049
0050 class G4CellScoreComposer
0051 {
0052  public:
0053   // get values for estimators based on track length
0054   void EstimatorCalculation(const G4Step& step);
0055
0056   // Called when a track enters the cell
0057   void TrackEnters();
0058
0059   // Called if the cell population is increased
0060   void NewTrackPopedUp();
0061
0062   // Called for every collision in the cell, taking weight of the colliding particle
0063   void SetCollisionWeight(G4double weight);
0064
0065   // Set the importance of the cell
0066   void SetImportnace(G4double importance);
0067
0068   // Return scores stored in G4CellScoreValues
0069   const G4CellScoreValues& GetStandardCellScoreValues() const;
0070
0071  private:
0072   mutable G4CellScoreValues fSCScoreValues;
0073 };
0074
0075 std::ostream& operator<<(std::ostream& out, const G4CellScoreComposer& ps);
0076
0077 #endif