TIDARoiDescriptor Class Reference

Describes the Region of Interest geometry It has basically 8 parameters. More...

#include <TIDARoiDescriptor.h>

Inheritance diagram for TIDARoiDescriptor:

Collaboration diagram for TIDARoiDescriptor:

Public Member Functions
	TIDARoiDescriptor (bool fullscan=false)
	default constructor
	TIDARoiDescriptor (double eta, double etaMinus, double etaPlus, double phi, double phiMinus, double phiPlus, double zed, double zedMinus, double zedPlus)
	constructor where phi,eta and zed are specified
	TIDARoiDescriptor (unsigned l1id, int id, double eta, double etaMinus, double etaPlus, double phi, double phiMinus, double phiPlus, double zed, double zedMinus, double zedPlus)
	constructor
	TIDARoiDescriptor (unsigned roiWord, unsigned l1id, int id, double eta, double etaMinus, double etaPlus, double phi, double phiMinus, double phiPlus, double zed, double zedMinus, double zedPlus)
	constructor
	TIDARoiDescriptor (const TIDARoiDescriptor &r)
	copy constructor
TIDARoiDescriptor &	operator= (const TIDARoiDescriptor &r)
	copy assignment
TIDARoiDescriptor &	operator= (TIDARoiDescriptor &&r) noexcept
	move assignment
virtual	~TIDARoiDescriptor ()
void	set_roiId (const unsigned int id)
	set roiId
void	set_l1Id (const unsigned int l1id)
	set event number
void	set_roiWord (const unsigned int roiWord)
	sets RoI word
double	phi () const
double	eta () const
double	zed () const
double	etaMinus () const
double	etaPlus () const
double	phiMinus () const
double	phiPlus () const
double	zedMinus () const
double	zedPlus () const
double	zedPlusR () const
	full containment methods
double	zedMinusR () const
double	rPlusZed () const
double	rMinusZed () const
double	maxR () const
double	maxZ () const
unsigned	roiId () const
	identifier methods
unsigned	l1Id () const
unsigned	roiWord () const
int	version () const
	operator std::string () const
bool	isFullscan () const
bool	composite () const
	composite RoI methods
size_t	size () const
const TIDARoiDescriptor *	operator[] (int i) const
const TIDARoiDescriptor *	at (int i) const
	gets phi half-width
double	phiHalfWidth () const
double	etaHalfWidth () const
	gets eta half-width
double	zedHalfWidth () const
	gets eta half-width
bool	operator== (const TIDARoiDescriptor &b) const
	operators
bool	operator!= (const TIDARoiDescriptor &b) const
void	push_back (const TIDARoiDescriptor &roi)
void	push_back (const TIDARoiDescriptor *roi)

Static Public Member Functions
static double	exitpoint (double tz0, double teta, double &zexit, double &rexit)
	returns the tantheta for the limits and the r and z exit points from the ID volume

Protected Member Functions
const TIDARoiParameters &	params () const
	access the internal parameter class
void	reset ()
	internal parameters
double	phicheck (double phi)
	helper function to check if phi range was violated
double	etacheck (double eta)
	helper function to check if eta range was violated
double	zedcheck (double zed)
	helper function to check if zed range was violated

Protected Attributes
TIDARoiParameters	m_params
	don't save
bool	m_fullscan
unsigned int	m_l1Id
unsigned int	m_roiId
unsigned int	m_roiWord
std::vector< TIDARoiDescriptor >	m_rois
bool	m_cached
double	m_dphi
	cache flag - these should be mutable
double	m_zedPlusR
	cached value -
double	m_zedMinusR
	don't save - transient zPlus at radius R
double	m_rPlusZed
	don't save - transient zMinus at radius R
double	m_rMinusZed
	don't save - transient zPlus at radius R
double	m_tanthetaPlus
	don't save - transient zMinus at radius R
double	m_tanthetaMinus
	don't save - transient roi edge gradients

Static Protected Attributes
static const double	maxRadius = 1000
static const double	maxZed = 2700
	don't save

Detailed Description

Describes the Region of Interest geometry It has basically 8 parameters.

