JAANET::JNeutrinoInteractionCategory Struct Reference

Class for neutrino interaction categories. More...

#include <JNeutrinoInteractionCategory.hh>

Inheritance diagram for JAANET::JNeutrinoInteractionCategory:

Classes
struct	JNeutrinoInteractionCategoryHelper
	Auxiliary class for I/O of neutrino interaction category. More...

Public Types
typedef JTOOLS::JRange< double >	JRange_t
typedef JClonable< JClonable_t >::clone_type	clone_type

Public Member Functions
	JNeutrinoInteractionCategory ()
	Default constructor.
	JNeutrinoInteractionCategory (const int neutrinoType)
	Constructor.
	JNeutrinoInteractionCategory (const int neutrinoType, const JRange_t &Erange, const JRange_t &coszRange)
	Constructor.
	JNeutrinoInteractionCategory (const int neutrinoType, const JInteractionTypeGENIE_t interactionType, const JScatteringTypeGENIE_t scatteringType, const int targetZ, const int targetA, const JRange_t &Erange, const JRange_t &coszRange)
	Constructor.
	JNeutrinoInteractionCategory (const JHead &header, const int primaryType)
	Constructor.
	JNeutrinoInteractionCategory (const JHead &header)
	Constructor.
bool	is_valid () const override final
	Check if neutrino interaction categories is valid.
bool	match (const JHead &header) const override final
	Check whether this event category matches with the given MC header.
bool	match (const Evt &event) const override final
	Check whether given event matches with this event category.
bool	less (const JEvtCategory &category) const override final
	Less-than method.
JProperties	getProperties (const JEquationParameters &eqpars=JEvtCategory::getEquationParameters()) override final
	Get properties of this class.
JProperties	getProperties (const JEquationParameters &eqpars=JEvtCategory::getEquationParameters()) const override final
	Get properties of this class.
virtual clone_type	clone () const override
	Get clone of this object.

Private Attributes
JParameter< int >	interactionType
	interaction type
JParameter< int >	scatteringType
	scattering type
JParameter< int >	targetZ
	target atomic number
JParameter< int >	targetA
	target mass number
JRange_t	Erange
	neutrino energy range
JRange_t	coszRange
	cosine zenith range

Detailed Description

Class for neutrino interaction categories.

Definition at line 134 of file JNeutrinoInteractionCategory.hh.

Member Typedef Documentation

JRange_t

typedef JTOOLS::JRange<double> JAANET::JNeutrinoInteractionCategory::JRange_t

Definition at line 137 of file JNeutrinoInteractionCategory.hh.

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

JNeutrinoInteractionCategory() [1/6]

JAANET::JNeutrinoInteractionCategory::JNeutrinoInteractionCategory ( )

inline

Default constructor.

Definition at line 143 of file JNeutrinoInteractionCategory.hh.

                                   :
      interactionType(),
      scatteringType (),
      targetZ        (),
      targetA        (),
      Erange         (DEFAULT_NEUTRINO_ENERGY_RANGE),
      coszRange      (DEFAULT_NEUTRINO_COSINE_ZENITH_ANGLE_RANGE)
    {}

JNeutrinoInteractionCategory() [2/6]

JAANET::JNeutrinoInteractionCategory::JNeutrinoInteractionCategory ( const int neutrinoType )

inline

Constructor.

Parameters

neutrinoType

neutrino PDG type

Definition at line 158 of file JNeutrinoInteractionCategory.hh.

                                                         :
      interactionType(),
      scatteringType (),
      targetZ        (),
      targetA        (),
      Erange         (DEFAULT_NEUTRINO_ENERGY_RANGE),
      coszRange      (DEFAULT_NEUTRINO_COSINE_ZENITH_ANGLE_RANGE)
    {
      this->primaryType = neutrinoType;
      
      check_validity();
    }

JNeutrinoInteractionCategory() [3/6]

JAANET::JNeutrinoInteractionCategory::JNeutrinoInteractionCategory ( const int neutrinoType, const JRange_t & Erange, const JRange_t & coszRange )

