rb::Cluster Class Reference

A collection of associated CellHits. More...

#include "/cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N20-04-08/RecoBase/Cluster.h"

Inheritance diagram for rb::Cluster:

Public Types
enum	ESaveGeVMode { kInitializeTotalGeV = 0, kResetTotalGeV = 1 }

Public Member Functions
virtual	~Cluster ()
virtual void	Add (const art::Ptr< rb::CellHit > &cell, double weight=1)
virtual void	Add (const art::PtrVector< rb::CellHit > &cells, const std::vector< double > &weights=std::vector< double >())
void	SetID (int id)
const int	ID () const
virtual double	W (const rb::CellHit *chit) const
	Estimate the unmeasured coordinate of chit. More...
virtual bool	Is3D () const
bool	Is2D () const
virtual geo::View_t	View () const
	kXorY for 3D clusters. More...
rb::Cluster	Exclude (const rb::Cluster *excl) const
	Create a cluster from this one, but with the hits of excl removed. More...
rb::RecoHit	RecoHit (const art::Ptr< rb::CellHit > &chit) const
	Return calibrated hit based on assumed W coordinate. More...
rb::RecoHit	RecoHit (geo::View_t view, unsigned int viewIdx) const
rb::RecoHit	RecoHit (unsigned int globalIdx) const
virtual void	Clear ()
	Forget about all owned cell hits. More...
void	RemoveHit (const art::Ptr< rb::CellHit > hit)
	Remove hit from current cluster. More...
void	RemoveHit (unsigned int globalIdx)
	Remove the ith hit from current cluster. More...
void	SetNoise (bool noise)
	Declare the cluster to consist of noise hits or not. More...
bool	IsNoise () const
	Is the noise flag set? More...
void	SetWeight (unsigned int globalIdx, double weight)
	Set weight of the cell at this index. More...
void	SetWeight (geo::View_t view, unsigned int viewIdx, double weight)
	Set weight of the cell at this index in this view. More...
void	StandardSort ()
	Put the cells in the cluster into a standard order. More...
void	SavePrecalcTotalGeV (ESaveGeVMode savemode)
	Store the current result of TotalGeV / CalorimetricEnergy. More...
bool	operator< (const Cluster &other) const
3D cluster constructors
	Cluster ()
	Cluster (const art::PtrVector< rb::CellHit > &cells, int id=0)
2D cluster constructors
	Cluster (geo::View_t view, int id=0)
	Cluster (geo::View_t view, const art::PtrVector< rb::CellHit > &cells, int id=0)
	Cluster (geo::View_t view, const std::vector< art::Ptr< rb::CellHit > > &cells, int id=0)
Cell counts
unsigned int	NCell (geo::View_t view) const
	Number of cells in view view. More...
unsigned int	NXCell () const
	Number of cells in the x-view. More...
unsigned int	NYCell () const
	Number of cells in the y-view. More...
unsigned int	NCell () const
	Number of cells in either view. More...
Cell Accessors
art::Ptr< rb::CellHit >	Cell (geo::View_t view, unsigned int viewIdx) const
	Get the ith cell from view view. More...
art::Ptr< rb::CellHit >	XCell (unsigned int xIdx) const
	Get the ith cell in the x-view. More...
art::Ptr< rb::CellHit >	YCell (unsigned int yIdx) const
	Get the ith cell in the y-view. More...
art::Ptr< rb::CellHit >	Cell (unsigned int globalIdx) const
	Get the ith cell from either view. More...
const art::PtrVector< rb::CellHit > &	XCells () const
	Get all cells from the x-view. More...
const art::PtrVector< rb::CellHit > &	YCells () const
	Get all cells from the x-view. More...
art::PtrVector< rb::CellHit >	AllCells () const
	Get all cells from both views. More...
std::vector< geo::OfflineChan >	OfflineChans () const
	Positions of all the CellHits. More...
std::vector< rb::WeightedHit >	WeightedHits () const
	Get all hits from both views, with weights attached. More...
double	Weight (unsigned int globalIdx) const
	Weight assigned to the cell. More...
double	Weight (geo::View_t view, unsigned int viewIdx) const
	Weight assigned to the cell. More...
Minima
The "lower" corner of a box containing all the hits
TVector3	MinXYZ () const
double	MinV (geo::View_t view) const
double	MinX () const
double	MinY () const
double	MinZ () const
double	MinTNS () const
unsigned int	MinPlane (geo::View_t view=geo::kXorY) const
unsigned int	MinCell (geo::View_t view) const
Maxima
The "upper" corner of a box containing all the hits
TVector3	MaxXYZ () const
double	MaxV (geo::View_t view) const
double	MaxX () const
double	MaxY () const
double	MaxZ () const
double	MaxTNS () const
unsigned int	MaxPlane (geo::View_t view=geo::kXorY) const
unsigned int	MaxCell (geo::View_t view) const
Means
The unweighted mean position and time of all the hits in the cluster
TVector3	MeanXYZ (rb::AveragingScheme=kDefaultScheme) const
double	MeanV (geo::View_t view, rb::AveragingScheme scheme=kDefaultScheme) const
double	MeanX (rb::AveragingScheme scheme=kDefaultScheme) const
double	MeanY (rb::AveragingScheme scheme=kDefaultScheme) const
double	MeanZ (rb::AveragingScheme scheme=kDefaultScheme) const
double	MeanTNS (rb::AveragingScheme scheme=kDefaultScheme) const
void	MinMaxMeanXYZ (TVector3 &lo, TVector3 &hi, TVector3 &mean, rb::AveragingScheme scheme=kDefaultScheme) const
	Gets the min/max/mean all at once, called by the functions above. More...
Extents
The size of a box containing all the hits
TVector3	ExtentXYZ () const
double	ExtentV (geo::View_t view) const
double	ExtentX () const
double	ExtentY () const
double	ExtentZ () const
unsigned int	ExtentPlane (geo::View_t view=geo::kXorY) const
unsigned int	ExtentCell (geo::View_t view) const
double	ExtentTNS () const
Connectedness measures
int	MostContiguousPlanes (geo::View_t view) const
	Longest run of adjacent planes with hits. More...
int	MostMissingPlanes (geo::View_t view) const
	Longest run of adjacent planes with no hits. More...
int	NMissingPlanes (geo::View_t view) const
	Total number of missing planes in cluster. More...

Protected Attributes
geo::View_t	fView
	view this cluster is in More...
art::PtrVector< rb::CellHit >	fXCell
	collection of x-view cells in cluster More...
art::PtrVector< rb::CellHit >	fYCell
	collection of y-view cells in cluster More...
std::vector< double >	fXWeights
	Weights, matching cell indexing. More...
std::vector< double >	fYWeights
	May be empty, means all weights are 1. More...
int	fID
	ID for cluster. More...
bool	fNoiseCluster
	flag for whether this is a noise cluster More...
double	fPrecalcTotalGeV
	-1 = uninitialized More...

Friends
std::ostream &	operator<< (std::ostream &o, const Cluster &c)

Totals
enum	EEnergyCalcScheme { kRecomputeEnergy = 0, kUsePrecalcEnergy = 1 }
double	TotalADC () const
	Sum of the ADC of all the contained hits. More...
double	TotalPE () const
	Sum of the PE value of all the contained hits. More...
double	TotalGeV (EEnergyCalcScheme escheme=kRecomputeEnergy) const
	Simple sum of the estimated GeV of all the hits. More...
double	TotalWeight () const
	Sum of all the weights. The effective number of hits. More...
double	CalorimetricEnergy (EEnergyCalcScheme escheme=kRecomputeEnergy) const
	Simple estimate of neutrino energy. More...

Internal helpers
void	EnsureWeightAlloc ()
	Helper. Resizes weights vectors to match cell vectors. More...
double	TotalGeVFastClusterOnly () const
	Optimized form of TotalGeV, only valid for actual Clusters. More...

Detailed Description

A collection of associated CellHits.

A Cluster is simply a "bag" of CellHits which have been reconstructed to be associated with each other in some way.

A cluster may be created as either 2D or 3D (ie containing hits from one or both views).

This class also contains various utility functions for obtaining the bulk properties of these hits.

It forms the basis of the reconstruction inheritance hierarchy, with the derived classes adding additional information about the hits.

Definition at line 47 of file Cluster.h.

Member Enumeration Documentation

enum rb::Cluster::EEnergyCalcScheme

Enumerator
kRecomputeEnergy	Default. Ask Calibrator about each hit, and sum.
kUsePrecalcEnergy	Use a value computed by a previous call to SavePrecalcTotalGeV.

Definition at line 177 of file Cluster.h.

                          {
      kRecomputeEnergy = 0, ///< Default. Ask Calibrator about each hit, and sum
      kUsePrecalcEnergy = 1 ///< Use a value computed by a previous call to \ref SavePrecalcTotalGeV
    };

enum rb::Cluster::ESaveGeVMode

Enumerator
kInitializeTotalGeV	Default, this is the initial/only call.
kResetTotalGeV	Altering the already-set value is not an error.

Definition at line 281 of file Cluster.h.

                     {
      kInitializeTotalGeV = 0, ///< Default, this is the initial/only call
      kResetTotalGeV = 1 ///< Altering the already-set value is not an error
    };

Constructor & Destructor Documentation

rb::Cluster::Cluster

(

)

Definition at line 25 of file Cluster.cxx.

    : fView(geo::kXorY)
    , fID(0)
    , fNoiseCluster(false)
    , fPrecalcTotalGeV(-1)
  {
  }

rb::Cluster::Cluster ( const art::PtrVector< rb::CellHit > &  cells, int  id = 0  )

explicit

Definition at line 34 of file Cluster.cxx.

References Add(), MECModelEnuComparisons::i, and art::PtrVector< T >::size().

    : fView(geo::kXorY)
    , fID(id)
    , fNoiseCluster(false)
    , fPrecalcTotalGeV(-1)
  {
    for(unsigned int i = 0; i < cells.size(); ++i) Add(cells[i]);
  }

rb::Cluster::Cluster	(	geo::View_t	view,
		int	id = 0
	)

Definition at line 44 of file Cluster.cxx.

    : fView(view)
    , fID(id)
    , fNoiseCluster(false)
    , fPrecalcTotalGeV(-1)
  {
  }

rb::Cluster::Cluster	(	geo::View_t	view,
		const art::PtrVector< rb::CellHit > &	cells,
		int	id = 0
	)

Definition at line 53 of file Cluster.cxx.

References Add(), ana::assert(), art::PtrVector< T >::empty(), fView, fXCell, fYCell, MECModelEnuComparisons::i, geo::kX, geo::kY, and art::PtrVector< T >::size().

    : fView(view)
    , fID(id)
    , fNoiseCluster(false)
    , fPrecalcTotalGeV(-1)
  {
    for(unsigned int i = 0; i < cells.size(); ++i) Add(cells[i]);

    assert((fView == geo::kX && fYCell.empty()) ||
     (fView == geo::kY && fXCell.empty()));
  }

rb::Cluster::Cluster	(	geo::View_t	view,
		const std::vector< art::Ptr< rb::CellHit > > &	cells,
		int	id = 0
	)

Definition at line 66 of file Cluster.cxx.

References Add(), ana::assert(), art::PtrVector< T >::empty(), fView, fXCell, fYCell, MECModelEnuComparisons::i, geo::kX, and geo::kY.

    : fView(view)
    , fID(id)
    , fNoiseCluster(false)
    , fPrecalcTotalGeV(-1)
  {
    for(unsigned int i = 0; i < cells.size(); ++i) Add(cells[i]);

    assert((fView == geo::kX && fYCell.empty()) ||
     (fView == geo::kY && fXCell.empty()));
  }

rb::Cluster::~Cluster ( )

virtual

Definition at line 79 of file Cluster.cxx.

  {
  }

Member Function Documentation

void rb::Cluster::Add ( const art::Ptr< rb::CellHit > &  cell, double  weight = 1  )

virtual

Definition at line 84 of file Cluster.cxx.

References ana::assert(), EnsureWeightAlloc(), fPrecalcTotalGeV, fView, fXCell, fXWeights, fYCell, fYWeights, geo::kX, geo::kY, art::PtrVector< T >::push_back(), and rb::CellHit::View().

Referenced by Add(), fuzz::FuzzyKVertex::AddProng(), bpfit::BPFTmvaTrainer::analyze(), bpf::BPFCVNAna::analyze(), htk::HoughTrack::analyze(), Cluster(), ddthelpers::cluster_hits(), sn::SNMichelAnalyzer::ClusterAroundTrackEnds(), tdslicer::TDSlicer::DBSCAN(), slicemergeviews::SliceMergeViews::DoMerge(), Exclude(), mono::MonopoleCluster::filter(), bsf::BremShowerFilter::filter(), mono::MonopoleTrack::filter(), mono::MonopoleCluster::find_isolated_hits(), trk::KalmanTrack::FindTracks(), cosrej::CosRejFxs::getActivity(), numusand::NumuSandFxs::getActivityVtx(), trk::KalmanTrackMerge::JoinTracks(), trk::WindowTrackingAlg::LookForBremsstrahlungHits(), mono::Cluster::make(), me::MEFinder::MakeSlcME(), fuzz::ViewMatchAlg::MakeTestProng(), nerd::ViewMatchAlg::MakeTestProng(), trk::WindowTrackingAlg::MakeTrack(), airshower::AirSlicer::MakeTrackSlices(), me::MEFinder::MakeTrkME(), numue::NumuEAlg::MakeVertexCluster(), fuzz::ViewMatchAlg::Matching(), nerd::ViewMatchAlg::Matching(), trk::KalmanTrackMerge::MatchTracks(), cheat::BackTracker::MCTruthToCluster(), qeef::QeFinder::produce(), slicer::Slicer4D::produce(), nuesand::FillNueSandbox::produce(), slid::Recluster::produce(), numusand::FillSandbox::produce(), cvn::CVNCosmicMapper::produce(), zcl::SPCluster::produce(), airshower::AirSlicer::produce(), zcl::SMMCluster::produce(), sn::SNSlicer::produce(), zcl::FMMTracker::produce(), cvn::CVNMapper::produce(), dif::DiFShowerFinder::produce(), bpfit::BPFEnergyEstimator::produce(), bpfit::BPFEnergyEstimatorOnly::produce(), tdslicer::TDSlicer::produce(), trk::WindowTrackingAlg::ShortTrack(), trk::WindowTrackingAlg::ShortTrackExtraPlane(), airshower::AirSlicer::TemporalClusters(), dt::Cand::ToTrack(), htk::Track3D::Track3D(), mono::Track3D::Track3D(), zcl::FMMTracker::Tracking2D(), slicemergeviews::SliceMergeViews::TrimNoise(), tdslicer::TDSlicer::TrimNoise(), trk::KalmanTrackMerge::ViewMergeTracks(), slicer::MMSlicer::WindowSlice(), and slicer::Slicer::WindowSlice().

  {
    fPrecalcTotalGeV = -1; // Invalidate any cached value

    assert(weight >= 0 && weight <= 1);

    // Are we optimizing (omitting) the weights storage?
    const bool optWeights = (weight == 1 && fXWeights.empty() && fYWeights.empty());
    if(!optWeights) EnsureWeightAlloc();

    if(cell->View() == geo::kX){
      assert(fView != geo::kY);
      fXCell.push_back(cell);
      if(!optWeights) fXWeights.push_back(weight);
    }
    else{
      assert(fView != geo::kX);
      fYCell.push_back(cell);
      if(!optWeights) fYWeights.push_back(weight);
    }
  }

