Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Acts::PlanarModuleCluster Class Reference

#include <acts/blob/sPHENIX/Core/include/Acts/Digitization/PlanarModuleCluster.hpp>

+ Inheritance diagram for Acts::PlanarModuleCluster:
+ Collaboration diagram for Acts::PlanarModuleCluster:

Public Member Functions

 PlanarModuleCluster (std::shared_ptr< const Surface > surface, SourceLink sourceLink, const Base::CovarianceMatrix &cov, double loc0, double loc1, double t, std::vector< DigitizationCell > dCells, const DigitizationModule *dModule=nullptr)
 
const SurfacereferenceObject () const
 Module surface.
 
const std::vector
< DigitizationCell > & 
digitizationCells () const
 
const DigitizationModuledigitizationModule () const
 
- Public Member Functions inherited from Acts::Measurement< BoundIndices, 3 >
 Measurement (SourceLink source, const std::array< BoundIndices, kSize > &indices, const Eigen::MatrixBase< parameters_t > &params, const Eigen::MatrixBase< covariance_t > &cov)
 
 Measurement ()=delete
 A measurement can only be constructed with valid parameters.
 
 Measurement (const Measurement &)=default
 
 Measurement (Measurement &&)=default
 
 ~Measurement ()=default
 
Measurementoperator= (const Measurement &)=default
 
Measurementoperator= (Measurement &&)=default
 
const SourceLinksourceLink () const
 Source link that connects to the underlying detector readout.
 
bool contains (BoundIndicesi) const
 Check if a specific parameter is part of this measurement.
 
constexpr std::array
< BoundIndices, kSize > 
indices () const
 The measurement indices.
 
const ParametersVectorparameters () const
 Measured parameters values.
 
const CovarianceMatrixcovariance () const
 Measured parameters covariance.
 
ProjectionMatrix projector () const
 Projection matrix from the full space into the measured subspace.
 
ExpansionMatrix expander () const
 
ParametersVector residuals (const FullParametersVector &reference) const
 
std::ostream & operator<< (std::ostream &os) const
 

Private Types

using Base = Measurement< BoundIndices, 3 >
 

Private Attributes

std::shared_ptr< const Surfacem_surface
 
std::vector< DigitizationCellm_digitizationCells
 
const DigitizationModulem_digitizationModule
 the digitization cells
 

Static Private Attributes

static constexpr std::array
< BoundIndices, 3 > 
kIndices
 

Additional Inherited Members

- Public Types inherited from Acts::Measurement< BoundIndices, 3 >
using Scalar = ActsScalar
 
using ParametersVector = ActsVector< kSize >
 Vector type containing for measured parameter values.
 
using CovarianceMatrix = ActsSquareMatrix< kSize >
 Matrix type for the measurement covariance.
 
using FullParametersVector = ActsVector< kFullSize >
 Vector type containing all parameters in the same space.
 
using ProjectionMatrix = ActsMatrix< kSize, kFullSize >
 
using ExpansionMatrix = ActsMatrix< kFullSize, kSize >
 
- Static Public Member Functions inherited from Acts::Measurement< BoundIndices, 3 >
static constexpr size_t size ()
 Number of measured parameters.
 

Detailed Description

Definition at line 21 of file PlanarModuleCluster.hpp.

View newest version in sPHENIX GitHub at line 21 of file PlanarModuleCluster.hpp

Member Typedef Documentation

Definition at line 22 of file PlanarModuleCluster.hpp.

View newest version in sPHENIX GitHub at line 22 of file PlanarModuleCluster.hpp

Constructor & Destructor Documentation

Acts::PlanarModuleCluster::PlanarModuleCluster ( std::shared_ptr< const Surface surface,
SourceLink  sourceLink,
const Base::CovarianceMatrix cov,
double  loc0,
double  loc1,
double  t,
std::vector< DigitizationCell dCells,
const DigitizationModule dModule = nullptr 
)
inline

Constructor from DigitizationCells

Parameters
[in]surfaceThe surface the cluster is on
[in]sourceLinkis the link to the truth information
[in]covis the covariance matrix
[in]loc0is the local position in the first coordinate
[in]loc1is the local position in the second coordinate
[in]tTimestamp of the cluster
[in]dCellsis the vector of digitization cells
[in]dModulean optional pointer to a digitization configuration

Definition at line 38 of file PlanarModuleCluster.hpp.

View newest version in sPHENIX GitHub at line 38 of file PlanarModuleCluster.hpp

References assert, and m_surface.

Member Function Documentation

const std::vector< DigitizationCell > & Acts::PlanarModuleCluster::digitizationCells ( ) const
inline

access to the digitization cells

Returns
the vector to the digitization cells

Definition at line 71 of file PlanarModuleCluster.hpp.

View newest version in sPHENIX GitHub at line 71 of file PlanarModuleCluster.hpp

References m_digitizationCells.

Referenced by ActsExamples::HitsPrinter::execute(), ActsExamples::CsvPlanarClusterWriter::writeT(), and ActsExamples::RootPlanarClusterWriter::writeT().

+ Here is the caller graph for this function:

const DigitizationModule * Acts::PlanarModuleCluster::digitizationModule ( ) const
inline

access to the digitization module

Returns
the pointer to the digitization module

Definition at line 75 of file PlanarModuleCluster.hpp.

View newest version in sPHENIX GitHub at line 75 of file PlanarModuleCluster.hpp

References m_digitizationModule.

const Surface& Acts::PlanarModuleCluster::referenceObject ( ) const
inline

Module surface.

Definition at line 52 of file PlanarModuleCluster.hpp.

View newest version in sPHENIX GitHub at line 52 of file PlanarModuleCluster.hpp

References m_surface.

Member Data Documentation

constexpr std::array<BoundIndices, 3> Acts::PlanarModuleCluster::kIndices
staticprivate
Initial value:

Definition at line 24 of file PlanarModuleCluster.hpp.

View newest version in sPHENIX GitHub at line 24 of file PlanarModuleCluster.hpp

std::vector<DigitizationCell> Acts::PlanarModuleCluster::m_digitizationCells
private

Definition at line 66 of file PlanarModuleCluster.hpp.

View newest version in sPHENIX GitHub at line 66 of file PlanarModuleCluster.hpp

Referenced by digitizationCells().

const DigitizationModule* Acts::PlanarModuleCluster::m_digitizationModule
private

the digitization cells

Definition at line 67 of file PlanarModuleCluster.hpp.

View newest version in sPHENIX GitHub at line 67 of file PlanarModuleCluster.hpp

Referenced by digitizationModule().

std::shared_ptr<const Surface> Acts::PlanarModuleCluster::m_surface
private

Definition at line 65 of file PlanarModuleCluster.hpp.

View newest version in sPHENIX GitHub at line 65 of file PlanarModuleCluster.hpp

Referenced by PlanarModuleCluster(), and referenceObject().


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