1. zed : z position at beamline of RoI
2. zedMinus : z position at beamline as rear of RoI
3. zedPlus : z position at beamline as front of RoI
4. phi : azimuthal angle (radians) of centre of RoI at origin in range from [-pi, pi]
5. phiMinus : most negative phi angle of RoI
6. phiPlus : most positive phi angle of RoI
7. eta : pseudo-rapidity of centre of RoI at origin
8. etaPlus : pseudo-rapidity at zed + zed half-width
9. etaMinus : pseudo-rapidity at zed - zed half-width

   Warning

   An attempt to construct the objects of this class with phi0 out of allowed range results in throwing exception

Definition at line 40 of file TIDARoiDescriptor.h.

Constructor & Destructor Documentation

TIDARoiDescriptor() [1/5]

TIDARoiDescriptor::TIDARoiDescriptor

(

bool

fullscan = false

)

default constructor

Definition at line 65 of file TIDARoiDescriptor.cxx.

  :  m_fullscan(fullscan), 
     m_l1Id(0), m_roiId(0), m_roiWord(0),
     m_cached(false), m_dphi(0),
     m_zedPlusR(0),
     m_zedMinusR(0),
     m_rPlusZed(0),
     m_rMinusZed(0)
{
  if ( m_fullscan ) { 
    m_params = TIDARoiParameters( 0, -5, 5, 0, -M_PI, M_PI, 0, -225, 225 );
    m_tanthetaPlus  = exitpoint(  225,  5,  m_zedPlusR,  m_rPlusZed );
    m_tanthetaMinus = exitpoint( -225, -5, m_zedMinusR, m_rMinusZed );
  } else {
    m_tanthetaPlus = 0.0;
    m_tanthetaMinus = 0.0;
  }
}

TIDARoiDescriptor() [2/5]

TIDARoiDescriptor::TIDARoiDescriptor	(	double	eta,
		double	etaMinus,
		double	etaPlus,
		double	phi,
		double	phiMinus,
		double	phiPlus,
		double	zed,
		double	zedMinus,
		double	zedPlus )

constructor where phi,eta and zed are specified

Parameters

eta	eta of RoI
phi	phi of RoI
zed	zed of RoI and limits for each

Definition at line 85 of file TIDARoiDescriptor.cxx.

  :  m_params( eta, etaMinus, etaPlus, 
           phi, phiMinus, phiPlus,
           zed, zedMinus, zedPlus ), 
     m_fullscan(false),
     m_l1Id(0), m_roiId(0), m_roiWord(0),
     m_cached(false), m_dphi(0)
{ 
  // calculate z limits at radius maxRadius
 
  m_tanthetaPlus  = exitpoint( this->zedPlus(),  this->etaPlus(),  m_zedPlusR,  m_rPlusZed );
  m_tanthetaMinus = exitpoint( this->zedMinus(), this->etaMinus(), m_zedMinusR, m_rMinusZed );
}

TIDARoiDescriptor() [3/5]

TIDARoiDescriptor::TIDARoiDescriptor	(	unsigned	l1id,
		int	id,
		double	eta,
		double	etaMinus,
		double	etaPlus,
		double	phi,
		double	phiMinus,
		double	phiPlus,
		double	zed,
		double	zedMinus,
		double	zedPlus )

constructor

Parameters

l1id	is event number asigned by LVL1 trigger
id	RoI number within event (0,1,.....)
eta	eta of RoI
phi	phi of RoI
zed	zed of RoI and limits for each

TIDARoiDescriptor() [4/5]

TIDARoiDescriptor::TIDARoiDescriptor	(	unsigned	roiWord,
		unsigned	l1id,
		int	id,
		double	eta,
		double	etaMinus,
		double	etaPlus,
		double	phi,
		double	phiMinus,
		double	phiPlus,
		double	zed,
		double	zedMinus,
		double	zedPlus )

constructor

Parameters

roiWord	LVL1 trigger decision word
l1id	is event number asigned by LVL1 trigger
id	RoI number within event (0,1,.....)
eta	eta of RoI
phi	phi of RoI
zed	zed of RoI and limits for each

TIDARoiDescriptor() [5/5]

TIDARoiDescriptor::TIDARoiDescriptor

(

const TIDARoiDescriptor &

r

)

copy constructor

Parameters

TIDARoiDescriptor

