Class merging clusters: recomputes start and end position and hit list. More...

Inheritance diagram for cluster::ClusterMerger:

Public Types
using	HitPtr_t = art::Ptr< recob::Hit >
	type of pointer to hits More...

using	HitVector_t = std::vector< HitPtr_t >
	vector of pointers to hits More...

using	ID_t = recob::Cluster::ID_t
	Type of cluster ID. More...

using	ClusterEnds_t = recob::Cluster::ClusterEnds_t

Public Member Functions
	ClusterMerger ()=default

	ClusterMerger (recob::Cluster const &cluster)

bool	Add (recob::Cluster const &cluster)
	Merges a single cluster into this object. More...

Accessors
float	fEndWires [ClusterEnds_t::NEnds]
	Data referring to start and end of the cluster. More...

float	fSigmaEndWires [ClusterEnds_t::NEnds]
	Uncertainty on wire coordinate of the start and end of the cluster. More...

float	fEndTicks [ClusterEnds_t::NEnds]
	Tick coordinate of the start and end of the cluster. More...

float	fSigmaEndTicks [ClusterEnds_t::NEnds]
	Uncertainty on tick coordinate of the start and end of the cluster. More...

float	fEndCharges [ClusterEnds_t::NEnds]
	Charge on the start and end wire of the cluster. More...

float	fAngles [ClusterEnds_t::NEnds]
	Angle of the start and end of the cluster, defined in [-pi,pi]. More...

float	fOpeningAngles [ClusterEnds_t::NEnds]
	Opening angle of the cluster shape at the start and end of the cluster. More...

float	fWidth
	A measure of the cluster width, in homogenized units. More...

geo::View_t	fView
	View for this cluster. More...

geo::PlaneID	fPlaneID
	Location of the start of the cluster. More...

unsigned int	n_clusters = 0
	number of clusters added so far More...

float	StartWire () const
	Returns the wire coordinate of the start of the cluster. More...

float	StartTick () const
	Returns the tick coordinate of the start of the cluster. More...

float	SigmaStartWire () const
	Returns the uncertainty on wire coordinate of the start of the cluster. More...

float	SigmaStartTick () const
	Data referring to start and end of the cluster. More...

float	EndWire () const
	Returns the wire coordinate of the end of the cluster. More...

float	EndTick () const
	Returns the tick coordinate of the end of the cluster. More...

float	SigmaEndWire () const
	Returns the uncertainty on wire coordinate of the end of the cluster. More...

float	SigmaEndTick () const
	Returns the uncertainty on tick coordinate of the end of the cluster. More...

float	WireCoord (ClusterEnds_t side) const
	Returns the wire coordinate of one of the end sides of the cluster. More...

float	TickCoord (ClusterEnds_t side) const
	Returns the tick coordinate of one of the end sides of the cluster. More...

float	SigmaWireCoord (ClusterEnds_t side) const
	Returns the uncertainty on wire coordinate of one of the end sides of the cluster. More...

float	SigmaTickCoord (ClusterEnds_t side) const
	Returns the uncertainty on tick coordinate of one of the end sides of the cluster. More...

float	StartCharge () const
	Returns the charge on the first wire of the cluster. More...

float	StartAngle () const
	Returns the starting angle of the cluster. More...

float	StartOpeningAngle () const
	Returns the opening angle at the start of the cluster. More...

float	EndCharge () const
	Returns the charge on the last wire of the cluster. More...

float	EndAngle () const
	Returns the ending angle of the cluster. More...

float	EndOpeningAngle () const
	Returns the opening angle at the end of the cluster. More...

float	EdgeCharge (ClusterEnds_t side) const
	Returns the charge on the first or last wire of the cluster. More...

float	Angle (ClusterEnds_t side) const
	Returns the angle at either end of the cluster. More...

float	OpeningAngle (ClusterEnds_t side) const
	Returns the opening angle at either end of the cluster. More...

float	Width () const
	A measure of the cluster width, in homogenized units. More...

geo::View_t	View () const
	Returns the view for this cluster. More...

geo::PlaneID	Plane () const
	Returns the plane ID this cluster lies on. More...

bool	hasPlane () const
	Returns whether geometry plane is valid. More...

void	AdoptEnd (recob::Cluster const &cluster, ClusterEnds_t iEnd)
	Imports all the member of the corresponding end. More...

template<typename T >
static void	top (T &var, T value)
	Data referring to start and end of the cluster. More...

template<typename T >
static void	bot (T &var, T value)
	Data referring to start and end of the cluster. More...

Detailed Description

