lar_content::InteractionDescriptor Class Reference

#include "LArInteractionTypeHelper.h"

Public Member Functions
	InteractionDescriptor (const bool isCC, const bool isQE, const bool isRes, const bool isDIS, const bool isCoherent, const bool isNumu, const bool isNue, const unsigned int nPiPlus, const unsigned int nPiMinus, const unsigned int nPhotons, const unsigned int nProtons)
	Constructor. More...
bool	IsCC () const
	Whether or not the interaction is CC. More...
bool	IsQE () const
	Whether or not the interaction is QE. More...
bool	IsResonant () const
	Whether or not the interaction is resonant. More...
bool	IsDIS () const
	Whether or not the interaction is DIS. More...
bool	IsCoherent () const
	Whether or not the interaction is coherent. More...
bool	IsMuonNeutrino () const
	Whether or not the interaction is muon neutrino. More...
bool	IsElectronNeutrino () const
	Whether or not the interaction is electron neutrino. More...
unsigned int	GetNumPiZero () const
	Retrieve the number of pi zeros. More...
unsigned int	GetNumPiPlus () const
	Retrieve the number of pi plus. More...
unsigned int	GetNumPiMinus () const
	Retrieve the number of pi minus. More...
unsigned int	GetNumPhotons () const
	Retrieve the number of photons. More...
unsigned int	GetNumProtons () const
	Retrieve the number of protons. More...
int	GetUniqueId () const
	Retrieve a unique ID describing the event (that is, a given type of interaction with specific final state particles has a particular ID) More...
const std::string &	ToString () const
	Retrieve the string descriptor for the event. More...

Static Public Attributes
static const int	CC = 8192
static const int	NC = 4096
static const int	QE = 2560
static const int	RES = 2048
static const int	DIS = 1536
static const int	COH = 1024
static const int	OTH = 512
static const int	MU = 256
static const int	E = 128
static const int	PIZERO = 64
static const int	PIPLUS = 32
static const int	PIMINUS = 16
static const int	PHOTON = 8
static const int	NP = 6

Private Attributes
const bool	m_isCC
const bool	m_isQE
const bool	m_isResonant
const bool	m_isDIS
const bool	m_isCoherent
const bool	m_isNumu
const bool	m_isNue
const unsigned int	m_nPiZero
const unsigned int	m_nPiPlus
const unsigned int	m_nPiMinus
const unsigned int	m_nPhotons
const unsigned int	m_nProtons
int	m_id
std::string	m_descriptor

Detailed Description

Definition at line 331 of file LArInteractionTypeHelper.h.

Constructor & Destructor Documentation

lar_content::InteractionDescriptor::InteractionDescriptor	(	const bool	isCC,
		const bool	isQE,
		const bool	isRes,
		const bool	isDIS,
		const bool	isCoherent,
		const bool	isNumu,
		const bool	isNue,
		const unsigned int	nPiPlus,
		const unsigned int	nPiMinus,
		const unsigned int	nPhotons,
		const unsigned int	nProtons
	)

Constructor.

Parameters

isCC	Whether or not the interaction is a CC interaction
isQE	Whether or not the interaction is a QE interaction
isRes	Whether or not the interaction is a resonant interaction
isDIS	Whether or not the interaction is a DIS interaction
isCoherent	Whether or not the interaction is a coherent interaction
isNumu	Whether or not the interaction is a numu interaction
isNue	Whether or not the interaction is a nue interaction
nPiPlus	Number of pi plus in the final state
nPiMinus	Number of pi minus in the final state
nPhotons	Number of photons in the final state
nProtons	Number of protons in the final state

Definition at line 747 of file LArInteractionTypeHelper.cc.

