Class for muon bundle categories. More...

#include <JMuonBundleCategory.hh>

Inheritance diagram for JAANET::JMuonBundleCategory:

Classes
struct	JMuonBundleCategoryHelper
	Auxiliary class for I/O of muon bundle category. More...

Public Types
typedef JClonable< JClonable_t >::clone_type	clone_type

Public Member Functions
	JMuonBundleCategory ()
	Default constructor. More...

	JMuonBundleCategory (const int primaryType)
	Constructor. More...

	JMuonBundleCategory (const int primaryType, const JRange< double > &Erange, const JRange< double > &coszRange, const JRange< int > &Mrange, const double Rmax)
	Constructor. More...

	JMuonBundleCategory (const JHead &header)
	Constructor. More...

bool	is_valid () const override final
	Check if muon bundle category is valid. More...

bool	match (const JHead &header) const override final
	Check whether this event category matches with the given MC header. More...

bool	match (const Evt &event) const override final
	Check whether given event matches with this event category. More...

bool	less (const JEvtCategory &category) const override final
	Less-than method. More...

JProperties	getProperties (const JEquationParameters &equation=JEvtCategory::getEquationParameters()) override final
	Get properties of this class. More...

JProperties	getProperties (const JEquationParameters &equation=JEvtCategory::getEquationParameters()) const override final
	Get properties of this class. More...

virtual clone_type	clone () const override
	Get clone of this object. More...

Private Attributes
JRange< double >	Erange
	energy range [GeV] More...

JRange< double >	coszRange
	cosine zenith-angle range [-] More...

JRange< int >	Mrange
	multiplicity range [-] More...

double	Rmax
	maximum radial extent [m] More...

Detailed Description

Class for muon bundle categories.

Definition at line 80 of file JMuonBundleCategory.hh.

Member Typedef Documentation

◆ clone_type

template<class JClonable_t , class JDerived_t >

typedef JClonable<JClonable_t>::clone_type JLANG::JClonable< JClonable_t, JDerived_t >::clone_type

inherited

Definition at line 61 of file JClonable.hh.

Constructor & Destructor Documentation

◆ JMuonBundleCategory() [1/4]

JAANET::JMuonBundleCategory::JMuonBundleCategory ( )

inline

Default constructor.

Definition at line 86 of file JMuonBundleCategory.hh.

                           :
       Erange     (DEFAULT_BUNDLE_ENERGY_RANGE),
       coszRange  (DEFAULT_BUNDLE_COSINE_ZENITH_ANGLE_RANGE),
       Mrange     (DEFAULT_BUNDLE_MULTIPLICITY_RANGE),
       Rmax       (DEFAULT_BUNDLE_RADIAL_EXTENT)
     {}

◆ JMuonBundleCategory() [2/4]

JAANET::JMuonBundleCategory::JMuonBundleCategory ( const int primaryType )

inline

Constructor.

Parameters

primaryType cosmic-ray primary PDG identifier

Definition at line 99 of file JMuonBundleCategory.hh.

                                                :
       Erange     (DEFAULT_BUNDLE_ENERGY_RANGE),
       coszRange  (DEFAULT_BUNDLE_COSINE_ZENITH_ANGLE_RANGE),
       Mrange     (DEFAULT_BUNDLE_MULTIPLICITY_RANGE),
       Rmax       (DEFAULT_BUNDLE_RADIAL_EXTENT)
     {
       this->primaryType = primaryType;
       
       check_validity();
     }

◆ JMuonBundleCategory() [3/4]

JAANET::JMuonBundleCategory::JMuonBundleCategory	(	const int	primaryType,
		const JRange< double > &	Erange,
		const JRange< double > &	coszRange,
		const JRange< int > &	Mrange,
		const double	Rmax
	)

inline

Constructor.

Parameters

primaryType	cosmic-ray primary PDG identifier
Erange	energy range
coszRange	cosine zenith-angle range
Mrange	multiplicity range
Rmax	maximum radial extent

Definition at line 120 of file JMuonBundleCategory.hh.

                                                     :
       Erange     (Erange),
       coszRange  (coszRange),
       Mrange     (Mrange),
       Rmax       (Rmax)
     {
       this->primaryType = primaryType;
       
       check_validity();
     }

