cluster::cluster_params Class Reference

#include "ClusterParams.h"

Public Member Functions
	cluster_params ()
void	Clear ()
template<typename Stream >
void	Report (Stream &os) const

Public Attributes
Polygon2D	PolyObject
	Polygon Object...see Polygon2D.hh. More...
util::PxPoint	start_point
	start point More...
util::PxPoint	end_point
	end point More...
double	sum_charge
	Sum charge of hits in ADC. More...
double	mean_charge
	Mean (average) charge of hits in ADC. More...
double	rms_charge
	RMS (standard deviation of sample) of charge of hits in ADC. More...
double	sum_ADC
	Sum charge of ADC counts of hits, in ADC. More...
double	mean_ADC
	Mean (average) of ADC counts of hits, in ADC. More...
double	rms_ADC
	RMS (standard deviation of sample) of ADC counts of hits in ADC. More...
double	mean_x
	Mean of hits along x, peaks only. More...
double	mean_y
	Mean of hits along y, peaks only. More...
double	rms_x
	rms of hits along x (wires) More...
double	rms_y
	rms of hits along y, (time) More...
double	charge_wgt_x
	Mean of hits along x, charge weighted. More...
double	charge_wgt_y
	Mean of hits along y, charge weighted. More...
double	cluster_angle_2d
	Linear best fit to high-charge hits in the cluster. More...
double	angle_2d
	Angle of axis in wire/hit view. More...
double	opening_angle
	Width of angular distubtion wrt vertx. More...
double	opening_angle_charge_wgt
	Same for charge_wgt. More...
double	closing_angle
	Width of angular distubtion wrt endpoint. More...
double	closing_angle_charge_wgt
	Same for charge_wgt. More...
double	start_charge
	Charge at the start of the cluster. More...
double	end_charge
	Charge at the (other) end of the cluster. More...
double	eigenvalue_principal
	the principal eigenvalue from PCA More...
double	eigenvalue_secondary
	the secondary eigenvalue from PCA More...
double	verticalness
	??? More...
double	length
double	width
double	hit_density_1D
double	hit_density_2D
double	multi_hit_wires
double	N_Wires
double	modified_hit_density
double	N_Hits
double	N_Hits_HC
double	modmeancharge
double	RMS_charge
int	direction
double	showerness
	got heart More...
double	trackness
	got soul More...
double	offaxis_hits
	got brain More...

Detailed Description

(Detailed) information holder for 2D cluster, computed by ClusterParamsAlg

Definition at line 14 of file ClusterParams.h.

Constructor & Destructor Documentation

cluster::cluster_params::cluster_params ( )

inline

Definition at line 17 of file ClusterParams.h.

References Clear().

                    {
      //Initialize all values.
      Clear();
    } 

Member Function Documentation

void cluster::cluster_params::Clear ( )

inline

Definition at line 75 of file ClusterParams.h.

References util::PxPoint::Clear().

Referenced by cluster_params(), and cluster::ClusterParamsAlg::Initialize().

                {
      start_point.Clear();
      end_point.Clear();
      sum_charge                        = -999.999 ;
      mean_charge                       = -999.999 ;
      rms_charge                        = -999.999 ;
      sum_ADC                           = -999.999 ;
      mean_ADC                          = -999.999 ;
      rms_ADC                           = -999.999 ;
      mean_x                            = -999.999 ;
      mean_y                            = -999.999 ;
      rms_x                             = -999.999 ;
      rms_y                             = -999.999 ;
      charge_wgt_x                      = -999.999 ;
      charge_wgt_y                      = -999.999 ;
      cluster_angle_2d                  = -999.999 ;
      angle_2d                          = -999.999 ;
      eigenvalue_principal              = -999.999 ;
      eigenvalue_secondary              = -999.999 ;
      multi_hit_wires                   = -999.999 ;
      N_Wires                           = -999.999 ;
      verticalness                      = -999.999 ;
      opening_angle                     = -999.999 ;
      opening_angle_charge_wgt          = -999.999 ;
      closing_angle                     = -999.999 ;
      closing_angle_charge_wgt          = -999.999 ;
      start_charge                      = -999.999 ;
      end_charge                        = -999.999 ;
      offaxis_hits                      = -999.999 ;
      modmeancharge                     = -999.999 ;
      RMS_charge                        = -999.999 ;
      modified_hit_density              = -999.999 ;    
      N_Hits                            = -999.999 ;    
      N_Hits_HC                         = -999.999 ;    
      length                            = -999.999 ;
      width                             = -999.999 ;
      hit_density_1D                    = -999.999 ;
      hit_density_2D                    = -999.999 ;
      direction                         =  0       ;
      showerness                        = -999.999 ;
      trackness                         = -999.999 ;
    }