void rb::Cluster::Add ( const art::PtrVector< rb::CellHit > &  cells, const std::vector< double > &  weights = std::vector<double>()  )

virtual

Definition at line 107 of file Cluster.cxx.

References Add(), ana::assert(), art::PtrVector< T >::empty(), getGoodRuns4SAM::n, and art::PtrVector< T >::size().

  {
    const unsigned int N = cells.size();

    assert(weights.empty() || weights.size() == N);

    for(unsigned int n = 0; n < N; ++n){
      assert(weights.empty() || (weights[n] >= 0 && weights[n] <= 1));
      Add(cells[n], weights.empty() ? 1 : weights[n]);
    }
  }

art::PtrVector< rb::CellHit > rb::Cluster::AllCells

(

)

const

Get all cells from both views.

Definition at line 180 of file Cluster.cxx.

References plot_validation_datamc::c, fXCell, fYCell, art::PtrVector< T >::push_back(), and art::PtrVector< T >::size().

Referenced by caf::AddSlcMEToVec(), caf::AddTrkMEToVec(), qeef::QeFinderVal::analyze(), calib::TestParticleCorrections::analyze(), murem::MuonRemoveAna::analyze(), validation::NoiseClusterAnalysis::analyze(), calib::HitEfficiency::analyze(), showere::ShowerEnergyAna::analyze(), hough::HoughValidate::analyze(), zcl::FastMMStudy::analyze(), upmuana::UpMuRecoAna::analyze(), upmuana::UpMuAnalysis::analyze(), htk::HoughTrack::analyze(), trk::KalmanTrackAna::CheckAssociations(), air::AirKalmanAna::CheckAssociations(), cheat::RecoCheckAna::CheckRecoClusters(), trk::KalmanTrackAna::CheckRecoTracks(), trk::WindowTrackingAlg::CheckTrackDirectionInY(), bpfit::dEdxCalculator::computeDEDX(), skim::SkimmingUtils::CopySlice(), murem::TrackCleanUpAlg::DeDxInPlane(), nnbar::NNbarUtilities::energyBalancingVertex(), dt::ViewMerger::FakeThirdDimension(), caf::FillDiFShowerVars(), caf::FillDiFVars(), calib::StopperThreshold::FillHist(), calib::CosmicTrends::FillHistograms(), caf::FillProngVars(), caf::FillShowerVars(), calib::StopperThreshold::FillTree(), trk::CosmicTrackAna::FillTrueInfo(), showere::ShowerEnergyFilterMC::filter(), cvn::Get2DProngEfficiencyByPDG(), cvn::Get2DProngEnergyByPDG(), cvn::Get2DProngPurityByPDG(), nnbar::NNbarUtilities::getCoordinateOfHits(), nuesand::FillNueSandbox::GetdEdx(), numusand::NumuSandFxs::getMissingE(), nnbar::NNbarUtilities::getMultipleCellFraction(), cvn::GetProngEfficiencyByPDG(), cvn::GetProngEnergyByPDG(), cvn::GetProngPurityByPDG(), nnbar::NNbarUtilities::getSliceBoundary(), nnbar::NNbarUtilities::getSliceTimeWindow(), nnbar::NNbarUtilities::getXyAsymmetry(), nnbar::NNbarUtilities::isFebFlasher(), novaddt::HorizontalMuonAna::IsHorzMuonTrack(), caf::IsTrueDiF(), calib::RockMuonStopperSelection::IsTrulyContainedStopper(), calib::StopperSelection::IsTrulyContainedStopper(), calib::RockMuonStopperSelection::IsTrulyInFiducial(), calib::ThroughgoingSelection::IsTrulyUncontained(), trk::KalmanTrackMerge::JoinTracks(), dt::ViewMerger::JoinTracks(), nerd::NERDProng::MakeCluster(), trk::WindowTrackingAlg::MakeTrack(), airshower::AirSlicer::MakeTrackSlices(), murem::FindParent::MatchToOrigSlice(), numue::NumuEAlg::MCTruthEnergyVariables(), murem::MuonRemove::MuonInfo(), mono::Monopole::n_mc_hits(), dq::FlasherFinder::Nflash(), zcl::FastMonopoleTriggers::NumberOfCellsPerLength(), zcl::FastMMStudy::NumberOfCellsPerLength(), zcl::FastMonopoleTriggers::NumberOfHitsInOverlapPlanesCut(), zcl::FastMMStudy::NumberOfHitsInOverlapPlanesCut(), mono::operator<<(), skim::ParametersNumu::ParametersNumu(), calib::PCHitsList::ProcessTrackForBelowThresholdHits(), calib::PCHitsList::ProcessTrackForFLSHits(), trk::TrkAssn::produce(), slid::Recluster::produce(), numusand::FillSandbox::produce(), hough::MultiHoughT::produce(), cosrej::CosRej::produce(), numue::NumuEnergy::produce(), earms::ElasticArmsHS::produce(), vdt::VertexDT::produce(), upmuana::UpMuProb::produce(), fuzz::FuzzyKVertex::produce(), nerd::NERDProng::produce(), caf::CAFMaker::produce(), cvn::ProngClassify(), sn::SliceRemover::remove(), murem::MuonRemove::RemoveByEfficiency(), trk::WindowTrackingAlg::SetTrackEndPoints(), trk::WindowTrackingAlg::ShortTrack(), cheat::BackTracker::SliceToMCTruth(), cheat::BackTracker::SliceToNeutrinoInteractions(), cosrej::MakeNueCosRej::SparsenessAsymmetry(), zcl::FastMonopoleTriggers::StdevCellsPerPlane(), zcl::FastMMStudy::StdevCellsPerPlane(), htk::Track3D::time_fit(), mono::Track3D::time_fit(), htk::Track3D::Track3D(), mono::Track3D::Track3D(), slid::NuEEnergyAlg::VertexEnergy(), zcl::FastMonopoleTriggers::WeightedCenterCut(), zcl::FastMMStudy::WeightedCenterCut(), moonshadowana::MoonShadowAna::WriteTrackInfo(), moonshadowana::MoonShadowAnaHough::WriteTrackInfo(), YCells(), dt::ViewMerger::ZipVerticalTracks(), and rb::Track::ZipWith().

  {
    art::PtrVector<rb::CellHit> all;
    for(size_t c = 0; c < fXCell.size(); ++c) all.push_back(fXCell[c]);
    for(size_t c = 0; c < fYCell.size(); ++c) all.push_back(fYCell[c]);

    return all;
  }

double rb::Cluster::CalorimetricEnergy

(

EEnergyCalcScheme

escheme = kRecomputeEnergy

)

const

Simple estimate of neutrino energy.

Uses a simple scale factor to correct for dead material and thresholds, could be more advanced, but this is simple enough to use for preselection etc.

Definition at line 439 of file Cluster.cxx.

References calib::Calibrator::GetGeVToCalorimetricScale(), and TotalGeV().

Referenced by caf::AddSlcMEToVec(), caf::AddTrkMEToVec(), tbem::TBRecoAna::analyze(), ncid::CompareByCalEnergy(), cosrej::CompareByCalEnergy(), caf::FillDiFShowerVars(), caf::FillDiFVars(), caf::FillHadClustVars(), caf::FillProngVars(), caf::FillShowerVars(), caf::FillSliceVars(), xsrec::MakeXSecCCPi0Inc::GetPhLL(), numue::NumuEAlg::GetUCMuonENonSingle(), numue::NumuEAlg::GetUCMuonESingle(), SliceLID::BasicProngVars::initBasicVars(), LSTME::BasicProngVars::initBasicVars(), me::MEFinder::MakeSlcME(), me::MEFinder::MakeTrkME(), skim::ParametersNue::ParametersNue(), skim::ParametersNumu::ParametersNumu(), me::MEFinder::PassesMEPresel(), presel::LEMPresel::produce(), numusand::FillSandbox::produce(), presel::NuePresel::produce(), cosrej::CosRej::produce(), cosrej::MakeNueCosRej::produce(), caf::CAFMaker::produce(), showerByEnergyNue(), showerByEnergyNumu(), lem::LEMSummarizer::SliceToLEMInput(), and ncid::NCNNKeras::TransMomFraction().

  {
    art::ServiceHandle<calib::Calibrator> cal;
    return cal->GetGeVToCalorimetricScale()*TotalGeV(escheme);
  }

art::Ptr< rb::CellHit > rb::Cluster::Cell	(	geo::View_t	view,
		unsigned int	viewIdx
	)		const

Get the ith cell from view view.

Definition at line 145 of file Cluster.cxx.

References ana::assert(), geo::kX, geo::kXorY, geo::kY, XCell(), and YCell().

Referenced by dqsf::DQSpillFlags::AccumulateSyncMetric(), rb::HitMap::Add(), fuzz::FuzzyKVertex::AddProng(), dif::DiFShowerFinder::adjustPlane(), dif::DiFShowerFinder::adjustPlane_end(), tut::TutAnalyzer::analyze(), qeef::QeFinderVal::analyze(), rsim::RecordNoiseSpectrumFile::analyze(), chaninfo::CosmicEff::analyze(), remid::ReMIdValidate::analyze(), comi::CosmicMetrics::analyze(), calib::TestParticleCorrections::analyze(), dprf::ChannelPlots::analyze(), remid::ReMIdTrain::analyze(), dprf::TrackPlots::analyze(), mcchk::MonopoleAna::analyze(), align::Alignment::analyze(), mcchk::RockAna::analyze(), align::SplitTracks::analyze(), murem::MuonRemoveAna::analyze(), pa::ClusterEva::analyze(), vf::TrackEva::analyze(), comi::NumiFilteringAna::analyze(), tbem::TBRecoAna::analyze(), zcl::FmmTriggerAna::analyze(), zcl::FmmTrackerValidation::analyze(), zcl::FmmTrackerAna::analyze(), showere::ShowerEnergyAna::analyze(), bpfit::BPFTmvaTrainer::analyze(), bpf::BPFCVNAna::analyze(), calib::CosmicTrends::analyze(), calib::CalibAna::analyze(), ncs::Xeff::analyze(), ncs::ROCKMRE::analyze(), ncs::NCAna::analyze(), me::MEFinder::BestSlcMatch(), fuzz::ViewMatchAlg::CalcEnergyProfile(), nerd::ViewMatchAlg::CalcEnergyProfile(), trk::KalmanTrackMerge::CalcMatchScore(), slid::ParticleIDAlg::CalcPlaneHits(), trk::KalmanTrackMerge::CanJoinTracks(), slid::NuEEnergyAlg::CellEnergy(), murem::TrackCleanUpAlg::CleanUpTrack(), bpfit::dEdxCalculator::computeDEDX(), remid::ReMIdTrain::ContainedEvent(), remid::ReMIdDedx::ContainedEvent(), remid::ReMIdDedxRock::ContainedEvent(), remid::ReMIdDedxStudies::ContainedEvent(), cvn::RegPixelMapProducer::CreateMapGivenBoundary(), cvn::PixelMapProducer::CreateMapGivenBoundary(), cvn::RegPixelMapProducer::CreateMapGivenShowerVertex(), cvn::RegPixelMapProducer::CreateMapGivenVertex(), jmshower::RecoJMShower::DepositEnergy(), evd::RecoBaseDrawer::DrawTrack2D(), skim::ParametersNumu::EarliestLatestHitPos(), jmshower::RecoJMShower::Energy(), dif::DiFShowerFinder::eparm(), Exclude(), dt::ViewMerger::Extremes(), caf::FillHadClustVars(), calib::StopperThreshold::FillHist(), bpfit::BreakPoint::FillHitList(), sn::SupernovaAna::FillPlaneSeperations(), dqsf::DQSpillFlags::FillPopulatedDCMs(), caf::FillProngVars(), trk::CosmicTrackAna::FillRecoInfo(), caf::FillSliceInfo(), caf::FillSliceVars(), trk::CosmicTrackAna::FillTrackHistograms(), calib::StopperThreshold::FillTree(), comi::NumiFiltering::filter(), bsf::BremShowerFilter::filter(), showere::ShowerEnergyFilterMC::filter(), cvn::RegPixelMapProducer::FindCenterMedian(), cvn::PixelMapProducer::FindCenterMedian(), airshower::AirSlicer::FindNeighbors(), bsf::BremShowerFilter::findShowerByReco(), dif::DiFShowerFinder::findShowerByReco(), trk::KalmanTrack::FindTracks(), trk::CosmicTrackUtilities::FindTriCells(), bpfit::DimuonFitter::FindVertex(), cvn::RegPixelMapProducer::FindVertexMaxGap(), cvn::PixelMapProducer::FindVertexMaxGap(), cvn::RegPixelMapProducer::FindVertexWindowThreshold(), cvn::PixelMapProducer::FindVertexWindowThreshold(), bpfit::BreakPoint::FitTracks(), nuesand::FillNueSandbox::FracAngChanges(), nuesand::FillNueSandbox::FracModalHits(), nuesand::FillNueSandbox::FracNonContiguous(), numusand::NumuSandFxs::getActivity(), numusand::NumuSandFxs::getAveTrackdEdx(), numusand::NumuSandFxs::getAveTrackdEdxLast4Cells(), numusand::NumuSandFxs::getAveTrackdEdxLast6Cells(), numusand::NumuSandFxs::getAveTrackdEdxLast8Cells(), trackinfo::TrackInfoFxs::getAveTrackdEdxLastCells(), cosrej::CosRejFxs::getBBC(), evd::SliceNavigator::GetBounds(), evd::SliceNavigator::GetBox(), evd::RecoBaseDrawer::GetClusterOutlines(), evd::RecoBaseDrawer::GetClusterOutlinesConvexHull(), nuesand::FillNueSandbox::GetdEdx(), cosrej::CosRejFxs::getFits(), jmshower::RecoJMShower::GetPlaneCentroidCell(), jmshower::RecoJMShower::GetPlaneE1Cell(), jmshower::JMShower::GetPlaneHits(), jmshower::RecoJMShower::GetRVPStats(), jmshower::JMShower::GetTransHits(), calib::PCHitsList::GetTrueEnergyPathAndLightForCell(), slid::DeconvolveAlg::GetWeights(), slid::NuEEnergyAlg::HadronicDepEnergy(), rb::HitList::HitList(), cvn::HitNuIndex(), tf::TimingFitAlg::HoughFit(), zcl::FastMonopoleTriggers::is_trigger_by_epoch1_fmmtrigger(), trk::CosmicTrackSelection::IsCalibTrack(), calib::RockMuonStopperSelection::IsContainedStopper(), calib::PCHitsList::IsGoodTrack(), trk::CosmicTrackAlg::IsTrackDownstreamFromTiming(), trk::KalmanTrackMerge::JoinTracks(), fuzz::ViewMatchAlg::MakeTestProng(), nerd::ViewMatchAlg::MakeTestProng(), trk::CosmicTrackAlg::MakeTrack(), me::MEFinder::MakeTrkME(), murem::FindParent::MatchToOrigSlice(), MaxCell(), nuesand::FillNueSandbox::MaxGap(), nuesand::FillNueSandbox::MaxHits(), MaxPlane(), MaxTNS(), MeanTNS(), dt::DiscreteTracker::MergeParasiteTracks(), MinCell(), nerd::NERDProng::MinHitClusterDist(), me::MEFinder::MinHitSlcDist(), MinMaxMeanXYZ(), MinPlane(), MinTNS(), MostContiguousPlanes(), MostMissingPlanes(), murem::MuonRemove::MuonInfo(), dif::DiFShowerFinder::muonstub(), NCell(), numue::NumuEAlg::NDEnergy(), numue::NumuEAlg::NDTrackEnergySplitting(), NMissingPlanes(), zcl::FmmTriggerEvd::NumberOfCellsPerLength(), zcl::FmmTriggerEvd::NumberOfHitsInOverlapPlanesCut(), zcl::FastMonopoleTriggers::NumberOfSurfaceHits(), zcl::FastMMStudy::NumberOfSurfaceHits(), OfflineChans(), skim::ParametersNumu::ParametersNumu(), zcl::FastMonopoleTriggers::passed_epoch2_fmmtrigger(), rb::Track::PlaneDirMap(), slid::ParticleIDAlg::PlaneRadius(), calib::PCHitsList::ProcessTrack(), calib::PCHitsList::ProcessTrackTrajectory(), trk::TrkAssn::produce(), vf::VertexFinder::produce(), qeef::QeFinder::produce(), hv::HoughVertex::produce(), nuesand::FillNueSandbox::produce(), slid::Recluster::produce(), numusand::FillSandbox::produce(), presel::NuePresel::produce(), lem::Preselection::produce(), slid::SliceLIDBuilder::produce(), zcl::SPCluster::produce(), lem::MakeLibrary::produce(), earms::ElasticArmsHS::produce(), dt::DiscreteTracker::produce(), zcl::SMMCluster::produce(), zcl::FMMTracker::produce(), zcl::FmmTriggerEvd::produce(), jmshower::NueSel::produce(), rvp::RecVarPID::produce(), dif::DiFShowerFinder::produce(), jmshower::NueSelLID::produce(), bpfit::BPFEnergyEstimator::produce(), bpfit::BPFEnergyEstimatorOnly::produce(), caf::CAFMaker::produce(), slid::ParticleIDAlg::Radius(), jmshower::RecoJMShower::Radius(), jmshower::RecoJMShower::RadiusV(), RecoHit(), jmshower::RecoJMShower::RecoShowers(), murem::MuonRemove::RemoveByTruth(), trk::KalmanTrack::RemoveHitsFromSignal(), trk::KalmanTrackMerge::ShiftInterpolationPoints(), lem::MakeLibrary::SliceMeanPosEWeighted(), lem::MakeLibrary::SliceOrigin(), lem::LEMSummarizer::SliceToLEMInput(), zcl::FmmTriggerEvd::StdevCellsPerPlane(), calib::StopperThreshold::testPath(), TotalADC(), dt::ViewMerger::TotalChargePerView(), rb::Prong::TotalLength(), TotalPE(), trk::CosmicTrackUtilities::TrackResiduals(), trk::KalmanTrackMerge::ViewMergeTracks(), rb::Prong::W(), rb::Track::W(), and WeightedHits().

  {
    switch(view){
    case geo::kX: return XCell(viewIdx);
    case geo::kY: return YCell(viewIdx);
    case geo::kXorY: return Cell(viewIdx);
    default: assert(0 && "Unknown view");
    }
  }

