LArSoft: recob::Cluster Class Reference

float fAngles[NEnds]

Definition: Cluster.h:130

float recob::Cluster::Angle ( unsigned int side ) const

inline

Returns the angle at either end of the cluster.

Parameters

side	clStart for start, clEnd for end of the cluster

Returns: angle in radians

See also: StartAngle(), EndAngle()

The angle of the group of hits at the specified position of the cluster is returned, defined $\alpha \in [ -\pi, \pi ]$ and so that $\tan(\alpha) = dT/dW$ (or, more precisely, angle = atan2(dT, dW)). The elements are expressed in physical distances and therefore this represents a physical angle on the plane orthogonal to the wires in the view and containing the drift direction ("x"); the angle is 0 or $\pi$ when lying on the wire plane, $\pm\pi/2$ when pointing into/from the wire plane. The angle is pointing so that increasing wire number yields positive $ dW $ . This value can be result of extrapolation or average from a range of hits.

Definition at line 570 of file Cluster.h.

570 { return fAngles[side]; }

float fAngles[NEnds]

Definition: Cluster.h:130

float recob::Cluster::Charge ( ChargeMode_t mode ) const

inline

Returns the total charge of the cluster.

Parameters

mode	cmFit to use fitted hit shape, cmADC for signal ADCs

Returns: total charge of the cluster, in ADC counts

See also: ChargeStdDev(), ChargeAverage(), SummedADC(), Integral()

The total charge is computed as the sum of the charge of all the hits. The charge of a single hit comes from the fitted hit shape (recob::Hit::Integral()) for cmFit, and signal ADC counts (recob::Hit::SummedADC()) for cmADC.

Note: Cluster class older than version 14 had a Charge() method too; the new one is not strictly equivalent, although in practice replacing the old Charge() with Charge(cmFit) should do the trick. The recommended update is to use Integral() instead.

Definition at line 676 of file Cluster.h.

676 { return fChargeSum[mode]; }

float fChargeSum[NChargeModes]

Definition: Cluster.h:145

float recob::Cluster::Charge ( unsigned int mode ) const

inline

Returns the total charge of the cluster.

Parameters

mode	cmFit to use fitted hit shape, cmADC for signal ADCs

Returns: total charge of the cluster, in ADC counts

See also: ChargeStdDev(), ChargeAverage(), SummedADC(), Integral()

The total charge is computed as the sum of the charge of all the hits. The charge of a single hit comes from the fitted hit shape (recob::Hit::Integral()) for cmFit, and signal ADC counts (recob::Hit::SummedADC()) for cmADC.

Note: Cluster class older than version 14 had a Charge() method too; the new one is not strictly equivalent, although in practice replacing the old Charge() with Charge(cmFit) should do the trick. The recommended update is to use Integral() instead.

Definition at line 677 of file Cluster.h.

677 { return fChargeSum[mode]; }

float fChargeSum[NChargeModes]

Definition: Cluster.h:145

float recob::Cluster::ChargeAverage ( ChargeMode_t mode ) const

inline

Returns the average charge of the cluster hits.

Returns: average of the charge of the cluster hits, in ADC counts

See also: Charge(), ChargeStdDev(), SummedADCaverage(), IntegralAverage()

The charge of a single hit comes from the fitted hit shape (recob::Hit::Integral()) for cmFit, and signal ADC counts (recob::Hit::SummedADC()) for cmADC. It should return 0 if no hit is available.

Definition at line 708 of file Cluster.h.

Referenced by Cluster().

709 { return fChargeAverage[mode]; }

float fChargeAverage[NChargeModes]

Definition: Cluster.h:153

float recob::Cluster::ChargeAverage ( unsigned int mode ) const

inline

Returns the average charge of the cluster hits.

Returns: average of the charge of the cluster hits, in ADC counts

See also: Charge(), ChargeStdDev(), SummedADCaverage(), IntegralAverage()

The charge of a single hit comes from the fitted hit shape (recob::Hit::Integral()) for cmFit, and signal ADC counts (recob::Hit::SummedADC()) for cmADC. It should return 0 if no hit is available.

Definition at line 710 of file Cluster.h.

711 { return fChargeAverage[mode]; }

float fChargeAverage[NChargeModes]

