GlobalSim::LArStripNeighborhood Class Reference

Class to hold windows of LAr strip cells in a the neighbourhood of a eFexRoI. More...

#include <LArStripNeighborhood.h>

Collaboration diagram for GlobalSim::LArStripNeighborhood:

Public Member Functions
	LArStripNeighborhood (const StripDataVector &phi_low, const StripDataVector &phi_center, const StripDataVector &phi_high, const Coords &roiCoords, const Coords &cellCoords, std::size_t max_cell_pos)
	Constructor to define a LArStripNeighborhood from input objects.
const StripDataVector &	phi_low () const
	Returns a vector of strip cell e/eta/phi data for the low phi row of the neighborhood.
const StripDataVector &	phi_center () const
	Returns a vector of strip cell e/eta/phi data for the central phi row of the neighborhood.
const StripDataVector &	phi_high () const
	Returns a vector of strip cell e/eta/phi data for the central high row of the neighborhood.
std::size_t	maxCellIndex () const
	Returns the index of the maximum energy cell in this neighbourhood.
const Coords &	roiCoords () const
	Returns the eta/phi coordinates of the RoI used to seed this neighbourhood.
const Coords &	cellCoords () const
	Returns the eta/phi coordinates of the maximum energy cell.
std::string	to_string () const
	print out contents to string

Private Attributes
StripDataVector	m_phi_low
	Parameter: Vector strip cell e/eta/phi, low phi row.
StripDataVector	m_phi_center
	Parameter: Vector strip cell e/eta/phi, central phi row.
StripDataVector	m_phi_high
	Parameter: Vector strip cell e/eta/phi, high phi row.
Coords	m_roiCoords {0., 0.}
	Parameter: eta/Phi coordinate of the seed eFexRoITOB.
Coords	m_cellCoords {0., 0.}
	Parameter: eta/phi coords of cell in RoI with maximum energy.
std::size_t	m_max_cell_pos {0}
	Parameter: Index of the cell with the maximum energy.

Detailed Description

Class to hold windows of LAr strip cells in a the neighbourhood of a eFexRoI.

This class represents windows of LAr strip cells centred on a eFexRoI. It defines three rows of cells e/eta/phi — low, center, high — surrounding the eFexRoI. It defines which cell has the maximum energy, and the max_cell/RoI eta/phi coordinates are also stored.

Definition at line 37 of file LArStripNeighborhood.h.

Constructor & Destructor Documentation

LArStripNeighborhood()

GlobalSim::LArStripNeighborhood::LArStripNeighborhood	(	const StripDataVector &	phi_low,
		const StripDataVector &	phi_center,
		const StripDataVector &	phi_high,
		const Coords &	roiCoords,
		const Coords &	cellCoords,
		std::size_t	max_cell_pos )

Constructor to define a LArStripNeighborhood from input objects.

Parameters

[in]	phi_low	A vector of e/eta/phi coordinates for the low phi row
[in]	phi_center	A vector of e/eta/phi coordinates for the center phi row
[in]	phi_high	A vector of e/eta/phi coordinates for the high phi row
[in]	roiCoords	The eta/phi coordinates of the eFexRoI that produced this object
[in]	cellCoords	The eta/phi coordinates of the maximum energy cell
[in]	max_cell_pos	The index of the maximum energy cell

To be used to create, and initilise a neighborhood of LAr Strip cells centred on a incoming eFeXRoITOB. The neighbourhood is organised as three rows of 17 strips in phi.

Definition at line 11 of file LArStripNeighborhood.cxx.

                                                 :
    m_phi_low{phi_low},
    m_phi_center{phi_center},
    m_phi_high{phi_high},
    m_roiCoords{roi},
    m_cellCoords{cell},
    m_max_cell_pos{max_cell_pos}{
  }

Member Function Documentation

cellCoords()

const Coords & GlobalSim::LArStripNeighborhood::cellCoords ( ) const

inline

Returns the eta/phi coordinates of the maximum energy cell.

Definition at line 72 of file LArStripNeighborhood.h.

{return m_cellCoords;}

maxCellIndex()

std::size_t GlobalSim::LArStripNeighborhood::maxCellIndex ( ) const

inline

Returns the index of the maximum energy cell in this neighbourhood.

Definition at line 67 of file LArStripNeighborhood.h.

{return m_max_cell_pos;}

phi_center()

const StripDataVector & GlobalSim::LArStripNeighborhood::phi_center ( ) const

inline

Returns a vector of strip cell e/eta/phi data for the central phi row of the neighborhood.

Definition at line 62 of file LArStripNeighborhood.h.

{return m_phi_center;}

phi_high()

const StripDataVector & GlobalSim::LArStripNeighborhood::phi_high ( ) const

inline

Returns a vector of strip cell e/eta/phi data for the central high row of the neighborhood.

Definition at line 64 of file LArStripNeighborhood.h.

{return m_phi_high;}

phi_low()

const StripDataVector & GlobalSim::LArStripNeighborhood::phi_low ( ) const

inline

Returns a vector of strip cell e/eta/phi data for the low phi row of the neighborhood.

Definition at line 60 of file LArStripNeighborhood.h.

{return m_phi_low;}

roiCoords()

const Coords & GlobalSim::LArStripNeighborhood::roiCoords ( ) const

inline

Returns the eta/phi coordinates of the RoI used to seed this neighbourhood.

Definition at line 70 of file LArStripNeighborhood.h.

{return m_roiCoords;}

to_string()

std::string GlobalSim::LArStripNeighborhood::to_string

(

)

const

print out contents to string

Definition at line 25 of file LArStripNeighborhood.cxx.

                                                  {
    std::stringstream ss;
    ss << "LArStripNeighborhood: roi coords ("
       << roiCoords().first << ','  << roiCoords().second << ") cell coords ("
       << cellCoords().first << ','  << cellCoords().second
       << ") max_cell_pos " << maxCellIndex() << '\n';
    
    ss << "phi low: " << " [" << phi_low().size() <<"]\n";
    for(const auto& sd : phi_low()) { ss << sd << '\n';}
    
    ss << '\n';
    
    ss << "phi center: " << " [" << phi_center().size() <<"]\n";
    for(const auto& sd : phi_center()) { ss << sd << '\n';}
    
    ss << '\n';
    
    ss << "phi high: " << " [" << phi_high().size() <<"]\n";
    for(const auto& sd : phi_high()) { ss << sd << '\n';}
    
    ss << '\n';
    return ss.str();
  }

Member Data Documentation

m_cellCoords

Coords GlobalSim::LArStripNeighborhood::m_cellCoords {0., 0.}

private

Parameter: eta/phi coords of cell in RoI with maximum energy.

Definition at line 87 of file LArStripNeighborhood.h.

{0., 0.};

m_max_cell_pos

std::size_t GlobalSim::LArStripNeighborhood::m_max_cell_pos {0}

private

Parameter: Index of the cell with the maximum energy.

Definition at line 89 of file LArStripNeighborhood.h.

{0};

m_phi_center

StripDataVector GlobalSim::LArStripNeighborhood::m_phi_center

private

Parameter: Vector strip cell e/eta/phi, central phi row.

Definition at line 81 of file LArStripNeighborhood.h.

m_phi_high

StripDataVector GlobalSim::LArStripNeighborhood::m_phi_high

private

Parameter: Vector strip cell e/eta/phi, high phi row.

Definition at line 83 of file LArStripNeighborhood.h.

m_phi_low

StripDataVector GlobalSim::LArStripNeighborhood::m_phi_low

private

Parameter: Vector strip cell e/eta/phi, low phi row.

Definition at line 79 of file LArStripNeighborhood.h.

m_roiCoords

Coords GlobalSim::LArStripNeighborhood::m_roiCoords {0., 0.}

private

Parameter: eta/Phi coordinate of the seed eFexRoITOB.

Definition at line 85 of file LArStripNeighborhood.h.

{0., 0.};

---

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

• LArStripNeighborhood.h
• LArStripNeighborhood.cxx