NcSignal.h

Go to the documentation of this file.

#ifndef NcSignal_h
#define NcSignal_h
// Copyright(c) 1999 NCFS/IIHE, All Rights Reserved.
// See cxx source for full Copyright notice.
 
#include "TObject.h"
#include "TArrayF.h"
#include "TH1.h"
#include "TObjArray.h"
#include "TArrayI.h"
 
#include "NcPosition.h"
#include "NcAttrib.h"
#include "NcObjMatrix.h"
#include "NcSample.h"
 
class NcDevice;
class NcTrack;

 
class NcSignal : public TNamed,public NcPosition,public NcAttrib
{
 public:
  NcSignal(const char* name="",const char* title="");           // Default constructor
  virtual ~NcSignal();                                          // Destructor
  NcSignal(const NcSignal& s);                                  // Copy constructor
  virtual TObject* Clone(const char* name="") const;            // Make a deep copy and provide its pointer
  virtual void SetSignal(Double_t sig,Int_t j=1);               // Store signal value for the j-th slot
  virtual void SetSignal(Double_t sig,TString name);            // Store signal value for the name-specified slot
  virtual void AddSignal(Double_t sig,Int_t j=1);               // Add value to the signal of the j-th slot
  virtual void AddSignal(Double_t sig,TString name);            // Add value to the signal of the name-specified slot
  virtual Float_t GetSignal(Int_t j=1,Int_t mode=0) const;      // Provide j-th (corrected) signal value
  virtual Float_t GetSignal(TString name,Int_t mode=0) const;   // Provide name-specified (corrected) signal value
  virtual void SetSignalError(Double_t dsig,Int_t j=1);         // Store error on the signal of the j-th slot
  virtual void SetSignalError(Double_t dsig,TString name);      // Store error on the signal of the name-specified slot
  virtual Float_t GetSignalError(Int_t j=1) const;              // Provide error on the signal of the j-th slot
  virtual Float_t GetSignalError(TString name) const;           // Provide err. on the sig. of the name-specified slot
  virtual void ResetSignals(Int_t mode=0);                      // Selective reset of signal values and/or errors
  virtual void DeleteSignals(Int_t mode=0);                     // Selectie delete of signal values and/or errors
  virtual void Reset(Int_t mode=0);                             // Reset signal and position values and errors
  virtual void Data(TString f="car",TString u="rad") const;     // Print all signal info for frame f and ang units u
  virtual void List(Int_t j=0) const;                           // Print signal info for the j-th (all) slot(s)
  virtual void List(TString name) const;                        // Print signal info for the name-specified slot
  void ListWaveform(Int_t j=0) const;                           // Print info for the j-th (all) waveform(s)
  void ListSample(Int_t j=0) const;                             // Print info for the j-th (all) sample(s)
  void ListTrack(Int_t j=0) const;                              // Print info for the j-th (all) assoc. track(s)
  Int_t GetNvalues() const;                                     // Provide the number of signal values
  Int_t GetNerrors() const;                                     // Provide the number of specified errors
  virtual Int_t GetNslots() const;                              // Provide the number of exising slots
  Int_t GetNwaveforms() const;                                  // Provide the number of specified waveforms
  void SetWaveform(TH1F* waveform,Int_t j=1);                   // Set the histogram for the j-th waveform
  TH1F* GetWaveform(Int_t j=1) const;                           // Pointer to the histo of the j-th waveform
  TH1F* GetWaveform(TString name) const;                        // Pointer to the waveform with the specified name
  Int_t GetWaveformIndex(TString name) const;                   // Index of the waveform with the specified name
  void ResetWaveform(Int_t j=1);                                // Reset the histo of the j-th waveform
  void ResetWaveform(TString name);                             // Reset the waveform histo with the specified name
  void DeleteWaveform(Int_t j=1);                               // Delete histo of the j-th waveform
  void DeleteWaveform(TString name);                            // Delete waveform histo with the specified name
  Int_t GetNsamples() const;                                    // Provide the number of specified samples
  void SetSample(NcSample* sample,Int_t j=1);                   // Set the sample data for the j-th sample
  NcSample* GetSample(Int_t j=1) const;                         // Pointer to the j-th sample
  NcSample* GetSample(TString name) const;                      // Pointer to the sample with the specified name
  Int_t GetSampleIndex(TString name) const;                     // Index of the sample with the specified name
  void ResetSample(Int_t j=1);                                  // Reset the data of the j-th sample
  void ResetSample(TString name);                               // Reset the sample with the specified name
  void DeleteSample(Int_t j=1);                                 // Delete the j-th sample
  void DeleteSample(TString name);                              // Delete te sample with the specified name
  Int_t GetNlinks(TObject* obj=0,Int_t j=0) const;              // Number of links for the specified object
  Int_t GetNlinks(TObject* obj,TString name) const;             // Number of links for the specified object
  void SetLink(TObject* obj,Int_t j=1,Int_t k=1);               // Link object to the j-th slot at position k
  void SetLink(TObject* obj,TString name,Int_t k=1);            // Link object to the name-specified slot at pos. k
  void AddLink(TObject* obj,Int_t j=1);                         // Link obj to the j-th slot at 1st free position
  void AddLink(TObject* obj,TString name);                      // Link obj to the name-specified slot at 1st free pos.
  TObject* GetLink(Int_t j=1,Int_t k=1) const;                  // Pointer of the object linked to the j-th slot
  TObject* GetLink(TString name,Int_t k=1) const;               // Pointer of object linked to the name-specified slot
  Int_t GetIndices(TObject* obj,TArrayI& js,TArrayI& ks) const; // Slot and pos. indices for linked objects
  Int_t GetIndices(TObject* obj,Int_t j,TArrayI& ks) const;     // Pos. indices for linked objects of j-th slot 
  Int_t GetIndices(TObject* obj,TString name,TArrayI& ks) const;// Pos. indices for linked objects of name-spec. slot 
  Int_t GetIndices(TObject* obj,TArrayI& js,Int_t k) const;     // Slot indices for linked objects at pos. k 
  void ResetLink(Int_t j=1,Int_t k=1);                          // Reset the link(s) of the j-th slot 
  void ResetLink(TString name,Int_t k=1);                       // Reset the link(s) of the name-specified slot 
  void ResetLinks(TObject* obj,Int_t j=0,Int_t k=0);            // Reset link(s) to object obj for j-th slot
  void ResetLinks(TObject* obj,TString name,Int_t k=0);         // Reset link(s) to object obj for name-specified slot
  void SetSwapMode(Int_t swap=1);                               // Set swapmode flag for the link storage
  Int_t GetSwapMode() const;                                    // Provide swapmode flag for the link storage
  NcDevice* GetDevice() const;                                  // Provide pointer to the owning device 
  void AddTrack(NcTrack& t,Int_t mode=1);                       // Relate an NcTrack to this signal
  void RemoveTrack(NcTrack& t,Int_t mode=1);                    // Remove related NcTrack from this signal
  void RemoveTracks(Int_t mode=1);                              // Remove all related NcTracks from this signal
  Int_t GetNtracks(NcTrack* t=0) const;                         // Provide number of related NcTracks
  NcTrack* GetTrack(Int_t j) const;                             // Access to the related NcTrack number j
  NcTrack* GetIdTrack(Int_t id) const;                          // Access to the related NcTrack with ID=id
  Int_t GetSignalFlag(Int_t j=1) const;                         // Provide signal value flag of the j-th slot
  Int_t GetSignalFlag(TString name) const;                      // Provide signal value flag of the name specified slot
  Int_t GetErrorFlag(Int_t j=1) const;                          // Provide error value flag of the j-th slot
  Int_t GetErrorFlag(TString name) const;                       // Provide error value flag of the name specified slot
  NcSample* DisplaySample(Int_t j=1,Int_t i=1) const;           // Display a graph of the selected variable of a sample
  NcSample* DisplaySample(TString name,Int_t i=1) const;        // Display a graph of the selected variable of a sample
 
  // Facilities that may only be used internally by NcDevice (or derived) objects
  void SetDevice(NcDevice* dev); // Store pointer to the device that owns this signal
  Bool_t fDevset;                // Flag to allow the setting of a device as owner (kTRUE) or not (kFALSE)
 
 protected:
  void SetSigFlags(Int_t is,Int_t ie,Int_t j); // Set flags for signal and/or error value settings
  TArrayF* fSignals;                           // Signal values
  TArrayF* fDsignals;                          // Errors on signal values
  TArrayI* fSigflags;                          // Flags to mark setting of signal and/or error values 
  TObjArray* fWaveforms;                       // The 1D histograms containing the signal waveforms
  TObjArray* fSamples;                         // The full data samples containing the recorded data series 
  NcObjMatrix* fLinks;                         // Pointers of objects related to the various slots
  TObject* fDevice;                            // Pointer to a related device or the device that owns this signal
  TObjArray* fTracks;                          // Pointers to associated tracks
 
 ClassDef(NcSignal,5) // Generic handling of (extrapolated) detector signals.
};
#endif