Class merging clusters: recomputes start and end position and hit list.

Definition at line 90 of file LineMerger_module.cc.

Member Typedef Documentation

using cluster::ClusterMerger::ClusterEnds_t = recob::Cluster::ClusterEnds_t

Definition at line 99 of file LineMerger_module.cc.

using cluster::ClusterMerger::HitPtr_t = art::Ptr<recob::Hit>

type of pointer to hits

Definition at line 95 of file LineMerger_module.cc.

using cluster::ClusterMerger::HitVector_t = std::vector<HitPtr_t>

vector of pointers to hits

Definition at line 96 of file LineMerger_module.cc.

using cluster::ClusterMerger::ID_t = recob::Cluster::ID_t

Type of cluster ID.

Definition at line 98 of file LineMerger_module.cc.

Constructor & Destructor Documentation

cluster::ClusterMerger::ClusterMerger ( )

default

cluster::ClusterMerger::ClusterMerger ( recob::Cluster const & cluster )

inline

Definition at line 112 of file LineMerger_module.cc.

                                               :
       ClusterMerger()
       { Add(cluster); }

Member Function Documentation

bool cluster::ClusterMerger::Add ( recob::Cluster const & cluster )

Merges a single cluster into this object.

Parameters

cluster the cluster to be merged

Returns: whether the addition was successful

The two ends of the cluster are merged into this one, that gets extended.

The new cluster must have the same view as the prevopus ones and must lay on the same plane. If the new cluster has invalid plane, the current one is kept; if the current plane is invalid, it is overwritten (that means that if both are invalid, the merged cluster will also have an invalid plane).

Note that this code is crap unless the cluster is track-like.

Definition at line 276 of file LineMerger_module.cc.

References recob::Cluster::EndWire(), recob::Cluster::hasPlane(), recob::Cluster::isValid(), recob::Cluster::Plane(), recob::Cluster::StartWire(), recob::Cluster::View(), and recob::Cluster::Width().

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

                                                      {
     if (!cluster.isValid()) return false;
     
     if (n_clusters == 0) { // special case: we are still empty
       AdoptEnd(cluster, ClusterEnds_t::clStart);
       AdoptEnd(cluster, ClusterEnds_t::clEnd);
       fWidth           = cluster.Width();
       fView            = cluster.View();
       fPlaneID         = cluster.Plane();
       ++n_clusters;
       return true;
     } // if empty
     
     if (cluster.View() != View()) return false;
     
     if (cluster.hasPlane() && hasPlane() && (cluster.Plane() != Plane()))
       return false;
     
     // this code has been moved here from the old recon::Cluster::operator+
     // of recob::Cluster v13.
     if (cluster.StartWire() < StartWire()) { // adopt the new start
       AdoptEnd(cluster, ClusterEnds_t::clStart);
     }
     if (cluster.EndWire() < EndWire()) { // adopt the new end
       AdoptEnd(cluster, ClusterEnds_t::clEnd);
     }
     
     top(fWidth, cluster.Width()); // extend width
     
     if (!hasPlane()) fPlaneID = cluster.Plane();
     
     return true;
   } // ClusterMerger::Add(Cluster)

void cluster::ClusterMerger::AdoptEnd	(	recob::Cluster const &	cluster,
		ClusterEnds_t	iEnd
	)

protected

Imports all the member of the corresponding end.

Definition at line 264 of file LineMerger_module.cc.

References recob::Cluster::Angle(), recob::Cluster::EdgeCharge(), recob::Cluster::OpeningAngle(), recob::Cluster::SigmaTickCoord(), recob::Cluster::SigmaWireCoord(), recob::Cluster::TickCoord(), and recob::Cluster::WireCoord().

Referenced by bot().

   {
     const ClusterEnds_t iDestEnd = iSrcEnd;
     fEndWires[iDestEnd]      = cluster.WireCoord(iSrcEnd);
     fSigmaEndWires[iDestEnd] = cluster.SigmaWireCoord(iSrcEnd);
     fEndTicks[iDestEnd]      = cluster.TickCoord(iSrcEnd);
     fSigmaEndTicks[iDestEnd] = cluster.SigmaTickCoord(iSrcEnd);
     fEndCharges[iDestEnd]    = cluster.EdgeCharge(iSrcEnd);
     fAngles[iDestEnd]        = cluster.Angle(iSrcEnd);
     fOpeningAngles[iDestEnd] = cluster.OpeningAngle(iSrcEnd);
   } // ClusterMerger::AdoptEnd()

float cluster::ClusterMerger::Angle ( ClusterEnds_t side ) const