Definition at line 137 of file TIDARoiDescriptor.cxx.

                                                               : 
  TObject(a),
  m_params(a.m_params),
  m_fullscan(a.m_fullscan),
  m_l1Id(a.m_l1Id), m_roiId(a.m_roiId), m_roiWord(a.m_roiWord),  
  m_rois(a.m_rois), 
  m_cached(false), m_dphi(0)
{ 
  m_tanthetaPlus  = exitpoint( this->zedPlus(),  this->etaPlus(),  m_zedPlusR,  m_rPlusZed );
  m_tanthetaMinus = exitpoint( this->zedMinus(), this->etaMinus(), m_zedMinusR, m_rMinusZed );
}

~TIDARoiDescriptor()

TIDARoiDescriptor::~TIDARoiDescriptor ( )

virtual

Definition at line 191 of file TIDARoiDescriptor.cxx.

{ }

Member Function Documentation

at()

const TIDARoiDescriptor * TIDARoiDescriptor::at ( int i ) const

inline

gets phi half-width

Definition at line 183 of file TIDARoiDescriptor.h.

composite()

bool TIDARoiDescriptor::composite ( ) const

inline

composite RoI methods

Definition at line 178 of file TIDARoiDescriptor.h.

{ return !m_rois.empty(); }

eta()

double TIDARoiDescriptor::eta ( ) const

inline

Definition at line 138 of file TIDARoiDescriptor.h.

{ return m_params.eta(); }

etacheck()

double TIDARoiDescriptor::etacheck ( double eta )

protected

helper function to check if eta range was violated

Definition at line 218 of file TIDARoiDescriptor.cxx.

                                             {
  if ( !(eta > -100  && eta < 100) ) { // check also for nan
    std::cerr << "TIDARoiDescriptor constructed with eta outside range -100 < eta <100  EtaRange" << std::endl;
  } 
  return eta;
}

etaHalfWidth()

double TIDARoiDescriptor::etaHalfWidth ( ) const

inline

gets eta half-width

Definition at line 192 of file TIDARoiDescriptor.h.

etaMinus()

double TIDARoiDescriptor::etaMinus ( ) const

inline

Definition at line 141 of file TIDARoiDescriptor.h.

{ return m_params.etaMinus(); }

etaPlus()

double TIDARoiDescriptor::etaPlus ( ) const

inline

Definition at line 142 of file TIDARoiDescriptor.h.

{ return m_params.etaPlus(); }

exitpoint()

double TIDARoiDescriptor::exitpoint ( double tz0, double teta, double & zexit, double & rexit )

static

returns the tantheta for the limits and the r and z exit points from the ID volume

do we need protection against eta=0 ?

leaves through the barrel side or front face?

through the barrel edge actually need to calculate the z exit coordinate
for proper containment rather than spurious
"eta containment"

Definition at line 33 of file TIDARoiDescriptor.cxx.

                                                                                            { 
 
  if      ( teta<0 ) zexit = -maxZed;
  else if ( teta>0 ) zexit =  maxZed;
  else { 
    zexit = tz0;
    rexit = maxRadius;
    return 1e16; // don't really want to use nan
  }
  
 
  double tantheta = std::tan( 2*std::atan( std::exp( -teta ) ) );
 
  rexit = (zexit-tz0) * tantheta;

  if ( std::fabs(rexit)>maxRadius ) {
    zexit = maxRadius / tantheta + tz0;
    rexit = maxRadius;
 
  }
 
  return tantheta;
}

isFullscan()

bool TIDARoiDescriptor::isFullscan ( ) const

inline

Definition at line 174 of file TIDARoiDescriptor.h.

{ return m_fullscan; } 

l1Id()

unsigned TIDARoiDescriptor::l1Id ( ) const

inline

Definition at line 167 of file TIDARoiDescriptor.h.

{ return m_l1Id; }

maxR()

double TIDARoiDescriptor::maxR ( ) const

inline

Definition at line 159 of file TIDARoiDescriptor.h.

{ return maxRadius; }

maxZ()

double TIDARoiDescriptor::maxZ ( ) const

inline

Definition at line 160 of file TIDARoiDescriptor.h.

{ return maxZed; }

operator std::string()

TIDARoiDescriptor::operator std::string

(

)

const

