HepMC3 event record library
|
Stores additional information about Heavy Ion generator. More...
#include <GenHeavyIon.h>
Public Member Functions | |
GenHeavyIon () | |
Empty default constructor. More... | |
bool | from_string (const std::string &att) override |
Implementation of Attribute::from_string. More... | |
bool | to_string (std::string &att) const override |
Implementation of Attribute::to_string. More... | |
bool | operator== (const GenHeavyIon &) const |
Operator ==. More... | |
bool | operator!= (const GenHeavyIon &) const |
Operator !=. More... | |
void | set (const int &nh, const int &np, const int &nt, const int &nc, const int &ns, const int &nsp, const int &nnw=0, const int &nwn=0, const int &nwnw=0, const double &im=0., const double &pl=0., const double &ec=0., const double &s=0., const double ¢=0., const double &ucent=0.) |
Set all fields. More... | |
bool | is_valid () const |
Verify that the instance contains non-zero information. More... | |
virtual bool | init () |
Optionally initialize the attribute after from_string. More... | |
virtual bool | init (const GenRunInfo &) |
Optionally initialize the attribute after from_string. More... | |
bool | is_parsed () const |
Check if this attribute is parsed. More... | |
const std::string & | unparsed_string () const |
Get unparsed string. More... | |
const GenEvent * | event () const |
GenParticlePtr | particle () |
ConstGenParticlePtr | particle () const |
GenVertexPtr | vertex () |
ConstGenVertexPtr | vertex () const |
Data Fields | |
int | Ncoll_hard |
the number of hard nucleon-nucleon collisions. More... | |
int | Npart_proj |
the number of participating nucleons in the projectile. More... | |
int | Npart_targ |
the number of participating nucleons in the target. More... | |
int | Ncoll |
the number of inelastic nucleon-nucleon collisions. More... | |
int | spectator_neutrons |
Total number of spectator neutrons. More... | |
int | spectator_protons |
Total number of spectator protons. More... | |
int | N_Nwounded_collisions |
Collisions with a diffractively excited target nucleon. More... | |
int | Nwounded_N_collisions |
Collisions with a diffractively excited projectile nucleon. More... | |
int | Nwounded_Nwounded_collisions |
Non-diffractive or doubly diffractive collisions. More... | |
double | impact_parameter |
The impact parameter. More... | |
double | event_plane_angle |
The event plane angle. More... | |
double | eccentricity |
The eccentricity. More... | |
double | sigma_inel_NN |
The assumed inelastic nucleon-nucleon cross section. More... | |
double | centrality |
The centrality. More... | |
double | user_cent_estimate |
A user defined centrality estimator. More... | |
int | Nspec_proj_n |
The number of spectator neutrons in the projectile. More... | |
int | Nspec_targ_n |
The number of spectator neutrons in the target. More... | |
int | Nspec_proj_p |
The number of spectator protons in the projectile. More... | |
int | Nspec_targ_p |
The number of spectator protons in the target. More... | |
std::map< int, double > | participant_plane_angles |
Participant plane angles. More... | |
std::map< int, double > | eccentricities |
Eccentricities. More... | |
bool | forceoldformat |
force writing in old format for compatibility purposes. More... | |
Protected Member Functions | |
void | set_is_parsed (bool flag) |
Set is_parsed flag. More... | |
void | set_unparsed_string (const std::string &st) |
Set unparsed string. More... | |
Stores additional information about Heavy Ion generator.
This is an example of event attribute used to store Heavy Ion information
Definition at line 28 of file GenHeavyIon.h.
|
inline |
Empty default constructor.
Definition at line 33 of file GenHeavyIon.h.
|
inlineinherited |
return the GenEvent to which this Attribute belongs, if at all.
Definition at line 109 of file Attribute.h.
References Attribute::m_event.
|
overridevirtual |
Implementation of Attribute::from_string.
Implements Attribute.
Definition at line 19 of file GenHeavyIon.cc.
References GenHeavyIon::centrality, GenHeavyIon::eccentricities, GenHeavyIon::eccentricity, GenHeavyIon::event_plane_angle, GenHeavyIon::impact_parameter, GenHeavyIon::N_Nwounded_collisions, GenHeavyIon::Ncoll, GenHeavyIon::Ncoll_hard, GenHeavyIon::Npart_proj, GenHeavyIon::Npart_targ, GenHeavyIon::Nspec_proj_n, GenHeavyIon::Nspec_proj_p, GenHeavyIon::Nspec_targ_n, GenHeavyIon::Nspec_targ_p, GenHeavyIon::Nwounded_N_collisions, GenHeavyIon::Nwounded_Nwounded_collisions, GenHeavyIon::participant_plane_angles, GenHeavyIon::sigma_inel_NN, GenHeavyIon::spectator_neutrons, GenHeavyIon::spectator_protons, GenHeavyIon::user_cent_estimate, and HepMC3::version().
|
inlinevirtualinherited |
Optionally initialize the attribute after from_string.
Reimplemented in HEPEUPAttribute.
Definition at line 82 of file Attribute.h.
|
inlinevirtualinherited |
Optionally initialize the attribute after from_string.
Is passed a reference to the GenRunInfo object to which the Attribute belongs.
Reimplemented in HEPEUPAttribute.
Definition at line 91 of file Attribute.h.
|
inlineinherited |
Check if this attribute is parsed.
Definition at line 103 of file Attribute.h.
References Attribute::m_is_parsed.
bool is_valid | ( | ) | const |
Verify that the instance contains non-zero information.
HEPMC3_DEPRECATED("Each filed now have default values meaning that they have not been set")
Definition at line 137 of file GenHeavyIon.cc.
References GenHeavyIon::centrality, GenHeavyIon::eccentricity, GenHeavyIon::event_plane_angle, GenHeavyIon::impact_parameter, GenHeavyIon::N_Nwounded_collisions, GenHeavyIon::Ncoll, GenHeavyIon::Ncoll_hard, GenHeavyIon::Npart_proj, GenHeavyIon::Npart_targ, GenHeavyIon::Nwounded_N_collisions, GenHeavyIon::Nwounded_Nwounded_collisions, GenHeavyIon::sigma_inel_NN, GenHeavyIon::spectator_neutrons, and GenHeavyIon::spectator_protons.
bool operator!= | ( | const GenHeavyIon & | a | ) | const |
Operator !=.
Definition at line 113 of file GenHeavyIon.cc.
bool operator== | ( | const GenHeavyIon & | a | ) | const |
Operator ==.
Definition at line 109 of file GenHeavyIon.cc.
|
inlineinherited |
return the GenParticle to which this Attribute belongs, if at all.
Definition at line 114 of file Attribute.h.
References Attribute::m_particle.
|
inlineinherited |
return the GenParticle to which this Attribute belongs, if at all.
Definition at line 119 of file Attribute.h.
References Attribute::m_particle.
void set | ( | const int & | nh, |
const int & | np, | ||
const int & | nt, | ||
const int & | nc, | ||
const int & | ns, | ||
const int & | nsp, | ||
const int & | nnw = 0 , |
||
const int & | nwn = 0 , |
||
const int & | nwnw = 0 , |
||
const double & | im = 0. , |
||
const double & | pl = 0. , |
||
const double & | ec = 0. , |
||
const double & | s = 0. , |
||
const double & | cent = 0. , |
||
const double & | ucent = 0. |
||
) |
Set all fields.
HEPMC3_DEPRECATED("Set individual fields directly instead.") Set all fields
Definition at line 117 of file GenHeavyIon.cc.
References GenHeavyIon::centrality, GenHeavyIon::eccentricity, GenHeavyIon::event_plane_angle, GenHeavyIon::impact_parameter, GenHeavyIon::N_Nwounded_collisions, GenHeavyIon::Ncoll, GenHeavyIon::Ncoll_hard, GenHeavyIon::Npart_proj, GenHeavyIon::Npart_targ, GenHeavyIon::Nwounded_N_collisions, GenHeavyIon::Nwounded_Nwounded_collisions, GenHeavyIon::sigma_inel_NN, GenHeavyIon::spectator_neutrons, GenHeavyIon::spectator_protons, and GenHeavyIon::user_cent_estimate.
|
inlineprotectedinherited |
|
inlineprotectedinherited |
|
overridevirtual |
Implementation of Attribute::to_string.
Implements Attribute.
Definition at line 66 of file GenHeavyIon.cc.
References GenHeavyIon::centrality, GenHeavyIon::eccentricities, GenHeavyIon::eccentricity, GenHeavyIon::event_plane_angle, GenHeavyIon::forceoldformat, GenHeavyIon::impact_parameter, GenHeavyIon::N_Nwounded_collisions, GenHeavyIon::Ncoll, GenHeavyIon::Ncoll_hard, GenHeavyIon::Npart_proj, GenHeavyIon::Npart_targ, GenHeavyIon::Nspec_proj_n, GenHeavyIon::Nspec_proj_p, GenHeavyIon::Nspec_targ_n, GenHeavyIon::Nspec_targ_p, GenHeavyIon::Nwounded_N_collisions, GenHeavyIon::Nwounded_Nwounded_collisions, GenHeavyIon::participant_plane_angles, GenHeavyIon::sigma_inel_NN, GenHeavyIon::spectator_neutrons, GenHeavyIon::spectator_protons, and GenHeavyIon::user_cent_estimate.
|
inlineinherited |
|
inlineinherited |
return the GenVertex to which this Attribute belongs, if at all.
Definition at line 124 of file Attribute.h.
References Attribute::m_vertex.
|
inlineinherited |
return the GenVertex to which this Attribute belongs, if at all.
Definition at line 129 of file Attribute.h.
References Attribute::m_vertex.
double centrality |
The centrality.
The generated centrality in percentiles, where 0 is the maximally central and 100 is the minimally central. A negative value means that the information is not available.
Definition at line 150 of file GenHeavyIon.h.
std::map<int,double> eccentricities |
Eccentricities.
Calculated to different orders. The key of the map specifies the order, and the value gives the corresponding eccentricity.
Definition at line 201 of file GenHeavyIon.h.
double eccentricity |
The eccentricity.
HEPMC3_DEPRECATED("Use eccentricities insted.")
Definition at line 135 of file GenHeavyIon.h.
double event_plane_angle |
The event plane angle.
The angle wrt. the x-axix of the impact parameter vector (pointing frm the target to the projectile). A positive number between 0 and two pi. A negative value means that the information is not available.
Definition at line 129 of file GenHeavyIon.h.
bool forceoldformat |
force writing in old format for compatibility purposes.
HEPMC3_DEPRECATED("This should really not be needed");
Definition at line 240 of file GenHeavyIon.h.
double impact_parameter |
The impact parameter.
The impact parameter given in units of femtometer. A negative value means that the information is not available.
Definition at line 121 of file GenHeavyIon.h.
int N_Nwounded_collisions |
Collisions with a diffractively excited target nucleon.
The number of single diffractive nucleon-nucleon collisions where the target nucleon is excited. A negative value means that the information is not available.
Definition at line 101 of file GenHeavyIon.h.
int Ncoll |
the number of inelastic nucleon-nucleon collisions.
Note that a one participating nucleon can be involved in many inelastic collisions, and that inelastic also includes diffractive excitation. A negative value means that the information is not available.
Definition at line 82 of file GenHeavyIon.h.
int Ncoll_hard |
the number of hard nucleon-nucleon collisions.
Model-dependent. Usually the number of nucleon-nucleon collisions containing a special signal process. A negative value means that the information is not available.
Definition at line 59 of file GenHeavyIon.h.
int Npart_proj |
the number of participating nucleons in the projectile.
The number of nucleons in the projectile participating in an inelastic collision (see Ncoll). A negative value means that the information is not available.
Definition at line 66 of file GenHeavyIon.h.
int Npart_targ |
the number of participating nucleons in the target.
The number of nucleons in the target participating in an inelastic collision (see Ncoll). A negative value means that the information is not available.
Definition at line 73 of file GenHeavyIon.h.
int Nspec_proj_n |
The number of spectator neutrons in the projectile.
ie. those that thave not participated in any inelastic nucleon-nucleon collision. A negative value indicatess that the information is not available.
Definition at line 167 of file GenHeavyIon.h.
int Nspec_proj_p |
The number of spectator protons in the projectile.
ie. those that thave not participated in any inelastic nucleon-nucleon collision. A negative value indicatess that the information is not available.
Definition at line 181 of file GenHeavyIon.h.
int Nspec_targ_n |
The number of spectator neutrons in the target.
ie. those that thave not participated in any inelastic nucleon-nucleon collision. A negative value indicatess that the information is not available.
Definition at line 174 of file GenHeavyIon.h.
int Nspec_targ_p |
The number of spectator protons in the target.
ie. those that thave not participated in any inelastic nucleon-nucleon collision. A negative value indicatess that the information is not available.
Definition at line 188 of file GenHeavyIon.h.
int Nwounded_N_collisions |
Collisions with a diffractively excited projectile nucleon.
The number of single diffractive nucleon-nucleon collisions where the projectile nucleon is excited. A negative value means that the information is not available.
Definition at line 108 of file GenHeavyIon.h.
int Nwounded_Nwounded_collisions |
Non-diffractive or doubly diffractive collisions.
The number of nucleon-nucleon collisions where both projectile and target nucleons are wounded. A negative value means that the information is not available.
Definition at line 115 of file GenHeavyIon.h.
std::map<int,double> participant_plane_angles |
Participant plane angles.
calculated to different orders. The key of the map specifies the order, and the value gives to the angle wrt. the event plane.
Definition at line 195 of file GenHeavyIon.h.
double sigma_inel_NN |
The assumed inelastic nucleon-nucleon cross section.
in units of millibarn. As used in a Glauber calculation to simulate the distribution in Ncoll. A negative value means that the information is not available.
Definition at line 143 of file GenHeavyIon.h.
int spectator_neutrons |
Total number of spectator neutrons.
HEPMC3_DEPRECATED("Use Nspec_proj_n and Nspec_targ_n instead.")
Definition at line 88 of file GenHeavyIon.h.
int spectator_protons |
Total number of spectator protons.
HEPMC3_DEPRECATED("Use Nspec_proj_p and Nspec_targ_p instead.")
Definition at line 93 of file GenHeavyIon.h.
double user_cent_estimate |
A user defined centrality estimator.
This variable may contain anything a generator feels is reasonable for estimating centrality. The value should be non-negative, and a low value corresponds to a low centrality. A negative value indicatess that the information is not available.
Definition at line 159 of file GenHeavyIon.h.