ROIPhiRZContainer Class Reference

container for phi sorted ROIs defined by phi, r and z. More...

#include <ROIPhiRZContainer.h>

Inheritance diagram for ROIPhiRZContainer:

Collaboration diagram for ROIPhiRZContainer:

Public Member Functions
bool	hasMatchingROI (float phi, double eta, double r, double z, float roi_phi_width, double roi_eta_width) const
	Test whether there is a matching ROI for the given phi and r,z corrected eta. More...
const_iterator	lowerPhiBound (float phi, float roi_phi_width) const
void	addROI (const Amg::Vector3D &global_position, float roi_phi_width)
void	sort ()

Static Public Member Functions
static double	eta (const ROIPhiRZ &roi)
static double	theta (const ROIPhiRZ &roi)
static float	phi (const ROIPhiRZ &roi)

Public Attributes
T	elements
	STL member. More...

Static Protected Member Functions
static double	sqr (double a)
static double	deltaEta (const ROIPhiRZ &roi, double other_r, double other_z, double other_eta)
	Helper function to compute a z position corrected delta eta. More...
static bool	order (const ROIPhiRZ &a, const ROIPhiRZ &b)
	Helper function to order ROIs defined by phi,r,z by phi. More...
static ROIPhiRZContainer::const_iterator	lowerPhiBound (const ROIPhiRZContainer &rois, float phi, float roi_phi_width)
	Helper function to find the lower bound of ROIs which match |phi - ROI_phi| < ROI_width;. More...
static bool	hasMatchingROI (const ROIPhiRZContainer &rois, float phi, double eta, double r, double z, float roi_phi_width, double roi_eta_width)

Detailed Description

container for phi sorted ROIs defined by phi, r and z.

Collection to hold a phi sorted array containing ROIs defined by phi, r and z, entries with close to 2 pi will also be stored with negaitve phi Thus the lower bound of ROIs with |phi - ROI_phi| < ROI_width, is can be obtained by a binary search for phi-ROI_width

Definition at line 49 of file ROIPhiRZContainer.h.

Member Function Documentation

addROI()

void ROIPhiRZContainer::addROI ( const Amg::Vector3D &  global_position, float  roi_phi_width  )

inline

Definition at line 63 of file ROIPhiRZContainer.h.

                                                                        {
 
      float phi = global_position.phi();
      assert (std::abs(phi)<=M_PI );
      float z = global_position.z();
      float r = global_position.perp();
      if ( std::abs(phi) > M_PI - roi_phi_width) {
         constexpr float pi_2 = 2*M_PI;
         float sign_phi_times_2_pi = std::copysign(pi_2,phi);
         // wrap ROIs close to -pi and pi around. Thus when searching for the lower bound ROI for phi-phi_width
         // ROIs close to -pi and ROIs close to +pi will be found.
         this->emplace_back( ROIPhiRZ{phi - sign_phi_times_2_pi, r, z} );
     }
     this->emplace_back( ROIPhiRZ{phi, r, z});
   }

deltaEta()

static double ROIPhiRZContainer::deltaEta ( const ROIPhiRZ &  roi, double  other_r, double  other_z, double  other_eta  )

inlinestaticprotected

Helper function to compute a z position corrected delta eta.

Definition at line 101 of file ROIPhiRZContainer.h.

                                                                                                        {
      //Correct eta of ROI to take into account the z postion of the reference
      double newR   = roi.r() - other_r;
      double newZ   = roi.z() - other_z;
      double newEta =  std::atanh( newZ / std::sqrt( newR*newR + newZ*newZ ) );
      double delta_eta = std::abs(newEta - other_eta);
      return delta_eta;
   }

eta()

static double ROIPhiRZContainer::eta ( const ROIPhiRZ &  roi )

inlinestatic

Definition at line 84 of file ROIPhiRZContainer.h.

                                                 {
      const double R   = roi.r();
      const double Z   = roi.z();
      return std::atanh( Z / std::sqrt( R*R + Z*Z ) );
   }

hasMatchingROI() [1/2]