template<typename Stream >

void cluster::cluster_params::Report ( Stream &  os ) const

inline

Definition at line 119 of file ClusterParams.h.

References util::PxPoint::t, and util::PxPoint::w.

Referenced by cluster::ClusterParamsAlg::Report().

                                  {

      os << "ClusterParams report: \n"
         << "   start_point  .............. : (" << start_point.w <<","<<start_point.t<<")\n"
         << "   end_point  ................ : (" << end_point.w <<","<<end_point.t<<")\n"
         << "   sum_charge  ............... : "<< sum_charge << "\n"
         << "   mean_charge   ............. : " << mean_charge << "\n"
         << "   mean_x  ................... : " << mean_x << "\n"
         << "   mean_y  ................... : " << mean_y << "\n"
         << "   rms_x  .................... : " << rms_x << "\n"
         << "   rms_y  .................... : " << rms_y << "\n"
         << "   charge_wgt_x  ............. : " << charge_wgt_x << "\n"
         << "   charge_wgt_y  ............. : " << charge_wgt_y << "\n"
         << "   cluster_angle_2d  ......... : " << cluster_angle_2d << "\n"
         << "   angle_2d  ................. : " << angle_2d         << "\n"
         << "   eigenvalue_principal  ..... : " << eigenvalue_principal << "\n"
         << "   eigenvalue_secondary  ..... : " << eigenvalue_secondary << "\n"
         << "   multi_hit_wires  .......... : " << multi_hit_wires << "\n"
         << "   N_Wires  .................. : " << N_Wires << "\n"
         << "   N_Hits  ................... : " << N_Hits << "\n"
         << "   N_Hits_HC  ................ : " << N_Hits_HC << "\n"
         << "   verticalness  ............. : " << verticalness << "\n"
         << "   opening_angle  ............ : " << opening_angle << "\n"
         << "   opening_angle_charge_wgt  . : " << opening_angle_charge_wgt << "\n"
         << "   closing_angle  ............ : " << closing_angle << "\n"
         << "   closing_angle_charge_wgt  . : " << closing_angle_charge_wgt << "\n"
         << "   start_charge  ............. : " << start_charge << "\n"
         << "   end_charge  ............... : " << end_charge << "\n"
         << "   offaxis_hits  ............. : " << offaxis_hits << "\n"
         << "   modified_hit_density  ..... : " << modified_hit_density << "\n"
         << "   modified mean charge ...... : " << modmeancharge << "\n"
         << "   charge_RMS ................ : " << RMS_charge << "\n"
         << "   length  ................... : " << length << "\n"
         << "   width  .................... : " << width << "\n"
         << "   hit_density_1D  ........... : " << hit_density_1D << "\n"
         << "   hit_density_2D  ........... : " << hit_density_2D << "\n"
         << "   showerness  ............... : " << showerness << "\n"
         << "   trackness  ................ : " << trackness << "\n"
         << "   direction  ................ : " << direction << "\n";
    }

Member Data Documentation

double cluster::cluster_params::angle_2d

Angle of axis in wire/hit view.

Definition at line 40 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::GetFinalSlope().

double cluster::cluster_params::charge_wgt_x

Mean of hits along x, charge weighted.

Definition at line 37 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::GetAverages(), and cluster::ClusterParamsAlg::GetRoughAxis().

double cluster::cluster_params::charge_wgt_y

Mean of hits along y, charge weighted.

Definition at line 38 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::GetAverages(), and cluster::ClusterParamsAlg::GetRoughAxis().

double cluster::cluster_params::closing_angle

Width of angular distubtion wrt endpoint.

Definition at line 43 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::GetFANNVector(), and cluster::ClusterParamsAlg::RefineDirection().

double cluster::cluster_params::closing_angle_charge_wgt

Same for charge_wgt.

Definition at line 44 of file ClusterParams.h.

Referenced by cluster::LazyClusterParamsAlg::EndOpeningAngle(), cluster::StandardClusterParamsAlg::EndOpeningAngle(), cluster::ClusterParamsAlg::GetFANNVector(), and cluster::ClusterParamsAlg::RefineDirection().

double cluster::cluster_params::cluster_angle_2d

Linear best fit to high-charge hits in the cluster.

