ATLAS Offline Software
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
Trk::IAlignModuleTool Class Referenceabstract

#include <IAlignModuleTool.h>

Inheritance diagram for Trk::IAlignModuleTool:
Collaboration diagram for Trk::IAlignModuleTool:

Public Member Functions

virtual ~IAlignModuleTool ()
 
virtual StatusCode initialize ()=0
 
virtual StatusCode finalize ()=0
 
AlignModuleListType alignModuleListType ()
 returns type of AlignModuleList (see AlignModuleList.h for more info) More...
 
virtual AlignModule::DetectorType getDetectorType (const TrkDetElementBase *det) const =0
 gets detector type for a detector element More...
 
virtual void setAlignModules (AlignModuleList *alignmods, std::vector< AlignModuleList * > *idHashToAlignModMap)=0
 sets AlignModules for a particular detector type More...
 
virtual void setAlignParLists (DataVector< DataVector< AlignPar > > *fullAlignParList, DataVector< DataVector< AlignPar > > *alignParList)=0
 sets AlignPar for AlignModules for a particular detector type More...
 
virtual void setSubDetElement (AlignModule::DetectorType detType, bool status)=0
 set and retrieve flag whether or not the sub-TrkDetElementBase structures are aligned for a given detector type More...
 
virtual bool subDetElement (AlignModule::DetectorType detType) const =0
 
virtual AlignModulefindAlignModule (const RIO_OnTrack *rio, AlignModule::DetectorType=AlignModule::NDetectorTypes) const =0
 finds AlignModule for a detector element (used by AlignTrackCreator) More...
 
virtual AlignModulefindAlignModule (const TrkDetElementBase *det, AlignModule::DetectorType=AlignModule::NDetectorTypes) const =0
 finds AlignModule for a detector element More...
 
virtual void setMeasurementProperties (AlignTSOS *) const
 allows to set detector specific properties of AlignTSOS, like measurement direction (CSC) or fan-out angle (SCT) More...
 
virtual int nAlignParameters () const =0
 number of alignment parameters for all detector types More...
 
virtual const AlignModuleListalignModules1D ()=0
 converts 2-D AlignParList and AlignModuleList for all detector types to single 1-D vectors (used by MatrixTool) More...
 
virtual DataVector< AlignPar > * alignParList1D ()=0
 
virtual DataVector< AlignPar > * getAlignPars (const AlignModule *alignModule) const =0
 returns alignment parameters for a single module More...
 
virtual void shiftModule (const AlignModule *, const Track *, AlignModule::TransformParameters, double) const
 shifts and restores tubes traversed by track in module (used by ShiftingDerivCalcTool) More...
 
virtual void restoreModule (const AlignModule *) const
 
virtual void fillDetAlignmentParameters (const TrkDetElementBase *det, DataVector< AlignPar > *apVec, AlignModule::DetectorType detType=AlignModule::NDetectorTypes) const =0
 returns alignment parameters for a detector element, applying AlignModule transforms if necessary More...
 
virtual const AlignModuleListgetAlignModuleCollection () const =0
 gets all AlignModules for a particular detector type More...
 
virtual DataVector< AlignPar > * getFullAlignPars (const AlignModule *alignModule) const =0
 returns vector of full AlignPars for an AlignModule More...
 
virtual void setLogStream (std::ostream *os)
 sets the output stream for the logfile More...
 

Static Public Member Functions

static const InterfaceID & interfaceID ()
 

Protected Attributes

int m_alignModuleListType
 uses Trk enum AlignModuleListType (L1,L2,L3,L1_5,L2_5) More...
 
std::ostream * m_logStream
 logfile output stream More...
 

Detailed Description

Definition at line 42 of file IAlignModuleTool.h.

Constructor & Destructor Documentation

◆ ~IAlignModuleTool()

virtual Trk::IAlignModuleTool::~IAlignModuleTool ( )
inlinevirtual

Definition at line 47 of file IAlignModuleTool.h.

47 {};

Member Function Documentation

◆ alignModuleListType()

AlignModuleListType Trk::IAlignModuleTool::alignModuleListType ( )
inline

returns type of AlignModuleList (see AlignModuleList.h for more info)

Definition at line 53 of file IAlignModuleTool.h.

◆ alignModules1D()

virtual const AlignModuleList* Trk::IAlignModuleTool::alignModules1D ( )
pure virtual

converts 2-D AlignParList and AlignModuleList for all detector types to single 1-D vectors (used by MatrixTool)

Implemented in Trk::AlignModuleTool.

◆ alignParList1D()

virtual DataVector<AlignPar>* Trk::IAlignModuleTool::alignParList1D ( )
pure virtual

Implemented in Trk::AlignModuleTool.

◆ fillDetAlignmentParameters()

virtual void Trk::IAlignModuleTool::fillDetAlignmentParameters ( const TrkDetElementBase det,
DataVector< AlignPar > *  apVec,
AlignModule::DetectorType  detType = AlignModule::NDetectorTypes 
) const
pure virtual

returns alignment parameters for a detector element, applying AlignModule transforms if necessary

Implemented in Trk::AlignModuleTool.

◆ finalize()

virtual StatusCode Trk::IAlignModuleTool::finalize ( )
pure virtual

◆ findAlignModule() [1/2]

virtual AlignModule* Trk::IAlignModuleTool::findAlignModule ( const RIO_OnTrack rio,
AlignModule::DetectorType  = AlignModule::NDetectorTypes 
) const
pure virtual