References CC, COH, DIS, E, m_descriptor, m_id, m_isCC, m_isCoherent, m_isDIS, m_isNue, m_isNumu, m_isQE, m_isResonant, m_nPhotons, m_nPiMinus, m_nPiPlus, m_nPiZero, m_nProtons, MU, NC, NP, OTH, PHOTON, PIMINUS, PIPLUS, PIZERO, QE, RES, and util::to_string().

                                 :
    m_isCC{isCC},
    m_isQE{isQE},
    m_isResonant{isRes},
    m_isDIS{isDIS},
    m_isCoherent{isCoherent},
    m_isNumu{isNumu},
    m_isNue{isNue},
    m_nPiZero{nPhotons / 2},
    m_nPiPlus{nPiPlus},
    m_nPiMinus{nPiMinus},
    m_nPhotons{nPhotons % 2},
    m_nProtons{nProtons},
    m_id{0},
    m_descriptor{}
{
    m_id += m_isCC ? CC : NC;
    m_descriptor += m_isCC ? "CC" : "NC";
    if (isQE)
    {
        m_id += QE;
        m_descriptor += "QE";
    }
    else if (isRes)
    {
        m_id += RES;
        m_descriptor += "RES";
    }
    else if (isDIS)
    {
        m_id += DIS;
        m_descriptor += "DIS";
    }
    else if (isCoherent)
    {
        m_id += COH;
        m_descriptor += "COH";
    }
    else
    {
        m_id += OTH;
        m_descriptor += "OTH";
    }

    if (m_isNumu)
    {
        m_id += MU;
        m_descriptor += "_MU";
    }
    else if (m_isNue)
    {
        m_id += E;
        m_descriptor += "_E";
    }

    m_id += m_nPiZero == 1 ? PIZERO : 0;
    m_descriptor += m_nPiZero == 1 ? "_PIZERO" : m_nPiZero > 0 ? "_NPIZERO" : "";
    m_id += m_nPiPlus == 1 ? PIPLUS : 0;
    m_descriptor += m_nPiPlus == 1 ? "_PIPLUS" : m_nPiPlus > 0 ? "_NPIPLUS" : "";
    m_id += m_nPiMinus == 1 ? PIMINUS : 0;
    m_descriptor += m_nPiMinus == 1 ? "_PIMINUS" : m_nPiMinus > 0 ? "_NPIMINUS" : "";
    m_id += m_nPhotons == 1 ? PHOTON : 0;
    m_descriptor += m_nPhotons == 1 ? "_PHOTON" : "";
    m_id += m_nProtons < NP ? m_nProtons : NP;
    m_descriptor += m_nProtons >= NP ? "NP" : m_nProtons > 0 ? "_" + std::to_string(m_nProtons) + "P" : "";
}

Member Function Documentation

unsigned int lar_content::InteractionDescriptor::GetNumPhotons ( ) const

inline

Retrieve the number of photons.

Returns

Retrieve the number of photons

Definition at line 555 of file LArInteractionTypeHelper.h.

{
    return m_nPhotons;
}

unsigned int lar_content::InteractionDescriptor::GetNumPiMinus ( ) const

inline

Retrieve the number of pi minus.

Returns

Retrieve the number of pi minus

Definition at line 548 of file LArInteractionTypeHelper.h.

{
    return m_nPiMinus;
}

unsigned int lar_content::InteractionDescriptor::GetNumPiPlus ( ) const

inline

Retrieve the number of pi plus.

Returns

Retrieve the number of pi plus

Definition at line 541 of file LArInteractionTypeHelper.h.

{
    return m_nPiPlus;
}

unsigned int lar_content::InteractionDescriptor::GetNumPiZero ( ) const

inline

Retrieve the number of pi zeros.

Returns

Retrieve the number of pi zeros

Definition at line 534 of file LArInteractionTypeHelper.h.

{
    return m_nPiZero;
}

unsigned int lar_content::InteractionDescriptor::GetNumProtons ( ) const

inline

Retrieve the number of protons.

Returns

Retrieve the number of protons

Definition at line 562 of file LArInteractionTypeHelper.h.

{
    return m_nProtons;
}

int lar_content::InteractionDescriptor::GetUniqueId ( ) const

inline

Retrieve a unique ID describing the event (that is, a given type of interaction with specific final state particles has a particular ID)

Returns

The unique identifier for the event

Definition at line 569 of file LArInteractionTypeHelper.h.

{
    return m_id;
}

bool lar_content::InteractionDescriptor::IsCC ( ) const

inline

Whether or not the interaction is CC.

Returns

Whether or not the interaction is CC

Definition at line 485 of file LArInteractionTypeHelper.h.

Referenced by lar_content::HierarchyValidationAlgorithm::Run().

{
    return m_isCC;
}

bool lar_content::InteractionDescriptor::IsCoherent ( ) const

inline

Whether or not the interaction is coherent.

Returns

Whether or not the interaction is coherent

Definition at line 513 of file LArInteractionTypeHelper.h.

{
    return m_isCoherent;
}

bool lar_content::InteractionDescriptor::IsDIS ( ) const

inline

Whether or not the interaction is DIS.

Returns

Whether or not the interaction is DIS

Definition at line 506 of file LArInteractionTypeHelper.h.

{
    return m_isDIS;
}

bool lar_content::InteractionDescriptor::IsElectronNeutrino ( ) const

inline

Whether or not the interaction is electron neutrino.

Returns

Whether or not the interaction is electron neutrino

Definition at line 527 of file LArInteractionTypeHelper.h.

{
    return m_isNue;
}

bool lar_content::InteractionDescriptor::IsMuonNeutrino ( ) const

inline

Whether or not the interaction is muon neutrino.

Returns

Whether or not the interaction is muon neutrino

Definition at line 520 of file LArInteractionTypeHelper.h.

{
    return m_isNumu;
}

bool lar_content::InteractionDescriptor::IsQE ( ) const

inline

Whether or not the interaction is QE.

Returns

Whether or not the interaction is QE

Definition at line 492 of file LArInteractionTypeHelper.h.

{
    return m_isQE;
}

bool lar_content::InteractionDescriptor::IsResonant ( ) const

inline

Whether or not the interaction is resonant.

Returns

Whether or not the interaction is resonant

Definition at line 499 of file LArInteractionTypeHelper.h.

{
    return m_isResonant;
}

const std::string & lar_content::InteractionDescriptor::ToString ( ) const

inline

Retrieve the string descriptor for the event.

Returns

The string descriptor for the event

Definition at line 576 of file LArInteractionTypeHelper.h.

{
    return m_descriptor;
}

Member Data Documentation

const int lar_content::InteractionDescriptor::CC = 8192

static

Definition at line 451 of file LArInteractionTypeHelper.h.

Referenced by InteractionDescriptor(), and lar_content::LArInteractionTypeHelper::InteractionParameters::InteractionParameters().

const int lar_content::InteractionDescriptor::COH = 1024

static

Definition at line 456 of file LArInteractionTypeHelper.h.

Referenced by InteractionDescriptor(), and lar_content::LArInteractionTypeHelper::InteractionParameters::InteractionParameters().

const int lar_content::InteractionDescriptor::DIS = 1536

static

Definition at line 455 of file LArInteractionTypeHelper.h.

Referenced by InteractionDescriptor(), and lar_content::LArInteractionTypeHelper::InteractionParameters::InteractionParameters().

const int lar_content::InteractionDescriptor::E = 128

static

Definition at line 459 of file LArInteractionTypeHelper.h.

Referenced by InteractionDescriptor(), and lar_content::LArInteractionTypeHelper::InteractionParameters::InteractionParameters().

std::string lar_content::InteractionDescriptor::m_descriptor

private

Definition at line 480 of file LArInteractionTypeHelper.h.

Referenced by InteractionDescriptor().

int lar_content::InteractionDescriptor::m_id

private

Definition at line 479 of file LArInteractionTypeHelper.h.

Referenced by InteractionDescriptor().

const bool lar_content::InteractionDescriptor::m_isCC

private

Definition at line 467 of file LArInteractionTypeHelper.h.

Referenced by InteractionDescriptor().

const bool lar_content::InteractionDescriptor::m_isCoherent

private

Definition at line 471 of file LArInteractionTypeHelper.h.

Referenced by InteractionDescriptor().

const bool lar_content::InteractionDescriptor::m_isDIS

private

Definition at line 470 of file LArInteractionTypeHelper.h.

Referenced by InteractionDescriptor().

const bool lar_content::InteractionDescriptor::m_isNue

private

Definition at line 473 of file LArInteractionTypeHelper.h.

Referenced by InteractionDescriptor().

const bool lar_content::InteractionDescriptor::m_isNumu

private

Definition at line 472 of file LArInteractionTypeHelper.h.

Referenced by InteractionDescriptor().

