lar_content::LArCaloHit Class Reference

LAr calo hit class. More...

#include "LArCaloHit.h"

Inheritance diagram for lar_content::LArCaloHit:

Public Member Functions
	LArCaloHit (const LArCaloHitParameters &parameters)
	Constructor. More...
unsigned int	GetLArTPCVolumeId () const
	Get the lar tpc volume id. More...
unsigned int	GetDaughterVolumeId () const
	Get the daughter volume id. More...
void	FillParameters (LArCaloHitParameters &parameters) const
	Fill the parameters associated with this calo hit. More...
float	GetTrackProbability () const
	Get the probability that the hit is track-like. More...
float	GetShowerProbability () const
	Get the probability that the hit is shower-like. More...
void	SetTrackProbability (const float probability)
	Set the probability that the hit is track-like. More...
void	SetShowerProbability (const float probability)
	Set the probability that the hit is shower-like. More...

Private Attributes
unsigned int	m_larTPCVolumeId
	The lar tpc volume id. More...
unsigned int	m_daughterVolumeId
	The daughter volume id. More...
pandora::InputFloat	m_pTrack
	The probability that the hit is track-like. More...
pandora::InputFloat	m_pShower
	The probability that the hit is shower-like. More...

Detailed Description

LAr calo hit class.

Definition at line 39 of file LArCaloHit.h.

Constructor & Destructor Documentation

lar_content::LArCaloHit::LArCaloHit ( const LArCaloHitParameters &  parameters )

inline

Constructor.

Parameters

parameters

the lar calo hit parameters

Definition at line 158 of file LArCaloHit.h.

                                                                    :
    object_creation::CaloHit::Object(parameters),
    m_larTPCVolumeId(parameters.m_larTPCVolumeId.Get()),
    m_daughterVolumeId(parameters.m_daughterVolumeId.IsInitialized() ? parameters.m_daughterVolumeId.Get() : 0)
{
}

Member Function Documentation

void lar_content::LArCaloHit::FillParameters ( LArCaloHitParameters &  parameters ) const

inline

Fill the parameters associated with this calo hit.

Parameters

parameters

the output parameters

Definition at line 181 of file LArCaloHit.h.

References GetDaughterVolumeId(), GetLArTPCVolumeId(), lar_content::LArCaloHitParameters::m_daughterVolumeId, and lar_content::LArCaloHitParameters::m_larTPCVolumeId.

{
    parameters.m_positionVector = this->GetPositionVector();
    parameters.m_expectedDirection = this->GetExpectedDirection();
    parameters.m_cellNormalVector = this->GetCellNormalVector();
    parameters.m_cellGeometry = this->GetCellGeometry();
    parameters.m_cellSize0 = this->GetCellSize0();
    parameters.m_cellSize1 = this->GetCellSize1();
    parameters.m_cellThickness = this->GetCellThickness();
    parameters.m_nCellRadiationLengths = this->GetNCellRadiationLengths();
    parameters.m_nCellInteractionLengths = this->GetNCellInteractionLengths();
    parameters.m_time = this->GetTime();
    parameters.m_inputEnergy = this->GetInputEnergy();
    parameters.m_mipEquivalentEnergy = this->GetMipEquivalentEnergy();
    parameters.m_electromagneticEnergy = this->GetElectromagneticEnergy();
    parameters.m_hadronicEnergy = this->GetHadronicEnergy();
    parameters.m_isDigital = this->IsDigital();
    parameters.m_hitType = this->GetHitType();
    parameters.m_hitRegion = this->GetHitRegion();
    parameters.m_layer = this->GetLayer();
    parameters.m_isInOuterSamplingLayer = this->IsInOuterSamplingLayer();
    // ATTN Set the parent address to the original owner of the calo hit
    parameters.m_pParentAddress = static_cast<const void *>(this);
    parameters.m_larTPCVolumeId = this->GetLArTPCVolumeId();
    parameters.m_daughterVolumeId = this->GetDaughterVolumeId();
}

