NcEvent.h

Go to the documentation of this file.

#ifndef NcEvent_h
#define NcEvent_h
// Copyright(c) 2001 NCFS/IIHE, All Rights Reserved.
// See cxx source for full Copyright notice.
 
#include "TDatime.h"
 
#include "NcVertex.h"
#include "NcTimestamp.h"
#include "NcDetector.h"

 
class NcEvent : public NcVertex,public NcTimestamp
{
 public:
  NcEvent();                              // Default constructor
  NcEvent(Int_t n);                       // Create an event to hold initially n tracks
  virtual ~NcEvent();                     // Default destructor
  NcEvent(const NcEvent& evt);            // Copy constructor
  virtual TObject* Clone(const char* name="") const; // Make a deep copy and provide its pointer
  virtual void SetOwner(Bool_t own=kTRUE);// Set ownership of all added objects
  void SetDayTime(TTimeStamp& stamp);     // (Obsolete, see docs) Set date/time exactly as specified (1ns accuracy)
  void SetDayTime(TDatime& stamp);        // (Obsolete, see docs) Set date/time interpreted as local time (1s accuracy)
  void SetRunNumber(Int_t run);           // Set the run number
  void SetEventNumber(Int_t evt);         // Set the event number
  void SetProjectile(Int_t a,Int_t z,Double_t pnuc,Int_t id=0); // Set projectile A, Z, momentum per nucleon and id
  void SetProjectile(Int_t a,Int_t z,Nc3Vector& p,Int_t id=0);  // Set projectile A, Z, 3-momentum per nucleon and id
  Int_t GetProjectileA() const;           // Provide A value of the projectile
  Int_t GetProjectileZ() const;           // Provide Z value of the projectile
  Double_t GetProjectilePnuc() const;     // Provide the projectile momentum value per nucleon
  Int_t GetProjectileId() const;          // Provide the user defined particle ID of the projectile
  void SetTarget(Int_t a,Int_t z,Double_t pnuc,Int_t id=0); // Set target A, Z, momentum per nucleon and id
  void SetTarget(Int_t a,Int_t z,Nc3Vector& p,Int_t id=0);  // Set target A, Z, 3-momentum per nucleon and id
  Int_t GetTargetA() const;               // Provide A value of the target
  Int_t GetTargetZ() const;               // Provide Z value of the target
  Double_t GetTargetPnuc() const;         // Provide the target momentum value per nucleon
  Int_t GetTargetId() const;              // Provide the user defined particle ID of the target
  virtual void Reset();                   // Reset all values
  TTimeStamp GetDayTime() const;          // (Obsolete, see docs) Provide the date and time stamp
  Int_t GetRunNumber() const;             // Provide the run number
  Int_t GetEventNumber() const;           // Provide the event number
  virtual void HeaderData();              // Print the event header information
  using NcVertex::Data;
  virtual void Data(TString f="car",TString u="rad"); // Print the event info within frame f and ang units u
  void SetDevCopy(Int_t j);               // (De)activate creation of private copies of the devices
  Int_t GetDevCopy() const;               // Provide DevCopy flag value      
  void AddDevice(NcDevice& d);            // Add a device to the event
  void AddDevice(NcDevice* d) { if (d) AddDevice(*d); }
  void RemoveDevice(NcDevice* d);         // Remove the specified device from the event
  void SetDetector(NcDetector d);         // Store the detector structure
  void SetDetector(NcDetector* d) { if (d) SetDetector(*d); }
  NcDetector* GetDetector() const;        // Provide the pointer to the (top level) detector structure
  Int_t GetNdevices() const;              // Provide the number of devices
  Int_t GetNdevices(TString classname,TObjArray* hits=0) const; // Provide the number of selected devices
  void ShowDevices(Int_t mode=1,Bool_t header=kTRUE) const;   // Provide on overview of the available devices
  void ShowDevices(TString classname,Int_t mode=1,Bool_t header=kTRUE) const; // Overview of selected devices
  TObjArray* GetDevices(TString classname,TObjArray* devices=0); // Provide references to the devices derived from the specified class
  NcDevice* GetDevice(Int_t i) const;     // Provide i-th device of the event
  NcDevice* GetDevice(TString name) const;// Provide the device with name "name"
  NcDevice* GetIdDevice(Int_t id,TObjArray* devs=0) const; // Get device with identifier "id"
  NcDevice* GetIdDevice(Int_t id,TString classname) const; // Get device with identifier "id" of specified class
  Int_t GetNhits(TString classname);  // Provide number of hits for the specified device class
  TObjArray* GetHits(TString classname,TObjArray* hits=0,TString name="none",Int_t mode=0,Int_t opt=0); // Provide refs to all hits of the specified device class and selections 
  NcSignal* GetIdHit(Int_t id,TString classname); // Provide hit with unique "id" for the specified device class
  TObjArray* SortHits(TString classname,TString name,Int_t mode=-1,Int_t mcal=1,Int_t deadcheck=1,TObjArray* ordered=0); // Sort hits by named signal
  TObjArray* SortHits(TString classname,Int_t idx=1,Int_t mode=-1,Int_t mcal=1,Int_t deadcheck=1,TObjArray* ordered=0);  // Sort hits by indexed signal
  Nc3Vector GetHitPath(TObjArray* hits,Int_t pos=0) const; // Provide the average direction of specified hit pattern
  NcPosition GetCOG(TObjArray* hits,Int_t pos=0,TString slotname="none",Int_t mode=0) const; // Provide the Center Of Gravity of the specified hits
  Double_t GetCVAL(TObjArray* hits,TString obsname,TString weightname="none",Int_t mode=0,Int_t type=1) const; // Provide the Central Value of "obsname" of the specified hits
  void GetExtremes(TString classname,Float_t& vmin,Float_t& vmax,Int_t idx=1,Int_t mode=1,Int_t deadcheck=1); // min and max signal
  void GetExtremes(TString classname,Float_t& vmin,Float_t& vmax,TString name,Int_t mode=1,Int_t deadcheck=1);// min and max signal
  void DisplayHits(TString classname,TString name,Float_t scale=-1,Int_t dp=0,Int_t mode=1,Int_t mcol=4);
  void DisplayHits(TString classname,Int_t idx=1,Float_t scale=-1,Int_t dp=0,Int_t mode=1,Int_t mcol=4);
  void ShowHits(TString classname,Int_t mode=1,TString f="car",TString u="rad"); // Overview of all hits of selected devices
  TObjArray* SortDevices(TString classname,TString name,Int_t mode=-1,Int_t mcal=1,Int_t deadcheck=1,TObjArray* ordered=0); // Sort devices by signal
  TObjArray* SortDevices(TString classname,Int_t idx=1,Int_t mode=-1,Int_t mcal=1,Int_t deadcheck=1,TObjArray* ordered=0);  // Sort devices by signal
  TObjArray* SortDevices(TObjArray* hits,TString name,Int_t mode=-1,Int_t mcal=1,Int_t deadcheck=1,TObjArray* ordered=0);       // Sort devices by signal
  TObjArray* SortDevices(TObjArray* hits,Int_t idx=1,Int_t mode=-1,Int_t mcal=1,Int_t deadcheck=1,TObjArray* ordered=0);        // Sort devices by signal
  void SetWeight(Double_t weight);  // Set the event weight      
  Double_t GetWeight() const;       // Provide the event weight      
  void SetSelectLevel(Int_t level); // Set the event selection level
  Int_t GetSelectLevel() const;     // Provide the event selection level
 
 protected:
  Int_t fRun;                           // The run number
  Int_t fEvent;                         // The event number
  Double_t fWeight;                     // The event weight
  Int_t fSelectLevel;                   // The event selection level (<0:reject 0:undecided >0:accept)
  NcDetector* fDetector;                // Pointer to the (top level) detector structure
  TObjArray* fDevices;                  // Array to hold the pointers to the various devices
  Int_t fDevCopy;                       // Flag to denote creation of private copies of the devices
  TObjArray* fHits;                     
  TObjArray* fOrdered;                  
  TObject* fDisplay;                    
  TObjArray* fDevs;                     
 
  void LoadHits(TString classname,TObjArray* hits=0); // Load references to the hits registered to the specified device class
  void CreateDetector(); // Create a default detector structure
 
 ClassDef(NcEvent,12) // Creation and investigation of an NCFS generic event structure.
};
#endif