Definition at line 194 of file TIDARoiDescriptor.cxx.

                                            {
  std::stringstream s;
  s << " z: "   << zed() << " (" << zedMinus() << " - " << zedPlus() << ")"
    << " eta: " << eta() << " (" << etaMinus() << " - " << etaPlus() << ")"
    << " phi: " << phi() << " (" << phiMinus() << " - " << phiPlus() << ")";
  if ( m_fullscan ) s << " (fullscan)";
  s  << " RoIid: " << roiId() << " RoIword: " << roiWord() << " (size " << size() << ")";
  for ( unsigned i=0 ; i<size() ; i++ ) s << "\n\t\t" << i << ": " << (std::string)*at(i);
  return s.str();
}

operator!=()

bool TIDARoiDescriptor::operator!= ( const TIDARoiDescriptor & b ) const

inline

Definition at line 213 of file TIDARoiDescriptor.h.

{ return !((*this)==b); }

operator=() [1/2]

TIDARoiDescriptor & TIDARoiDescriptor::operator=

(

const TIDARoiDescriptor &

r

)

copy assignment

Parameters

TIDARoiDescriptor

Definition at line 150 of file TIDARoiDescriptor.cxx.

{
  if (this != &a) {
    TObject::operator= (a);
    m_params   = a.m_params;
    m_fullscan = a.m_fullscan;
    m_l1Id     = a.m_l1Id;
    m_roiId    = a.m_roiId;
    m_roiWord  = a.m_roiWord;
    m_rois     = a.m_rois;
    m_cached   = a.m_cached;
    m_dphi     = a.m_dphi;
    m_tanthetaPlus  = exitpoint( this->zedPlus(),  this->etaPlus(),  m_zedPlusR,  m_rPlusZed );
    m_tanthetaMinus = exitpoint( this->zedMinus(), this->etaMinus(), m_zedMinusR, m_rMinusZed );
  }
  return *this;
}

operator=() [2/2]

TIDARoiDescriptor & TIDARoiDescriptor::operator= ( TIDARoiDescriptor && r )

noexcept

move assignment

Parameters

TIDARoiDescriptor

Definition at line 168 of file TIDARoiDescriptor.cxx.

                                                                            {
  if (this != &a) {
    TObject::operator=(a);  // TObject may not have a move assignment
    m_params         = std::move(a.m_params);
    m_fullscan       = a.m_fullscan;
    m_l1Id           = a.m_l1Id;
    m_roiId          = a.m_roiId;
    m_roiWord        = a.m_roiWord;
    m_rois           = std::move(a.m_rois);
    m_cached         = a.m_cached;
    m_dphi           = a.m_dphi;
    m_zedPlusR       = a.m_zedPlusR;
    m_zedMinusR      = a.m_zedMinusR;
    m_rPlusZed       = a.m_rPlusZed;
    m_rMinusZed      = a.m_rMinusZed;
    m_tanthetaPlus   = a.m_tanthetaPlus;
    m_tanthetaMinus  = a.m_tanthetaMinus;
  }
  return *this;
}

operator==()

bool TIDARoiDescriptor::operator== ( const TIDARoiDescriptor & b ) const

inline

operators

Definition at line 204 of file TIDARoiDescriptor.h.

                                                    {
    if ( roiWord() != b.roiWord() ) return false;
    double epsilon=0.001; // arbitrary , but seems to be reasonable
    if ( std::fabs( phi() - b.phi()) > epsilon ) return false;
    if ( std::fabs( eta() - b.eta()) > epsilon ) return false;
    if ( std::fabs( zed() - b.zed()) > epsilon ) return false;
    return true;
  }

operator[]()

const TIDARoiDescriptor * TIDARoiDescriptor::operator[] ( int i ) const

inline

Definition at line 182 of file TIDARoiDescriptor.h.

{ return &m_rois.at(i); }

params()

const TIDARoiParameters & TIDARoiDescriptor::params ( ) const

inlineprotected

access the internal parameter class

Definition at line 250 of file TIDARoiDescriptor.h.

{ return m_params; };  

phi()

double TIDARoiDescriptor::phi ( ) const

inline

Definition at line 137 of file TIDARoiDescriptor.h.

{ return m_params.phi(); }

phicheck()

