Base class for fluence scoring. More...
#include <egs_fluence_scoring.h>
Inheritance diagram for EGS_FluenceScoring:
Public Member Functions | |
| EGS_FluenceScoring (const string &Name="", EGS_ObjectFactory *f=0) | |
| ~EGS_FluenceScoring () | |
| void | initScoring (EGS_Input *inp) |
| void | getSensitiveRegions (EGS_Input *inp) |
| void | getNumberRegions (const string &str, vector< int > ®s) |
| void | getLabelRegions (const string &str, vector< int > ®s) |
| void | setUpRegionFlags () |
| void | describeMe () |
| int | getDigits (int i) |
| void | flagSecondaries (const int &iarg, const int &q) |
 Public Member Functions inherited from EGS_AusgabObject | |
| EGS_AusgabObject (const string &Name="", EGS_ObjectFactory *f=0) | |
| Construct an ausgab object named Name. | |
| EGS_AusgabObject (EGS_Input *input, EGS_ObjectFactory *f=0) | |
| Construct an ausgab object from the input pointed to by inp. More... | |
| virtual int | processEvent (EGS_Application::AusgabCall iarg)=0 |
| Process an ausgab call for event iarg. More... | |
| virtual int | processEvent (EGS_Application::AusgabCall iarg, int ir) |
| virtual bool | needsCall (EGS_Application::AusgabCall iarg) const |
| Is the ausgab call iarg relevant for this object? More... | |
| virtual void | setApplication (EGS_Application *App) |
| Set the application this object belongs to. | |
| virtual void | setCurrentCase (EGS_I64 ncase) |
| Set the current event. | |
| const char * | getObjectDescription () const |
| Get a short description of this ausgab object. More... | |
| virtual bool | storeState (ostream &data_out) const |
| Store the source state into the stream data_out. More... | |
| virtual bool | setState (istream &data_in) |
| Set the ausgab object state based on data from the stream data_in. More... | |
| virtual bool | addState (istream &data_in) |
| Add data from the stream data_in to the ausgab object state. More... | |
| virtual void | resetCounter () |
| Reset the ausgab object state. More... | |
| virtual void | reportResults () |
| Report results. More... | |
| Public Member Functions inherited from EGS_Object | |
| EGS_Object (const string &Name="", EGS_ObjectFactory *f=0) | |
| Create an EGS_Object named Name belonging to the object factory f. More... | |
| EGS_Object (EGS_Input *inp, EGS_ObjectFactory *f=0) | |
| Create an EGS_Object from the information pointed to by inp that belongs to object factory f. More... | |
| const string & | getObjectName () const |
| Get the object name. | |
| void | setObjectName (const string &Name) |
| Set the object name to Name. | |
| const string & | getObjectType () const |
| Get the object type. | |
| virtual EGS_Object * | createObject (EGS_Input *inp) |
| Create an object from the infromation pointed to by inp. More... | |
| void | setName (EGS_Input *inp) |
| Set the name of the object from the information provided by inp. More... | |
| int | ref () |
| Increase the reference count to this object. | |
| int | deref () |
| Decrease the reference count to this object. | |
| void | setFactory (EGS_ObjectFactory *f) |
| Set the factory to which the object belongs. More... | |
Protected Attributes | |
| EGS_I64 | current_ncase |
| ParticleType | scoring_charge |
| ParticleType | source_charge |
| EGS_ScoringArray ** | flu |
| EGS_ScoringArray ** | flu_p |
| EGS_ScoringArray * | fluT |
| EGS_ScoringArray * | fluT_p |
| vector< bool > | is_sensitive |
| vector< bool > | is_source |
| vector< int > | f_start |
| vector< int > | f_stop |
| vector< int > | f_region |
| vector< int > | s_region |
| string | f_regionsString |
| string | s_regionsString |
| int | n_scoring_regions |
| int | n_source_regions |
| int | nreg |
| int | max_reg |
| int | active_region |
| bool | score_in_all_regions |
| bool | source_in_all_regions |
| EGS_Float | norm_u |
| EGS_Float | flu_a |
| EGS_Float | flu_a_i |
| EGS_Float | flu_b |
| EGS_Float | flu_xmin |
| EGS_Float | flu_xmax |
| int | flu_s |
| int | flu_nbin |
| EGS_Float | m_primary |
| EGS_Float | m_tot |
| string | particle_name |
| bool | verbose |
| bool | score_spe |
| bool | score_primaries |
| Protected Attributes inherited from EGS_AusgabObject | |
| string | description |
| A short ausgab object description. More... | |
| EGS_Application * | app |
| The application this object belongs to. | |
| Protected Attributes inherited from EGS_Object | |
| string | name |
| The object name. | |
| string | otype |
| The object type. | |
| int | nref |
| Number of references to the object. | |
| EGS_ObjectFactory * | factory |
| The factory this object belongs to. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from EGS_AusgabObject | |
| static void | createAusgabObjects (EGS_Input *) |
| Create ausgab objects from the information pointed to by input. More... | |
| static EGS_AusgabObject * | getAusgabObject (const string &Name) |
| Get a pointer to the ausgab object named Name. More... | |
| static void | addKnownAusgabObject (EGS_AusgabObject *o) |
| Add a known ausgab object to the ausgab object factory. More... | |
| static void | addKnownTypeId (const char *name) |
| Add a known ausgab object typeid to the ausgab object factory. More... | |
| static int | nObjects () |
| Returns the number of ausgab objects in the internal list. | |
| static EGS_AusgabObject * | getObject (int j) |
| Returns the j'th ausgab object in the internal list. | |
| Static Public Member Functions inherited from EGS_Object | |
| static string | getUniqueName (const EGS_Object *o=0) |
| Create and return a unique object name. More... | |
| static void | deleteObject (EGS_Object *o) |
| Delete an object. More... | |
Detailed Description
Base class for fluence scoring.
Contains the basic ingredients for fluence scoring such as energy grid, particle type, scoring regions, and whether to score primary fluence. Provides the method for defining primary and secondary particles.
- Todo:
Account for multiple app geometries
Fluence for any particle type?
Definition at line 98 of file egs_fluence_scoring.h.
Constructor & Destructor Documentation
| EGS_FluenceScoring::EGS_FluenceScoring | ( | const string & | Name = "", |
| EGS_ObjectFactory * | f = 0 |
||
| ) |
| EGS_FluenceScoring::~EGS_FluenceScoring | ( | ) |
Destructor.
Definition at line 63 of file egs_fluence_scoring.cpp.
The documentation for this class was generated from the following files:
- /home/rwtownson/EGSnrc/HEN_HOUSE/egs++/ausgab_objects/egs_fluence_scoring/egs_fluence_scoring.h
- /home/rwtownson/EGSnrc/HEN_HOUSE/egs++/ausgab_objects/egs_fluence_scoring/egs_fluence_scoring.cpp