art::Ptr< rb::CellHit > rb::Cluster::Cell

(

unsigned int

globalIdx

)

const

Get the ith cell from either view.

Definition at line 173 of file Cluster.cxx.

References NXCell(), XCell(), and YCell().

  {
    if(globalIdx < NXCell()) return XCell(globalIdx);
    return YCell(globalIdx-NXCell());
  }

void rb::Cluster::Clear ( )

virtual

Forget about all owned cell hits.

Virtual function because derived classes may have more stuff to clear

Definition at line 279 of file Cluster.cxx.

References art::PtrVector< T >::clear(), fPrecalcTotalGeV, fXCell, fXWeights, fYCell, and fYWeights.

Referenced by bsf::BremShowerFilter::filter(), mono::Cluster::make(), calib::PCHitsList::ProcessTrackForFLSHits(), nuesand::FillNueSandbox::produce(), cvn::CVNCosmicMapper::produce(), jmshower::RecoJMShower::RecoShowers(), and YCells().

  {
    fPrecalcTotalGeV = -1; // Invalidate any cached value

    fXCell.clear();
    fYCell.clear();
    fXWeights.clear();
    fYWeights.clear();
  }

void rb::Cluster::EnsureWeightAlloc ( )

protected

Helper. Resizes weights vectors to match cell vectors.

Definition at line 712 of file Cluster.cxx.

References fXCell, fXWeights, fYCell, fYWeights, and art::PtrVector< T >::size().

Referenced by Add(), and SetWeight().

  {
    if(fXWeights.size() != fXCell.size()) fXWeights.resize(fXCell.size(), 1);
    if(fYWeights.size() != fYCell.size()) fYWeights.resize(fYCell.size(), 1);
  }

rb::Cluster rb::Cluster::Exclude

(

const rb::Cluster *

excl

)

const

Create a cluster from this one, but with the hits of excl removed.

Definition at line 233 of file Cluster.cxx.

References Add(), Cell(), fID, fNoiseCluster, fView, MECModelEnuComparisons::i, calib::j, genie::utils::mec::J(), NCell(), runNovaSAM::ret, SetNoise(), and Weight().

Referenced by mono::MonopoleCluster::filter(), nerd::NERDProng::MakeCluster(), slid::Recluster::produce(), slid::NuEEnergyAlg::VertexEnergy(), and YCells().

  {
    rb::Cluster ret(fView, fID);
    ret.SetNoise(fNoiseCluster);

    const unsigned int I = NCell();
    const unsigned int J = excl->NCell();
    for(unsigned int i = 0; i < I; ++i){
      const art::Ptr<rb::CellHit> chit = Cell(i);
      bool clash = false;
      for(unsigned int j = 0; j < J; ++j){
        if(excl->Cell(j) == chit){
          clash = true;
          break;
        }
      } // end for j
      if(!clash) ret.Add(chit, Weight(i));
    }

    if(ret.NCell() == 0)
      mf::LogWarning("Cluster") << "Exclude created empty cluster";

    return ret;
  }

unsigned int rb::Cluster::ExtentCell

(

geo::View_t

view

)

const

Definition at line 570 of file Cluster.cxx.

References MaxCell(), and MinCell().

Referenced by sn::SNSlicer::ClusterIsGood(), and ExtentPlane().

  {
    return MaxCell(view)-MinCell(view)+1;
  }

unsigned int rb::Cluster::ExtentPlane ( geo::View_t  view = geo::kXorY ) const

inline

Definition at line 250 of file Cluster.h.

References ExtentCell(), MaxPlane(), and MinPlane().

Referenced by dt::ViewMerger::Adjacent(), align::AlignInspect::analyze(), align::Alignment::analyze(), align::SplitTracks::analyze(), calib::PEResponse::analyze(), ncs::Xeff::analyze(), ncs::ROCKMRE::analyze(), ncs::NCAna::analyze(), trk::KalmanTrackMerge::CalcMatchScore(), sn::SNSlicer::ClusterIsGood(), dt::ViewMerger::FakeThirdDimension(), caf::FillDiFShowerVars(), caf::FillDiFVars(), calib::CosmicTrends::FillHistograms(), caf::FillProngVars(), caf::FillShowerVars(), jmshower::RecoJMShower::GetRVPStats(), LSTME::BasicProngVars::initBasicVars(), align::AlignInspect::IsGoodTrack(), align::Alignment::IsGoodTrack(), dt::ViewMerger::MatchScore(), dt::DiscreteTracker::MergeParasiteTracks(), skim::ParametersNue::ParametersNue(), presel::CosmicVeto::produce(), lem::Preselection::produce(), presel::NuePresel::produce(), rvp::RecVarPID::produce(), dprf::ChannelPlots::TrackOK(), dprf::TrackPlots::TrackOK(), and trk::KalmanTrackMerge::ViewMergeTracks().

{return MaxPlane(view)-MinPlane(view)+1;}

double rb::Cluster::ExtentTNS ( ) const

inline

Definition at line 252 of file Cluster.h.

References MaxTNS(), MinTNS(), MostContiguousPlanes(), MostMissingPlanes(), NMissingPlanes(), and StandardSort().

Referenced by comi::DataCheck::analyze(), and sn::SNSlicer::ClusterIsGood().

{return MaxTNS()-MinTNS();}

double rb::Cluster::ExtentV ( geo::View_t  view ) const

inline

Definition at line 246 of file Cluster.h.

References MaxV(), and MinV().

{return MaxV(view)-MinV(view);}

double rb::Cluster::ExtentX ( ) const

inline

Definition at line 247 of file Cluster.h.

References ExtentXYZ().

{return ExtentXYZ().X();}

TVector3 rb::Cluster::ExtentXYZ ( ) const

inline

Definition at line 245 of file Cluster.h.

References MaxXYZ(), and MinXYZ().

Referenced by ExtentX(), ExtentY(), and ExtentZ().

{return MaxXYZ()-MinXYZ();}

double rb::Cluster::ExtentY ( ) const

inline

Definition at line 248 of file Cluster.h.

References ExtentXYZ().

{return ExtentXYZ().Y();}

double rb::Cluster::ExtentZ ( ) const

inline

Definition at line 249 of file Cluster.h.

References ExtentXYZ().

Referenced by air::AirFilter::parallel_muon_slice().

{return ExtentXYZ().Z();}

const int rb::Cluster::ID ( ) const

inline

Definition at line 75 of file Cluster.h.

References fID, and W().

Referenced by align::SplitTracks::analyze(), sn::SNMichelAnalyzer::ClusterAroundTrackEnds(), jmshower::RecoJMShower::ContStartPlane(), jmshower::RecoJMShower::DepositEnergy(), jmshower::RecoJMShower::Energy(), jmshower::RecoJMShower::GetCellTransDedx(), jmshower::RecoJMShower::GetDedxInvLongLL(), jmshower::RecoJMShower::GetDedxLongLL(), jmshower::RecoJMShower::GetPlaneDedx(), jmshower::RecoJMShower::GetTrkDistToEdge(), jmshower::RecoJMShower::GetTrkHitPath(), jmshower::RecoJMShower::IsFiducial(), trk::KalmanTrackMerge::JoinTracks(), jmshower::RecoJMShower::NMIPPlane(), rb::operator<<(), jmshower::RecoJMShower::Radius(), jmshower::RecoJMShower::RecoShowers(), slid::ParticleIDAlg::SetShower(), and trk::KalmanTrackMerge::ViewMergeTracks().

{ return fID; }

bool rb::Cluster::Is2D ( ) const

inline

Definition at line 96 of file Cluster.h.

References Is3D().

Referenced by dt::ViewMerger::Adjacent(), moonshadowana::MoonShadowAna::analyze(), slid::DeconvolveAlg::DistanceToCore(), evd::RecoBaseDrawer::DrawCluster2D(), bpfit::BreakPoint::GoodProng(), slid::Recluster::produce(), moonshadowana::MoonShadowAna::WriteEventInfo(), moonshadowana::MoonShadowAnaHough::WriteEventInfo(), and rb::Track::ZipWith().

{return !Is3D();}

virtual bool rb::Cluster::Is3D ( ) const

inlinevirtual

Reimplemented in rb::Prong.

Definition at line 95 of file Cluster.h.

References fXCell, fYCell, and art::PtrVector< T >::size().

Referenced by Is2D(), rb::operator<<(), and dif::DiFShowerFinder::produce().

{return ((fXCell.size() > 0) && (fYCell.size() > 0));}

bool rb::Cluster::IsNoise ( ) const

inline

Is the noise flag set?

Definition at line 163 of file Cluster.h.

References fNoiseCluster, SetWeight(), TotalADC(), TotalPE(), and plotSysts::weight.

Referenced by qeef::QeFinderVal::analyze(), rsim::RecordNoiseSpectrumFile::analyze(), tut::RecoValidationTutorial::analyze(), calib::TestParticleCorrections::analyze(), mcchk::MonopoleAna::analyze(), sn::SupernovaAna::analyze(), comi::DataCheck::analyze(), validation::NoiseClusterAnalysis::analyze(), comi::NumiFilteringAna::analyze(), showere::ShowerEnergyAna::analyze(), hough::HoughValidate::analyze(), rockmuon::NDRockMuon::analyze(), ncid::NCNNKerasVal::analyze(), bpf::BPFCVNAna::analyze(), ncs::Xbeam::analyze(), ncs::Xeff::analyze(), ncs::ROCKMRE::analyze(), slid::LIDTraining::analyze(), ncs::NCAna::analyze(), me::MEFinder::BestSlcMatch(), trk::KalmanTrackAna::CheckAssociations(), air::AirKalmanAna::CheckAssociations(), evd::RecoBaseDrawer::DrawCluster2D(), LSTME::FillLSTME::fillEnergies(), SliceLID::FillSliceLID::fillSliceLIDPreds(), filter::Filter::FillSliceVariables(), comi::NumiFiltering::filter(), bsf::BremShowerFilter::filter(), showere::ShowerEnergyFilterMC::filter(), me::MEFinder::GetPhysNoiseSlcs(), mono::HighEnergySliceRemoval::is_high_energy_slice(), novaddt::HorizontalMuonAna::IsHorzMuonTrack(), skim::EvaluatorNue::KeepSlice(), airshower::AirSlicer::MakeTrackSlices(), murem::FindParent::MatchToOrigSlice(), air::AirFilter::parallel_muon_slice(), presel::LEMPresel::produce(), lem::LEMAssociator::produce(), qeef::QeFinder::produce(), hough::HoughT::produce(), hv::HoughVertex::produce(), nuesand::FillNueSandbox::produce(), lem::UnTranspose::produce(), numue::TrackOverlapECalc::produce(), wsnumu::WSNumu::produce(), lem::LEMSummarizer::produce(), presel::RockPresel::produce(), slid::Recluster::produce(), trackinfo::TrackInfo::produce(), nussand::FillNusSandbox::produce(), presel::CosmicVeto::produce(), presel::CosmicCVNVeto::produce(), lem::Preselection::produce(), numusand::FillSandbox::produce(), presel::NuePresel::produce(), jmshower::JMTrackMerge::produce(), hough::MultiHoughT::produce(), cosrej::CosRej::produce(), numue::NumuEnergy::produce(), earms::ElasticArmsHS::produce(), dt::DiscreteTracker::produce(), jmshower::JMClusterMerge::produce(), vdt::VertexDT::produce(), ncpi0::MakeNCPi0BkgRej::produce(), jmshower::NueSel::produce(), rvp::RecVarPID::produce(), crvtx::CosmicRayVertex::produce(), dif::DiFShowerFinder::produce(), xnue::XnuePID::produce(), jmshower::NueSelLID::produce(), ncid::MakeNCCosRej::produce(), cosrej::MakeNueCosRej::produce(), ncid::NCNNKeras::produce(), murem::FindParent::produce(), fuzz::FuzzyKVertex::produce(), nerd::NERDProng::produce(), bpfit::DimuonFitter::produce(), caf::CAFMaker::produce(), jmshower::RecoJMShower::RecoShowers(), and sn::SliceRemover::remove().

{return fNoiseCluster;}

unsigned int rb::Cluster::MaxCell

(

geo::View_t

view

)

const

Definition at line 518 of file Cluster.cxx.

References ana::assert(), rb::CellHit::Cell(), Cell(), MECModelEnuComparisons::i, NCell(), and runNovaSAM::ret.

