THaSpectrometer.h

Go to the documentation of this file.

#ifndef Podd_THaSpectrometer_h_
#define Podd_THaSpectrometer_h_
 
//
// THaSpectrometer
//
 
#include "THaApparatus.h"
#include "THaVertexModule.h"
#include "THaTrackingModule.h"
#include "TClonesArray.h"
#include "TVector3.h"
#include "TRotation.h"
#include "THaParticleInfo.h"
#include "THaPidDetector.h"
#include <cassert>
 
class THaTrack;
class TList;
class THaCut;
 
class THaSpectrometer : public THaApparatus, public THaTrackingModule,
                        public THaVertexModule {
  
public:
  virtual ~THaSpectrometer();
  
  // Main functions
  virtual void             Clear( Option_t* opt="");
  virtual Int_t            CoarseTrack();
  virtual Int_t            CoarseReconstruct();
  virtual EStatus          Init( const TDatime& run_time );
  virtual Int_t            Track();
  virtual Int_t            Reconstruct();
  virtual Int_t            CalcPID();
  virtual Int_t            FindVertices( TClonesArray& tracks ) = 0;
  virtual Int_t            TrackCalc() = 0;
 
  // Auxiliary functions
  virtual Int_t            AddDetector( THaDetector* det, Bool_t quiet = false,
                                        Bool_t first = false );
  virtual Int_t            AddPidParticle( const char* shortname, 
                                           const char* name,
                                           Double_t mass, Int_t charge = 0 );
  virtual void             DefinePidParticles();
          THaTrack*        GetGoldenTrack() const { return fGoldenTrack; }
          Int_t            GetNpidParticles() const;
          Int_t            GetNpidDetectors() const;
          THaParticleInfo* GetPidParticleInfo( Int_t i ) const;
          THaPidDetector*  GetPidDetector( Int_t i ) const;
          Int_t            GetNTracks()  const { return fTracks->GetLast()+1; }
          TClonesArray*    GetTracks()   const { return fTracks; }
          TClonesArray*    GetTrackPID() const { return fTrackPID; }
  virtual const TVector3&  GetVertex()   const;
  virtual Bool_t           HasVertex() const;
 
          Bool_t           IsDone( UInt_t stage ) const;
          Bool_t           IsPID() const       { return fPID; }
          void             SetGoldenTrack( THaTrack* t ) { fGoldenTrack = t; }
          void             SetPID( Bool_t b = true )    { fPID = b; }
 
  // The following is specific to small-acceptance pointing spectrometers
  // using spectrometer-specific coordinates such as TRANSPORT
  const   TRotation&       GetToLabRot() const { return fToLabRot; }
  const   TRotation&       GetToTraRot() const { return fToTraRot; }
  const   TVector3&        GetPointingOffset() const { return fPointingOffset; }
          Double_t         GetThetaGeo() const { return fThetaGeo; }
          Double_t         GetPhiGeo()   const { return fPhiGeo; }
          Double_t         GetThetaSph() const { return fThetaSph; }
          Double_t         GetPhiSph()   const { return fPhiSph; }
          Double_t         GetPcentral() const { return fPcentral; }
          Double_t         GetCollDist() const { return fCollDist; }
 
          void             SetCentralAngles( Double_t th, Double_t ph,
                                             Bool_t bend_down );
 
  virtual void             TrackToLab( THaTrack& track, TVector3& pvect ) const;
  virtual void             TransportToLab( Double_t p, Double_t th, 
                                           Double_t ph, TVector3& pvect ) const;
  virtual void             LabToTransport( const TVector3& vertex, 
                                           const TVector3& pvect,
                                           TVector3& tvertex,
                                           Double_t* ray ) const;
          void             LabToTransport( const TVector3& vertex, 
                                           const TVector3& pvect,
                                           Double_t* ray ) const;
  enum EStagesDone {
    kCoarseTrack = BIT(0),
    kCoarseRecon = BIT(1),
    kTracking    = BIT(2),
    kReconstruct = BIT(3)
  };
 
protected:
 
  static const Int_t kInitTrackMultiplicity = 5;
 
  TClonesArray*   fTracks;                //Tracks 
  TClonesArray*   fTrackPID;              //PID info for the tracks
  TList*          fTrackingDetectors;     //Tracking detectors
  TList*          fNonTrackingDetectors;  //Non-tracking detectors
  TObjArray*      fPidDetectors;          //PID detectors
  TObjArray*      fPidParticles;          //Particles for which we want PID
  THaTrack*       fGoldenTrack;           //Golden track within fTracks
 
  // The following is specific to small-acceptance pointing spectrometers
  TRotation       fToLabRot;              //Rotation matrix from TRANSPORT to lab
  TRotation       fToTraRot;              //Rotation matrix from lab to TRANSPORT
  TVector3        fPointingOffset;        //Optical point in lab coordinate system
  Double_t        fThetaGeo;              //In-plane geographic central angle (rad)
  Double_t        fPhiGeo;                //Out-of-plane geographic central angle (rad)
  Double_t        fThetaSph, fPhiSph;     //Central angles in spherical coords. (rad)
  Double_t        fSinThGeo, fCosThGeo;   //Sine and cosine of central angles
  Double_t        fSinPhGeo, fCosPhGeo;   // in geographical coordinates
  Double_t        fSinThSph, fCosThSph;   //Sine and cosine of central angles in
  Double_t        fSinPhSph, fCosPhSph;   // spherical coordinates
  Double_t        fPcentral;              //Central momentum (GeV)
  Double_t        fCollDist;              //Distance from collimator to target center (m)
 
  // Status flags
  UInt_t          fStagesDone;            //Bitfield of completed analysis stages
  Bool_t          fPID;                   //PID enabled
 
  // only derived classes can construct me
  THaSpectrometer( const char* name, const char* description );
 
  virtual Int_t   DefineVariables( EMode mode = kDefine );
  virtual Int_t   ReadRunDatabase( const TDatime& date );
  virtual void    ListInit();     // Initialize lists of detector types
  virtual void    PidInit();      // Initialize PID structures
 
  ClassDef(THaSpectrometer,1)     // A generic spectrometer
};
 
 
//---------------- inlines ----------------------------------------------------
inline Int_t THaSpectrometer::GetNpidParticles() const
{
  return fPidParticles->GetLast()+1;
}
 
//_____________________________________________________________________________
inline Int_t THaSpectrometer::GetNpidDetectors() const
{
  return fPidDetectors->GetLast()+1;
}
 
//_____________________________________________________________________________
inline THaParticleInfo* THaSpectrometer::GetPidParticleInfo( Int_t i ) const
{
  assert(dynamic_cast<THaParticleInfo*>(fPidParticles->At(i)));
  return static_cast<THaParticleInfo*>( fPidParticles->At(i) );
}
 
//_____________________________________________________________________________
inline THaPidDetector* THaSpectrometer::GetPidDetector( Int_t i ) const
{
  assert(dynamic_cast<THaPidDetector*>(fPidDetectors->At(i)));
  return static_cast<THaPidDetector*>( fPidDetectors->At(i) );
}
 
//_____________________________________________________________________________
inline 
Bool_t THaSpectrometer::IsDone( UInt_t stage ) const
{
  return ((fStagesDone & stage) != 0);
}
 
//_____________________________________________________________________________
inline
void THaSpectrometer::LabToTransport( const TVector3& vertex,
                                      const TVector3& pvect,
                                      Double_t* ray ) const
{
  TVector3 dummy;
  LabToTransport( vertex, pvect, dummy, ray );
}
 
#endif