const bool lar_content::InteractionDescriptor::m_isQE

private

Definition at line 468 of file LArInteractionTypeHelper.h.

Referenced by InteractionDescriptor().

const bool lar_content::InteractionDescriptor::m_isResonant

private

Definition at line 469 of file LArInteractionTypeHelper.h.

Referenced by InteractionDescriptor().

const unsigned int lar_content::InteractionDescriptor::m_nPhotons

private

Definition at line 477 of file LArInteractionTypeHelper.h.

Referenced by InteractionDescriptor().

const unsigned int lar_content::InteractionDescriptor::m_nPiMinus

private

Definition at line 476 of file LArInteractionTypeHelper.h.

Referenced by InteractionDescriptor().

const unsigned int lar_content::InteractionDescriptor::m_nPiPlus

private

Definition at line 475 of file LArInteractionTypeHelper.h.

Referenced by InteractionDescriptor().

const unsigned int lar_content::InteractionDescriptor::m_nPiZero

private

Definition at line 474 of file LArInteractionTypeHelper.h.

Referenced by InteractionDescriptor().

const unsigned int lar_content::InteractionDescriptor::m_nProtons

private

Definition at line 478 of file LArInteractionTypeHelper.h.

Referenced by InteractionDescriptor().

const int lar_content::InteractionDescriptor::MU = 256

static

Definition at line 458 of file LArInteractionTypeHelper.h.

Referenced by InteractionDescriptor(), and lar_content::LArInteractionTypeHelper::InteractionParameters::InteractionParameters().

const int lar_content::InteractionDescriptor::NC = 4096

static

Definition at line 452 of file LArInteractionTypeHelper.h.

Referenced by InteractionDescriptor(), and lar_content::LArInteractionTypeHelper::InteractionParameters::InteractionParameters().

const int lar_content::InteractionDescriptor::NP = 6

static

Definition at line 464 of file LArInteractionTypeHelper.h.

Referenced by InteractionDescriptor(), and lar_content::LArInteractionTypeHelper::InteractionParameters::InteractionParameters().

const int lar_content::InteractionDescriptor::OTH = 512

static

Definition at line 457 of file LArInteractionTypeHelper.h.

Referenced by InteractionDescriptor(), and lar_content::LArInteractionTypeHelper::InteractionParameters::InteractionParameters().

const int lar_content::InteractionDescriptor::PHOTON = 8

static

Definition at line 463 of file LArInteractionTypeHelper.h.

Referenced by InteractionDescriptor(), and lar_content::LArInteractionTypeHelper::InteractionParameters::InteractionParameters().

const int lar_content::InteractionDescriptor::PIMINUS = 16

static

Definition at line 462 of file LArInteractionTypeHelper.h.

Referenced by InteractionDescriptor(), and lar_content::LArInteractionTypeHelper::InteractionParameters::InteractionParameters().

const int lar_content::InteractionDescriptor::PIPLUS = 32

static

Definition at line 461 of file LArInteractionTypeHelper.h.

Referenced by InteractionDescriptor(), and lar_content::LArInteractionTypeHelper::InteractionParameters::InteractionParameters().

const int lar_content::InteractionDescriptor::PIZERO = 64

static

Definition at line 460 of file LArInteractionTypeHelper.h.

Referenced by InteractionDescriptor(), and lar_content::LArInteractionTypeHelper::InteractionParameters::InteractionParameters().

const int lar_content::InteractionDescriptor::QE = 2560

static

Definition at line 453 of file LArInteractionTypeHelper.h.

Referenced by InteractionDescriptor(), and lar_content::LArInteractionTypeHelper::InteractionParameters::InteractionParameters().

const int lar_content::InteractionDescriptor::RES = 2048

static

Definition at line 454 of file LArInteractionTypeHelper.h.

Referenced by InteractionDescriptor(), and lar_content::LArInteractionTypeHelper::InteractionParameters::InteractionParameters().

---

The documentation for this class was generated from the following files:

• larpandoracontent/v04_08_01/source/larpandoracontent/LArHelpers/LArInteractionTypeHelper.h
• larpandoracontent/v04_08_01/source/larpandoracontent/LArHelpers/LArInteractionTypeHelper.cc