Referenced by align::SplitTracks::analyze(), cvn::PixelMapProducer::DefineBoundary(), ExtentCell(), caf::FillHadClustVars(), caf::FillSliceVars(), hough::HoughT::is_good_slice(), MaxZ(), lem::MeanCell(), dt::View::View(), trk::KalmanTrackMerge::ViewMergeTracks(), and dt::ViewMerger::ZipVerticalTracks().

  {
    assert(NCell(view) > 0);
    unsigned int ret = 0;
    for(unsigned int i = 0; i < NCell(view); ++i)
      if(Cell(view, i)->Cell() > ret) ret = Cell(view, i)->Cell();
    return ret;
  }

unsigned int rb::Cluster::MaxPlane

(

geo::View_t

view = geo::kXorY

)

const

Definition at line 508 of file Cluster.cxx.

References ana::assert(), Cell(), MECModelEnuComparisons::i, NCell(), rb::CellHit::Plane(), and runNovaSAM::ret.

Referenced by dif::DiFShowerFinder::adjustPlane(), dif::DiFShowerFinder::adjustPlane_end(), align::SplitTracks::analyze(), calib::HitEfficiency::analyze(), tbem::TBRecoAna::analyze(), trk::KalmanTrackMerge::CalcMatchScore(), slid::ParticleIDAlg::CalcPlaneHits(), trk::KalmanTrackMerge::CanJoinTracks(), skim::Evaluator::CheckSliceQuality(), remid::ReMIdTrain::ContainedEvent(), remid::ReMIdDedx::ContainedEvent(), remid::ReMIdDedxRock::ContainedEvent(), remid::ReMIdDedxStudies::ContainedEvent(), murem::TrackCleanUpAlg::DeDxInPlane(), lem::DefaultVertex(), cvn::PixelMapProducer::DefineBoundary(), dif::DiFShowerFinder::eparm(), ExtentPlane(), caf::FillDiFVars(), caf::FillHadClustVars(), trk::CosmicTrackAna::FillRecoInfo(), caf::FillSliceInfo(), caf::FillSliceVars(), bsf::BremShowerFilter::findShowerByReco(), dif::DiFShowerFinder::findShowerByReco(), bsf::BremShowerFilter::findShowerByTruth(), trk::KalmanTrack::FindTracks(), cvn::RegPixelMapProducer::FindVertexWindowThreshold(), cvn::PixelMapProducer::FindVertexWindowThreshold(), hough::HoughT::is_good_slice(), trk::CosmicTrackSelection::IsCalibTrack(), calib::PCHitsList::IsGoodTrack(), trk::KalmanTrackMerge::JoinTracks(), dt::ViewMerger::JoinTracks(), dt::ViewMerger::MatchScore(), murem::FindParent::MatchToOrigSlice(), MaxZ(), dif::DiFShowerFinder::muonstub(), skim::ParametersNumu::ParametersNumu(), slid::Recluster::produce(), remid::RecoMuon::produce(), fuzz::FuzzyKVertex::produce(), nerd::NERDProng::produce(), dt::ViewMerger::ScoreForExtension(), dt::ViewMerger::ScoreForJoinPlusExtension(), trk::WindowTrackingAlg::SetTrackEndPoints(), cosrej::MakeNueCosRej::SparsenessAsymmetry(), slid::NuEEnergyAlg::VertexEnergy(), dt::View::View(), and trk::KalmanTrackMerge::ViewMergeTracks().

  {
    assert(NCell(view) > 0);
    unsigned int ret = 0;
    for(unsigned int i = 0; i < NCell(view); ++i)
      if(Cell(view, i)->Plane() > ret) ret = Cell(view, i)->Plane();
    return ret;
  }

double rb::Cluster::MaxTNS

(

)

const

Definition at line 528 of file Cluster.cxx.

References ana::assert(), Cell(), MECModelEnuComparisons::i, NCell(), runNovaSAM::ret, and rb::CellHit::TNS().

Referenced by align::AlignInspect::analyze(), nnbar::ShowerMuonCoincidence::analyze(), ncs::NCAna::analyze(), evd::RecoBaseDrawer::DrawCluster2D(), evd::RecoBaseDrawer::DrawTrack2D(), ExtentTNS(), caf::FillProngVars(), caf::FillSliceVars(), bsf::BremShowerFilter::findShowerByTruth(), MaxZ(), skim::ParametersNumu::ParametersNumu(), trk::TrkAssn::produce(), jmshower::JMTrackMerge::produce(), jmshower::JMClusterMerge::produce(), caf::CAFMaker::produce(), and sn::TrackActivityRemover::remove().

  {
    assert(NCell() > 0);
    double ret = -DBL_MAX;
    for(unsigned int i = 0; i < NCell(); ++i)
      if(Cell(i)->TNS() > ret) ret = Cell(i)->TNS();
    return ret;
  }

double rb::Cluster::MaxV

(

geo::View_t

view

)

const

Definition at line 500 of file Cluster.cxx.

References ana::assert(), geo::kX, geo::kY, and MaxXYZ().

Referenced by ExtentV(), MinZ(), fuzz::FuzzyKVertex::produce(), and nerd::NERDProng::produce().

  {
    assert(view == geo::kX || view == geo::kY);
    if(view == geo::kX) return MaxXYZ().X();
    return MaxXYZ().Y();
  }

double rb::Cluster::MaxX ( ) const

inline

Definition at line 217 of file Cluster.h.

References MaxXYZ().

Referenced by caf::FillProngVars(), and presel::CosmicVeto::produce().

{return MaxXYZ().X();}

TVector3 rb::Cluster::MaxXYZ

(

)

const

Definition at line 492 of file Cluster.cxx.

References hi(), and MinMaxMeanXYZ().

Referenced by comi::NumiFilteringAna::analyze(), ExtentXYZ(), comi::NumiFiltering::filter(), evd::SliceNavigator::GetBounds(), evd::SliceNavigator::GetBox(), skim::EvaluatorNue::KeepSlice(), MaxV(), MaxX(), MaxY(), MaxZ(), MinZ(), skim::ParametersNumu::ParametersNumu(), nuesand::FillNueSandbox::produce(), presel::CosmicVeto::produce(), cosrej::CosRej::produce(), and caf::CAFMaker::produce().

  {
    TVector3 hi, junk;
    MinMaxMeanXYZ(junk, hi, junk);
    return hi;
  }

double rb::Cluster::MaxY ( ) const

inline

Definition at line 218 of file Cluster.h.

References MaxXYZ().

Referenced by caf::FillProngVars(), and presel::CosmicVeto::produce().

{return MaxXYZ().Y();}

double rb::Cluster::MaxZ ( ) const

inline

Definition at line 219 of file Cluster.h.

References geo::kXorY, MaxCell(), MaxPlane(), MaxTNS(), MaxXYZ(), MeanV(), and MeanXYZ().

Referenced by fuzz::FuzzyKVertex::produce(), and nerd::NERDProng::produce().

{return MaxXYZ().Z();}

double rb::Cluster::MeanTNS

(

rb::AveragingScheme

scheme = kDefaultScheme

)

const

Definition at line 554 of file Cluster.cxx.

References ana::assert(), Cell(), MECModelEnuComparisons::i, rb::kByEnergy, NCell(), rb::CellHit::PE(), runNovaSAM::ret, rb::CellHit::TNS(), w, and Weight().

Referenced by me::MEFinder::AddMEHit(), tbem::TBRecoAna::analyze(), ncs::NCAna::analyze(), sn::SNMichelAnalyzer::analyze(), me::MEFinder::BestSlcMatch(), skim::Evaluator::CheckTiming(), sn::SNMichelAnalyzer::ClusterAroundTrackEnds(), remid::ReMIdDedx::ContainedEvent(), remid::ReMIdDedxRock::ContainedEvent(), remid::ReMIdDedxStudies::ContainedEvent(), caf::FillProngVars(), caf::FillSliceVars(), comi::NumiFiltering::filter(), bsf::BremShowerFilter::filter(), tf::TimingFitAlg::HoughFit(), skim::EvaluatorNue::KeepSlice(), me::MEFinder::MakeSlcME(), me::MEFinder::MakeTrkME(), MeanZ(), cosrej::MakeNueCosRej::MuonParentByDist(), cosrej::MakeNueCosRej::MuonParentByTime(), calib::PCHitsList::ProcessTrackForFLSHits(), recodemo::RecoDemo::produce(), hv::HoughVertex::produce(), presel::CosmicVeto::produce(), presel::CosmicCVNVeto::produce(), vdt::VertexDT::produce(), jmshower::NueSel::produce(), dif::DiFShowerFinder::produce(), jmshower::NueSelLID::produce(), and caf::CAFMaker::produce().

  {
    assert(NCell() > 0);
    double ret = 0;
    double totW = 0;
    for(unsigned int i = 0; i < NCell(); ++i){
      double w = Weight(i);
      if(scheme == kByEnergy) w *= Cell(i)->PE();

      ret += Cell(i)->TNS()*w;
      totW += w;
    }
    return ret/totW;
  }

double rb::Cluster::MeanV	(	geo::View_t	view,
		rb::AveragingScheme	scheme = kDefaultScheme
	)		const

Definition at line 546 of file Cluster.cxx.

References ana::assert(), geo::kX, geo::kY, and MeanXYZ().

Referenced by nerd::NERDProng::AddProngs(), MaxZ(), and W().

  {
    assert(view == geo::kX || view == geo::kY);
    if(view == geo::kX) return MeanXYZ(scheme).X();
    return MeanXYZ(scheme).Y();
  }

double rb::Cluster::MeanX ( rb::AveragingScheme  scheme = kDefaultScheme ) const

inline

Definition at line 231 of file Cluster.h.

References MeanXYZ().

Referenced by caf::AddSlcMEToVec(), caf::AddTrkMEToVec(), calib::TestParticleCorrections::analyze(), me::TrkME::DistToTrk(), slid::NuEEnergyAlg::HadronicDepEnergy(), recodemo::RecoDemo::produce(), and me::MEFinder::TrkMEDist().

{return MeanXYZ(scheme).X();}

TVector3 rb::Cluster::MeanXYZ

(

rb::AveragingScheme

scheme = kDefaultScheme

)

const

Definition at line 538 of file Cluster.cxx.

References extractScale::mean, and MinMaxMeanXYZ().

Referenced by sn::SNMichelAnalyzer::ClusterAroundTrackEnds(), jmshower::RecoJMShower::GetRVPStats(), tf::TimingFitAlg::HoughFit(), MaxZ(), MeanV(), MeanX(), MeanY(), MeanZ(), nuesand::FillNueSandbox::produce(), presel::NuePresel::produce(), lem::Preselection::produce(), and TotalGeVFastClusterOnly().

  {
    TVector3 mean, junk;
    MinMaxMeanXYZ(junk, junk, mean, scheme);
    return mean;
  }

double rb::Cluster::MeanY ( rb::AveragingScheme  scheme = kDefaultScheme ) const

inline

Definition at line 232 of file Cluster.h.

References MeanXYZ().

Referenced by caf::AddSlcMEToVec(), caf::AddTrkMEToVec(), me::TrkME::DistToTrk(), slid::NuEEnergyAlg::HadronicDepEnergy(), recodemo::RecoDemo::produce(), and me::MEFinder::TrkMEDist().

{return MeanXYZ(scheme).Y();}

double rb::Cluster::MeanZ ( rb::AveragingScheme  scheme = kDefaultScheme ) const

inline

Definition at line 233 of file Cluster.h.

References hi(), lo(), extractScale::mean, MeanTNS(), MeanXYZ(), and MinMaxMeanXYZ().

Referenced by nerd::NERDProng::AddProngs(), caf::AddSlcMEToVec(), caf::AddTrkMEToVec(), trk::KalmanTrackMerge::CanJoinTracks(), me::TrkME::DistToTrk(), operator<(), recodemo::RecoDemo::produce(), and me::MEFinder::TrkMEDist().

{return MeanXYZ(scheme).Z();}

unsigned int rb::Cluster::MinCell

(

geo::View_t

view

)

const

Definition at line 472 of file Cluster.cxx.

References ana::assert(), rb::CellHit::Cell(), Cell(), MECModelEnuComparisons::i, NCell(), and runNovaSAM::ret.

Referenced by calib::TestParticleCorrections::analyze(), align::SplitTracks::analyze(), cvn::PixelMapProducer::DefineBoundary(), ExtentCell(), caf::FillHadClustVars(), caf::FillSliceVars(), hough::HoughT::is_good_slice(), lem::MeanCell(), MinZ(), dt::View::View(), trk::KalmanTrackMerge::ViewMergeTracks(), and dt::ViewMerger::ZipVerticalTracks().

  {
    assert(NCell(view) > 0);
    unsigned int ret = UINT_MAX;
    for(unsigned int i = 0; i < NCell(view); ++i)
      if(Cell(view, i)->Cell() < ret) ret = Cell(view, i)->Cell();
    return ret;
  }

void rb::Cluster::MinMaxMeanXYZ	(	TVector3 &	lo,
		TVector3 &	hi,
		TVector3 &	mean,
		rb::AveragingScheme	scheme = kDefaultScheme
	)		const

Gets the min/max/mean all at once, called by the functions above.

Todo:

Won't be quite right in the FD when cells aren't at right angles?

Definition at line 582 of file Cluster.cxx.

References ana::assert(), rb::CellHit::Cell(), Cell(), geom(), demo3::h, hi(), MECModelEnuComparisons::i, rb::kByEnergy, geo::kX, geo::kY, lo(), extractScale::mean, getGoodRuns4SAM::n, NCell(), rb::CellHit::PE(), rb::CellHit::Plane(), geo::GeometryBase::Plane(), POTSpillRate::view, View(), Weight(), plotSysts::weight, submit_syst::x, submit_syst::y, and test::z.

Referenced by caf::FillHadClustVars(), caf::FillSliceVars(), MaxXYZ(), MeanXYZ(), MeanZ(), and MinXYZ().

  {
    // If this becomes a bottleneck we can cache the results

    /// \todo Won't be quite right in the FD when cells aren't at right angles?

    assert(NCell() > 0);

    art::ServiceHandle<geo::Geometry> geom;

    double Wx = 0;
    double Wy = 0;
    for(int n = 0; n < 3; ++n){
      lo(n) = DBL_MAX;
      hi(n) = -DBL_MAX;
      mean(n) = 0;
    }

    for(unsigned int i = 0; i < NCell(); ++i){
      const art::Ptr<rb::CellHit>& h = Cell(i);
      double xyz[3];
      geom->Plane(h->Plane())->Cell(h->Cell())->GetCenter(xyz);
      const double x = xyz[0];
      const double y = xyz[1];
      const double z = xyz[2];
      const geo::View_t view = geom->Plane(h->Plane())->View();
      double weight = Weight(i);
      if(scheme == kByEnergy) weight *= h->PE();

      if(view == geo::kX){
        if(x < lo.X()) lo.SetX(x);
        if(x > hi.X()) hi.SetX(x);
        mean.SetX(mean.X()+x*weight);
        Wx += weight;
      }
      if(view == geo::kY){
        if(y < lo.Y()) lo.SetY(y);
        if(y > hi.Y()) hi.SetY(y);
        mean.SetY(mean.Y()+y*weight);
        Wy += weight;
      }
      if(z < lo.Z()) lo.SetZ(z);
      if(z > hi.Z()) hi.SetZ(z);
      mean.SetZ(mean.Z()+z*weight);
    }

    if(Wx) mean.SetX(mean.X()/Wx);
    if(Wy) mean.SetY(mean.Y()/Wy);
    if(Wx || Wy) mean.SetZ(mean.Z()/(Wx+Wy));
  }