inline

Returns the angle at either end of the cluster.

Definition at line 201 of file LineMerger_module.cc.

201 { return fAngles[side]; }

cluster::ClusterMerger::fAngles

float fAngles[ClusterEnds_t::NEnds]

Angle of the start and end of the cluster, defined in [-pi,pi].

Definition: LineMerger_module.cc:240

template<typename T >

static void cluster::ClusterMerger::bot	(	T &	var,
		T	value
	)

inlinestaticprotected

Data referring to start and end of the cluster.

Definition at line 260 of file LineMerger_module.cc.

References AdoptEnd(), and fhicl::detail::atom::value().

260 { if (value < var) var = value; }

fhicl::detail::atom::value

std::string value(boost::any const &)

Definition: printing_helpers.cc:97

float cluster::ClusterMerger::EdgeCharge ( ClusterEnds_t side ) const

inline

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

Definition at line 197 of file LineMerger_module.cc.

197 { return fEndCharges[side]; }

cluster::ClusterMerger::fEndCharges

float fEndCharges[ClusterEnds_t::NEnds]

Charge on the start and end wire of the cluster.

Definition: LineMerger_module.cc:237

float cluster::ClusterMerger::EndAngle ( ) const

inline

Returns the ending angle of the cluster.

Definition at line 191 of file LineMerger_module.cc.

191 { return fAngles[ClusterEnds_t::clEnd]; }

cluster::ClusterMerger::fAngles

float fAngles[ClusterEnds_t::NEnds]

Angle of the start and end of the cluster, defined in [-pi,pi].

Definition: LineMerger_module.cc:240

float cluster::ClusterMerger::EndCharge ( ) const

inline

Returns the charge on the last wire of the cluster.

Definition at line 188 of file LineMerger_module.cc.

188 { return fEndCharges[ClusterEnds_t::clEnd]; }

cluster::ClusterMerger::fEndCharges

float fEndCharges[ClusterEnds_t::NEnds]

Charge on the start and end wire of the cluster.

Definition: LineMerger_module.cc:237

float cluster::ClusterMerger::EndOpeningAngle ( ) const

inline

Returns the opening angle at the end of the cluster.

Definition at line 194 of file LineMerger_module.cc.

194 { return fOpeningAngles[ClusterEnds_t::clEnd]; }

cluster::ClusterMerger::fOpeningAngles

float fOpeningAngles[ClusterEnds_t::NEnds]

Opening angle of the cluster shape at the start and end of the cluster.

Definition: LineMerger_module.cc:243

float cluster::ClusterMerger::EndTick ( ) const

inline

Returns the tick coordinate of the end of the cluster.

Definition at line 153 of file LineMerger_module.cc.

153 { return fEndTicks[ClusterEnds_t::clEnd]; }

cluster::ClusterMerger::fEndTicks

float fEndTicks[ClusterEnds_t::NEnds]

Tick coordinate of the start and end of the cluster.

Definition: LineMerger_module.cc:231

float cluster::ClusterMerger::EndWire ( ) const

inline

Returns the wire coordinate of the end of the cluster.

Definition at line 150 of file LineMerger_module.cc.

150 { return fEndWires[ClusterEnds_t::clEnd]; }

cluster::ClusterMerger::fEndWires

float fEndWires[ClusterEnds_t::NEnds]

Data referring to start and end of the cluster.

Definition: LineMerger_module.cc:225

bool cluster::ClusterMerger::hasPlane ( ) const

inline

Returns whether geometry plane is valid.

Definition at line 219 of file LineMerger_module.cc.

219 { return Plane().isValid; }

geo::CryostatID::isValid

bool isValid

Whether this ID points to a valid element.

Definition: geo_types.h:129

cluster::ClusterMerger::Plane

geo::PlaneID Plane() const

Returns the plane ID this cluster lies on.

Definition: LineMerger_module.cc:216

float cluster::ClusterMerger::OpeningAngle ( ClusterEnds_t side ) const

inline

Returns the opening angle at either end of the cluster.

Definition at line 205 of file LineMerger_module.cc.

205 { return fOpeningAngles[side]; }

cluster::ClusterMerger::fOpeningAngles

float fOpeningAngles[ClusterEnds_t::NEnds]

Opening angle of the cluster shape at the start and end of the cluster.

Definition: LineMerger_module.cc:243

geo::PlaneID cluster::ClusterMerger::Plane ( ) const

inline

Returns the plane ID this cluster lies on.

Definition at line 216 of file LineMerger_module.cc.

216 { return fPlaneID; }