inline

Constructor.

Parameters

neutrinoType	neutrino PDG type
Erange	neutrino energy range
coszRange	zenith-angle range

Definition at line 179 of file JNeutrinoInteractionCategory.hh.

                                                            :
      interactionType(),
      scatteringType (),
      targetZ        (),
      targetA        (),
      Erange         (Erange),
      coszRange      (coszRange)
    {
      this->primaryType = neutrinoType;
      
      check_validity();
    }

JNeutrinoInteractionCategory() [4/6]

JAANET::JNeutrinoInteractionCategory::JNeutrinoInteractionCategory ( const int neutrinoType, const JInteractionTypeGENIE_t interactionType, const JScatteringTypeGENIE_t scatteringType, const int targetZ, const int targetA, const JRange_t & Erange, const JRange_t & coszRange )

inline

Constructor.

Parameters

neutrinoType	neutrino PDG type
interactionType	interaction type
scatteringType	scattering type
targetZ	target atomic number
targetA	target mass number
Erange	neutrino energy range
coszRange	zenith-angle range

Definition at line 206 of file JNeutrinoInteractionCategory.hh.

                                                                          :
      interactionType((int) interactionType),
      scatteringType ((int) scatteringType),
      targetZ        (targetZ),
      targetA        (targetA),
      Erange         (Erange),
      coszRange      (coszRange)
    {
      this->primaryType = neutrinoType;      
      
      check_validity();
    }

JNeutrinoInteractionCategory() [5/6]

JAANET::JNeutrinoInteractionCategory::JNeutrinoInteractionCategory ( const JHead & header, const int primaryType )

inline

Constructor.

Parameters

header	MC header
primaryType	primary PDG type

Definition at line 232 of file JNeutrinoInteractionCategory.hh.

                                                           :
      JNeutrinoInteractionCategory()
    {
      using namespace std;
      using namespace JPP;
 
      if (is_gseagen(header)) {
 
        vector<JAANET::flux>::const_iterator i = find_if(header.flux.cbegin(), header.flux.cend(),
                                                         make_predicate(&JAANET::flux::type, primaryType));
          
        if (primaryType == header.primary.type || i != header.flux.cend()) {
          this->primaryType = primaryType;
        } else {
          THROW(JValueOutOfRange, "JNeutrinoInteractionCategory::JNeutrinoInteractionCategory(): Given header does not match with given primary type " << primaryType << ".");
        }
        
        const JInteractionTypeGENIE_t intType = getInteractionType(header);
 
        if (intType != JInteractionTypeGENIE_t::UNDEFINED) {
          interactionType = (int) intType;
        }
        
        const pair<JParameter<int>,
                   JParameter<int> > targetInfo = getTargetInfo(header);
        
        targetZ   = targetInfo.first;
        targetA   = targetInfo.second; 
 
        if (header.cut_nu.E.is_valid() &&
            header.cut_nu.E != cut().E) {
          Erange    = header.cut_nu.E;
        }
 
        if (header.cut_nu.cosT.is_valid() &&
            header.cut_nu.cosT != cut().cosT) {
          coszRange = header.cut_nu.cosT;
        }
      }
      
      check_validity();
    }

JNeutrinoInteractionCategory() [6/6]

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

inline

Constructor.

N.B.: In this method, the neutrino PDG type is taken from JAANET::JHead::primary::type.

Parameters

header

MC header

Definition at line 284 of file JNeutrinoInteractionCategory.hh.

                                                      :
      JNeutrinoInteractionCategory(header, header.primary.type)
    {}

Member Function Documentation

is_valid()

bool JAANET::JNeutrinoInteractionCategory::is_valid ( ) const

inlinefinaloverride

Check if neutrino interaction categories is valid.

Returns

true if neutrino interaction category is valid; else false