unsigned int rb::Cluster::MinPlane

(

geo::View_t

view = geo::kXorY

)

const

Definition at line 462 of file Cluster.cxx.

References ana::assert(), Cell(), MECModelEnuComparisons::i, NCell(), rb::CellHit::Plane(), and runNovaSAM::ret.

Referenced by dif::DiFShowerFinder::adjustPlane(), dif::DiFShowerFinder::adjustPlane_end(), align::AlignInspect::analyze(), calib::TestParticleCorrections::analyze(), align::SplitTracks::analyze(), calib::HitEfficiency::analyze(), ncs::ROCKMRE::analyze(), ncs::NCAna::analyze(), trk::KalmanTrackMerge::CalcMatchScore(), slid::ParticleIDAlg::CalcPlaneHits(), trk::KalmanTrackMerge::CanJoinTracks(), skim::Evaluator::CheckSliceQuality(), remid::ReMIdTrain::ContainedEvent(), remid::ReMIdDedx::ContainedEvent(), remid::ReMIdDedxRock::ContainedEvent(), remid::ReMIdDedxStudies::ContainedEvent(), murem::TrackCleanUpAlg::DeDxInPlane(), lem::DefaultVertex(), cvn::PixelMapProducer::DefineBoundary(), dif::DiFShowerFinder::eparm(), ExtentPlane(), caf::FillDiFVars(), caf::FillHadClustVars(), trk::CosmicTrackAna::FillRecoInfo(), caf::FillSliceInfo(), caf::FillSliceVars(), bsf::BremShowerFilter::findShowerByReco(), dif::DiFShowerFinder::findShowerByReco(), bsf::BremShowerFilter::findShowerByTruth(), trk::KalmanTrack::FindTracks(), cvn::RegPixelMapProducer::FindVertexMaxGap(), cvn::PixelMapProducer::FindVertexMaxGap(), cvn::RegPixelMapProducer::FindVertexWindowThreshold(), cvn::PixelMapProducer::FindVertexWindowThreshold(), jmshower::RecoJMShower::GetRVPStats(), hough::HoughT::is_good_slice(), trk::CosmicTrackSelection::IsCalibTrack(), calib::PCHitsList::IsGoodTrack(), trk::KalmanTrackMerge::JoinTracks(), dt::ViewMerger::JoinTracks(), dt::ViewMerger::MatchScore(), murem::FindParent::MatchToOrigSlice(), MinZ(), skim::ParametersNue::ParametersNue(), skim::ParametersNumu::ParametersNumu(), slid::Recluster::produce(), rvp::RecVarPID::produce(), remid::RecoMuon::produce(), fuzz::FuzzyKVertex::produce(), nerd::NERDProng::produce(), jmshower::RecoJMShower::RecoShowers(), dt::ViewMerger::ScoreForExtension(), dt::ViewMerger::ScoreForJoinPlusExtension(), trk::WindowTrackingAlg::SetTrackEndPoints(), cosrej::MakeNueCosRej::SparsenessAsymmetry(), slid::NuEEnergyAlg::VertexEnergy(), dt::View::View(), trk::KalmanTrackMerge::ViewMergeTracks(), and dt::ViewMerger::ZipVerticalTracks().

  {
    assert(NCell(view) > 0);
    unsigned int ret = UINT_MAX;
    for(unsigned int i = 0; i < NCell(view); ++i)
      if(Cell(view, i)->Plane() < ret) ret = Cell(view, i)->Plane();
    return ret;
  }

double rb::Cluster::MinTNS

(

)

const

Definition at line 482 of file Cluster.cxx.

References ana::assert(), Cell(), MECModelEnuComparisons::i, NCell(), runNovaSAM::ret, and rb::CellHit::TNS().

Referenced by align::AlignInspect::analyze(), tbem::TBRecoAna::analyze(), nnbar::ShowerMuonCoincidence::analyze(), ncs::NCAna::analyze(), rb::CompareTracksByTime(), evd::RecoBaseDrawer::DrawCluster2D(), evd::RecoBaseDrawer::DrawTrack2D(), ExtentTNS(), caf::FillProngVars(), caf::FillSliceVars(), bsf::BremShowerFilter::findShowerByTruth(), MinZ(), murem::MuonRemove::MuonInfo(), skim::ParametersNumu::ParametersNumu(), trk::TrkAssn::produce(), jmshower::JMTrackMerge::produce(), earms::ElasticArmsHS::produce(), jmshower::JMClusterMerge::produce(), caf::CAFMaker::produce(), sn::TrackActivityRemover::remove(), sn::SortClustersByTime(), and sn::SortTracksByTime().

  {
    assert(NCell() > 0);
    double ret = DBL_MAX;
    for(unsigned int i = 0; i < NCell(); ++i)
      if(Cell(i)->TNS() < ret) ret = Cell(i)->TNS();
    return ret;
  }

double rb::Cluster::MinV

(

geo::View_t

view

)

const

Definition at line 454 of file Cluster.cxx.

References ana::assert(), geo::kX, geo::kY, and MinXYZ().

Referenced by ExtentV(), fuzz::FuzzyKVertex::produce(), and nerd::NERDProng::produce().

  {
    assert(view == geo::kX || view == geo::kY);
    if(view == geo::kX) return MinXYZ().X();
    return MinXYZ().Y();
  }

double rb::Cluster::MinX ( ) const

inline

Definition at line 204 of file Cluster.h.

References MinXYZ().

Referenced by caf::FillProngVars(), and presel::CosmicVeto::produce().

{return MinXYZ().X();}

TVector3 rb::Cluster::MinXYZ

(

)

const

Definition at line 446 of file Cluster.cxx.

References lo(), and MinMaxMeanXYZ().

Referenced by comi::NumiFilteringAna::analyze(), ExtentXYZ(), comi::NumiFiltering::filter(), evd::SliceNavigator::GetBounds(), evd::SliceNavigator::GetBox(), MinV(), MinX(), MinY(), MinZ(), skim::ParametersNumu::ParametersNumu(), nuesand::FillNueSandbox::produce(), presel::CosmicVeto::produce(), cosrej::CosRej::produce(), and caf::CAFMaker::produce().

  {
    TVector3 lo, junk;
    MinMaxMeanXYZ(lo, junk, junk);
    return lo;
  }

double rb::Cluster::MinY ( ) const

inline

Definition at line 205 of file Cluster.h.

References MinXYZ().

Referenced by caf::FillProngVars(), and presel::CosmicVeto::produce().

{return MinXYZ().Y();}

double rb::Cluster::MinZ ( ) const

inline

Definition at line 206 of file Cluster.h.

References geo::kXorY, MaxV(), MaxXYZ(), MinCell(), MinPlane(), MinTNS(), and MinXYZ().

Referenced by fuzz::FuzzyKVertex::produce(), and nerd::NERDProng::produce().

{return MinXYZ().Z();}

int rb::Cluster::MostContiguousPlanes

(

geo::View_t

view

)

const

Longest run of adjacent planes with hits.

view may be kXorY to require hits on every plane no matter the view

Definition at line 635 of file Cluster.cxx.

References Cell(), MECModelEnuComparisons::i, geo::kXorY, std::max(), NCell(), and NDAPDHVSetting::plane.

Referenced by ncid::NCNNKerasVal::analyze(), ExtentTNS(), caf::FillDiFShowerVars(), caf::FillDiFVars(), caf::FillHadClustVars(), caf::FillProngVars(), caf::FillShowerVars(), caf::FillSliceInfo(), caf::FillSliceVars(), and skim::ParametersNumu::ParametersNumu().

  {
    std::set<int> planes;

    for(unsigned int i = 0; i < NCell(view); ++i)
      planes.insert(Cell(view, i)->Plane());

    if(planes.empty()) return 0;

    // In 3D expect a hit every plane, in 2D only every other plane.
    //
    // This isn't right if the planes aren't alternating in views, but
    // thankfully we stopped building detectors like that.
    const int expGap = (view == geo::kXorY) ? 1 : 2;

    int prevPlane = -999;
    int curRun = 1;
    int longestRun = 0;
    for(auto plane: planes){
      if(plane - prevPlane == expGap){
        ++curRun;
        longestRun = std::max(longestRun, curRun);
      }
      else{
        curRun = 1;
      }
      prevPlane = plane;
    } // end for plane

    return longestRun;
  }

int rb::Cluster::MostMissingPlanes

(

geo::View_t

view

)

const

Longest run of adjacent planes with no hits.

view may be kXorY to allow a hit in either view to end the run

Definition at line 668 of file Cluster.cxx.

References Cell(), MECModelEnuComparisons::i, geo::kXorY, std::max(), NCell(), and NDAPDHVSetting::plane.

Referenced by ExtentTNS(), caf::FillDiFShowerVars(), caf::FillDiFVars(), caf::FillProngVars(), caf::FillShowerVars(), and xsrec::MakeXSecCCPi0Inc::GetPhLL().

  {
    std::set<int> planes;

    for(unsigned int i = 0; i < NCell(view); ++i)
      planes.insert(Cell(view, i)->Plane());

    if(planes.empty()) return 0;

    int maxDiff = 1;
    int prevPlane = *planes.begin();
    for(int plane: planes){
      maxDiff = std::max(maxDiff, plane-prevPlane);
      prevPlane = plane;
    }

    // One plane difference as expected in 3D isn't a gap
    if(view == geo::kXorY) return maxDiff-1;

    // Two plane difference in 2D isn't a gap. Beyond that, every two planes
    // difference only indicates one missing plane of hits.
    return (maxDiff-2)/2;
  }

unsigned int rb::Cluster::NCell

(

geo::View_t

view

)

const

Number of cells in view view.

Definition at line 134 of file Cluster.cxx.

References ana::assert(), geo::kX, geo::kXorY, geo::kY, NCell(), NXCell(), and NYCell().