finds AlignModule for a detector element (used by AlignTrackCreator)

Implemented in Trk::AlignModuleTool.

◆ findAlignModule() [2/2]

virtual AlignModule* Trk::IAlignModuleTool::findAlignModule ( const TrkDetElementBase det,
AlignModule::DetectorType  = AlignModule::NDetectorTypes 
) const
pure virtual

finds AlignModule for a detector element

Implemented in Trk::AlignModuleTool.

◆ getAlignModuleCollection()

virtual const AlignModuleList* Trk::IAlignModuleTool::getAlignModuleCollection ( ) const
pure virtual

gets all AlignModules for a particular detector type

Implemented in Trk::AlignModuleTool.

◆ getAlignPars()

virtual DataVector<AlignPar>* Trk::IAlignModuleTool::getAlignPars ( const AlignModule alignModule) const
pure virtual

returns alignment parameters for a single module

Implemented in Trk::AlignModuleTool.

◆ getDetectorType()

virtual AlignModule::DetectorType Trk::IAlignModuleTool::getDetectorType ( const TrkDetElementBase det) const
pure virtual

gets detector type for a detector element

Implemented in Trk::AlignModuleTool.

◆ getFullAlignPars()

virtual DataVector<AlignPar>* Trk::IAlignModuleTool::getFullAlignPars ( const AlignModule alignModule) const
pure virtual

returns vector of full AlignPars for an AlignModule

Implemented in Trk::AlignModuleTool.

◆ initialize()

virtual StatusCode Trk::IAlignModuleTool::initialize ( )
pure virtual

◆ interfaceID()

const InterfaceID & Trk::IAlignModuleTool::interfaceID ( )
inlinestatic

Definition at line 149 of file IAlignModuleTool.h.

150  { return IID_TRKALIGNINTERFACES_IAlignModuleTool; }

◆ nAlignParameters()

virtual int Trk::IAlignModuleTool::nAlignParameters ( ) const
pure virtual

number of alignment parameters for all detector types

Implemented in Trk::AlignModuleTool.

◆ restoreModule()

virtual void Trk::IAlignModuleTool::restoreModule ( const AlignModule ) const
inlinevirtual

Reimplemented in Trk::AlignModuleTool.

Definition at line 110 of file IAlignModuleTool.h.

110 {}

◆ setAlignModules()

virtual void Trk::IAlignModuleTool::setAlignModules ( AlignModuleList alignmods,
std::vector< AlignModuleList * > *  idHashToAlignModMap 
)
pure virtual

sets AlignModules for a particular detector type

Implemented in Trk::AlignModuleTool.

◆ setAlignParLists()

virtual void Trk::IAlignModuleTool::setAlignParLists ( DataVector< DataVector< AlignPar > > *  fullAlignParList,
DataVector< DataVector< AlignPar > > *  alignParList 
)
pure virtual

sets AlignPar for AlignModules for a particular detector type

◆ setLogStream()

virtual void Trk::IAlignModuleTool::setLogStream ( std::ostream *  os)
inlinevirtual

sets the output stream for the logfile

Definition at line 140 of file IAlignModuleTool.h.

140 { m_logStream = os; }

◆ setMeasurementProperties()

virtual void Trk::IAlignModuleTool::setMeasurementProperties ( AlignTSOS ) const
inlinevirtual

allows to set detector specific properties of AlignTSOS, like measurement direction (CSC) or fan-out angle (SCT)

Reimplemented in InDet::InDetAlignModuleTool.

Definition at line 87 of file IAlignModuleTool.h.

87 {};

◆ setSubDetElement()

virtual void Trk::IAlignModuleTool::setSubDetElement ( AlignModule::DetectorType  detType,
bool  status 
)
pure virtual

set and retrieve flag whether or not the sub-TrkDetElementBase structures are aligned for a given detector type

Implemented in Trk::AlignModuleTool.

◆ shiftModule()

virtual void Trk::IAlignModuleTool::shiftModule ( const AlignModule ,
const Track ,
AlignModule::TransformParameters  ,
double   
) const
inlinevirtual

shifts and restores tubes traversed by track in module (used by ShiftingDerivCalcTool)

Reimplemented in Trk::AlignModuleTool.

Definition at line 108 of file IAlignModuleTool.h.

109  {}

◆ subDetElement()

virtual bool Trk::IAlignModuleTool::subDetElement ( AlignModule::DetectorType  detType) const
pure virtual

Implemented in Trk::AlignModuleTool.

Member Data Documentation

◆ m_alignModuleListType

int Trk::IAlignModuleTool::m_alignModuleListType
protected

uses Trk enum AlignModuleListType (L1,L2,L3,L1_5,L2_5)

Definition at line 143 of file IAlignModuleTool.h.

◆ m_logStream

std::ostream* Trk::IAlignModuleTool::m_logStream
protected

logfile output stream

Definition at line 145 of file IAlignModuleTool.h.


The documentation for this class was generated from the following file:
Trk::IAlignModuleTool::m_alignModuleListType
int m_alignModuleListType
uses Trk enum AlignModuleListType (L1,L2,L3,L1_5,L2_5)
Definition: IAlignModuleTool.h:143
ReadFromCoolCompare.os
os
Definition: ReadFromCoolCompare.py:231
Trk::IAlignModuleTool::m_logStream
std::ostream * m_logStream
logfile output stream
Definition: IAlignModuleTool.h:145
Trk::AlignModuleListType
AlignModuleListType
Type of AlignModuleList (see description above).
Definition: AlignModuleList.h:32