Definition at line 294 of file JNeutrinoInteractionCategory.hh.

    {
      if (!is_neutrino_primary(this->primaryType)) {
        return false;
      }
 
      if (  interactionType.isDefined() &&
            !(interactionType.getValue() > (int) JInteractionTypeGENIE_t::INTERACTION_TYPES_START &&
              interactionType.getValue() < (int) JInteractionTypeGENIE_t::INTERACTION_TYPES_END) ) {
        return false;
      }
 
      if (   scatteringType.isDefined() &&
             !((scatteringType > (int) JScatteringTypeGENIE_t::NEUTRINO_SCATTERING_TYPES_START    &&
                scatteringType < (int) JScatteringTypeGENIE_t::NEUTRINO_SCATTERING_TYPES_END)     ||
               (scatteringType > (int) JScatteringTypeGENIE_t::DARK_MATTER_SCATTERING_TYPES_START &&
                scatteringType < (int) JScatteringTypeGENIE_t::DARK_MATTER_SCATTERING_TYPES_END))  ) {
        return false;
      }
 
      if (targetZ.isDefined() && targetZ.getValue() <= 0) {
        return false;
      }
 
      if (  targetA.isDefined() &&
            (!targetZ.isDefined() || targetA.getValue() < targetZ.getValue())) {
        return false;
      }
 
      return Erange.is_valid() && coszRange.is_valid();
    }

match() [1/2]

bool JAANET::JNeutrinoInteractionCategory::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 333 of file JNeutrinoInteractionCategory.hh.

    {
      if (is_gseagen(header)) {
        
        const JNeutrinoInteractionCategory cat(header);
 
        return (this->primaryType     == cat.primaryType     &&
                this->interactionType == cat.interactionType &&
                this->scatteringType  == cat.scatteringType  &&
                this->targetZ         == cat.targetZ         &&
                this->targetA         == cat.targetA         &&
                this->Erange    .overlap(cat.Erange)         &&
                this->coszRange .overlap(cat.coszRange));
        
      } else {
        
        return false;
      }
    }

match() [2/2]

bool JAANET::JNeutrinoInteractionCategory::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 360 of file JNeutrinoInteractionCategory.hh.

    {
      using namespace std;
      using namespace JPP;
 
      const Trk& primary = get_primary(event);
 
      if (!is_neutrino(primary)) { return false; }
        
      if (interactionType.isDefined()                      &&
          event.w2list.size() > W2LIST_GSEAGEN_CC          &&
          interactionType.getValue() != event.w2list[W2LIST_GSEAGEN_CC]) {
        return false;
      }
 
      if (scatteringType.isDefined()                       &&
          event.w2list.size() > W2LIST_GSEAGEN_ICHAN       &&
          scatteringType.getValue() != event.w2list[W2LIST_GSEAGEN_ICHAN]) {
        return false;
      }
 
      if (targetZ.isDefined()                              &&
          event.w2list.size() > W2LIST_GSEAGEN_TARGETZ     &&
          targetZ.getValue() != event.w2list[W2LIST_GSEAGEN_TARGETZ]) {
        return false;
      }
 
      if (targetA != 0                                     &&
          event.w2list.size() > W2LIST_GSEAGEN_TARGETA     &&
          targetA.getValue() != event.w2list[W2LIST_GSEAGEN_TARGETA]) {
        return false;
      }
 
      return Erange(primary.E) && coszRange(-primary.dir.z);
    }

less()

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

inlinefinaloverride

Less-than method.