◆ JMuonBundleCategory() [4/4]

JAANET::JMuonBundleCategory::JMuonBundleCategory ( const JHead & header )

inline

Constructor.

Parameters

header MC header

Definition at line 141 of file JMuonBundleCategory.hh.

                                              :
       JMuonBundleCategory()
     {
       using namespace std;
       using namespace JPP;
  
       if        (is_mupage(header)) {
         this->primaryType = PDG_MUONBUNDLE;
         this->Erange      = header.cut_in.E;
         this->coszRange   = header.cut_in.cosT;
       } else if (is_corsika(header)) {
         this->primaryType = header.primary.type;
         this->Erange      = header.cut_primary.E;
         this->coszRange   = header.cut_primary.cosT;
       }
  
       check_validity();
     }

Member Function Documentation

◆ is_valid()

bool JAANET::JMuonBundleCategory::is_valid ( ) const

inlinefinaloverride

Check if muon bundle category is valid.

Returns: true if muon bundle category is valid; else false

Definition at line 166 of file JMuonBundleCategory.hh.

     {
       return (is_muon_bundle_primary(this->primaryType) &&
               Erange   .is_valid()                      &&
               coszRange.is_valid()                      &&
               Mrange.getLowerLimit() >= 0               &&
               Mrange   .is_valid()                      &&
               Rmax > 0);
     }

◆ match() [1/2]

bool JAANET::JMuonBundleCategory::match ( const JHead & header ) const

inlinefinaloverride

Check whether this event category matches with the given MC header.

Parameters

header header

Returns: true if matching; else false

Definition at line 183 of file JMuonBundleCategory.hh.

     {
       if (is_mupage(header) || is_corsika(header)) {
         
         const JMuonBundleCategory cat(header);
  
         return (this->primaryType == cat.getPrimaryType() &&
                 this->Erange   .overlap (cat.Erange)      &&
                 this->coszRange.overlap (cat.coszRange));
         
       } else {
         
         return false;
       }
     }

◆ match() [2/2]

bool JAANET::JMuonBundleCategory::match ( const Evt & event ) const

inlinefinaloverride

Check whether given event matches with this event category.

Parameters

event event

Returns: true if matching; else false

Definition at line 206 of file JMuonBundleCategory.hh.

     {
       using namespace std;
       using namespace JPP;
  
       const Trk& primary = get_primary(event);
  
       if (!(is_muonbundle(primary) || is_muon(primary)) ||
           !Erange   ( primary.E)                        ||
           !coszRange(-primary.dir.z)) { return false; }
  
       if (Mrange == DEFAULT_BUNDLE_MULTIPLICITY_RANGE &&
           Rmax   == DEFAULT_BUNDLE_RADIAL_EXTENT) { return true; }
  
       const JTrack3E&     tp = getTrack(primary);
       const JDirection3D& dp = tp.getDirection();
       const JPosition3D&  pp = tp.getPosition();
         
       int    multiplicity = 0;
       double maxR         = 0.0;
         
       for (vector<Trk>::const_iterator i = event.mc_trks.cbegin(); i != event.mc_trks.cend(); ++i) {
         if (is_finalstate(*i) && is_muon(*i)) {
  
           const JTrack3E&    ti = getTrack(*i);
           const JPosition3D& pi = ti.getPosition();
             
           const double R = getCross<JVector3D>(dp, pi - pp).getLength();
             
           if (R > maxR) { maxR = R; }
             
           ++multiplicity;
         }
       }
  
       return (Mrange(multiplicity) && maxR < Rmax);
     }

◆ less()

bool JAANET::JMuonBundleCategory::less ( const JEvtCategory & category ) const

inlinefinaloverride

Less-than method.

Note: The energy, cosine zenith-angle and multiplicity ranges are compared based on the lower limit first.
If the lower limits are equal, the upper limits are compared.

Parameters

category event category

Returns: true if first this event category less than given event category; else false