Definition at line 39 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::GetRoughAxis(), cluster::LazyClusterParamsAlg::StartAngle(), and cluster::StandardClusterParamsAlg::StartAngle().

int cluster::cluster_params::direction

+1 means shower is "forward - start wire < end wire" -1 is backwards, 0 is undecided

Definition at line 69 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::RefineStartPointAndDirection().

double cluster::cluster_params::eigenvalue_principal

the principal eigenvalue from PCA

Definition at line 47 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::GetAverages(), and cluster::ClusterParamsAlg::GetFANNVector().

double cluster::cluster_params::eigenvalue_secondary

the secondary eigenvalue from PCA

Definition at line 48 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::GetAverages(), and cluster::ClusterParamsAlg::GetFANNVector().

double cluster::cluster_params::end_charge

Charge at the (other) end of the cluster.

Definition at line 46 of file ClusterParams.h.

Referenced by cluster::LazyClusterParamsAlg::EndCharge(), and cluster::ClusterParamsAlg::GetEndCharges().

util::PxPoint cluster::cluster_params::end_point

end point

Definition at line 25 of file ClusterParams.h.

Referenced by cluster::ClusterMergeHelper::AppendResult(), cluster::ClusterParamsAlg::GetProfileInfo(), cluster::SimpleClusterMerger::produce(), cluster::FuzzyClusterMerger::produce(), cluster::ClusterParamsAlg::RefineDirection(), cluster::ClusterParamsAlg::RefineStartPointAndDirection(), cluster::ClusterParamsAlg::RefineStartPoints(), and cluster::ClusterParamsAlg::SetPlane().

double cluster::cluster_params::hit_density_1D

Definition at line 54 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::GetFANNVector(), cluster::ClusterParamsAlg::GetFinalSlope(), and cluster::ClusterParamsAlg::RefineStartPoints().

double cluster::cluster_params::hit_density_2D

Definition at line 55 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::RefineStartPoints().

double cluster::cluster_params::length

Definition at line 51 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::GetFANNVector(), cluster::ClusterParamsAlg::GetFinalSlope(), cluster::ClusterParamsAlg::MultipleHitDensity(), and cluster::ClusterParamsAlg::RefineStartPoints().

double cluster::cluster_params::mean_ADC

Mean (average) of ADC counts of hits, in ADC.

Definition at line 31 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::GetAverages().

double cluster::cluster_params::mean_charge

Mean (average) charge of hits in ADC.

Definition at line 28 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::GetAverages(), cluster::ClusterParamsAlg::GetFANNVector(), cluster::ClusterParamsAlg::GetFinalSlope(), cluster::ClusterParamsAlg::GetRoughAxis(), and cluster::ClusterParamsAlg::RefineDirection().

double cluster::cluster_params::mean_x

Mean of hits along x, peaks only.

Definition at line 33 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::GetAverages(), and cluster::ClusterParamsAlg::GetRoughAxis().

double cluster::cluster_params::mean_y

Mean of hits along y, peaks only.

Definition at line 34 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::GetAverages(), and cluster::ClusterParamsAlg::GetRoughAxis().

double cluster::cluster_params::modified_hit_density

Definition at line 58 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::GetFANNVector(), and cluster::ClusterParamsAlg::GetFinalSlope().

double cluster::cluster_params::modmeancharge

Definition at line 62 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::GetFinalSlope().

double cluster::cluster_params::multi_hit_wires

Definition at line 56 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::GetAverages(), cluster::ClusterParamsAlg::GetFANNVector(), cluster::LazyClusterParamsAlg::MultipleHitDensity(), cluster::StandardClusterParamsAlg::MultipleHitDensity(), cluster::ClusterParamsAlg::MultipleHitDensity(), and cluster::ClusterParamsAlg::MultipleHitWires().

double cluster::cluster_params::N_Hits

Definition at line 59 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::GetAverages(), cluster::ClusterParamsAlg::GetFANNVector(), cluster::ClusterParamsAlg::GetProfileInfo(), cluster::ClusterParamsAlg::GetRoughAxis(), cluster::LazyClusterParamsAlg::NHits(), cluster::StandardClusterParamsAlg::NHits(), cluster::ClusterParamsAlg::RefineDirection(), and cluster::ClusterParamsAlg::RefineStartPoints().

double cluster::cluster_params::N_Hits_HC

Definition at line 60 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::GetFANNVector(), cluster::ClusterParamsAlg::GetRoughAxis(), and cluster::ClusterParamsAlg::RefineDirection().

double cluster::cluster_params::N_Wires

Definition at line 57 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::GetAverages(), cluster::ClusterParamsAlg::GetFANNVector(), cluster::LazyClusterParamsAlg::MultipleHitDensity(), cluster::StandardClusterParamsAlg::MultipleHitDensity(), and cluster::ClusterParamsAlg::MultipleHitWires().

double cluster::cluster_params::offaxis_hits

got brain

Definition at line 73 of file ClusterParams.h.

double cluster::cluster_params::opening_angle

Width of angular distubtion wrt vertx.

Definition at line 41 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::GetFANNVector(), cmtool::CFAlgoShowerCompat::PrintClusterInfo(), and cluster::ClusterParamsAlg::RefineDirection().

double cluster::cluster_params::opening_angle_charge_wgt

Same for charge_wgt.

Definition at line 42 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::GetFANNVector(), cluster::ClusterParamsAlg::RefineDirection(), cluster::LazyClusterParamsAlg::StartOpeningAngle(), and cluster::StandardClusterParamsAlg::StartOpeningAngle().

Polygon2D cluster::cluster_params::PolyObject

Polygon Object...see Polygon2D.hh.

Definition at line 22 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::FillPolygon().

double cluster::cluster_params::rms_ADC

RMS (standard deviation of sample) of ADC counts of hits in ADC.

Definition at line 32 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::GetAverages(), cluster::LazyClusterParamsAlg::SummedADCStdDev(), and cluster::StandardClusterParamsAlg::SummedADCStdDev().

double cluster::cluster_params::rms_charge

RMS (standard deviation of sample) of charge of hits in ADC.

Definition at line 29 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::GetAverages(), cluster::LazyClusterParamsAlg::IntegralStdDev(), and cluster::StandardClusterParamsAlg::IntegralStdDev().

double cluster::cluster_params::RMS_charge

Definition at line 63 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::GetFANNVector(), and cluster::ClusterParamsAlg::GetRoughAxis().

double cluster::cluster_params::rms_x

rms of hits along x (wires)

Definition at line 35 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::GetRoughAxis().

double cluster::cluster_params::rms_y

rms of hits along y, (time)

Definition at line 36 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::GetRoughAxis().

double cluster::cluster_params::showerness

got heart

Definition at line 71 of file ClusterParams.h.

double cluster::cluster_params::start_charge

Charge at the start of the cluster.

Definition at line 45 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::GetEndCharges(), and cluster::LazyClusterParamsAlg::StartCharge().

util::PxPoint cluster::cluster_params::start_point

start point

Definition at line 24 of file ClusterParams.h.

Referenced by cluster::ClusterMergeHelper::AppendResult(), cluster::ClusterParamsAlg::GetFinalSlope(), cluster::ClusterParamsAlg::GetProfileInfo(), cluster::SimpleClusterMerger::produce(), cluster::FuzzyClusterMerger::produce(), cluster::ClusterParamsAlg::RefineDirection(), cluster::ClusterParamsAlg::RefineStartPointAndDirection(), cluster::ClusterParamsAlg::RefineStartPoints(), and cluster::ClusterParamsAlg::SetPlane().

double cluster::cluster_params::sum_ADC

Sum charge of ADC counts of hits, in ADC.

Definition at line 30 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::GetAverages(), cluster::LazyClusterParamsAlg::SummedADC(), and cluster::StandardClusterParamsAlg::SummedADC().

double cluster::cluster_params::sum_charge

Sum charge of hits in ADC.

Definition at line 27 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::GetAverages(), cluster::ClusterParamsAlg::GetFANNVector(), cluster::ClusterParamsAlg::GetProfileInfo(), cluster::LazyClusterParamsAlg::Integral(), cluster::StandardClusterParamsAlg::Integral(), and cluster::ClusterParamsAlg::RefineDirection().

double cluster::cluster_params::trackness

got soul

Definition at line 72 of file ClusterParams.h.

double cluster::cluster_params::verticalness

???

Definition at line 49 of file ClusterParams.h.

double cluster::cluster_params::width

Definition at line 52 of file ClusterParams.h.

Referenced by cluster::ClusterParamsAlg::GetFANNVector(), cluster::ClusterParamsAlg::GetProfileInfo(), cluster::ClusterParamsAlg::RefineStartPoints(), cluster::LazyClusterParamsAlg::Width(), and cluster::StandardClusterParamsAlg::Width().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larreco/v07_10_02/source/larreco/RecoAlg/ClusterRecoUtil/ClusterParams.h