Note: The energy and cosine zenith-angle 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 406 of file JNeutrinoInteractionCategory.hh.

    {
#define RETURN_IF_DIFFERENT(A, B)               \
      if (A != B) { return A < B; }
      
      RETURN_IF_DIFFERENT(this->primaryType, category.getPrimaryType());
      
      const JNeutrinoInteractionCategory* p = dynamic_cast<const JNeutrinoInteractionCategory*>(&category);
      
      if (p == NULL) { return false; }
      
      RETURN_IF_DIFFERENT(this->interactionType, p->interactionType);
      RETURN_IF_DIFFERENT(this->scatteringType,  p->scatteringType);
      RETURN_IF_DIFFERENT(this->targetZ,         p->targetZ);
      RETURN_IF_DIFFERENT(this->targetA,         p->targetA);
      
      if (p->Erange != this->Erange) {
        return (this->Erange.getLowerLimit() == p->Erange.getLowerLimit() ?
                this->Erange.getUpperLimit() <  p->Erange.getUpperLimit() :
                this->Erange.getLowerLimit() <  p->Erange.getLowerLimit());
      } else {
        return (this->coszRange.getLowerLimit() == p->coszRange.getLowerLimit() ?
                this->coszRange.getUpperLimit() <  p->coszRange.getUpperLimit() :
                this->coszRange.getLowerLimit() <  p->coszRange.getLowerLimit());
      }
#undef RETURN_IF_DIFFERENT            
    }

getProperties() [1/2]

JProperties JAANET::JNeutrinoInteractionCategory::getProperties ( const JEquationParameters & eqpars = JEvtCategory::getEquationParameters() )

inlinefinaloverride

Get properties of this class.

Parameters

eqpars

equation parameters

Definition at line 440 of file JNeutrinoInteractionCategory.hh.

    {
      return JNeutrinoInteractionCategoryHelper(*this, eqpars);
    }

getProperties() [2/2]

JProperties JAANET::JNeutrinoInteractionCategory::getProperties ( const JEquationParameters & eqpars = JEvtCategory::getEquationParameters() ) const

inlinefinaloverride

Get properties of this class.

Parameters

eqpars

equation parameters

Definition at line 451 of file JNeutrinoInteractionCategory.hh.

    {
      return JNeutrinoInteractionCategoryHelper(*this, eqpars);
    }

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 JLANG::JClonable< JMatch< hit_type > >, JLANG::JClonable< JMatch< hit_type >, JMatch1D >, JLANG::JClonable< JMatch< hit_type >, JMatch3D >, JLANG::JClonable< JMatch< JTRIGGER::JHitR1 > >, JLANG::JClonable< JMatch< JTRIGGER::JHitR1 >, JMatch3G< JTRIGGER::JHitR1 > >, JPHYSICS::JPDFTransformer_t< JArgument_t >, JPHYSICS::JPD0Transformer_t< JArgument_t >, JPHYSICS::JPDGTransformer_t< JArgument_t >, JPHYSICS::JPDFTransformer< 2, JArgument_t >, JPHYSICS::JPDFTransformer< 3, JArgument_t >, JPHYSICS::JPDFTransformer< 4, JArgument_t >, JPHYSICS::JPDFTransformer< 5, JArgument_t >, and JTOOLS::JMultiMapTransformer< N, JArgument_t >::JMultiMapDefaultTransformer.

Definition at line 69 of file JClonable.hh.

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

Member Data Documentation

interactionType

JParameter<int> JAANET::JNeutrinoInteractionCategory::interactionType

private

interaction type

Definition at line 459 of file JNeutrinoInteractionCategory.hh.

scatteringType

JParameter<int> JAANET::JNeutrinoInteractionCategory::scatteringType

private

scattering type

Definition at line 460 of file JNeutrinoInteractionCategory.hh.

targetZ

JParameter<int> JAANET::JNeutrinoInteractionCategory::targetZ

private

target atomic number

Definition at line 461 of file JNeutrinoInteractionCategory.hh.

targetA

JParameter<int> JAANET::JNeutrinoInteractionCategory::targetA

private

target mass number

Definition at line 462 of file JNeutrinoInteractionCategory.hh.

Erange

JRange_t JAANET::JNeutrinoInteractionCategory::Erange

private

neutrino energy range

Definition at line 463 of file JNeutrinoInteractionCategory.hh.

coszRange

JRange_t JAANET::JNeutrinoInteractionCategory::coszRange

private

cosine zenith range

Definition at line 464 of file JNeutrinoInteractionCategory.hh.

---

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

• JNeutrinoInteractionCategory.hh