Definition at line 254 of file JMuonBundleCategory.hh.

     {
 #define RETURN_IF_DIFFERENT_RANGE(A, B)     \
       if (A != B) { return (A.getLowerLimit() == B.getLowerLimit() ?  \
                             A.getUpperLimit() <  B.getUpperLimit() :  \
                             A.getLowerLimit() <  B.getLowerLimit() ); }
       
       if (this->primaryType != category.getPrimaryType()) {
         return this->primaryType < category.getPrimaryType();
       }
       
       const JMuonBundleCategory* p = dynamic_cast<const JMuonBundleCategory*>(&category);
             
       if (p == NULL) { return false; }
  
       RETURN_IF_DIFFERENT_RANGE(this->Erange,    p->Erange);
       RETURN_IF_DIFFERENT_RANGE(this->coszRange, p->coszRange);
       RETURN_IF_DIFFERENT_RANGE(this->Mrange,    p->Mrange);
  
       return this->Rmax < p->Rmax;
       
 #undef RETURN_IF_DIFFERENT_RANGE
     }

◆ getProperties() [1/2]

JProperties JAANET::JMuonBundleCategory::getProperties ( const JEquationParameters & equation = JEvtCategory::getEquationParameters() )

inlinefinaloverride

Get properties of this class.

Parameters

equation equation parameters

Definition at line 284 of file JMuonBundleCategory.hh.

     {
       return JMuonBundleCategoryHelper(*this, equation);
     }

◆ getProperties() [2/2]

JProperties JAANET::JMuonBundleCategory::getProperties ( const JEquationParameters & equation = JEvtCategory::getEquationParameters() ) const

inlinefinaloverride

Get properties of this class.

Parameters

equation equation parameters

Definition at line 295 of file JMuonBundleCategory.hh.

     {
       return JMuonBundleCategoryHelper(*this, equation);
     }

◆ clone()

template<class JClonable_t , class JDerived_t >

virtual clone_type JLANG::JClonable< JClonable_t, JDerived_t >::clone ( ) const

inlineoverridevirtualinherited

Get clone of this object.

Returns: pointer to newly created object

Reimplemented in JTOOLS::JMultiMapTransformer< N, JArgument_t >::JMultiMapDefaultTransformer, JPHYSICS::JPDFTransformer< 5, JArgument_t >, JPHYSICS::JPDFTransformer< 4, JArgument_t >, JPHYSICS::JPDFTransformer< 3, JArgument_t >, JPHYSICS::JPDFTransformer< 2, JArgument_t >, JPHYSICS::JPDGTransformer_t< JArgument_t >, JPHYSICS::JPD0Transformer_t< JArgument_t >, and JPHYSICS::JPDFTransformer_t< JArgument_t >.

Definition at line 69 of file JClonable.hh.

     {
       return new JDerived_t(static_cast<const JDerived_t&>(*this));
     }

Member Data Documentation

◆ Erange

JRange<double> JAANET::JMuonBundleCategory::Erange

private

energy range [GeV]

Definition at line 303 of file JMuonBundleCategory.hh.

◆ coszRange

JRange<double> JAANET::JMuonBundleCategory::coszRange

private

cosine zenith-angle range [-]

Definition at line 304 of file JMuonBundleCategory.hh.

◆ Mrange

JRange<int> JAANET::JMuonBundleCategory::Mrange

private

multiplicity range [-]

Definition at line 305 of file JMuonBundleCategory.hh.

◆ Rmax

double JAANET::JMuonBundleCategory::Rmax

private

maximum radial extent [m]

Definition at line 306 of file JMuonBundleCategory.hh.

The documentation for this struct was generated from the following file:

JMuonBundleCategory.hh

Classes

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ clone_type

Constructor & Destructor Documentation

◆ JMuonBundleCategory() [1/4]

◆ JMuonBundleCategory() [2/4]

◆ JMuonBundleCategory() [3/4]

◆ JMuonBundleCategory() [4/4]

Member Function Documentation

◆ is_valid()

◆ match() [1/2]

◆ match() [2/2]

◆ less()

◆ getProperties() [1/2]

◆ getProperties() [2/2]

◆ clone()

Member Data Documentation

◆ Erange

◆ coszRange

◆ Mrange

◆ Rmax