Definition: Cluster.h:153

float recob::Cluster::ChargeStdDev ( ChargeMode_t mode ) const

inline

Returns the standard deviation of charge of the cluster hits.

Returns: standard deviation of charge of the cluster hits, in ADC counts

See also: Charge(), ChargeAverage(), SummedADCstdDev(), IntegralStdDev()

The charge of a single hit comes from the fitted hit shape (recob::Hit::Integral()) for cmFit, and signal ADC counts (recob::Hit::SummedADC()) for cmADC. It should return 0 if less than two hits are available.

Definition at line 691 of file Cluster.h.

Referenced by Cluster().

692 { return fChargeStdDev[mode]; }

float fChargeStdDev[NChargeModes]

Definition: Cluster.h:149

float recob::Cluster::ChargeStdDev ( unsigned int mode ) const

inline

Returns the standard deviation of charge of the cluster hits.

Returns: standard deviation of charge of the cluster hits, in ADC counts

See also: Charge(), ChargeAverage(), SummedADCstdDev(), IntegralStdDev()

The charge of a single hit comes from the fitted hit shape (recob::Hit::Integral()) for cmFit, and signal ADC counts (recob::Hit::SummedADC()) for cmADC. It should return 0 if less than two hits are available.

Definition at line 693 of file Cluster.h.

694 { return fChargeStdDev[mode]; }

float fChargeStdDev[NChargeModes]

Definition: Cluster.h:149

float recob::Cluster::EdgeCharge ( ClusterEnds_t side ) const

inline

Returns the charge on the first or last wire of the cluster.

Parameters

side	clStart for start, clEnd for end of the cluster

Returns: charge on the requested wire in ADC counts, negative if not available

See also: StartCharge(), EndCharge()

The returned value is in unit of ADC count, although it may be fractional. This value can be result of extrapolation or average from a range of hits.

Definition at line 544 of file Cluster.h.

Referenced by cluster::ClusterMerger::AdoptEnd().

544 { return fEndCharges[side]; }

float fEndCharges[NEnds]

Definition: Cluster.h:120

float recob::Cluster::EdgeCharge ( unsigned int side ) const

inline

Returns the charge on the first or last wire of the cluster.

Parameters

side	clStart for start, clEnd for end of the cluster

Returns: charge on the requested wire in ADC counts, negative if not available

See also: StartCharge(), EndCharge()

The returned value is in unit of ADC count, although it may be fractional. This value can be result of extrapolation or average from a range of hits.

Definition at line 545 of file Cluster.h.

545 { return fEndCharges[side]; }

float fEndCharges[NEnds]

Definition: Cluster.h:120

float recob::Cluster::EndAngle ( ) const

inline

Returns the ending angle of the cluster.

Returns: angle in radians

See also: StartAngle(), Angle()

The angle of the group of hits at the end position of the cluster is returned, defined $\alpha \in [ -\pi, \pi ]$ and so that $\tan(\alpha) = dT/dW$ (or, more precisely, angle = atan2(dT, dW)). The elements are expressed in physical distances and therefore this represents a physical angle on the plane orthogonal to the wires in the view and containing the drift direction ("x"); the angle is 0 or $\pi$ when lying on the wire plane, $\pm\pi/2$ when pointing into/from the wire plane. The angle is pointing toward the outside of the cluster (that is, $ dW $ is positive going toward the last wire). This value can be result of extrapolation or average from a range of hits.

Definition at line 519 of file Cluster.h.

References clEnd.

Referenced by trkf::CCTrackMaker::produce().

519 { return fAngles[clEnd]; }

float fAngles[NEnds]

Definition: Cluster.h:130

Represents the end, or the alternative start, of the cluster.

Definition: Cluster.h:79

float recob::Cluster::EndCharge ( ) const

inline

Returns the charge on the last wire of the cluster.

Returns: charge on the last wire in ADC counts, negative if not available

See also: StartCharge(), EdgeCharge()

The returned value is in unit of ADC count, although it may be fractional. This value can be result of extrapolation or average from a range of hits.

Definition at line 498 of file Cluster.h.

References clEnd.

Referenced by trkf::CCTrackMaker::produce().

498 { return fEndCharges[clEnd]; }

float fEndCharges[NEnds]