double TIDARoiDescriptor::phicheck ( double phi )

protected

helper function to check if phi range was violated

Definition at line 207 of file TIDARoiDescriptor.cxx.

                                             {
  if ( !(phi > -M_PIF && phi < M_PIF ) ) { // use ! of range rather than range to also catch nan etc
    if ( phi < -M_PIF )  phi += M_2PI;
    else                 phi -= M_2PI;
    //       std::cerr << "TIDARoiDescriptor constructed with phi smaller than -PI (allowed range -PI / +PI) PhiRange" << std::endl;
    //       std::cerr << "TIDARoiDescriptor constructed with phi greater than PI (allowed range -PI / +PI) PhiRange" << std::endl;
  } 
  return phi;
}

phiHalfWidth()

double TIDARoiDescriptor::phiHalfWidth ( ) const

inline

Definition at line 186 of file TIDARoiDescriptor.h.

                              { 
    double dphi = 0.5*(params().phiPlus()-params().phiMinus());
    if ( params().phiMinus()>params().phiPlus() ) dphi += M_PI;
    return dphi;
  }

phiMinus()

double TIDARoiDescriptor::phiMinus ( ) const

inline

Definition at line 144 of file TIDARoiDescriptor.h.

{ return m_params.phiMinus(); }

phiPlus()

double TIDARoiDescriptor::phiPlus ( ) const

inline

Definition at line 145 of file TIDARoiDescriptor.h.

{ return m_params.phiPlus(); }

push_back() [1/2]

void TIDARoiDescriptor::push_back ( const TIDARoiDescriptor & roi )

inline

Definition at line 215 of file TIDARoiDescriptor.h.

{ m_rois.push_back( roi ); }

push_back() [2/2]

void TIDARoiDescriptor::push_back ( const TIDARoiDescriptor * roi )

inline

Definition at line 216 of file TIDARoiDescriptor.h.

{ m_rois.push_back( *roi ); }

reset()

void TIDARoiDescriptor::reset ( )

inlineprotected

internal parameters

resets all variables of RoI

Definition at line 255 of file TIDARoiDescriptor.h.

               {
    m_params = TIDARoiParameters();
    //    m_phi=0.0;          m_eta=0.0;          m_zed=0.0;
    //    m_phiHalfWidth=0.1; m_etaHalfWidth=0.1; m_zedHalfWidth=168;
    //    m_etaPlus=m_eta;    m_etaMinus=m_eta;
    m_l1Id=0; 
    m_roiId=0;  
    m_roiWord=0;
    m_rois.clear();
  }

rMinusZed()

double TIDARoiDescriptor::rMinusZed ( ) const

inline

Definition at line 157 of file TIDARoiDescriptor.h.

{ return m_rMinusZed; }

roiId()

unsigned TIDARoiDescriptor::roiId ( ) const

inline

identifier methods

Definition at line 166 of file TIDARoiDescriptor.h.

{ return m_roiId; }

roiWord()

unsigned TIDARoiDescriptor::roiWord ( ) const

inline

Definition at line 168 of file TIDARoiDescriptor.h.

{ return m_roiWord; }

rPlusZed()

double TIDARoiDescriptor::rPlusZed ( ) const

inline

Definition at line 156 of file TIDARoiDescriptor.h.

{ return m_rPlusZed; }

set_l1Id()

void TIDARoiDescriptor::set_l1Id ( const unsigned int l1id )

inline

set event number

Definition at line 121 of file TIDARoiDescriptor.h.

set_roiId()

void TIDARoiDescriptor::set_roiId ( const unsigned int id )

inline

set roiId

Definition at line 120 of file TIDARoiDescriptor.h.

set_roiWord()

void TIDARoiDescriptor::set_roiWord ( const unsigned int roiWord )

inline

sets RoI word

Definition at line 122 of file TIDARoiDescriptor.h.

size()

size_t TIDARoiDescriptor::size ( ) const

inline

Definition at line 180 of file TIDARoiDescriptor.h.

{ return m_rois.size(); }

version()

int TIDARoiDescriptor::version ( ) const

inline

Definition at line 170 of file TIDARoiDescriptor.h.

{ return 4; }  

zed()

double TIDARoiDescriptor::zed ( ) const

inline