Referenced by dqsf::DQSpillFlags::AccumulateSyncMetric(), rb::HitMap::Add(), fuzz::FuzzyKVertex::AddProng(), dif::DiFShowerFinder::adjustPlane(), dif::DiFShowerFinder::adjustPlane_end(), tut::TutAnalyzer::analyze(), qeef::QeFinderVal::analyze(), rsim::RecordNoiseSpectrumFile::analyze(), remid::ReMIdValidate::analyze(), chaninfo::CosmicEff::analyze(), comi::CosmicMetrics::analyze(), align::AlignInspect::analyze(), tut::RecoValidationTutorial::analyze(), calib::TestParticleCorrections::analyze(), dprf::ChannelPlots::analyze(), remid::ReMIdTrain::analyze(), dprf::TrackPlots::analyze(), mcchk::MonopoleAna::analyze(), align::Alignment::analyze(), mcchk::RockAna::analyze(), sn::SupernovaAna::analyze(), murem::MuonRemoveAna::analyze(), align::SplitTracks::analyze(), pa::ClusterEva::analyze(), comi::DataCheck::analyze(), vf::TrackEva::analyze(), comi::NumiFilteringAna::analyze(), tbem::TBRecoAna::analyze(), zcl::FmmTriggerAna::analyze(), zcl::FmmTrackerAna::analyze(), zcl::FmmTrackerValidation::analyze(), trk::KalmanTrackAna::analyze(), showere::ShowerEnergyAna::analyze(), hough::HoughValidate::analyze(), rockmuon::NDRockMuon::analyze(), zcl::FastMMStudy::analyze(), bpfit::BPFTmvaTrainer::analyze(), bpf::BPFCVNAna::analyze(), calib::CosmicTrends::analyze(), calib::CalibAna::analyze(), ncs::Xeff::analyze(), moonshadowana::MoonShadowAna::analyze(), ncs::ROCKMRE::analyze(), ncs::NCAna::analyze(), htk::HoughTrack::analyze(), me::MEFinder::BestSlcMatch(), fuzz::ViewMatchAlg::CalcEnergyProfile(), nerd::ViewMatchAlg::CalcEnergyProfile(), trk::KalmanTrackMerge::CalcMatchScore(), slid::ParticleIDAlg::CalcPlaneHits(), trk::KalmanTrackMerge::CanJoinTracks(), trk::KalmanTrackAna::CheckRecoTracks(), murem::TrackCleanUpAlg::CleanUpTrack(), sn::SNMichelAnalyzer::ClusterAroundTrackEnds(), sn::SNSlicer::ClusterIsGood(), murem::TrackCleanUpAlg::ComputeVertexRegion(), remid::ReMIdTrain::ContainedEvent(), remid::ReMIdDedx::ContainedEvent(), remid::ReMIdDedxFD::ContainedEvent(), remid::ReMIdDedxRock::ContainedEvent(), remid::ReMIdDedxStudies::ContainedEvent(), nnbar::NNbarUtilities::correlationTCell(), nnbar::NNbarUtilities::correlationTPlane(), cvn::RegPixelMapProducer::CreateMapGivenBoundary(), cvn::PixelMapProducer::CreateMapGivenBoundary(), cvn::RegPixelMapProducer::CreateMapGivenShowerVertex(), cvn::RegPixelMapProducer::CreateMapGivenVertex(), jmshower::RecoJMShower::DepositEnergy(), evd::RecoBaseDrawer::DrawTrack2D(), skim::ParametersNumu::EarliestLatestHitPos(), jmshower::RecoJMShower::Energy(), dif::DiFShowerFinder::eparm(), Exclude(), dt::ViewMerger::Extremes(), numue::NumuEAlg::FDEnergy(), caf::FillDiFShowerVars(), caf::FillDiFVars(), caf::FillHadClustVars(), calib::StopperThreshold::FillHist(), bpfit::BreakPoint::FillHitList(), sn::SupernovaAna::FillPlaneSeperations(), dqsf::DQSpillFlags::FillPopulatedDCMs(), caf::FillProngVars(), trk::CosmicTrackAna::FillRecoInfo(), caf::FillShowerVars(), caf::FillSliceInfo(), filter::Filter::FillSliceVariables(), caf::FillSliceVars(), trk::CosmicTrackAna::FillTrackHistograms(), calib::StopperThreshold::FillTree(), comi::NumiFiltering::filter(), bsf::BremShowerFilter::filter(), showere::ShowerEnergyFilterMC::filter(), mono::MonopoleTrack::filter(), cvn::RegPixelMapProducer::FindCenterMedian(), cvn::PixelMapProducer::FindCenterMedian(), airshower::AirSlicer::FindNeighbors(), bsf::BremShowerFilter::findShowerByReco(), dif::DiFShowerFinder::findShowerByReco(), trk::KalmanTrack::FindTracks(), trk::CosmicTrackUtilities::FindTriCells(), bpfit::DimuonFitter::FindVertex(), cvn::RegPixelMapProducer::FindVertexMaxGap(), cvn::PixelMapProducer::FindVertexMaxGap(), cvn::RegPixelMapProducer::FindVertexWindowThreshold(), cvn::PixelMapProducer::FindVertexWindowThreshold(), bpfit::BreakPoint::FitTracks(), nuesand::FillNueSandbox::FracAngChanges(), nuesand::FillNueSandbox::FracModalHits(), nuesand::FillNueSandbox::FracNonContiguous(), cosrej::CosRejFxs::getActivity(), numusand::NumuSandFxs::getActivity(), numusand::NumuSandFxs::getActivityVtx(), numusand::NumuSandFxs::getAveTrackdEdx(), numusand::NumuSandFxs::getAveTrackdEdxLast4Cells(), numusand::NumuSandFxs::getAveTrackdEdxLast6Cells(), numusand::NumuSandFxs::getAveTrackdEdxLast8Cells(), trackinfo::TrackInfoFxs::getAveTrackdEdxLastCells(), cosrej::CosRejFxs::getBBC(), evd::SliceNavigator::GetBounds(), evd::SliceNavigator::GetBox(), xsrec::MakeXSecCCPi0Inc::GetBPI(), evd::RecoBaseDrawer::GetClusterOutlines(), evd::RecoBaseDrawer::GetClusterOutlinesConvexHull(), cosrej::CosRejFxs::getCVVars(), cosrej::CosRejFxs::getFits(), xsrec::MakeXSecCCPi0Inc::GetPhLL(), me::MEFinder::GetPhysNoiseSlcs(), jmshower::RecoJMShower::GetPlaneCentroidCell(), jmshower::RecoJMShower::GetPlaneE1Cell(), jmshower::RecoJMShower::GetRVPStats(), numue::NumuEAlg::GetUCMuonENonSingle(), numue::NumuEAlg::GetUCMuonESingle(), fuzz::FuzzyKValidate::GeVCalc(), slid::NuEEnergyAlg::HadronicDepEnergy(), dt::DiscreteTracker::HighActivity(), nnbar::NNbarUtilities::hitCountInView(), rb::HitList::HitList(), cvn::HitNuIndex(), jmshower::hitSort(), tf::TimingFitAlg::HoughFit(), LSTME::BasicProngVars::initBasicVars(), hough::HoughT::is_good_slice(), zcl::FastMonopoleTriggers::is_trigger_by_epoch1_fmmtrigger(), trk::CosmicTrackSelection::IsCalibTrack(), calib::RockMuonStopperSelection::IsContainedStopper(), calib::PCHitsList::IsGoodTrack(), trk::CosmicTrackAlg::IsTrackDownstreamFromTiming(), trk::KalmanTrackMerge::JoinTracks(), nerd::NERDProng::MakeCluster(), me::MEFinder::MakeSlcME(), fuzz::ViewMatchAlg::MakeTestProng(), nerd::ViewMatchAlg::MakeTestProng(), trk::CosmicTrackAlg::MakeTrack(), trk::WindowTrackingAlg::MakeTrack(), airshower::AirSlicer::MakeTrackSlices(), me::MEFinder::MakeTrkME(), murem::FindParent::MatchToOrigSlice(), nuesand::FillNueSandbox::MaxGap(), nuesand::FillNueSandbox::MaxHits(), dt::DiscreteTracker::MergeParasiteTracks(), nerd::NERDProng::MinHitClusterDist(), me::MEFinder::MinHitSlcDist(), dt::ViewMerger::MissingChargeByExtension(), murem::MuonRemove::MuonInfo(), dif::DiFShowerFinder::muonstub(), numue::NumuEAlg::NDEnergy(), numue::NumuEAlg::NDTrackEnergySplitting(), zcl::FmmTriggerEvd::NumberOfCellsPerLength(), zcl::FastMonopoleTriggers::NumberOfHitsInOverlapPlanesCut(), zcl::FmmTriggerEvd::NumberOfHitsInOverlapPlanesCut(), zcl::FastMMStudy::NumberOfHitsInOverlapPlanesCut(), zcl::FastMonopoleTriggers::NumberOfSurfaceHits(), zcl::FastMMStudy::NumberOfSurfaceHits(), rb::operator<<(), air::AirFilter::parallel_muon_slice(), skim::ParametersNumu::ParametersNumu(), zcl::FastMonopoleTriggers::passed_epoch2_fmmtrigger(), me::MEFinder::PassesMEPresel(), calib::PCHitsList::ProcessTrack(), calib::PCHitsList::ProcessTrackTrajectory(), trk::TrkAssn::produce(), vf::VertexFinder::produce(), qeef::QeFinder::produce(), hv::HoughVertex::produce(), nuesand::FillNueSandbox::produce(), wsnumu::WSNumu::produce(), presel::CosmicVeto::produce(), slid::Recluster::produce(), numusand::FillSandbox::produce(), presel::NuePresel::produce(), presel::CosmicCVNVeto::produce(), lem::Preselection::produce(), slid::SliceLIDBuilder::produce(), cosrej::CosRej::produce(), zcl::SPCluster::produce(), numue::NumuEnergy::produce(), lem::MakeLibrary::produce(), earms::ElasticArmsHS::produce(), dt::DiscreteTracker::produce(), calib::PCHitsList::produce(), vdt::VertexDT::produce(), zcl::FmmTriggerEvd::produce(), jmshower::NueSel::produce(), dif::DiFShowerFinder::produce(), rvp::RecVarPID::produce(), jmshower::NueSelLID::produce(), bpfit::BPFEnergyEstimator::produce(), bpfit::BPFEnergyEstimatorOnly::produce(), cosrej::MakeNueCosRej::produce(), ncid::NCNNKeras::produce(), murem::MuonRemove::produce(), fuzz::FuzzyKVertex::produce(), nerd::NERDProng::produce(), caf::CAFMaker::produce(), slid::ParticleIDAlg::Radius(), jmshower::RecoJMShower::Radius(), jmshower::RecoJMShower::RadiusV(), jmshower::RecoJMShower::RecoShowers(), murem::MuonRemove::RemoveByTruth(), trk::KalmanTrack::RemoveHitsFromSignal(), dt::ViewMerger::ScoreForJoinPlusExtension(), trk::KalmanTrackMerge::ShiftInterpolationPoints(), slid::NuEEnergyAlg::ShowerDepEnergy(), lem::MakeLibrary::SliceMeanPosEWeighted(), lem::MakeLibrary::SliceOrigin(), lem::LEMSummarizer::SliceToLEMInput(), remid::ReMIdValidate::SortByHits(), remid::ReMIdTrain::SortByHits(), htk::sortByNCell(), zcl::FmmTriggerEvd::StdevCellsPerPlane(), nnbar::NNbarUtilities::temporalExpand(), calib::StopperThreshold::testPath(), htk::Track3D::time_fit(), mono::Track3D::time_fit(), dt::ViewMerger::TotalChargePerView(), nnbar::NNbarUtilities::totalVisibleEnergyInView(), zcl::FMMTracker::Tracking2D(), dprf::ChannelPlots::TrackOK(), dprf::TrackPlots::TrackOK(), trk::CosmicTrackUtilities::TrackResiduals(), slid::NuEEnergyAlg::VertexEnergy(), and trk::KalmanTrackMerge::ViewMergeTracks().

  {
    switch(view){
    case geo::kX: return NXCell();
    case geo::kY: return NYCell();
    case geo::kXorY: return NCell();
    default: assert(0 && "Unknown view");
    }
  }

unsigned int rb::Cluster::NCell ( ) const

inline

Number of cells in either view.

Definition at line 110 of file Cluster.h.

References Cell(), NXCell(), NYCell(), XCell(), and YCell().

Referenced by Exclude(), jmshower::JMShower::GetPlaneHits(), jmshower::JMShower::GetTransHits(), MaxCell(), MaxPlane(), MaxTNS(), MeanTNS(), MinCell(), MinMaxMeanXYZ(), MinPlane(), MinTNS(), MostContiguousPlanes(), MostMissingPlanes(), NCell(), NMissingPlanes(), OfflineChans(), rb::Track::PlaneDirMap(), RemoveHit(), TotalADC(), TotalGeV(), rb::Prong::TotalLength(), TotalPE(), TotalWeight(), View(), and WeightedHits().

{return NXCell()+NYCell();}

int rb::Cluster::NMissingPlanes

(

geo::View_t

view

)

const

Total number of missing planes in cluster.

Put simply, number of planes spanned minus number of hit planes. If track is 2D, only planes in that view are counted.

Definition at line 693 of file Cluster.cxx.

References Cell(), MECModelEnuComparisons::i, geo::kXorY, NCell(), update_sam_good_runs_metadata::stride, and View().

Referenced by bpf::BPFCVNAna::analyze(), ExtentTNS(), caf::FillTrackVars(), skim::ParametersNue::ParametersNue(), wsnumu::WSNumu::produce(), and slid::SliceLIDBuilder::produce().

  {
    if(view == geo::kXorY) view = View();

    const int stride = (view == geo::kXorY) ? 1 : 2;
    
    std::set<int> planes;

    for(unsigned int i = 0; i < NCell(view); ++i)
      planes.insert(Cell(view, i)->Plane());

    if(planes.empty()) return 0;
    
    return (*planes.rbegin() - *planes.begin())/stride - (int)planes.size() + 1; 

  }

unsigned int rb::Cluster::NXCell ( ) const

inline

Number of cells in the x-view.

Definition at line 106 of file Cluster.h.

References fXCell, and art::PtrVector< T >::size().

Referenced by caf::AddSlcMEToVec(), caf::AddTrkMEToVec(), chaninfo::CosmicEff::analyze(), comi::CosmicMetrics::analyze(), align::AlignInspect::analyze(), align::Alignment::analyze(), align::SplitTracks::analyze(), calib::HitEfficiency::analyze(), calib::PEResponse::analyze(), trk::KalmanTrackAna::analyze(), hough::HoughValidate::analyze(), slid::LIDTraining::analyze(), red::EWCosmics::analyze(), Cell(), sn::SNMichelAnalyzer::ClusterAroundTrackEnds(), sn::SNSlicer::ClusterIsGood(), cvn::PixelMapProducer::CreateMapGivenBoundary(), me::TrkME::DistToTrk(), evd::RecoBaseDrawer::DrawCluster2D(), caf::FillDiFShowerVars(), caf::FillDiFVars(), caf::FillHadClustVars(), caf::FillProngVars(), trk::CosmicTrackAna::FillRecoInfo(), caf::FillShowerVars(), filter::Filter::FillSliceVariables(), caf::FillSliceVars(), cvn::Get2DProngEfficiencyByPDG(), cvn::Get2DProngEnergyByPDG(), cvn::Get2DProngPurityByPDG(), jmshower::RecoJMShower::GetCentroid(), cvn::GetProngEfficiencyByPDG(), cvn::GetProngEnergyByPDG(), cvn::GetProngPurityByPDG(), jmshower::RecoJMShower::GetRVPStats(), bpfit::BreakPoint::GoodProng(), LSTME::BasicProngVars::initBasicVars(), trk::CosmicTrackSelection::IsCalibTrack(), calib::PCHitsList::IsGoodTrack(), skim::EvaluatorNue::KeepSlice(), nerd::NERDProng::MakeCluster(), trk::CosmicTrackAlg::MakeTrack(), NCell(), skim::ParametersNue::ParametersNue(), skim::ParametersNumu::ParametersNumu(), hough::HoughT::produce(), nuesand::FillNueSandbox::produce(), nussand::FillNusSandbox::produce(), hough::MultiHoughT::produce(), lem::Preselection::produce(), presel::NuePresel::produce(), earms::ElasticArmsHS::produce(), jmshower::JMClusterMerge::produce(), vdt::VertexDT::produce(), jmshower::NueSel::produce(), rvp::RecVarPID::produce(), cvntf::CVNProngEvaluatorTF::produce(), jmshower::NueSelLID::produce(), remid::RecoMuon::produce(), fuzz::FuzzyKVertex::produce(), nerd::NERDProng::produce(), caf::CAFMaker::produce(), cvn::ProngClassify(), jmshower::RecoJMShower::RecoShowers(), RemoveHit(), SetWeight(), lem::LEMSummarizer::SliceToLEMInput(), TotalGeVFastClusterOnly(), dprf::ChannelPlots::TrackOK(), dprf::TrackPlots::TrackOK(), me::MEFinder::TrkMEDist(), Weight(), and slicer::MMSlicer::WindowSlice().

{return fXCell.size();}

unsigned int rb::Cluster::NYCell ( ) const

inline

Number of cells in the y-view.

Definition at line 108 of file Cluster.h.

References fYCell, and art::PtrVector< T >::size().

Referenced by caf::AddSlcMEToVec(), caf::AddTrkMEToVec(), chaninfo::CosmicEff::analyze(), comi::CosmicMetrics::analyze(), align::AlignInspect::analyze(), align::Alignment::analyze(), align::SplitTracks::analyze(), calib::HitEfficiency::analyze(), calib::PEResponse::analyze(), trk::KalmanTrackAna::analyze(), hough::HoughValidate::analyze(), slid::LIDTraining::analyze(), red::EWCosmics::analyze(), sn::SNMichelAnalyzer::ClusterAroundTrackEnds(), sn::SNSlicer::ClusterIsGood(), cvn::PixelMapProducer::CreateMapGivenBoundary(), me::TrkME::DistToTrk(), evd::RecoBaseDrawer::DrawCluster2D(), caf::FillDiFShowerVars(), caf::FillDiFVars(), caf::FillHadClustVars(), caf::FillProngVars(), trk::CosmicTrackAna::FillRecoInfo(), caf::FillShowerVars(), filter::Filter::FillSliceVariables(), caf::FillSliceVars(), cvn::Get2DProngEfficiencyByPDG(), cvn::Get2DProngEnergyByPDG(), cvn::Get2DProngPurityByPDG(), jmshower::RecoJMShower::GetCentroid(), cvn::GetProngEfficiencyByPDG(), cvn::GetProngEnergyByPDG(), cvn::GetProngPurityByPDG(), jmshower::RecoJMShower::GetRVPStats(), bpfit::BreakPoint::GoodProng(), LSTME::BasicProngVars::initBasicVars(), trk::CosmicTrackSelection::IsCalibTrack(), calib::PCHitsList::IsGoodTrack(), skim::EvaluatorNue::KeepSlice(), nerd::NERDProng::MakeCluster(), trk::CosmicTrackAlg::MakeTrack(), NCell(), skim::ParametersNue::ParametersNue(), skim::ParametersNumu::ParametersNumu(), hough::HoughT::produce(), nuesand::FillNueSandbox::produce(), nussand::FillNusSandbox::produce(), hough::MultiHoughT::produce(), presel::NuePresel::produce(), lem::Preselection::produce(), earms::ElasticArmsHS::produce(), jmshower::JMClusterMerge::produce(), vdt::VertexDT::produce(), jmshower::NueSel::produce(), rvp::RecVarPID::produce(), cvntf::CVNProngEvaluatorTF::produce(), jmshower::NueSelLID::produce(), remid::RecoMuon::produce(), fuzz::FuzzyKVertex::produce(), nerd::NERDProng::produce(), caf::CAFMaker::produce(), cvn::ProngClassify(), jmshower::RecoJMShower::RecoShowers(), RemoveHit(), lem::LEMSummarizer::SliceToLEMInput(), TotalGeVFastClusterOnly(), dprf::ChannelPlots::TrackOK(), dprf::TrackPlots::TrackOK(), me::MEFinder::TrkMEDist(), and slicer::MMSlicer::WindowSlice().

{return fYCell.size();}

std::vector< geo::OfflineChan > rb::Cluster::OfflineChans

(

)

const

Positions of all the CellHits.

Definition at line 190 of file Cluster.cxx.

References Cell(), MECModelEnuComparisons::i, NCell(), and runNovaSAM::ret.

Referenced by calib::PCHitsList::ProcessTrack(), calib::PCHitsList::ProcessTrackForBelowThresholdHits(), calib::PCHitsList::ProcessTrackForFLSHits(), and YCells().

  {
    std::vector<geo::OfflineChan> ret;
    ret.reserve(NCell());
    for(unsigned int i = 0; i < NCell(); ++i)
      ret.push_back(Cell(i)->OfflineChan());
    return ret;
  }

