IRoiDescriptor Class Reference

Describes the API of the Region of Ineterest geometry. More...

#include <IRoiDescriptor.h>

Inheritance diagram for IRoiDescriptor:

Collaboration diagram for IRoiDescriptor:

Public Types
typedef std::vector< constIRoiDescriptor * >::const_iterator	roi_iterator

Public Member Functions
	IRoiDescriptor ()
	default constructor
virtual	~IRoiDescriptor ()
virtual double	phi () const =0
	Methods to retrieve data members.
virtual double	eta () const =0
virtual double	zed () const =0
virtual double	zedPlus () const =0
	the zed and eta values at the most forward and most rear ends of the RoI
virtual double	zedMinus () const =0
virtual double	etaPlus () const =0
virtual double	etaMinus () const =0
virtual double	phiPlus () const =0
	extreme phi values
virtual double	phiMinus () const =0
virtual unsigned int	roiId () const =0
	identifiers
virtual unsigned int	l1Id () const =0
virtual unsigned int	roiWord () const =0
virtual int	version () const =0
	which roi version?
virtual	operator std::string () const =0
	cast to a string
virtual bool	isFullscan () const =0
	is this a full detector RoI?
virtual bool	composite () const =0
	Super RoI access methods.
virtual unsigned	size () const =0
	number of constituents
virtual const IRoiDescriptor *	at (int i) const =0
	find an RoiDescriptor constituent
virtual roi_iterator	begin () const =0
	const limit iterators
virtual roi_iterator	end () const =0
virtual double	zedMin (double r) const =0
	useful methods to determine whether items lie partially within the RoI
virtual double	zedMax (double r) const =0
virtual double	rhoMin (double z) const =0
	accessors to calculate r position at position z along the RoI boundaries
virtual double	rhoMax (double z) const =0
virtual double	dzdrMinus () const =0
	return the gradients
virtual double	dzdrPlus () const =0
virtual double	drdzMinus () const =0
virtual double	drdzPlus () const =0
virtual double	zedOuterPlus () const =0
	zed limits at some outer radius
virtual double	zedOuterMinus () const =0

Detailed Description

Describes the API of the Region of Ineterest geometry.

Definition at line 23 of file IRoiDescriptor.h.

Member Typedef Documentation

roi_iterator

typedef std::vector<constIRoiDescriptor*>::const_iterator IRoiDescriptor::roi_iterator

Definition at line 28 of file IRoiDescriptor.h.

Constructor & Destructor Documentation

IRoiDescriptor()

IRoiDescriptor::IRoiDescriptor ( )

inline

default constructor

Definition at line 35 of file IRoiDescriptor.h.

{ }

~IRoiDescriptor()

virtual IRoiDescriptor::~IRoiDescriptor ( )

inlinevirtual

Definition at line 38 of file IRoiDescriptor.h.

{ }

Member Function Documentation

at()

virtual const IRoiDescriptor * IRoiDescriptor::at ( int i ) const

pure virtual

find an RoiDescriptor constituent

Implemented in RoiDescriptor.

begin()

virtual roi_iterator IRoiDescriptor::begin ( ) const

pure virtual

const limit iterators

Implemented in RoiDescriptor.

composite()

virtual bool IRoiDescriptor::composite ( ) const

pure virtual

Super RoI access methods.

am I a SuperRoi?

Implemented in RoiDescriptor.

drdzMinus()

virtual double IRoiDescriptor::drdzMinus ( ) const

pure virtual

Implemented in RoiDescriptor.

drdzPlus()

virtual double IRoiDescriptor::drdzPlus ( ) const

pure virtual

Implemented in RoiDescriptor.

dzdrMinus()

virtual double IRoiDescriptor::dzdrMinus ( ) const

pure virtual

return the gradients

Implemented in RoiDescriptor.

dzdrPlus()

virtual double IRoiDescriptor::dzdrPlus ( ) const

pure virtual

Implemented in RoiDescriptor.

end()

virtual roi_iterator IRoiDescriptor::end ( ) const

pure virtual

Implemented in RoiDescriptor.

eta()

virtual double IRoiDescriptor::eta ( ) const

pure virtual

Implemented in RoiDescriptor.

etaMinus()

virtual double IRoiDescriptor::etaMinus ( ) const

pure virtual

Implemented in RoiDescriptor.

etaPlus()

virtual double IRoiDescriptor::etaPlus ( ) const

pure virtual

Implemented in RoiDescriptor.

isFullscan()

virtual bool IRoiDescriptor::isFullscan ( ) const

pure virtual

is this a full detector RoI?

Implemented in RoiDescriptor.

l1Id()

virtual unsigned int IRoiDescriptor::l1Id ( ) const

pure virtual

Implemented in RoiDescriptor, and TrigRoiDescriptor.

operator std::string()

virtual IRoiDescriptor::operator std::string ( ) const

pure virtual

cast to a string

Implemented in RoiDescriptor, and TrigRoiDescriptor.

phi()

virtual double IRoiDescriptor::phi ( ) const

pure virtual

Methods to retrieve data members.

directions

Implemented in RoiDescriptor.

phiMinus()

virtual double IRoiDescriptor::phiMinus ( ) const

pure virtual

Implemented in RoiDescriptor.

phiPlus()

virtual double IRoiDescriptor::phiPlus ( ) const

pure virtual

extreme phi values

Implemented in RoiDescriptor.

rhoMax()

virtual double IRoiDescriptor::rhoMax ( double z ) const

pure virtual

Implemented in RoiDescriptor.

rhoMin()

virtual double IRoiDescriptor::rhoMin ( double z ) const

pure virtual

accessors to calculate r position at position z along the RoI boundaries

Implemented in RoiDescriptor.

roiId()

virtual unsigned int IRoiDescriptor::roiId ( ) const

pure virtual

identifiers

Implemented in RoiDescriptor, and TrigRoiDescriptor.

roiWord()

virtual unsigned int IRoiDescriptor::roiWord ( ) const

pure virtual

Implemented in RoiDescriptor, and TrigRoiDescriptor.

size()

virtual unsigned IRoiDescriptor::size ( ) const

pure virtual

number of constituents

Implemented in RoiDescriptor.

version()

virtual int IRoiDescriptor::version ( ) const

pure virtual

which roi version?

Implemented in RoiDescriptor.

zed()

virtual double IRoiDescriptor::zed ( ) const

pure virtual

Implemented in RoiDescriptor.

zedMax()

virtual double IRoiDescriptor::zedMax ( double r ) const

pure virtual

Implemented in RoiDescriptor.

zedMin()

virtual double IRoiDescriptor::zedMin ( double r ) const

pure virtual

useful methods to determine whether items lie partially within the RoI

accessors to calculate z position at radius r along the RoI boundaries

Implemented in RoiDescriptor.

zedMinus()

virtual double IRoiDescriptor::zedMinus ( ) const

pure virtual

Implemented in RoiDescriptor.

zedOuterMinus()

virtual double IRoiDescriptor::zedOuterMinus ( ) const

pure virtual

Implemented in RoiDescriptor.

zedOuterPlus()

virtual double IRoiDescriptor::zedOuterPlus ( ) const

pure virtual

zed limits at some outer radius

Implemented in RoiDescriptor.

zedPlus()

virtual double IRoiDescriptor::zedPlus ( ) const

pure virtual

the zed and eta values at the most forward and most rear ends of the RoI

Implemented in RoiDescriptor.

---

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

• IRoiDescriptor.h