Definition at line 139 of file TIDARoiDescriptor.h.

{ return m_params.zed(); }

zedcheck()

double TIDARoiDescriptor::zedcheck ( double zed )

protected

helper function to check if zed range was violated

Definition at line 226 of file TIDARoiDescriptor.cxx.

                                             {
  if ( !(zed > -100000  && zed < 100000 ) ) { // check also for nan
    std::cerr << "TIDARoiDescriptor constructed with eta outside range -100000 < sed <100000  ZedRange" << std::endl;
  } 
  return zed;
}

zedHalfWidth()

double TIDARoiDescriptor::zedHalfWidth ( ) const

inline

gets eta half-width

Definition at line 193 of file TIDARoiDescriptor.h.

zedMinus()

double TIDARoiDescriptor::zedMinus ( ) const

inline

Definition at line 147 of file TIDARoiDescriptor.h.

{ return m_params.zedMinus(); }

zedMinusR()

double TIDARoiDescriptor::zedMinusR ( ) const

inline

Definition at line 154 of file TIDARoiDescriptor.h.

{ return m_zedMinusR; }

zedPlus()

double TIDARoiDescriptor::zedPlus ( ) const

inline

Definition at line 148 of file TIDARoiDescriptor.h.

{ return m_params.zedPlus(); }

zedPlusR()

double TIDARoiDescriptor::zedPlusR ( ) const

inline

full containment methods

Definition at line 153 of file TIDARoiDescriptor.h.

{ return m_zedPlusR; }

Member Data Documentation

m_cached

bool TIDARoiDescriptor::m_cached

protected

Definition at line 287 of file TIDARoiDescriptor.h.

m_dphi

double TIDARoiDescriptor::m_dphi

protected

cache flag - these should be mutable

Definition at line 288 of file TIDARoiDescriptor.h.

m_fullscan

bool TIDARoiDescriptor::m_fullscan

protected

Definition at line 279 of file TIDARoiDescriptor.h.

m_l1Id

unsigned int TIDARoiDescriptor::m_l1Id

protected

Definition at line 281 of file TIDARoiDescriptor.h.

m_params

TIDARoiParameters TIDARoiDescriptor::m_params

protected

don't save

Definition at line 277 of file TIDARoiDescriptor.h.

m_rMinusZed

double TIDARoiDescriptor::m_rMinusZed

protected

don't save - transient zPlus at radius R

Definition at line 294 of file TIDARoiDescriptor.h.

m_roiId

unsigned int TIDARoiDescriptor::m_roiId

protected

Definition at line 282 of file TIDARoiDescriptor.h.

m_rois

std::vector<TIDARoiDescriptor> TIDARoiDescriptor::m_rois

protected

Definition at line 285 of file TIDARoiDescriptor.h.

m_roiWord

unsigned int TIDARoiDescriptor::m_roiWord

protected

Definition at line 283 of file TIDARoiDescriptor.h.

m_rPlusZed

double TIDARoiDescriptor::m_rPlusZed

protected

don't save - transient zMinus at radius R

Definition at line 293 of file TIDARoiDescriptor.h.

m_tanthetaMinus

double TIDARoiDescriptor::m_tanthetaMinus

protected

don't save - transient roi edge gradients

Definition at line 297 of file TIDARoiDescriptor.h.

m_tanthetaPlus

double TIDARoiDescriptor::m_tanthetaPlus

protected

don't save - transient zMinus at radius R

Definition at line 296 of file TIDARoiDescriptor.h.

m_zedMinusR

double TIDARoiDescriptor::m_zedMinusR

protected

don't save - transient zPlus at radius R

Definition at line 291 of file TIDARoiDescriptor.h.

m_zedPlusR

double TIDARoiDescriptor::m_zedPlusR

protected

cached value -

Definition at line 290 of file TIDARoiDescriptor.h.

maxRadius

const double TIDARoiDescriptor::maxRadius = 1000

staticprotected

Definition at line 272 of file TIDARoiDescriptor.h.

maxZed

const double TIDARoiDescriptor::maxZed = 2700

staticprotected

don't save

Definition at line 273 of file TIDARoiDescriptor.h.

---

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

• TIDARoiDescriptor.h
• TIDARoiDescriptor.cxx