Pandora
Pandora source code navigator
Loading...
Searching...
No Matches
lar_content::ClusterAssociation Class Reference

ClusterAssociation class. More...

#include "ClusterAssociation.h"

Inheritance diagram for lar_content::ClusterAssociation:
Collaboration diagram for lar_content::ClusterAssociation:

Public Member Functions

 ClusterAssociation ()
 Default constructor.
 
 ClusterAssociation (const pandora::CartesianVector &upstreamMergePoint, const pandora::CartesianVector &upstreamMergeDirection, const pandora::CartesianVector &downstreamMergePoint, const pandora::CartesianVector &downstreamMergeDirection)
 Constructor.
 
const pandora::CartesianVector GetUpstreamMergePoint () const
 Returns the upstream cluster merge point.
 
const pandora::CartesianVector GetUpstreamMergeDirection () const
 Returns the cluster direction at the upstream merge point.
 
const pandora::CartesianVector GetDownstreamMergePoint () const
 Returns the downstream cluster merge point.
 
const pandora::CartesianVector GetDownstreamMergeDirection () const
 Returns the cluster direction at the downstream merge point.
 
const pandora::CartesianVector GetConnectingLineDirection () const
 Returns the unit vector of the line connecting the upstream and downstream merge points (upstream -> downstream)
 
void SetUpstreamMergePoint (const pandora::CartesianVector &upstreamMergePoint)
 Set the upstream merge point.
 
void SetDownstreamMergePoint (const pandora::CartesianVector &downstreamMergePoint)
 Set the downstream merge point.
 
bool operator== (const ClusterAssociation &clusterAssociation) const
 
bool operator< (const ClusterAssociation &clusterAssociation) const
 

Protected Member Functions

void UpdateConnectingLine ()
 Update the connecting line.
 

Protected Attributes

pandora::CartesianVector m_upstreamMergePoint
 The upstream cluster point to be used in the merging process.
 
pandora::CartesianVector m_upstreamMergeDirection
 The upstream cluster direction at the upstream merge point (points in the direction of the downstream cluster)
 
pandora::CartesianVector m_downstreamMergePoint
 The downstream cluster point to be used in the merging process.
 
pandora::CartesianVector m_downstreamMergeDirection
 The downstream cluster direction at the downstream merge point (points in the direction of the upstream cluster)
 
pandora::CartesianVector m_connectingLineDirection
 The unit vector of the line connecting the upstream and downstream merge points (upstream -> downstream)
 

Detailed Description

ClusterAssociation class.

Definition at line 18 of file ClusterAssociation.h.

Constructor & Destructor Documentation

◆ ClusterAssociation() [1/2]

lar_content::ClusterAssociation::ClusterAssociation ( )
inline

Default constructor.

Definition at line 151 of file ClusterAssociation.h.

◆ ClusterAssociation() [2/2]

lar_content::ClusterAssociation::ClusterAssociation ( const pandora::CartesianVector upstreamMergePoint,
const pandora::CartesianVector upstreamMergeDirection,
const pandora::CartesianVector downstreamMergePoint,
const pandora::CartesianVector downstreamMergeDirection 
)
inline

Constructor.

Parameters
upstreamMergePointthe upstream merge point
upstreamMergeDirectionthe cluster direction at the upstream merge point
downstreamMergePointthe downstream merge point
downstreamMergeDirectionthe cluster direction at the downstream merge point

Definition at line 162 of file ClusterAssociation.h.

Here is the call graph for this function:

Member Function Documentation

◆ GetConnectingLineDirection()

const pandora::CartesianVector lar_content::ClusterAssociation::GetConnectingLineDirection ( ) const
inline

Returns the unit vector of the line connecting the upstream and downstream merge points (upstream -> downstream)

Returns
the unit displacement vector from the upstream merge point to the downstream merge point

Definition at line 222 of file ClusterAssociation.h.

Here is the caller graph for this function:

◆ GetDownstreamMergeDirection()