static bool ROIPhiRZContainer::hasMatchingROI ( const ROIPhiRZContainer &  rois, float  phi, double  eta, double  r, double  z, float  roi_phi_width, double  roi_eta_width  )

inlinestaticprotected

Definition at line 129 of file ROIPhiRZContainer.h.

                                                                                                                                                           {
      ROIPhiRZContainer::const_iterator start_roi_iter = lowerPhiBound( rois, phi, roi_phi_width);
      //  by construction if the iterator is valid the cluster it is pointing to has a phi larger than phi-roi_phi_width.
      //  So now just check for all clusters which are not too far away in phi whether there is one with a matching eta.
      for (ROIPhiRZContainer::const_iterator roi_iter = start_roi_iter; roi_iter != rois.end() && roi_iter->phi()  < phi + roi_phi_width; ++roi_iter) {
         if ( deltaEta(*roi_iter, r, z , eta) < roi_eta_width) { return true; }
      }
      return false;
   }

hasMatchingROI() [2/2]

bool ROIPhiRZContainer::hasMatchingROI ( float  phi, double  eta, double  r, double  z, float  roi_phi_width, double  roi_eta_width  ) const

inline

Test whether there is a matching ROI for the given phi and r,z corrected eta.

Definition at line 55 of file ROIPhiRZContainer.h.

                                                                                                                           {
      return hasMatchingROI(*this,phi,eta,r,z,roi_phi_width,roi_eta_width);
   }

lowerPhiBound() [1/2]

static ROIPhiRZContainer::const_iterator ROIPhiRZContainer::lowerPhiBound ( const ROIPhiRZContainer &  rois, float  phi, float  roi_phi_width  )

inlinestaticprotected

Helper function to find the lower bound of ROIs which match |phi - ROI_phi| < ROI_width;.

Parameters

rois	the phi sorted roi container
phi	the phi value for which the lower bound of ROIs is desired.
ROI	width the width of the ROI in phi (must be smaller or equal the width that was used during the creation of the ROI container.
the	lower phi bound of ROIs matching |phi - ROI_phi| < ROI_width or rois.end() if there are no matching rois.

Definition at line 120 of file ROIPhiRZContainer.h.

                                                                                                                               {
      if (phi>M_PI) {
         phi -= 2*M_PI;
      }
      //search first ROI which is greater than phi - row_phi-width i.e. the first ROI which could be within the vicinity of phi
      return std::upper_bound( rois.begin(), rois.end(), phi-roi_phi_width, [](float value, const ROIPhiRZ &element) { return element.phi() >= value; } );
   }

lowerPhiBound() [2/2]

const_iterator ROIPhiRZContainer::lowerPhiBound ( float  phi, float  roi_phi_width  ) const

inline

Definition at line 59 of file ROIPhiRZContainer.h.

                                                                              {
      return lowerPhiBound( *this, phi, roi_phi_width);
   }

order()

static bool ROIPhiRZContainer::order ( const ROIPhiRZ &  a, const ROIPhiRZ &  b  )

inlinestaticprotected

Helper function to order ROIs defined by phi,r,z by phi.

Definition at line 112 of file ROIPhiRZContainer.h.

{ return a.phi() < b.phi(); }

phi()

static float ROIPhiRZContainer::phi ( const ROIPhiRZ &  roi )

inlinestatic

Definition at line 92 of file ROIPhiRZContainer.h.

                                                {
      return roi.phi();
   }

sort()

void ROIPhiRZContainer::sort ( )

inline

Definition at line 79 of file ROIPhiRZContainer.h.

               {
      // sort output ROIs by phi
      std::sort( this->begin(), this->end(), order );
   }

sqr()

static double ROIPhiRZContainer::sqr ( double  a )

inlinestaticprotected

Definition at line 97 of file ROIPhiRZContainer.h.

{ return a * a; }

theta()

static double ROIPhiRZContainer::theta ( const ROIPhiRZ &  roi )

inlinestatic

Definition at line 89 of file ROIPhiRZContainer.h.

                                                   {
      return std::atan2(1., roi.z() / roi.r());
   }

Member Data Documentation

elements

T std::vector< T >::elements

inherited

STL member.

---

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

• ROIPhiRZContainer.h