bool rb::Cluster::operator<

(

const Cluster &

other

)

const

Definition at line 576 of file Cluster.cxx.

References MeanZ().

  {
    return this->MeanZ() < other.MeanZ();
  }

rb::RecoHit rb::Cluster::RecoHit

(

const art::Ptr< rb::CellHit > &

chit

)

const

Return calibrated hit based on assumed W coordinate.

To calibrate a hit you must know its distance from the readout. This is a convenience function which uses the W function to estimate the position of a CellHit and then uses calib::Calibrator to produce a calibrated hit from that information.

Definition at line 259 of file Cluster.cxx.

References art::Ptr< T >::get(), and calib::Calibrator::MakeRecoHit().

Referenced by dif::DiFShowerFinder::adjustPlane(), dif::DiFShowerFinder::adjustPlane_end(), tut::TutAnalyzer::analyze(), calib::TestParticleCorrections::analyze(), tbem::TBRecoAna::analyze(), showere::ShowerEnergyAna::analyze(), trk::KalmanTrackAna::analyze(), upmuana::UpMuRecoAna::analyze(), upmuana::UpMuAnalysis::analyze(), slid::NuEEnergyAlg::CellEnergy(), murem::TrackCleanUpAlg::CleanUpTrack(), nnbar::NNbarUtilities::correlationTCell(), nnbar::NNbarUtilities::correlationTPlane(), cvn::RegPixelMapProducer::CreateMapGivenBoundary(), cvn::PixelMapProducer::CreateMapGivenBoundary(), cvn::RegPixelMapProducer::CreateMapGivenShowerVertex(), cvn::RegPixelMapProducer::CreateMapGivenVertex(), murem::TrackCleanUpAlg::DeDxInPlane(), nnbar::NNbarUtilities::energyBalancingVertex(), dif::DiFShowerFinder::eparm(), calib::StopperThreshold::FillHist(), trk::CosmicTrackAna::FillTrackHistograms(), calib::StopperThreshold::FillTree(), showere::ShowerEnergyFilterMC::filter(), bsf::BremShowerFilter::findShowerByReco(), dif::DiFShowerFinder::findShowerByReco(), numusand::NumuSandFxs::getActivity(), numusand::NumuSandFxs::getAveTrackdEdx(), numusand::NumuSandFxs::getAveTrackdEdxLast4Cells(), numusand::NumuSandFxs::getAveTrackdEdxLast6Cells(), numusand::NumuSandFxs::getAveTrackdEdxLast8Cells(), trackinfo::TrackInfoFxs::getAveTrackdEdxLastCells(), xsrec::MakeXSecCCPi0Inc::GetBPI(), nnbar::NNbarUtilities::getCoordinateOfHits(), cosrej::CosRejFxs::getFits(), nuesand::FillNueSandbox::GetPlaneEnergy(), fuzz::FuzzyKValidate::GeVCalc(), tf::TimingFitAlg::HoughFit(), dif::DiFShowerFinder::muonstub(), numue::NumuEAlg::NDEnergy(), numue::NumuEAlg::NDTrackEnergySplitting(), nussand::FillNusSandbox::produce(), numusand::FillSandbox::produce(), slid::SliceLIDBuilder::produce(), lem::MakeLibrary::produce(), remid::RecoMuon::produce(), upmuana::UpMuProb::produce(), caf::CAFMaker::produce(), RecoHit(), lem::MakeLibrary::SliceMeanPosEWeighted(), lem::LEMSummarizer::SliceToLEMInput(), nnbar::NNbarUtilities::temporalExpand(), calib::StopperThreshold::testPath(), dt::ViewMerger::TotalChargePerView(), TotalGeV(), nnbar::NNbarUtilities::totalVisibleEnergyInView(), trk::CosmicTrackUtilities::TrackResiduals(), and YCells().

  {
    art::ServiceHandle<calib::Calibrator> cal;
    rb::RecoHit rb(cal->MakeRecoHit(*chit, this->W(chit.get())));
    return rb;
  }

rb::RecoHit rb::Cluster::RecoHit	(	geo::View_t	view,
		unsigned int	viewIdx
	)		const

Definition at line 267 of file Cluster.cxx.

References Cell(), and RecoHit().

  {
    return RecoHit(Cell(view, viewIdx));
  }

rb::RecoHit rb::Cluster::RecoHit

(

unsigned int

globalIdx

)

const

Definition at line 273 of file Cluster.cxx.

References Cell(), and RecoHit().

  {
    return RecoHit(Cell(globalIdx));
  }

void rb::Cluster::RemoveHit

(

const art::Ptr< rb::CellHit >

hit

)

Remove hit from current cluster.

Definition at line 290 of file Cluster.cxx.

References art::PtrVector< T >::begin(), art::PtrVector< T >::erase(), fPrecalcTotalGeV, fXCell, fXWeights, fYCell, fYWeights, MECModelEnuComparisons::i, geo::kX, geo::kY, NXCell(), NYCell(), and rb::CellHit::View().

Referenced by slid::NuEEnergyAlg::HadronicDepEnergy(), murem::FindParent::MatchToOrigSlice(), slid::Recluster::produce(), sn::SNSlicer::produce(), slid::NuEEnergyAlg::VertexEnergy(), and YCells().

  {
    fPrecalcTotalGeV = -1; // Invalidate any cached value

    if(hit->View() == geo::kX){
      // try to find the hit in the xcells
      for(unsigned int i = 0;i<NXCell();++i){
        if(fXCell[i] == hit){
          fXCell.erase(fXCell.begin()+i);
          if(!fXWeights.empty()) fXWeights.erase(fXWeights.begin()+i);
          break;
        }
      }
    }
    else if(hit->View() == geo::kY){
     // try to find the hit in the ycells
      for(unsigned int i = 0;i<NYCell();++i){
        if(fYCell[i] == hit){
          fYCell.erase(fYCell.begin()+i);
          if(!fYWeights.empty()) fYWeights.erase(fYWeights.begin()+i);
          break;
        }
      }
    }
  }

void rb::Cluster::RemoveHit

(

unsigned int

globalIdx

)

Remove the ith hit from current cluster.

Definition at line 317 of file Cluster.cxx.

References ana::assert(), art::PtrVector< T >::begin(), art::PtrVector< T >::erase(), fPrecalcTotalGeV, fXCell, fYCell, NCell(), and NXCell().

  {
    fPrecalcTotalGeV = -1; // Invalidate any cached value

    assert(globalIdx < NCell());
    if(globalIdx < NXCell()) fXCell.erase(fXCell.begin()+globalIdx);
    else fYCell.erase(fYCell.begin()+globalIdx-NXCell());
  }

void rb::Cluster::SavePrecalcTotalGeV

(

ESaveGeVMode

savemode

)

Store the current result of TotalGeV / CalorimetricEnergy.

If you intend to lock in the current calibrations, call this method immediately before storing the product in the event. The result can be retrieved by passing kUsePrecalcEnergy to TotalGeV or CalorimetricEnergy.

Multiple calls are considered to be an error. If you really do need to update the energy, pass kResetTotalGeV.

Definition at line 751 of file Cluster.cxx.

References allTimeWatchdog::endl, stan::math::fabs(), fPrecalcTotalGeV, kRecomputeEnergy, kResetTotalGeV, and TotalGeV().

  {
    const double gev = TotalGeV(kRecomputeEnergy);
    if(fPrecalcTotalGeV < 0 || savemode == kResetTotalGeV){
      fPrecalcTotalGeV = gev;
    }
    else{
      if(fabs(gev-fPrecalcTotalGeV) > .01){
        mf::LogError("rb::Cluster") << "SaveTotalGeV() already called. Old value was " << fPrecalcTotalGeV << ", now " << gev
                                    << ". If you intended to reset the stored value, you must pass kResetTotalGeV. Aborting." << std::endl;
        abort();
      }
      else{
        mf::LogWarning("rb::Cluster") << "Called SaveTotalGeV() twice for the same cluster, which is inefficient." << std::endl;
      }
    }
  }

void rb::Cluster::SetID ( int  id )

inline

Definition at line 74 of file Cluster.h.

References fID.

Referenced by sn::SNMichelAnalyzer::ClusterAroundTrackEnds(), fuzz::ViewMatchAlg::Matching(), nerd::ViewMatchAlg::Matching(), trk::KalmanTrackMerge::MatchTracks(), slid::Recluster::produce(), rb::Prong::Prong(), jmshower::RecoJMShower::RecoShowers(), rb::Shower::Shower(), rb::Track::Track(), trk::KalmanTrackMerge::ViewMergeTracks(), and rb::WeightedProng::WeightedProng().

{ fID = id;   }

void rb::Cluster::SetNoise ( bool  noise )

inline

Declare the cluster to consist of noise hits or not.

Definition at line 161 of file Cluster.h.

References fNoiseCluster.

Referenced by Exclude(), slicer::Slicer4D::produce(), airshower::AirSlicer::produce(), jmshower::JMClusterMerge::produce(), tdslicer::TDSlicer::produce(), and slicer::Slicer::WindowSlice().

{fNoiseCluster = noise;}

void rb::Cluster::SetWeight	(	unsigned int	globalIdx,
		double	weight
	)

Set weight of the cell at this index.

Definition at line 327 of file Cluster.cxx.

References fPrecalcTotalGeV, geo::kX, geo::kY, and NXCell().

Referenced by IsNoise(), rb::Shower::Shower(), and rb::Track::Track().

  {
    fPrecalcTotalGeV = -1; // Invalidate any cached value

    if(globalIdx < NXCell())
      SetWeight(geo::kX, globalIdx, weight);
    else
      SetWeight(geo::kY, globalIdx-NXCell(), weight);
  }

void rb::Cluster::SetWeight	(	geo::View_t	view,
		unsigned int	viewIdx,
		double	weight
	)

Set weight of the cell at this index in this view.

Definition at line 338 of file Cluster.cxx.

References ana::assert(), EnsureWeightAlloc(), fPrecalcTotalGeV, fXCell, fXWeights, fYCell, fYWeights, geo::kX, art::PtrVector< T >::size(), and plotSysts::weight.

  {
    fPrecalcTotalGeV = -1; // Invalidate any cached value

    assert(weight >= 0 && weight <= 1);

    // Are we optimizing (omitting) the weights storage?
    const bool optWeights = (weight == 1 && fXWeights.empty() && fYWeights.empty());
    if(!optWeights) EnsureWeightAlloc();

    if(view == geo::kX){
      assert(viewIdx < fXCell.size());
      if(!optWeights) fXWeights[viewIdx] = weight;
    }
    else{
      assert(viewIdx < fYCell.size());
      if(!optWeights) fYWeights[viewIdx] = weight;
    }
  }

void rb::Cluster::StandardSort

(

)

Put the cells in the cluster into a standard order.

Helps ensure that two clusters composed of the same cell hits present in exactly the same way.

Definition at line 731 of file Cluster.cxx.

References art::PtrVector< T >::begin(), om::cerr, art::PtrVector< T >::end(), allTimeWatchdog::endl, fXCell, fXWeights, fYCell, fYWeights, and rb::standard_compare().

Referenced by ExtentTNS().

  {
    //
    // Unweighted clusters are an easy sorting job
    //
    if (fXWeights.size()==0 && fYWeights.size()==0) {
      sort(fXCell.begin(), fXCell.end(), standard_compare);
      sort(fYCell.begin(), fYCell.end(), standard_compare);
      return;
    }
    //
    // \todo Sorting weighted hits requires more complicated code
    //
    std::cerr << __FILE__ << ":" << __LINE__ 
              << " Sort for weighted hits not implemented"
              << std::endl;
    abort();
  }

double rb::Cluster::TotalADC

(

)

const

Sum of the ADC of all the contained hits.

Definition at line 360 of file Cluster.cxx.

References rawdata::RawDigit::ADC(), Cell(), MECModelEnuComparisons::i, NCell(), runNovaSAM::ret, and Weight().

Referenced by caf::AddSlcMEToVec(), caf::AddTrkMEToVec(), sn::SupernovaAna::analyze(), tbem::TBRecoAna::analyze(), air::AirKalmanAna::analyze(), sn::SNMichelAnalyzer::ClusterAroundTrackEnds(), sn::SNSlicer::ClusterIsGood(), mono::HighEnergySliceRemoval::is_high_energy_slice(), IsNoise(), rb::operator<<(), air::AirFilter::parallel_muon_slice(), and skim::ParametersNumu::ParametersNumu().

  {
    double ret = 0;
    for(unsigned int i = 0; i < NCell(); ++i)
      ret += Cell(i)->ADC()*Weight(i);
    return ret;
  }

double rb::Cluster::TotalGeV

(

EEnergyCalcScheme

escheme = kRecomputeEnergy

)

const

Simple sum of the estimated GeV of all the hits.

WARNING: This is not a sensible energy estimator by itself. If you just want a simple calorimetric estimate look at CalorimetricEnergy. Otherwise, a range of more sophisticated/elaborate estimators are available elsewhere.

Definition at line 378 of file Cluster.cxx.

References allTimeWatchdog::endl, fPrecalcTotalGeV, rb::RecoHit::GeV(), MECModelEnuComparisons::i, rb::RecoHit::IsCalibrated(), kUsePrecalcEnergy, NCell(), RecoHit(), runNovaSAM::ret, TotalGeVFastClusterOnly(), and Weight().

Referenced by calib::TestParticleCorrections::analyze(), vf::TrackEva::analyze(), tbem::TBRecoAna::analyze(), bpfit::BPFTmvaTrainer::analyze(), bpf::BPFCVNAna::analyze(), htk::HoughTrack::analyze(), CalorimetricEnergy(), sn::SNMichelAnalyzer::ClusterAroundTrackEnds(), bpf::BPFCVNAna::CompareE(), murem::TrackCleanUpAlg::DeDxInPlane(), nnbar::NNbarUtilities::energyBalancingVertex(), numue::NumuEAlg::FDEnergy(), caf::FillNueEnergyVars(), trk::CosmicTrackAna::FillRecoInfo(), fnex::NuEAnalysisSetup::FillRecoVars(), cosrej::CosRejFxs::getActivity(), numusand::NumuSandFxs::getActivityVtx(), mono::MonopoleCluster::is_cosmic_track(), numue::NumuEAlg::NDEnergy(), skim::ParametersNue::ParametersNue(), skim::ParametersNumu::ParametersNumu(), qeef::QeFinder::produce(), numusand::FillSandbox::produce(), slid::SliceLIDBuilder::produce(), cosrej::CosRej::produce(), numue::NumuEnergy::produce(), bpfit::BPFEnergyEstimator::produce(), bpfit::BPFEnergyEstimatorOnly::produce(), cvn::ProngClassify(), and SavePrecalcTotalGeV().

  {
    if(escheme == kUsePrecalcEnergy){
      if(fPrecalcTotalGeV >= 0) return fPrecalcTotalGeV;

      mf::LogWarning("rb::Cluster::TotalGeV()") << "Passed kUsePrecalcEnergy but no energy was cached in the Cluster. Falling back to recomputing." << std::endl;
    }

    // Optimization that's only safe for literal Clusters
    if(typeid(*this) == typeid(rb::Cluster)) return TotalGeVFastClusterOnly();

    // For derived classes, fall through to the generic implementation

    double ret = 0;
    for(unsigned int i = 0; i < NCell(); ++i){
      const rb::RecoHit rhit = RecoHit(i);
      if(rhit.IsCalibrated()) ret += rhit.GeV()*Weight(i);
    }
    return ret;
  }

double rb::Cluster::TotalGeVFastClusterOnly ( ) const

private

Optimized form of TotalGeV, only valid for actual Clusters.

Definition at line 400 of file Cluster.cxx.

References ana::assert(), rb::RecoHit::GeV(), MECModelEnuComparisons::i, rb::RecoHit::IsCalibrated(), geo::kX, geo::kY, calib::Calibrator::MakeRecoHit(), extractScale::mean, MeanXYZ(), NXCell(), NYCell(), Weight(), XCell(), and YCell().

Referenced by TotalGeV().

  {
    // This is only safe for objects that return the same W for all hits in the
    // same view. We only know that's the case for Cluster. It's definitely not
    // correct for Prong and Track.
    assert(typeid(*this) == typeid(rb::Cluster));

    art::ServiceHandle<calib::Calibrator> cal;

    double gev = 0;

    // We just use the mean position for the W estimate in all cases.
    // Precalculate once up front, instead of NCell() times as we would
    // otherwise.
    const TVector3 mean = MeanXYZ();

    // X and Y cells have the mean of the opposite view as their W
    for(unsigned int i = 0; i < NXCell(); ++i){
      const rb::RecoHit rhit(cal->MakeRecoHit(*(XCell(i)), mean.Y()));
      if(rhit.IsCalibrated()) gev += rhit.GeV()*Weight(geo::kX, i);
    }
    for(unsigned int i = 0; i < NYCell(); ++i){
      const rb::RecoHit rhit(cal->MakeRecoHit(*(YCell(i)), mean.X()));
      if(rhit.IsCalibrated()) gev += rhit.GeV()*Weight(geo::kY, i);
    }

    return gev;
  }

double rb::Cluster::TotalPE

(

)

const

Sum of the PE value of all the contained hits.

Definition at line 369 of file Cluster.cxx.

References Cell(), MECModelEnuComparisons::i, NCell(), rb::CellHit::PE(), runNovaSAM::ret, and Weight().

Referenced by IsNoise().

  {
    double ret = 0;
    for(unsigned int i = 0; i < NCell(); ++i)
      ret += Cell(i)->PE()*Weight(i);
    return ret;
  }

double rb::Cluster::TotalWeight

(

)

const

Sum of all the weights. The effective number of hits.

Definition at line 430 of file Cluster.cxx.

References NCell(), runNovaSAM::ret, and Weight().

  {
    double ret = 0;
    for(unsigned int cellIdx = 0; cellIdx < NCell(); ++cellIdx)
      ret += Weight(cellIdx);
    return ret;
  }

virtual geo::View_t rb::Cluster::View ( ) const

inlinevirtual

kXorY for 3D clusters.

Definition at line 99 of file Cluster.h.

References fView, and NCell().

Referenced by nerd::NERDProng::AddProngs(), dt::ViewMerger::Adjacent(), calib::HitEfficiency::analyze(), trk::KalmanTrackAna::analyze(), trk::KalmanTrackMerge::CalcMatchScore(), trk::KalmanTrackMerge::CanJoinTracks(), cheat::RecoCheckAna::CheckRecoClusters(), trk::KalmanTrackAna::CheckRecoTracks(), skim::SkimmingUtils::CopySlice(), slid::DeconvolveAlg::DistanceToCore(), evd::RecoBaseDrawer::DrawTrack2D(), dt::ViewMerger::FakeThirdDimension(), trk::KalmanTrackMerge::JoinTracks(), dt::ViewMerger::JoinTracks(), trk::WindowTrackingAlg::LookForBremsstrahlungHits(), trk::WindowTrackingAlg::Make3DTrack(), MinMaxMeanXYZ(), dt::ViewMerger::MissingChargeByExtension(), NMissingPlanes(), rb::operator<<(), nussand::FillNusSandbox::produce(), nerd::NERDProng::produce(), dt::ViewMerger::ScoreForJoinPlusExtension(), trk::KalmanTrackMerge::ShiftInterpolationPoints(), trk::WindowTrackingAlg::ShortTrackExtraPlane(), and rb::Track::ZipWith().

{return fView;}

double rb::Cluster::W ( const rb::CellHit *  chit ) const

virtual

Estimate the unmeasured coordinate of chit.

The nomenclature for the coordinates is that XYZ are the physical coordinates. Whichever of XY is measured by the cell is "V", the direction along the cell is "W". The origin of VW space is the same as the origin of XY space, the detector centreline.

This method should be overridden in all descendants of Cluster which have additional information to make this determination.

For Cluster, this is simply the average coordinate of all hits in the view in question.

Parameters

chit	Any CellHit, not necessarily owned by this container

Returns

Estimated unmeasured coordinate of this hit (cm) assuming it to be associated with this reconstructed object.

Reimplemented in rb::Track, and rb::Prong.

Definition at line 121 of file Cluster.cxx.

References geo::GeometryBase::DetId(), geom(), novadaq::cnv::kTESTBEAM, geo::kX, geo::kY, MeanV(), and rb::CellHit::View().

Referenced by ncs::Xeff::analyze(), ncs::ROCKMRE::analyze(), slid::LIDTraining::analyze(), ncs::NCAna::analyze(), caf::FillHadClustVars(), caf::FillSliceVars(), jmshower::RecoJMShower::GetRVPStats(), ID(), nuesand::FillNueSandbox::produce(), lem::Preselection::produce(), presel::NuePresel::produce(), jmshower::NueSel::produce(), rvp::RecVarPID::produce(), jmshower::NueSelLID::produce(), jmshower::RecoJMShower::RecoShowers(), and lem::LEMSummarizer::SliceToLEMInput().

  {
    geo::View_t otherView = geo::kX;
    if(hit->View() == geo::kX) otherView = geo::kY;

    // TB horizontal modules (Y-view) have readout on opposite end as ND/FD
    art::ServiceHandle<geo::Geometry> geom;
    if(geom->DetId() == novadaq::cnv::kTESTBEAM && hit->View() == geo::kY) return -MeanV(otherView);

    return MeanV(otherView);
  }

double rb::Cluster::Weight

(

unsigned int

globalIdx

)

const

Weight assigned to the cell.

Definition at line 209 of file Cluster.cxx.

References fXWeights, fYWeights, geo::kX, geo::kY, and NXCell().

Referenced by fuzz::ViewMatchAlg::CalcEnergyProfile(), nerd::ViewMatchAlg::CalcEnergyProfile(), slid::NuEEnergyAlg::CellEnergy(), skim::SkimmingUtils::CopySlice(), Exclude(), trk::CosmicTrackAna::FillRecoInfo(), fuzz::FuzzyKValidate::GeVCalc(), fuzz::ViewMatchAlg::MakeTestProng(), nerd::ViewMatchAlg::MakeTestProng(), MeanTNS(), MinMaxMeanXYZ(), nussand::FillNusSandbox::produce(), TotalADC(), TotalGeV(), TotalGeVFastClusterOnly(), TotalPE(), TotalWeight(), WeightedHits(), and YCells().

  {
    if(fXWeights.empty() && fYWeights.empty()) return 1;

    if(globalIdx < NXCell()) return Weight(geo::kX, globalIdx);
    return Weight(geo::kY, globalIdx-NXCell());
  }

double rb::Cluster::Weight	(	geo::View_t	view,
		unsigned int	viewIdx
	)		const

Weight assigned to the cell.

Definition at line 218 of file Cluster.cxx.

References ana::assert(), fXWeights, fYWeights, and geo::kX.

  {
    if(fXWeights.empty() && fYWeights.empty()) return 1;

    if(view == geo::kX){
      assert(viewIdx < fXWeights.size());
      return fXWeights[viewIdx];
    }
    else{
      assert(viewIdx < fYWeights.size());
      return fYWeights[viewIdx];
    }
  }

std::vector< rb::WeightedHit > rb::Cluster::WeightedHits

(

)

const

Get all hits from both views, with weights attached.

Definition at line 200 of file Cluster.cxx.

References Cell(), NCell(), and Weight().

Referenced by YCells().

  {
    std::vector<rb::WeightedHit> all;
    for(unsigned int cellIdx = 0; cellIdx < NCell(); ++cellIdx)
      all.push_back(rb::WeightedHit(Cell(cellIdx), Weight(cellIdx)));
    return all;
  }

art::Ptr< rb::CellHit > rb::Cluster::XCell

(

unsigned int

xIdx

)

const

Get the ith cell in the x-view.

Definition at line 157 of file Cluster.cxx.

References ana::assert(), fXCell, and art::PtrVector< T >::size().

Referenced by align::SplitTracks::analyze(), trk::KalmanTrackAna::analyze(), zcl::FastMMStudy::analyze(), slid::LIDTraining::analyze(), Cell(), evd::RecoBaseDrawer::DrawCluster2D(), caf::FillHadClustVars(), caf::FillSliceVars(), jmshower::RecoJMShower::GetCentroid(), jmshower::RecoJMShower::GetRVPStats(), skim::EvaluatorNue::KeepSlice(), nerd::NERDProng::MakeCluster(), trk::CosmicTrackAlg::MakeTrack(), NCell(), nuesand::FillNueSandbox::produce(), nussand::FillNusSandbox::produce(), lem::Preselection::produce(), presel::NuePresel::produce(), vdt::VertexDT::produce(), jmshower::NueSel::produce(), rvp::RecVarPID::produce(), jmshower::NueSelLID::produce(), remid::RecoMuon::produce(), caf::CAFMaker::produce(), jmshower::RecoJMShower::RecoShowers(), lem::LEMSummarizer::SliceToLEMInput(), and TotalGeVFastClusterOnly().

  {
    assert(xIdx < fXCell.size());

    return fXCell[xIdx];
  }

const art::PtrVector<rb::CellHit>& rb::Cluster::XCells ( ) const

inline

Get all cells from the x-view.

Definition at line 124 of file Cluster.h.

References fXCell.

Referenced by upmuana::UpMuAnalysis::analyze(), caf::FillDiFShowerVars(), caf::FillDiFVars(), caf::FillProngVars(), caf::FillShowerVars(), mono::MonopoleCluster::find_isolated_hits(), zcl::FMMTracker::produce(), cvn::ProngClassify(), and mono::Track3D::Track3D().

{ return fXCell; }

art::Ptr< rb::CellHit > rb::Cluster::YCell

(

unsigned int

yIdx

)

const

Get the ith cell in the y-view.

Definition at line 165 of file Cluster.cxx.

References ana::assert(), fYCell, and art::PtrVector< T >::size().

Referenced by align::SplitTracks::analyze(), trk::KalmanTrackAna::analyze(), slid::LIDTraining::analyze(), Cell(), evd::RecoBaseDrawer::DrawCluster2D(), caf::FillHadClustVars(), caf::FillSliceVars(), jmshower::RecoJMShower::GetCentroid(), jmshower::RecoJMShower::GetRVPStats(), skim::EvaluatorNue::KeepSlice(), nerd::NERDProng::MakeCluster(), trk::CosmicTrackAlg::MakeTrack(), NCell(), nuesand::FillNueSandbox::produce(), nussand::FillNusSandbox::produce(), lem::Preselection::produce(), presel::NuePresel::produce(), vdt::VertexDT::produce(), jmshower::NueSel::produce(), rvp::RecVarPID::produce(), jmshower::NueSelLID::produce(), remid::RecoMuon::produce(), caf::CAFMaker::produce(), jmshower::RecoJMShower::RecoShowers(), lem::LEMSummarizer::SliceToLEMInput(), and TotalGeVFastClusterOnly().

  {
    assert(yIdx < fYCell.size());

    return fYCell[yIdx];
  }

const art::PtrVector<rb::CellHit>& rb::Cluster::YCells ( ) const

inline

Get all cells from the x-view.

Definition at line 126 of file Cluster.h.

References AllCells(), Clear(), Exclude(), fYCell, OfflineChans(), RecoHit(), RemoveHit(), Weight(), and WeightedHits().

Referenced by upmuana::UpMuAnalysis::analyze(), caf::FillDiFShowerVars(), caf::FillDiFVars(), caf::FillProngVars(), caf::FillShowerVars(), mono::MonopoleCluster::find_isolated_hits(), zcl::FMMTracker::produce(), cvn::ProngClassify(), and mono::Track3D::Track3D().

{ return fYCell; }

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  o, const Cluster &  c  )

friend

Definition at line 770 of file Cluster.cxx.

  {
    o << std::setiosflags(std::ios::fixed) << std::setprecision(2);
    o << "View = "    << std::setw(1) << std::right << c.View()
      << " ID = "     << std::setw(1) << std::right << c.ID()
      << " #Cells = " << std::setw(3) << std::right << c.NCell()
      << " Is3D = "   << std::setw(1) << std::right << c.Is3D()
      << " TotalADC = " << std::setw(5) << std::right << c.TotalADC();

    return o;
  }

Member Data Documentation

int rb::Cluster::fID

protected

ID for cluster.

Definition at line 321 of file Cluster.h.

Referenced by Exclude(), ID(), and SetID().

bool rb::Cluster::fNoiseCluster

protected

flag for whether this is a noise cluster

Definition at line 322 of file Cluster.h.

Referenced by Exclude(), IsNoise(), and SetNoise().

double rb::Cluster::fPrecalcTotalGeV

protected

-1 = uninitialized

Definition at line 324 of file Cluster.h.

Referenced by Add(), rb::Track::AppendTrajectoryPoint(), Clear(), rb::Track::ClearTrajectoryPoints(), rb::Track::PrependTrajectoryPoint(), RemoveHit(), rb::Track::RemoveTrajectoryPoint(), SavePrecalcTotalGeV(), rb::Prong::SetDir(), rb::Prong::SetStart(), SetWeight(), and TotalGeV().

geo::View_t rb::Cluster::fView

protected

view this cluster is in

Definition at line 316 of file Cluster.h.

Referenced by Add(), rb::Track::AppendTrajectoryPoint(), Cluster(), Exclude(), rb::Prong::Is3D(), rb::Track::PrependTrajectoryPoint(), rb::Prong::SetDir(), rb::Prong::SetStart(), rb::Track::Track(), and View().

art::PtrVector<rb::CellHit> rb::Cluster::fXCell

protected

collection of x-view cells in cluster

Definition at line 317 of file Cluster.h.

Referenced by Add(), AllCells(), Clear(), Cluster(), EnsureWeightAlloc(), Is3D(), NXCell(), RemoveHit(), SetWeight(), StandardSort(), XCell(), and XCells().

std::vector<double> rb::Cluster::fXWeights

protected

Weights, matching cell indexing.

Definition at line 319 of file Cluster.h.

Referenced by Add(), Clear(), EnsureWeightAlloc(), RemoveHit(), SetWeight(), StandardSort(), and Weight().

art::PtrVector<rb::CellHit> rb::Cluster::fYCell

protected

collection of y-view cells in cluster

Definition at line 318 of file Cluster.h.

Referenced by Add(), AllCells(), Clear(), Cluster(), EnsureWeightAlloc(), Is3D(), NYCell(), RemoveHit(), SetWeight(), StandardSort(), YCell(), and YCells().

std::vector<double> rb::Cluster::fYWeights

protected

May be empty, means all weights are 1.

Definition at line 320 of file Cluster.h.

Referenced by Add(), Clear(), EnsureWeightAlloc(), RemoveHit(), SetWeight(), StandardSort(), and Weight().

---

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

• /cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N20-04-08/RecoBase/Cluster.h
• /cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N20-04-08/RecoBase/Cluster.cxx