unsigned int lar_content::LArCaloHit::GetDaughterVolumeId ( ) const

inline

Get the daughter volume id.

Returns

the daughter volume id

Definition at line 174 of file LArCaloHit.h.

References m_daughterVolumeId.

Referenced by FillParameters(), lar_content::LArClusterHelper::GetDaughterVolumeIDs(), and lar_content::LArCaloHitFactory::Write().

{
    return m_daughterVolumeId;
}

unsigned int lar_content::LArCaloHit::GetLArTPCVolumeId ( ) const

inline

Get the lar tpc volume id.

Returns

the lar tpc volume id

Definition at line 167 of file LArCaloHit.h.

References m_larTPCVolumeId.

Referenced by lar_content::CosmicRayTaggingTool::CheckIfInTime(), FillParameters(), lar_content::MasterAlgorithm::GetVolumeIdToHitListMap(), and lar_content::LArCaloHitFactory::Write().

{
    return m_larTPCVolumeId;
}

float lar_content::LArCaloHit::GetShowerProbability ( ) const

inline

Get the probability that the hit is shower-like.

Returns

the probability the hit is shower-like

Definition at line 217 of file LArCaloHit.h.

References m_pShower.

{
    return m_pShower.Get();
}

float lar_content::LArCaloHit::GetTrackProbability ( ) const

inline

Get the probability that the hit is track-like.

Returns

the probability the hit is track-like

Definition at line 210 of file LArCaloHit.h.

References m_pTrack.

Referenced by lar_dl_content::DlTrackShowerStreamSelectionAlgorithm::AllocateToStreams(), lar_dl_content::DlPfoCharacterisationAlgorithm::DlPfoCharacterisationAlgorithm(), lar_dl_content::DlPfoCharacterisationAlgorithm::IsClearTrack(), lar_dl_content::DlClusterCharacterisationAlgorithm::IsClearTrack(), and lar_dl_content::DlHitValidationAlgorithm::Run().

{
    return m_pTrack.Get();
}

void lar_content::LArCaloHit::SetShowerProbability ( const float  probability )

inline

Set the probability that the hit is shower-like.

Parameters

probability

the probability the hit is shower-like

Definition at line 234 of file LArCaloHit.h.

References f, and m_pShower.

Referenced by lar_dl_content::DlHitTrackShowerIdAlgorithm::Infer().

{
    if (probability >= 0.f)
        m_pShower = probability;
    else
        throw pandora::StatusCodeException(pandora::STATUS_CODE_INVALID_PARAMETER);
}

void lar_content::LArCaloHit::SetTrackProbability ( const float  probability )

inline

Set the probability that the hit is track-like.

Parameters

probability

the probability the hit is track-like

Definition at line 224 of file LArCaloHit.h.

References f, and m_pTrack.

{
    if (probability >= 0.f)
        m_pTrack = probability;
    else
        throw pandora::StatusCodeException(pandora::STATUS_CODE_INVALID_PARAMETER);
}

Member Data Documentation

unsigned int lar_content::LArCaloHit::m_daughterVolumeId

private

The daughter volume id.

Definition at line 100 of file LArCaloHit.h.

Referenced by GetDaughterVolumeId().

unsigned int lar_content::LArCaloHit::m_larTPCVolumeId

private

The lar tpc volume id.

Definition at line 99 of file LArCaloHit.h.

Referenced by GetLArTPCVolumeId().

pandora::InputFloat lar_content::LArCaloHit::m_pShower

private

The probability that the hit is shower-like.

Definition at line 102 of file LArCaloHit.h.

Referenced by GetShowerProbability(), and SetShowerProbability().

pandora::InputFloat lar_content::LArCaloHit::m_pTrack

private

The probability that the hit is track-like.

Definition at line 101 of file LArCaloHit.h.

Referenced by GetTrackProbability(), and SetTrackProbability().

---

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

• larpandoracontent/v04_08_01/source/larpandoracontent/LArObjects/LArCaloHit.h