Algorithm class inheriting cluster parameters. More...

#include <LazyClusterParamsAlg.h>

Inheritance diagram for cluster::LazyClusterParamsAlg:

Public Types
using	Measure_t = ClusterParamsAlgBase::Measure_t

Public Types inherited from cluster::ClusterParamsAlgBase
using	Measure_t = details::Measure_t< float >
	Type used to return values with errors. More...

Public Member Functions
	LazyClusterParamsAlg (cluster_params const &new_params)
	Constructor: references to the parameters (no copy is performed!) More...

void	Clear () override
	Restores the class to post-configuration, pre-initialization state; dummy. More...

void	SetHits (util::GeometryUtilities const &gser, std::vector< recob::Hit const * > const &hits) override
	Sets the list of input hits. More...

size_t	NHits () override
	Returns the number of hits in the cluster. More...

float	MultipleHitDensity () override
	Fraction of wires in the cluster with more than one hit. More...

float	Width (util::GeometryUtilities const &) override
	Computes the width of the cluster. More...

cluster_params const &	GetParams () const
	Returns the original precomputed parameters. More...


Measure_t	StartCharge (util::GeometryUtilities const &gser) override
	Computes the charge on the first and last wire of the track. More...

Measure_t	EndCharge (util::GeometryUtilities const &gser) override


Measure_t	StartAngle () override
	Computes the angle of the cluster. More...

Measure_t	EndAngle () override


Measure_t	StartOpeningAngle () override
	Computes the opening angle at the start or end of the cluster. More...

Measure_t	EndOpeningAngle () override

Cluster charge
Measure_t	Integral () override
	Computes the total charge of the cluster from Hit::Integral() More...

Measure_t	IntegralStdDev () override
	Computes the standard deviation on the charge of the cluster hits. More...

Measure_t	SummedADC () override
	Computes the total charge of the cluster from Hit::SummedADC() More...

Measure_t	SummedADCStdDev () override
	Computes the standard deviation on the charge of the cluster hits. More...

Public Member Functions inherited from cluster::ClusterParamsAlgBase
virtual	~ClusterParamsAlgBase ()=default

virtual void	SetHits (util::GeometryUtilities const &gser, std::vector< recob::Hit > const &hits)
	Sets the list of input hits. More...

virtual void	SetVerbose (int level=1)
	Set the verbosity level. More...

Protected Attributes
cluster_params const &	params
	the parameters, already computed More...

Protected Attributes inherited from cluster::ClusterParamsAlgBase
int	verbose = 0
	verbosity level: 0 is normal, negative is even quieter More...

Additional Inherited Members
Static Protected Member Functions inherited from cluster::ClusterParamsAlgBase
static std::logic_error	NotImplemented (std::string function_name)

Detailed Description

Algorithm class inheriting cluster parameters.

See also: ClusterParamsAlg

This class wraps ClusterParamsAlg class, designed in the context of shower reconstruction, to expose a standard ClusterParamsBaseAlg interface. All the information is supposed to have been computed already.

In addition to the standard interface, GetParams() is also available.

Definition at line 39 of file LazyClusterParamsAlg.h.

Member Typedef Documentation

using cluster::LazyClusterParamsAlg::Measure_t = ClusterParamsAlgBase::Measure_t

Definition at line 41 of file LazyClusterParamsAlg.h.

Constructor & Destructor Documentation

cluster::LazyClusterParamsAlg::LazyClusterParamsAlg ( cluster_params const & new_params )

inline

Constructor: references to the parameters (no copy is performed!)

Definition at line 44 of file LazyClusterParamsAlg.h.

44 : params(new_params) {}

cluster::LazyClusterParamsAlg::params

cluster_params const & params

the parameters, already computed

Definition: LazyClusterParamsAlg.h:183

Member Function Documentation

void cluster::LazyClusterParamsAlg::Clear ( void )

inlineoverridevirtual

Restores the class to post-configuration, pre-initialization state; dummy.

Reimplemented from cluster::ClusterParamsAlgBase.

Definition at line 48 of file LazyClusterParamsAlg.h.

49 {}

cluster::LazyClusterParamsAlg::Measure_t cluster::LazyClusterParamsAlg::EndAngle ( )

overridevirtual

Reimplemented from cluster::ClusterParamsAlgBase.

Definition at line 44 of file LazyClusterParamsAlg.cxx.

 {
   return StartAngle();
 }

cluster::LazyClusterParamsAlg::Measure_t cluster::LazyClusterParamsAlg::EndCharge ( util::GeometryUtilities const & gser )

overridevirtual

Reimplemented from cluster::ClusterParamsAlgBase.

Definition at line 30 of file LazyClusterParamsAlg.cxx.

 {
   return {(float)params.end_charge};
 }

cluster::LazyClusterParamsAlg::Measure_t cluster::LazyClusterParamsAlg::EndOpeningAngle ( )

overridevirtual

Reimplemented from cluster::ClusterParamsAlgBase.

Definition at line 58 of file LazyClusterParamsAlg.cxx.

 {
   return {(float)params.closing_angle_charge_wgt};
 }

cluster_params const& cluster::LazyClusterParamsAlg::GetParams ( ) const

inline

Returns the original precomputed parameters.

Definition at line 177 of file LazyClusterParamsAlg.h.

     {
       return params;
     }

cluster::LazyClusterParamsAlg::Measure_t cluster::LazyClusterParamsAlg::Integral ( )

overridevirtual

Computes the total charge of the cluster from Hit::Integral()

Returns: total charge of the cluster, in ADC count units

See also: IntegralStdDev(), SummedADC()

ClusterParamsAlg computes the sum from all hits.

Reimplemented from cluster::ClusterParamsAlgBase.

Definition at line 65 of file LazyClusterParamsAlg.cxx.

 {
   return {(float)params.sum_charge};
 }

cluster::LazyClusterParamsAlg::Measure_t cluster::LazyClusterParamsAlg::IntegralStdDev ( )

overridevirtual

Computes the standard deviation on the charge of the cluster hits.

Returns: the standard deviation of charge of hits, in ADC count units

See also: Integral()

ClusterParamsAlg computes the standard deviation of the sample of charges from all hits. Hit charge is obtained by recob::Hit::Integral().

Reimplemented from cluster::ClusterParamsAlgBase.

Definition at line 72 of file LazyClusterParamsAlg.cxx.

 {
   return {(float)params.rms_charge};
 }

float cluster::LazyClusterParamsAlg::MultipleHitDensity ( )

overridevirtual

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

Returns: fraction of wires with more than one hit, or 0 if no wires

Returns a quantity defined as NMultiHitWires / NWires, where NWires is the number of wires hosting at least one hit of this cluster, and NMultiHitWires is the number of wires which have more than just one hit.

Reimplemented from cluster::ClusterParamsAlgBase.

Definition at line 101 of file LazyClusterParamsAlg.cxx.

 {
   return params.N_Wires ? params.multi_hit_wires / params.N_Wires : 0.;
 }

size_t cluster::LazyClusterParamsAlg::NHits ( )

overridevirtual

Returns the number of hits in the cluster.

Reimplemented from cluster::ClusterParamsAlgBase.

Definition at line 94 of file LazyClusterParamsAlg.cxx.

 {
   return (size_t)params.N_Hits;
 }

void cluster::LazyClusterParamsAlg::SetHits	(	util::GeometryUtilities const &	gser,
		std::vector< recob::Hit const * > const &	hits
	)

inlineoverridevirtual

Sets the list of input hits.

Parameters

hits	list of hits

Exceptions

undefined in case of error, this method can throw (anything)

The parameters have already been computed. This function is dummy.

Implements cluster::ClusterParamsAlgBase.

Definition at line 60 of file LazyClusterParamsAlg.h.

62 {}

cluster::LazyClusterParamsAlg::Measure_t cluster::LazyClusterParamsAlg::StartAngle ( )

overridevirtual

Computes the angle of the cluster.

Returns: angle of the cluster in the wire x time space, in radians

Uses the coordinates from the hits, weighted by charge (Hit::Integral()) to compute a slope in the homogenized wire x time space. The homogenized space has both wires and ticks converted into a distance (by using detector parameters: wire pitch and drift velocity).

The angle is in the $[ -\pi, \pi ]$ range, with 0 corresponding to a cluster parallel to the wire plane and $\pi$ to a cluster orthogonal to the wire plane, going farther from it.

Note: Both the methods return the same value.

Reimplemented from cluster::ClusterParamsAlgBase.

Definition at line 37 of file LazyClusterParamsAlg.cxx.

 {
   return {(float)util::DegreesToRadians(params.cluster_angle_2d)};
 }

cluster::LazyClusterParamsAlg::Measure_t cluster::LazyClusterParamsAlg::StartCharge ( util::GeometryUtilities const & gser )

overridevirtual

Computes the charge on the first and last wire of the track.

Returns: the charge in ADC counts, with uncertainty

The implementation in ClusterParamsAlg provides an estimation of the charge collected in the first or last 1 cm of the cluster, using a linear fit on the deposited charge to reduce fluctuations.

Reimplemented from cluster::ClusterParamsAlgBase.

Definition at line 23 of file LazyClusterParamsAlg.cxx.

 {
   return {(float)params.start_charge};
 }

cluster::LazyClusterParamsAlg::Measure_t cluster::LazyClusterParamsAlg::StartOpeningAngle ( )

overridevirtual

Computes the opening angle at the start or end of the cluster.

Returns: angle at the start of the cluster, in radians

This algorithm returns an opening angle after weighting the hits by their charge (as defined bu Hit::Integral());

Reimplemented from cluster::ClusterParamsAlgBase.

Definition at line 51 of file LazyClusterParamsAlg.cxx.

 {
   return {(float)params.opening_angle_charge_wgt};
 }

cluster::LazyClusterParamsAlg::Measure_t cluster::LazyClusterParamsAlg::SummedADC ( )

overridevirtual

Computes the total charge of the cluster from Hit::SummedADC()

Returns: total charge of the cluster, in ADC count units

See also: SummedADCStdDev(), Integral()

ClusterParamsAlg computes the sum from all hits.

Reimplemented from cluster::ClusterParamsAlgBase.

Definition at line 79 of file LazyClusterParamsAlg.cxx.

 {
   const double sumADC = params.sum_ADC;
   return {(float)sumADC, (float)std::sqrt(sumADC)};
 }

cluster::LazyClusterParamsAlg::Measure_t cluster::LazyClusterParamsAlg::SummedADCStdDev ( )

overridevirtual

Computes the standard deviation on the charge of the cluster hits.

Returns: the standard deviation of charge of hits, in ADC count units

See also: SummedADC()

ClusterParamsAlg computes the standard deviation of the sample of charges from all hits. Hit charge is obtained by recob::Hit::SummedADC().

Reimplemented from cluster::ClusterParamsAlgBase.

Definition at line 87 of file LazyClusterParamsAlg.cxx.

 {
   return {(float)params.rms_ADC};
 }

float cluster::LazyClusterParamsAlg::Width ( util::GeometryUtilities const & )

overridevirtual

Computes the width of the cluster.

Returns: width of the cluster

Todo:: provide a description of the algorithm by words

Reimplemented from cluster::ClusterParamsAlgBase.

Definition at line 108 of file LazyClusterParamsAlg.cxx.

 {
   return params.width;
 }

Member Data Documentation

cluster_params const& cluster::LazyClusterParamsAlg::params

protected

the parameters, already computed

Definition at line 183 of file LazyClusterParamsAlg.h.

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

larreco/larreco/RecoAlg/ClusterRecoUtil/LazyClusterParamsAlg.h
larreco/larreco/RecoAlg/ClusterRecoUtil/LazyClusterParamsAlg.cxx

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation