#include <ChamberViewer.h>

Collaboration diagram for xAOD::ChamberViewer< HitObjContainer >:

Public Types
using	value_type = typename HitObjContainer::value_type

using	element_type = typename Acts::RemovePointer_t< value_type >

using	const_iterator = typename HitObjContainer::const_iterator

using	const_ref = typename const_iterator::reference

using	ViewMode = ChamberView::Mode

Public Member Functions
	ChamberViewer (const HitObjContainer &container) noexcept requires(ChamberViewConcepts
	Standard constructor. More...

	ChamberViewer (const HitObjContainer &container, const Muon::IMuonIdHelperSvc *idHelperSvc, const ViewMode mode=ViewMode::DetElement) noexcept requires(ChamberViewConcepts
	Standard constructor. More...

	ChamberViewer (const ChamberViewer &other)=delete
	Delete the copy constructor. More...

ChamberViewer &	operator= (const ChamberViewer &other)=delete
	Delete the copy assignment operator. More...

	ChamberViewer (ChamberViewer &&other)=default
	Standard move constructor. More...

ChamberViewer &	operator= (ChamberViewer &&other)=default
	Standard move operator. More...

const_iterator	begin () const noexcept
	Begin iterator of the current chamber view. More...

const_iterator	end () const noexcept
	End iterator of the current chamber view. More...

std::size_t	size () const noexcept
	Returns how many hits are in the current chamber. More...

const_ref	at (const std::size_t idx) const
	Returns the i-the measurement from the current chamber. More...

bool	next () noexcept
	Loads the hits from the next chamber. More...

bool	loadView (const Identifier &chamberId) requires(ChamberViewConcepts
	Loads the view matching the parsed identifier. More...

bool	loadView (const IdentifierHash &idHash) requires(ChamberViewConcepts
	Loads the view matching the parsed IdentifierHash. More...

bool	loadView (std::function< bool(const_ref)> selector)
	Loads the view range based on a generic selector function. More...

bool	next (std::function< bool(const_ref)> selector)

Private Member Functions
IdentifierHash	idHash (const Identifier &id) const
	Returns the IdentifierHash from an Identifier. More...

Private Attributes
const HitObjContainer &	m_container

const Muon::IMuonIdHelperSvc *	m_idHelperSvc {nullptr}

const ViewMode	m_mode {ViewMode::DetElement}

const_iterator	m_end {m_container.begin()}

const_iterator	m_begin {m_container.begin()}

Detailed Description

template<ChamberViewConcepts::ContainerConcept HitObjContainer>
class xAOD::ChamberViewer< HitObjContainer >

Definition at line 59 of file ChamberViewer.h.

Member Typedef Documentation

◆ const_iterator

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

using xAOD::ChamberViewer< HitObjContainer >::const_iterator = typename HitObjContainer::const_iterator

Definition at line 64 of file ChamberViewer.h.

◆ const_ref

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

using xAOD::ChamberViewer< HitObjContainer >::const_ref = typename const_iterator::reference

Definition at line 65 of file ChamberViewer.h.

◆ element_type

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

using xAOD::ChamberViewer< HitObjContainer >::element_type = typename Acts::RemovePointer_t<value_type>

Definition at line 62 of file ChamberViewer.h.

◆ value_type

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

using xAOD::ChamberViewer< HitObjContainer >::value_type = typename HitObjContainer::value_type

Definition at line 61 of file ChamberViewer.h.

◆ ViewMode

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

using xAOD::ChamberViewer< HitObjContainer >::ViewMode = ChamberView::Mode

Definition at line 66 of file ChamberViewer.h.

Constructor & Destructor Documentation

◆ ChamberViewer() [1/4]

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

xAOD::ChamberViewer< HitObjContainer >::ChamberViewer ( const HitObjContainer & container )

inlinenoexcept

Standard constructor.

Parameters

container UncalibratedMeasurementContainer from which the views per chamber shall be generated

Definition at line 70 of file ChamberViewer.h.

                                                                                     :
                     m_container{container} {                   
                     next();
                 }

◆ ChamberViewer() [2/4]

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

xAOD::ChamberViewer< HitObjContainer >::ChamberViewer	(	const HitObjContainer &	container,
		const Muon::IMuonIdHelperSvc *	idHelperSvc,
		const ViewMode	mode = `ViewMode::DetElement`
	)

inlinenoexcept

Standard constructor.

Parameters

container UncalibratedMeasurementContainer from which the views per chamber shall be generated

Definition at line 77 of file ChamberViewer.h.

                                                                               :
                     m_container{container},
                     m_idHelperSvc{idHelperSvc},
                     m_mode{mode} {                   
                     next();
                 }

◆ ChamberViewer() [3/4]

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

xAOD::ChamberViewer< HitObjContainer >::ChamberViewer ( const ChamberViewer< HitObjContainer > & other )

delete

Delete the copy constructor.

◆ ChamberViewer() [4/4]

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

xAOD::ChamberViewer< HitObjContainer >::ChamberViewer ( ChamberViewer< HitObjContainer > && other )

default

Standard move constructor.

Member Function Documentation

◆ at()

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

const_ref xAOD::ChamberViewer< HitObjContainer >::at ( const std::size_t idx ) const

inline

Returns the i-the measurement from the current chamber.

Definition at line 107 of file ChamberViewer.h.

                                                         {
                     if (idx >= size()) {
                         throw std::domain_error(std::format("Invalid index given {:}. size: {:}, requested:{:} ", 
                                                         typeid(const_ref).name(), size(), idx));
                     }
                     return (*m_begin +idx);
                 }

◆ begin()

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

const_iterator xAOD::ChamberViewer< HitObjContainer >::begin ( ) const

inlinenoexcept

Begin iterator of the current chamber view.

Definition at line 95 of file ChamberViewer.h.

                                                      {
                     return m_begin;
                 }

◆ end()

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

const_iterator xAOD::ChamberViewer< HitObjContainer >::end ( ) const

inlinenoexcept

End iterator of the current chamber view.

Definition at line 99 of file ChamberViewer.h.

                                                     {
                     return m_end;
                 }

◆ idHash()

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

IdentifierHash xAOD::ChamberViewer< HitObjContainer >::idHash ( const Identifier & id ) const

inlineprivate

Returns the IdentifierHash from an Identifier.

Definition at line 197 of file ChamberViewer.h.

                                                                   {
                     return m_mode == ViewMode::DetElement ? m_idHelperSvc->detElementHash(id)
                                                           : m_idHelperSvc->moduleHash(id);
                 }

◆ loadView() [1/3]

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

bool xAOD::ChamberViewer< HitObjContainer >::loadView ( const Identifier & chamberId )

inline

Loads the view matching the parsed identifier.

I.e. the collection of hits sharing the same IdentifierHash. Returns whether the view is empty or not

Parameters

chamberId Identifier from the chamber / detElement to consider

Definition at line 143 of file ChamberViewer.h.

                                                                                {
  
                     const IdentifierHash detId = idHash(chamberId);
                     m_begin = std::ranges::find_if(m_container,[this,&detId](const_ref meas) {
                                                         return idHash(meas->identify()) == detId;
                                                    });
                     m_end = std::find_if(m_begin, m_container.end(),[this,&detId](const_ref meas) {
                                                         return idHash(meas->identify()) != detId;
                                                    });
                     return m_begin != m_end;
                 }

◆ loadView() [2/3]

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

bool xAOD::ChamberViewer< HitObjContainer >::loadView ( const IdentifierHash & idHash )

inline

Loads the view matching the parsed IdentifierHash.

I.e. either the detector element hash or the chamber module hash. There's no cross-check whether the interpretion of both hashes is the same

Parameters

idHash IdentifierHash to search

Definition at line 158 of file ChamberViewer.h.

                                                                                      {                   
                     m_begin = std::ranges::find_if(m_container,[&idHash](const_ref meas) {
                                                         return meas->identifierHash() == idHash;
                                                    });
                     m_end = std::find_if(m_begin, m_container.end(),[&idHash](const_ref meas) {
                                                         return meas->identifierHash() != idHash;
                                                    });
                      return m_begin != m_end;
                 }

◆ loadView() [3/3]

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

bool xAOD::ChamberViewer< HitObjContainer >::loadView ( std::function< bool(const_ref)> selector )

inline

Loads the view range based on a generic selector function.

Parameters

selector Generic selector to base the range on

Definition at line 170 of file ChamberViewer.h.

                                                                      {
                     m_begin = std::ranges::find_if(m_container, selector);
                     m_end = std::find_if(m_begin, m_container.end(),
                                          [&selector](const_ref meas) {
                                             return !selector(meas);
                                         });
                     return m_begin != m_end;
                 }

◆ next() [1/2]

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

bool xAOD::ChamberViewer< HitObjContainer >::next ( )

inlinenoexcept

Loads the hits from the next chamber.

Returns false if all chambers have been traversed.

Definition at line 116 of file ChamberViewer.h.

                                      {
                     if (m_end == m_container.end()) {
                         return false;
                     }
                     m_begin = m_end;
                     if constexpr (ChamberViewConcepts::identifierHashConcept<element_type>) {
                         const IdentifierHash currentHash = (*m_end)->identifierHash();
                         m_end = std::find_if(m_begin, m_container.end(),
                                          [&currentHash](const_ref meas){
                                             return meas->identifierHash() != currentHash;
                                         });
                     } else {
                          const IdentifierHash currentHash = idHash((*m_end)->identify());
                          m_end = std::find_if(m_begin, m_container.end(),
                                          [this,&currentHash](const_ref meas){
                                             return idHash(meas->identify()) != currentHash;
                                         });                       
                     }
                     if (m_begin == m_end) {
                         return next(); // veto empty views
                     }
                     return true;
                 }

◆ next() [2/2]

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

bool xAOD::ChamberViewer< HitObjContainer >::next ( std::function< bool(const_ref)> selector )

inline

Check whether a new element is available

Definition at line 178 of file ChamberViewer.h.

                                                                  {
                     if (m_end == m_container.end()) {
                         return false;
                     }
                     const_iterator nextBegin = std::ranges::find_if(m_end, m_container.end(), selector);
                     if (nextBegin == m_container.end()) {
                         return false;
                     }
                     m_begin = nextBegin;
                     m_end = std::find_if(m_begin, m_container.end(),
                                          [&selector](const_ref meas) {
                                             return !selector(meas);
                                         });
                     return true;
                 }

◆ operator=() [1/2]

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

ChamberViewer& xAOD::ChamberViewer< HitObjContainer >::operator= ( ChamberViewer< HitObjContainer > && other )

default

Standard move operator.

◆ operator=() [2/2]

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

ChamberViewer& xAOD::ChamberViewer< HitObjContainer >::operator= ( const ChamberViewer< HitObjContainer > & other )

delete

Delete the copy assignment operator.

◆ size()

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

std::size_t xAOD::ChamberViewer< HitObjContainer >::size ( ) const

inlinenoexcept

Returns how many hits are in the current chamber.

Definition at line 103 of file ChamberViewer.h.

                                                 {
                     return std::distance(m_begin, m_end);
                 }

Member Data Documentation

◆ m_begin

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

const_iterator xAOD::ChamberViewer< HitObjContainer >::m_begin {m_container.begin()}

private

Definition at line 205 of file ChamberViewer.h.

◆ m_container

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

const HitObjContainer& xAOD::ChamberViewer< HitObjContainer >::m_container

private

Definition at line 201 of file ChamberViewer.h.

◆ m_end

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

const_iterator xAOD::ChamberViewer< HitObjContainer >::m_end {m_container.begin()}

private

Definition at line 204 of file ChamberViewer.h.

◆ m_idHelperSvc

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

const Muon::IMuonIdHelperSvc* xAOD::ChamberViewer< HitObjContainer >::m_idHelperSvc {nullptr}

private

Definition at line 202 of file ChamberViewer.h.

◆ m_mode

template<ChamberViewConcepts::ContainerConcept HitObjContainer>

const ViewMode xAOD::ChamberViewer< HitObjContainer >::m_mode {ViewMode::DetElement}

private

Definition at line 203 of file ChamberViewer.h.

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

ChamberViewer.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

template<ChamberViewConcepts::ContainerConcept HitObjContainer> class xAOD::ChamberViewer< HitObjContainer >

Member Typedef Documentation

◆ const_iterator

◆ const_ref

◆ element_type

◆ value_type

◆ ViewMode

Constructor & Destructor Documentation

◆ ChamberViewer() [1/4]

◆ ChamberViewer() [2/4]

◆ ChamberViewer() [3/4]

◆ ChamberViewer() [4/4]

Member Function Documentation

◆ at()

◆ begin()

◆ end()

◆ idHash()

◆ loadView() [1/3]

◆ loadView() [2/3]

◆ loadView() [3/3]

◆ next() [1/2]

◆ next() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ size()

Member Data Documentation

◆ m_begin

◆ m_container

◆ m_end

◆ m_idHelperSvc

◆ m_mode

template<ChamberViewConcepts::ContainerConcept HitObjContainer>
class xAOD::ChamberViewer< HitObjContainer >