Definition: Cluster.h:120

Represents the end, or the alternative start, of the cluster.

Definition: Cluster.h:79

float recob::Cluster::EndOpeningAngle ( ) const

inline

Returns the opening angle at the end of the cluster.

Returns: opening angle in radians

See also: StartOpeningAngle(), OpeningAngle()

The returned value is from homogenized coordinates and in the range $[ 0, \pi ]$ .

Definition at line 529 of file Cluster.h.

References clEnd.

529 { return fOpeningAngles[clEnd]; }

float fOpeningAngles[NEnds]

Definition: Cluster.h:137

Represents the end, or the alternative start, of the cluster.

Definition: Cluster.h:79

float recob::Cluster::EndTick ( ) const

inline

Returns the tick coordinate of the end of the cluster.

Returns: tick coordinate of the end of the cluster (may be fractional)

See also: StartTick(), TickCoord(), EndWire()

The "end" of the cluster is, in the more ambiguous cluster shapes, defined as an alternative cluster start. The tick coordinate is in tick units (the homogenized coordinate), but can have a fractional part describing the relative time from the previous tick.

Definition at line 342 of file Cluster.h.

References clEnd.

Referenced by Cluster(), filter::MuonFilter::filter(), shwf::ShowerReco::GetVertexAndAnglesFromCluster(), recob::operator<(), recob::operator<<(), cosmic::CosmicClusterTagger::produce(), and trkf::CCTrackMaker::produce().

342 { return fEndTicks[clEnd]; }

float fEndTicks[NEnds]

Definition: Cluster.h:111

Represents the end, or the alternative start, of the cluster.

Definition: Cluster.h:79

float recob::Cluster::EndWire ( ) const

inline

Returns the wire coordinate of the end of the cluster.

Returns: wire coordinate of the end of the cluster (may lie between wires)

See also: StartWire(), WireCoord(), EndTick()

The "end" of the cluster is, in the more ambiguous cluster shapes, defined as an alternative cluster start. The wire coordinate is in wire units (the homogenized coordinate), but can have a fractional part describing the relative distance from the previous wire.

Definition at line 329 of file Cluster.h.

References clEnd.

Referenced by cluster::ClusterMerger::Add(), Cluster(), filter::MuonFilter::filter(), shwf::ShowerReco::GetVertexAndAnglesFromCluster(), recob::operator<<(), and trkf::CCTrackMaker::produce().

329 { return fEndWires[clEnd]; }

float fEndWires[NEnds]

Definition: Cluster.h:103

Represents the end, or the alternative start, of the cluster.

Definition: Cluster.h:79

bool recob::Cluster::hasPlane ( ) const

inline

Returns whether geometry plane is valid.

Definition at line 749 of file Cluster.h.

References geo::CryostatID::isValid.

Referenced by cluster::ClusterMerger::Add(), Cluster(), and recob::operator<().

749 { return fPlaneID.isValid; }

geo::CryostatID::isValid

bool isValid

Whether this ID points to a valid element.

Definition: geo_types.h:129

recob::Cluster::fPlaneID

geo::PlaneID fPlaneID

Location of the start of the cluster.

Definition: Cluster.h:170

ID_t recob::Cluster::ID ( ) const

inline

Identifier of this cluster.

Returns: the identifier of this cluster

See also: isValid()

The identifier should be unique per event and per algorithm. An invalid cluster can be defined by having an ID Cluster::InvalidID.

Definition at line 738 of file Cluster.h.

References fID.

Referenced by cluster::ClusterMatchAlg::AppendClusterInfo(), calo::LinearEnergyAlg::CalculateEnergy(), Cluster(), isValid(), recob::operator<(), recob::operator<<(), lar_pandora::LArPandoraEventDump::PrintCluster(), cluster::LineMerger::produce(), and shwf::ShowerFinder::produce().

738 { return fID; }

recob::Cluster::fID

ID_t fID

Definition: Cluster.h:165

float recob::Cluster::Integral ( ) const

inline

Returns the total charge of the cluster from hit shape.

Returns: total charge of the cluster from hit shape, in ADC counts

See also: IntegralStdDev(), IntegralAverage(), SummedADC(), Charge()

The total charge is computed as the sum of the charge of all the hits. The charge of a single hit includes the hit shape (fit) and is obtained by recob::Hit::Integral().

Definition at line 600 of file Cluster.h.

References cmFit.

Referenced by Cluster(), recob::operator<<(), and trkf::CCTrackMaker::produce().

600 { return fChargeSum[cmFit]; }

recob::Cluster::cmFit

Sums from the fitted hit values.

Definition: Cluster.h:85

float fChargeSum[NChargeModes]

Definition: Cluster.h:145

float recob::Cluster::IntegralAverage ( ) const

inline

Returns the average charge of the cluster hits.

Returns: average of the charge of the cluster hits, in ADC counts

See also: Integral(), IntegralStdDev(), SummedADCaverage(), ChargeAverage()

The charge of a single hit includes the hit shape (fit) and is obtained by recob::Hit::Integral(). It should return 0 if no hit is available.

Definition at line 622 of file Cluster.h.

References cmFit.

622 { return fChargeAverage[cmFit]; }

recob::Cluster::cmFit

Sums from the fitted hit values.

Definition: Cluster.h:85

float fChargeAverage[NChargeModes]

Definition: Cluster.h:153

float recob::Cluster::IntegralStdDev ( ) const

inline

Returns the standard deviation of the charge of the cluster hits.

Returns: standard deviation of the charge of the cluster hits, in ADC counts

See also: Integral(), IntegralAverage(), SummedADCstdDev(), ChargeStdDev()

The charge of a single hit includes the hit shape (fit) and is obtained by recob::Hit::Integral(). It should return 0 if less than two hits are available.

Definition at line 611 of file Cluster.h.

References cmFit.

611 { return fChargeStdDev[cmFit]; }

recob::Cluster::cmFit

Sums from the fitted hit values.

Definition: Cluster.h:85

recob::Cluster::InvalidID

float fChargeStdDev[NChargeModes]

Definition: Cluster.h:149

bool recob::Cluster::isValid ( ) const

inline

Returns if the cluster is valid (that is, if its ID is not invalid)

Definition at line 753 of file Cluster.h.

References ID(), InvalidID, operator<, and operator<<.

Referenced by cluster::ClusterMerger::Add().

753 { return ID() != InvalidID; }

static constexpr ID_t InvalidID

Value for an invalid cluster ID.

Definition: Cluster.h:179

recob::Cluster::ID

ID_t ID() const

Identifier of this cluster.

Definition: Cluster.h:738

float recob::Cluster::MultipleHitDensity ( ) const

inline

Density of wires in the cluster with more than one hit.

Returns: density of wires in the cluster with more than one hit

Returns a quantity defined as NMultiHitWires / Length, where NMultiHitWires is the number of wires which have more than just one hit amd Length is an estimation of the length of the cluster, in centimetres.

Definition at line 723 of file Cluster.h.

References fMultipleHitDensity.

723 { return fMultipleHitDensity; }

recob::Cluster::fMultipleHitDensity

float fMultipleHitDensity

Density of wires in the cluster with more than one hit.

Definition: Cluster.h:157

unsigned int recob::Cluster::NHits ( ) const

inline

Number of hits in the cluster.

Definition at line 275 of file Cluster.h.

References fNHits.

Referenced by Cluster(), and recob::operator<<().

275 { return fNHits; }

recob::Cluster::fNHits

unsigned int fNHits

Number of hits in the cluster.

Definition: Cluster.h:97

float recob::Cluster::OpeningAngle ( ClusterEnds_t side ) const

inline

Returns the opening angle at either end of the cluster.

Returns: opening angle in radians

See also: StartOpeningAngle(), EndOpeningAngle()

The returned value is from homogenized coordinates and in the range $[ 0, \pi ]$ . This value can be result of extrapolation or average from a range of hits.

Definition at line 584 of file Cluster.h.

Referenced by cluster::ClusterMerger::AdoptEnd().

585 { return fOpeningAngles[side]; }

float fOpeningAngles[NEnds]

Definition: Cluster.h:137

float recob::Cluster::OpeningAngle ( unsigned int side ) const

inline

Returns the opening angle at either end of the cluster.

Returns: opening angle in radians

See also: StartOpeningAngle(), EndOpeningAngle()

The returned value is from homogenized coordinates and in the range $[ 0, \pi ]$ . This value can be result of extrapolation or average from a range of hits.

Definition at line 586 of file Cluster.h.

587 { return fOpeningAngles[side]; }

float fOpeningAngles[NEnds]

Definition: Cluster.h:137

Cluster& recob::Cluster::operator= ( Cluster const & )

default

Copy assignment: automatically generated.

Referenced by Cluster(), and operator=().

Cluster& recob::Cluster::operator= ( Cluster && from )

inline

Move assignment: as copy, but source cluster gets an invalid ID.

Definition at line 261 of file Cluster.h.

References InvalidID, operator=(), and ~Cluster().

         {
           if (&from != this) { operator=(from); from.fID = InvalidID; }
           return *this;
         }

geo::PlaneID recob::Cluster::Plane ( ) const

inline

Returns the plane ID this cluster lies on.

Definition at line 744 of file Cluster.h.

References fPlaneID.

Referenced by cluster::ClusterMerger::Add(), calo::LinearEnergyAlg::CalculateEnergy(), shower::EMShowerAlg::CheckShowerPlanes(), Cluster(), filter::MuonFilter::filter(), recob::operator<(), and recob::operator<<().

744 { return fPlaneID; }

recob::Cluster::fPlaneID

geo::PlaneID fPlaneID

Location of the start of the cluster.

Definition: Cluster.h:170

float recob::Cluster::SigmaEndTick ( ) const

inline

Returns the uncertainty on tick coordinate of the end of the cluster.

Returns: uncertainty on tick coordinate of the end of the cluster

See also: EndTick()

The tick uncertainty is in tick units (as for EndTick()).

Definition at line 360 of file Cluster.h.

References clEnd.

360 { return fSigmaEndTicks[clEnd]; }

float fSigmaEndTicks[NEnds]

Definition: Cluster.h:115

Represents the end, or the alternative start, of the cluster.

Definition: Cluster.h:79

float recob::Cluster::SigmaEndWire ( ) const

inline

Returns the uncertainty on wire coordinate of the end of the cluster.

Returns: uncertainty on wire coordinate of the end of the cluster

See also: EndWire()

The wire uncertainty is in wire units (as for EndWire()).

Definition at line 351 of file Cluster.h.

References clEnd.

351 { return fSigmaEndWires[clEnd]; }

float fSigmaEndWires[NEnds]

Definition: Cluster.h:107

Represents the end, or the alternative start, of the cluster.

Definition: Cluster.h:79

float recob::Cluster::SigmaStartTick ( ) const

inline

Returns the uncertainty on tick coordinate of the start of the cluster.

Returns: uncertainty on tick coordinate of the start of the cluster

See also: StartTick()

The tick uncertainty is in tick units (as for StartTick()).

Definition at line 315 of file Cluster.h.

References clStart.

Referenced by shwf::ShowerReco::GetVertexAndAnglesFromCluster().

315 { return fSigmaEndTicks[clStart]; }

float fSigmaEndTicks[NEnds]

Definition: Cluster.h:115

Represents the most likely start of the cluster.

Definition: Cluster.h:78

float recob::Cluster::SigmaStartWire ( ) const

inline

Returns the uncertainty on wire coordinate of the start of the cluster.

Returns: uncertainty on wire coordinate of the start of the cluster

See also: StartWire()

The wire uncertainty is in wire units (as for StartWire()).

Definition at line 306 of file Cluster.h.

References clStart.

Referenced by shwf::ShowerReco::GetVertexAndAnglesFromCluster().

306 { return fSigmaEndWires[clStart]; }

float fSigmaEndWires[NEnds]

Definition: Cluster.h:107

Represents the most likely start of the cluster.

Definition: Cluster.h:78

float recob::Cluster::SigmaTickCoord ( ClusterEnds_t side ) const

inline

Returns the uncertainty on tick coordinate of one of the end sides of the cluster.

Parameters

side	clStart for start, clEnd for end of the cluster

Returns: uncertainty on tick coordinate of the requested end of the cluster

See also: SigmaStartTick(), SigmaEndTick(), SigmaWireCoord(), TimeCoord()

Usage of this method is similar to TimeCoord().

Definition at line 440 of file Cluster.h.

Referenced by cluster::ClusterMerger::AdoptEnd().

440 { return fSigmaEndTicks[side]; }

float fSigmaEndTicks[NEnds]

Definition: Cluster.h:115

float recob::Cluster::SigmaTickCoord ( unsigned int side ) const

inline

Returns the uncertainty on tick coordinate of one of the end sides of the cluster.

Parameters

side	clStart for start, clEnd for end of the cluster

Returns: uncertainty on tick coordinate of the requested end of the cluster

See also: SigmaStartTick(), SigmaEndTick(), SigmaWireCoord(), TimeCoord()

Usage of this method is similar to TimeCoord().

Definition at line 441 of file Cluster.h.

441 { return fSigmaEndTicks[side]; }

float fSigmaEndTicks[NEnds]

Definition: Cluster.h:115

float recob::Cluster::SigmaWireCoord ( ClusterEnds_t side ) const

inline

Returns the uncertainty on wire coordinate of one of the end sides of the cluster.

Parameters

side	clStart for start, clEnd for end of the cluster

Returns: uncertainty on wire coordinate of the requested end of the cluster

See also: SigmaStartWire(), SigmaEndWire(), SigmaTickCoord(), TimeCoord()

Usage of this method is similar to WireCoord().

Definition at line 427 of file Cluster.h.

Referenced by cluster::ClusterMerger::AdoptEnd().

427 { return fSigmaEndWires[side]; }

float fSigmaEndWires[NEnds]

Definition: Cluster.h:107

float recob::Cluster::SigmaWireCoord ( unsigned int side ) const

inline

Returns the uncertainty on wire coordinate of one of the end sides of the cluster.

Parameters

side	clStart for start, clEnd for end of the cluster

Returns: uncertainty on wire coordinate of the requested end of the cluster

See also: SigmaStartWire(), SigmaEndWire(), SigmaTickCoord(), TimeCoord()

Usage of this method is similar to WireCoord().

Definition at line 428 of file Cluster.h.

428 { return fSigmaEndWires[side]; }

float fSigmaEndWires[NEnds]

Definition: Cluster.h:107

float recob::Cluster::StartAngle ( ) const

inline

Returns the starting angle of the cluster.

Returns: angle in radians

See also: EndAngle(), Angle()

The angle of the group of hits at the start position of the cluster is returned, defined $\alpha \in [ -\pi, \pi ]$ and so that $\tan(\alpha) = dT/dW$ (or, more precisely, angle = atan2(dT, dW)). The elements are expressed in physical distances and therefore this represents a physical angle on the plane orthogonal to the wires in the view and containing the drift direction ("x"); the angle is 0 or $\pi$ when lying on the wire plane, $\pm\pi/2$ when pointing into/from the wire plane. The angle is pointing toward the inside of the cluster (that is, $ dW $ is positive going from the first wire on). This value can be result of extrapolation or average from a range of hits.

Definition at line 475 of file Cluster.h.

References clStart.

Referenced by shwf::ShowerReco::GetVertexAndAnglesFromCluster(), trkf::SpacePts::produce(), and trkf::CCTrackMaker::produce().

475 { return fAngles[clStart]; }

Represents the most likely start of the cluster.

Definition: Cluster.h:78

float fAngles[NEnds]

Definition: Cluster.h:130

float recob::Cluster::StartCharge ( ) const

inline

Returns the charge on the first wire of the cluster.

Returns: charge on the first wire in ADC counts, negative if not available

See also: EndCharge(), EdgeCharge()

The returned value is in unit of ADC count, although it may be fractional. This value can be result of extrapolation or average from a range of hits.

Definition at line 454 of file Cluster.h.

References clStart.

Referenced by trkf::CCTrackMaker::produce().

454 { return fEndCharges[clStart]; }

float fEndCharges[NEnds]

Definition: Cluster.h:120

Represents the most likely start of the cluster.

Definition: Cluster.h:78

float recob::Cluster::StartOpeningAngle ( ) const

inline

Returns the opening angle at the start of the cluster.

Returns: opening angle in radians

See also: EndOpeningAngle(), OpeningAngle()

The returned value is from physical coordinates and in the range $[ 0, \pi ]$ .

Definition at line 485 of file Cluster.h.