cluster::ClusterMerger::fPlaneID

geo::PlaneID fPlaneID

Location of the start of the cluster.

Definition: LineMerger_module.cc:250

float cluster::ClusterMerger::SigmaEndTick ( ) const

inline

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

Definition at line 159 of file LineMerger_module.cc.

159 { return fSigmaEndTicks[ClusterEnds_t::clEnd]; }

cluster::ClusterMerger::fSigmaEndTicks

float fSigmaEndTicks[ClusterEnds_t::NEnds]

Uncertainty on tick coordinate of the start and end of the cluster.

Definition: LineMerger_module.cc:234

float cluster::ClusterMerger::SigmaEndWire ( ) const

inline

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

Definition at line 156 of file LineMerger_module.cc.

156 { return fSigmaEndWires[ClusterEnds_t::clEnd]; }

cluster::ClusterMerger::fSigmaEndWires

float fSigmaEndWires[ClusterEnds_t::NEnds]

Uncertainty on wire coordinate of the start and end of the cluster.

Definition: LineMerger_module.cc:228

float cluster::ClusterMerger::SigmaStartTick ( ) const

inline

Data referring to start and end of the cluster.

Definition at line 147 of file LineMerger_module.cc.

147 { return fSigmaEndTicks[ClusterEnds_t::clStart]; }

cluster::ClusterMerger::fSigmaEndTicks

float fSigmaEndTicks[ClusterEnds_t::NEnds]

Uncertainty on tick coordinate of the start and end of the cluster.

Definition: LineMerger_module.cc:234

float cluster::ClusterMerger::SigmaStartWire ( ) const

inline

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

Definition at line 144 of file LineMerger_module.cc.

144 { return fSigmaEndWires[ClusterEnds_t::clStart]; }

cluster::ClusterMerger::fSigmaEndWires

float fSigmaEndWires[ClusterEnds_t::NEnds]

Uncertainty on wire coordinate of the start and end of the cluster.

Definition: LineMerger_module.cc:228

float cluster::ClusterMerger::SigmaTickCoord ( ClusterEnds_t side ) const

inline

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

Definition at line 174 of file LineMerger_module.cc.

174 { return fSigmaEndTicks[side]; }

cluster::ClusterMerger::fSigmaEndTicks

float fSigmaEndTicks[ClusterEnds_t::NEnds]

Uncertainty on tick coordinate of the start and end of the cluster.

Definition: LineMerger_module.cc:234

float cluster::ClusterMerger::SigmaWireCoord ( ClusterEnds_t side ) const

inline

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

Definition at line 170 of file LineMerger_module.cc.

170 { return fSigmaEndWires[side]; }

cluster::ClusterMerger::fSigmaEndWires

float fSigmaEndWires[ClusterEnds_t::NEnds]

Uncertainty on wire coordinate of the start and end of the cluster.

Definition: LineMerger_module.cc:228

float cluster::ClusterMerger::StartAngle ( ) const

inline

Returns the starting angle of the cluster.

Definition at line 182 of file LineMerger_module.cc.

182 { return fAngles[ClusterEnds_t::clStart]; }

cluster::ClusterMerger::fAngles

float fAngles[ClusterEnds_t::NEnds]

Angle of the start and end of the cluster, defined in [-pi,pi].

Definition: LineMerger_module.cc:240

float cluster::ClusterMerger::StartCharge ( ) const

inline

Returns the charge on the first wire of the cluster.

Definition at line 179 of file LineMerger_module.cc.

179 { return fEndCharges[ClusterEnds_t::clStart]; }

cluster::ClusterMerger::fEndCharges

float fEndCharges[ClusterEnds_t::NEnds]

Charge on the start and end wire of the cluster.

Definition: LineMerger_module.cc:237

float cluster::ClusterMerger::StartOpeningAngle ( ) const

inline

Returns the opening angle at the start of the cluster.

Definition at line 185 of file LineMerger_module.cc.

185 { return fOpeningAngles[ClusterEnds_t::clStart]; }

cluster::ClusterMerger::fOpeningAngles

float fOpeningAngles[ClusterEnds_t::NEnds]

Opening angle of the cluster shape at the start and end of the cluster.

Definition: LineMerger_module.cc:243

float cluster::ClusterMerger::StartTick ( ) const

inline

Returns the tick coordinate of the start of the cluster.

Definition at line 141 of file LineMerger_module.cc.

141 { return fEndTicks[ClusterEnds_t::clStart]; }

cluster::ClusterMerger::fEndTicks

float fEndTicks[ClusterEnds_t::NEnds]