const pandora::CartesianVector lar_content::ClusterAssociation::GetDownstreamMergeDirection ( ) const
inline

Returns the cluster direction at the downstream merge point.

Returns
the cluster direction at the downstream merge point

Definition at line 215 of file ClusterAssociation.h.

Here is the caller graph for this function:

◆ GetDownstreamMergePoint()

const pandora::CartesianVector lar_content::ClusterAssociation::GetDownstreamMergePoint ( ) const
inline

Returns the downstream cluster merge point.

Returns
the downstream merge point

Definition at line 208 of file ClusterAssociation.h.

Here is the caller graph for this function:

◆ GetUpstreamMergeDirection()

const pandora::CartesianVector lar_content::ClusterAssociation::GetUpstreamMergeDirection ( ) const
inline

Returns the cluster direction at the upstream merge point.

Returns
the cluster direction at the upstream merge point

Definition at line 201 of file ClusterAssociation.h.

Here is the caller graph for this function:

◆ GetUpstreamMergePoint()

const pandora::CartesianVector lar_content::ClusterAssociation::GetUpstreamMergePoint ( ) const
inline

Returns the upstream cluster merge point.

Returns
the upstream merge point

Definition at line 194 of file ClusterAssociation.h.

Here is the caller graph for this function:

◆ operator<()

bool lar_content::ClusterAssociation::operator< ( const ClusterAssociation clusterAssociation) const
inline

Definition at line 187 of file ClusterAssociation.h.

Here is the call graph for this function:

◆ operator==()

bool lar_content::ClusterAssociation::operator== ( const ClusterAssociation clusterAssociation) const
inline

Definition at line 177 of file ClusterAssociation.h.

Here is the call graph for this function:

◆ SetDownstreamMergePoint()

void lar_content::ClusterAssociation::SetDownstreamMergePoint ( const pandora::CartesianVector downstreamMergePoint)
inline

Set the downstream merge point.

Parameters
downstreamMergePointthe new downstream merge point

Definition at line 237 of file ClusterAssociation.h.

Here is the call graph for this function:

◆ SetUpstreamMergePoint()

void lar_content::ClusterAssociation::SetUpstreamMergePoint ( const pandora::CartesianVector upstreamMergePoint)
inline

Set the upstream merge point.

Parameters
upstreamMergePointthe new upstream merge point

Definition at line 229 of file ClusterAssociation.h.

Here is the call graph for this function:

◆ UpdateConnectingLine()

void lar_content::ClusterAssociation::UpdateConnectingLine ( )
inlineprotected

Update the connecting line.

Definition at line 245 of file ClusterAssociation.h.

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ m_connectingLineDirection

pandora::CartesianVector lar_content::ClusterAssociation::m_connectingLineDirection
protected

The unit vector of the line connecting the upstream and downstream merge points (upstream -> downstream)

Definition at line 99 of file ClusterAssociation.h.

◆ m_downstreamMergeDirection

pandora::CartesianVector lar_content::ClusterAssociation::m_downstreamMergeDirection
protected

The downstream cluster direction at the downstream merge point (points in the direction of the upstream cluster)

Definition at line 98 of file ClusterAssociation.h.

◆ m_downstreamMergePoint

pandora::CartesianVector lar_content::ClusterAssociation::m_downstreamMergePoint
protected

The downstream cluster point to be used in the merging process.

Definition at line 97 of file ClusterAssociation.h.

◆ m_upstreamMergeDirection

pandora::CartesianVector lar_content::ClusterAssociation::m_upstreamMergeDirection
protected

The upstream cluster direction at the upstream merge point (points in the direction of the downstream cluster)

Definition at line 96 of file ClusterAssociation.h.

◆ m_upstreamMergePoint

pandora::CartesianVector lar_content::ClusterAssociation::m_upstreamMergePoint
protected

The upstream cluster point to be used in the merging process.

Definition at line 95 of file ClusterAssociation.h.


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