References clStart.

485 { return fOpeningAngles[clStart]; }

Represents the most likely start of the cluster.

Definition: Cluster.h:78

float fOpeningAngles[NEnds]

Definition: Cluster.h:137

float recob::Cluster::StartTick ( ) const

inline

Returns the tick coordinate of the start of the cluster.

Returns: tick coordinate of the start of the cluster (may br fractional)

See also: EndTick(), TickCoord(), StartWire()

The tick coordinate is in tick units (the homogenized coordinate), but can have a fractional part describing the relative time from the previous tick.

Definition at line 297 of file Cluster.h.

References clStart.

Referenced by Cluster(), filter::MuonFilter::filter(), shwf::ShowerReco::GetVertexAndAnglesFromCluster(), recob::operator<(), recob::operator<<(), trkf::SpacePts::produce(), cosmic::CosmicClusterTagger::produce(), and trkf::CCTrackMaker::produce().

297 { return fEndTicks[clStart]; }

float fEndTicks[NEnds]

Definition: Cluster.h:111

Represents the most likely start of the cluster.

Definition: Cluster.h:78

float recob::Cluster::StartWire ( ) const

inline

Returns the wire coordinate of the start of the cluster.

Returns: wire coordinate of the start of the cluster (may lie between wires)

See also: EndWire(), WireCoord(), StartTick()

The wire coordinate is in wire units (the homogenized coordinate), but can have a fractional part describing the relative distance from the previous wire.

Definition at line 286 of file Cluster.h.

References clStart.

Referenced by cluster::ClusterMerger::Add(), Cluster(), filter::MuonFilter::filter(), shwf::ShowerReco::GetVertexAndAnglesFromCluster(), recob::operator<<(), trkf::SpacePts::produce(), and trkf::CCTrackMaker::produce().

286 { return fEndWires[clStart]; }

float fEndWires[NEnds]

Definition: Cluster.h:103

Represents the most likely start of the cluster.

Definition: Cluster.h:78

float recob::Cluster::SummedADC ( ) const

inline

Returns the total charge of the cluster from signal ADC counts.

Returns: total charge of the cluster from signal ADC, in ADC counts

See also: SummedADCstdDev(), SummedADCaverage(), Integral(), Charge()

The total charge is computed as the sum of the charge of all the hits. The charge of a single hit includes the signal ADC counts and is obtained by recob::Hit::SummedADC().

Definition at line 634 of file Cluster.h.

References cmADC.

Referenced by Cluster(), and recob::operator<<().

634 { return fChargeSum[cmADC]; }

recob::Cluster::cmADC

Sums directly from ADC counts.

Definition: Cluster.h:86

float fChargeSum[NChargeModes]

Definition: Cluster.h:145

float recob::Cluster::SummedADCaverage ( ) const

inline

Returns the average signal ADC counts of the cluster hits.

Returns: average of the signal of the cluster hits, in ADC counts

See also: SummedADC(), SummedADCstdDev(), IntegralAverage(), ChargeAverage()

The charge of a single hit includes the signal ADC counts and is obtained by recob::Hit::SummedADC(). It should return 0 if no hit is available.

Definition at line 656 of file Cluster.h.

References cmADC.

656 { return fChargeAverage[cmADC]; }

recob::Cluster::cmADC

Sums directly from ADC counts.

Definition: Cluster.h:86

float fChargeAverage[NChargeModes]

Definition: Cluster.h:153

float recob::Cluster::SummedADCstdDev ( ) const

inline

Returns the standard deviation of the signal ADC counts of the cluster hits.

Returns: standard deviation of the signal of the cluster hits, in ADC counts

See also: SummedADC(), SummedADCaverage(), IntegralStdDev(), ChargeStdDev()

The charge of a single hit includes the signal ADC counts and is obtained by recob::Hit::SummedADC(). It should return 0 if less than two hits are available.

Definition at line 645 of file Cluster.h.

References cmADC.

645 { return fChargeStdDev[cmADC]; }

recob::Cluster::cmADC

Sums directly from ADC counts.

Definition: Cluster.h:86

float fChargeStdDev[NChargeModes]

Definition: Cluster.h:149

float recob::Cluster::TickCoord ( ClusterEnds_t side ) const

inline

Returns the tick coordinate of one of the end sides of the cluster.

Parameters

side	clStart for start, clEnd for end of the cluster

Returns: tick coordinate of the requested end of the cluster (may be fractional)

See also: StartTick(), EndTick(), WireCoord()

The tick coordinate is in tick units (the homogenized coordinate), but can have a fractional part describing the relative time from the previous tick.

For algorithms not distinguishing start and end, all the ends can be tested by the loop:

for (unsigned int side = recob::Cluster::clFirstEnd;
  side < recob::Cluster::NEnds; ++side)
{
  float wire = cluster.WireCoord(side);
  float tick = cluster.TickCoord(side);
  // ...
} // for

Definition at line 413 of file Cluster.h.

Referenced by cluster::ClusterMerger::AdoptEnd().

413 { return fEndTicks[side]; }

float fEndTicks[NEnds]

Definition: Cluster.h:111

float recob::Cluster::TickCoord ( unsigned int side ) const

inline

Returns the tick coordinate of one of the end sides of the cluster.

Parameters

side	clStart for start, clEnd for end of the cluster

Returns: tick coordinate of the requested end of the cluster (may be fractional)

See also: StartTick(), EndTick(), WireCoord()

The tick coordinate is in tick units (the homogenized coordinate), but can have a fractional part describing the relative time from the previous tick.

For algorithms not distinguishing start and end, all the ends can be tested by the loop:

for (unsigned int side = recob::Cluster::clFirstEnd;
  side < recob::Cluster::NEnds; ++side)
{
  float wire = cluster.WireCoord(side);
  float tick = cluster.TickCoord(side);
  // ...
} // for

Definition at line 414 of file Cluster.h.

414 { return fEndTicks[side]; }

Referenced by cluster::ClusterMerger::Add(), cluster::ClusterPCA::analyze(), cluster::ClusterMatchAlg::AppendClusterInfo(), Cluster(), trkf::BezierTrackerModule::GetHitsFromClusters(), trkf::SeedFinderModule::GetSortedHitsFromClusters(), recob::operator<(), recob::operator<<(), lar_pandora::LArPandoraEventDump::PrintCluster(), trkf::SpacePointCheater::produce(), trkf::SpacePointFinder::produce(), cluster::LineMerger::produce(), trkf::SpacePts::produce(), and trkf::Track3Dreco::produce().

float fEndTicks[NEnds]

Definition: Cluster.h:111

geo::View_t recob::Cluster::View ( ) const

inline

Returns the view for this cluster.

Definition at line 741 of file Cluster.h.

References fView.

741 { return fView; }

recob::Cluster::fView

geo::View_t fView

View for this cluster.

Definition: Cluster.h:168

float recob::Cluster::Width ( ) const

inline

A measure of the cluster width, in homogenized units.

Definition at line 727 of file Cluster.h.

References fWidth.

Referenced by cluster::ClusterMerger::Add(), and recob::operator<<().

727 { return fWidth; }

recob::Cluster::fWidth

float fWidth

A measure of the cluster width, in homogenized units.

Definition: Cluster.h:160

float recob::Cluster::WireCoord ( ClusterEnds_t side ) const

inline

Returns the wire coordinate of one of the end sides of the cluster.

Parameters

side	clStart for start, clEnd for end of the cluster

Returns: wire coordinate of the requested end of the cluster (may lie between wires)

See also: StartWire(), EndWire(), TickCoord()

The wire coordinate is in wire units (the homogenized coordinate), but can have a fractional part describing the relative distance from the previous wire.

For algorithms not distinguishing start and end, all the ends can be tested by the loop:

for (unsigned int side = recob::Cluster::clFirstEnd;
  side < recob::Cluster::NEnds; ++side)
{
  float wire = cluster.WireCoord(side);
  float tick = cluster.TickCoord(side);
  // ...
} // for

Definition at line 386 of file Cluster.h.

Referenced by cluster::ClusterMerger::AdoptEnd().

386 { return fEndWires[side]; }

float fEndWires[NEnds]

Definition: Cluster.h:103

float recob::Cluster::WireCoord ( unsigned int side ) const

inline

Number of hits in the cluster.

Definition at line 387 of file Cluster.h.

387 { return fEndWires[side]; }