Tick coordinate of the start and end of the cluster.

Definition: LineMerger_module.cc:231

float cluster::ClusterMerger::StartWire ( ) const

inline

Returns the wire coordinate of the start of the cluster.

Definition at line 138 of file LineMerger_module.cc.

138 { return fEndWires[ClusterEnds_t::clStart]; }

cluster::ClusterMerger::fEndWires

float fEndWires[ClusterEnds_t::NEnds]

Data referring to start and end of the cluster.

Definition: LineMerger_module.cc:225

float cluster::ClusterMerger::TickCoord ( ClusterEnds_t side ) const

inline

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

Definition at line 166 of file LineMerger_module.cc.

166 { return fEndTicks[side]; }

cluster::ClusterMerger::fEndTicks

float fEndTicks[ClusterEnds_t::NEnds]

Tick coordinate of the start and end of the cluster.

Definition: LineMerger_module.cc:231

template<typename T >

static void cluster::ClusterMerger::top	(	T &	var,
		T	value
	)

inlinestaticprotected

Data referring to start and end of the cluster.

Definition at line 258 of file LineMerger_module.cc.

References fhicl::detail::atom::value().

258 { if (value > var) var = value; }

fhicl::detail::atom::value

std::string value(boost::any const &)

Definition: printing_helpers.cc:97

geo::View_t cluster::ClusterMerger::View ( ) const

inline

Returns the view for this cluster.

Definition at line 213 of file LineMerger_module.cc.

213 { return fView; }

cluster::ClusterMerger::fView

geo::View_t fView

View for this cluster.

Definition: LineMerger_module.cc:248

float cluster::ClusterMerger::Width ( ) const

inline

A measure of the cluster width, in homogenized units.

Definition at line 210 of file LineMerger_module.cc.

210 { return fWidth; }

cluster::ClusterMerger::fWidth

float fWidth

A measure of the cluster width, in homogenized units.

Definition: LineMerger_module.cc:246

float cluster::ClusterMerger::WireCoord ( ClusterEnds_t side ) const

inline

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

Definition at line 162 of file LineMerger_module.cc.

162 { return fEndWires[side]; }

cluster::ClusterMerger::fEndWires

float fEndWires[ClusterEnds_t::NEnds]

Data referring to start and end of the cluster.

Definition: LineMerger_module.cc:225

Member Data Documentation

float cluster::ClusterMerger::fAngles[ClusterEnds_t::NEnds]

protected

Angle of the start and end of the cluster, defined in [-pi,pi].

Definition at line 240 of file LineMerger_module.cc.

float cluster::ClusterMerger::fEndCharges[ClusterEnds_t::NEnds]

protected

Charge on the start and end wire of the cluster.

Definition at line 237 of file LineMerger_module.cc.

float cluster::ClusterMerger::fEndTicks[ClusterEnds_t::NEnds]

protected

Tick coordinate of the start and end of the cluster.

Definition at line 231 of file LineMerger_module.cc.

float cluster::ClusterMerger::fEndWires[ClusterEnds_t::NEnds]

protected

Data referring to start and end of the cluster.

Definition at line 225 of file LineMerger_module.cc.

float cluster::ClusterMerger::fOpeningAngles[ClusterEnds_t::NEnds]

protected

Opening angle of the cluster shape at the start and end of the cluster.

Definition at line 243 of file LineMerger_module.cc.

geo::PlaneID cluster::ClusterMerger::fPlaneID

protected

Location of the start of the cluster.

Definition at line 250 of file LineMerger_module.cc.

float cluster::ClusterMerger::fSigmaEndTicks[ClusterEnds_t::NEnds]

protected

Uncertainty on tick coordinate of the start and end of the cluster.

Definition at line 234 of file LineMerger_module.cc.

float cluster::ClusterMerger::fSigmaEndWires[ClusterEnds_t::NEnds]

protected

Uncertainty on wire coordinate of the start and end of the cluster.

Definition at line 228 of file LineMerger_module.cc.

geo::View_t cluster::ClusterMerger::fView

protected

View for this cluster.

Definition at line 248 of file LineMerger_module.cc.

float cluster::ClusterMerger::fWidth

protected

A measure of the cluster width, in homogenized units.

Definition at line 246 of file LineMerger_module.cc.

unsigned int cluster::ClusterMerger::n_clusters = 0

protected

number of clusters added so far

Definition at line 252 of file LineMerger_module.cc.

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

larreco/v06_64_02/source/larreco/ClusterFinder/LineMerger_module.cc

Public Types

Public Member Functions

Accessors

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation