Electronics.h

Go to the documentation of this file.

#ifndef CONVENTIONS_ELECTRONICS_H
#define CONVENTIONS_ELECTRONICS_H 1

#include "Conventions/Detectors.h"
#include "CLHEP/Units/SystemOfUnits.h"
#include <vector>

namespace DayaBay {

  typedef std::vector<int> DigitalSignal;
  typedef std::vector<double> AnalogSignal;

  class ElecChannelId : public Detector {
  public:
    ElecChannelId() : Detector(0) {}

    ElecChannelId(int board, int connector,
                Site::Site_t site,
                DetectorId::DetectorId_t det);

    ElecChannelId(const ElecChannelId& channel) : Detector(channel) {}

    ElecChannelId(int data) : Detector(data) {}
    virtual ~ElecChannelId();

    ElecChannelId& operator=(const ElecChannelId& id)
      { m_data = id.m_data; return *this; }

    int board() const;

    int connector() const;

    virtual bool bogus() const;
  };

  class FeeChannelId : public ElecChannelId {
  public:
    FeeChannelId() : ElecChannelId(0) {}
    FeeChannelId(int board, int connector,
               Site::Site_t site, DetectorId::DetectorId_t det) :
               ElecChannelId(board, connector, site, det) {}
    FeeChannelId(const FeeChannelId& channel) : ElecChannelId(channel) {}
    FeeChannelId(int data) : ElecChannelId(data) {}
    virtual ~FeeChannelId();
    // Assignment Operator
    FeeChannelId& operator=(const FeeChannelId& id)
      { m_data = id.m_data; return *this; }

    FeeChannelId boardId() const;

    virtual bool bogus() const;

  };

  class FadcChannelId : public ElecChannelId {
  public:
    FadcChannelId() : ElecChannelId(0) {}
    FadcChannelId(int connector,
               Site::Site_t site, DetectorId::DetectorId_t det) :
               ElecChannelId(20, connector, site, det) {}
        FadcChannelId(int board, int connector,
               Site::Site_t site, DetectorId::DetectorId_t det) :
               ElecChannelId(board, connector, site, det) {}
    FadcChannelId(const FeeChannelId& channel) : ElecChannelId(channel) {}
    FadcChannelId(int data) : ElecChannelId(data) {}
    virtual ~FadcChannelId();
    // Assignment Operator
    FadcChannelId& operator=(const FadcChannelId& id)
      { m_data = id.m_data; return *this; }

    // Return the electronics identifier of the entire board
    FadcChannelId boardId() const;
    // given an input channel return the channel Id of the output.
    int outputId() const;
    // given an output channel return the first input channel Id.
    int firstInputId() const;
    // given an output channel return the second input channel Id.
    int secondInputId() const;

    virtual bool bogus() const;
  };

  class FecChannelId : public ElecChannelId {
  public:
    FecChannelId() : ElecChannelId(0) {}
    FecChannelId(int board, int connector,
                 Site::Site_t site, DetectorId::DetectorId_t det) :
      ElecChannelId(board, connector, site, det) {}
    FecChannelId(unsigned int cfId, unsigned int fecId, int connector,
                 Site::Site_t site, DetectorId::DetectorId_t det) :
      ElecChannelId(convertToBoard(cfId, fecId), connector, site, det) {}
    FecChannelId(const FecChannelId& channel) : ElecChannelId(channel) {}
    FecChannelId(int data) : ElecChannelId(data) {}
    virtual ~FecChannelId();
    // Assignment Operator
    FecChannelId& operator=(const FecChannelId& id)
      { m_data = id.m_data; return *this; }

    FecChannelId boardId() const;

    unsigned int cfId() const;
    unsigned int fecId() const;
    unsigned int rtmCfId() const;
    unsigned int rtmRotId() const;

    unsigned int fecHit() const;

    virtual bool bogus() const;

    static unsigned int connectorToHit(unsigned int connector) {return 0x1<<connector;}
    static unsigned int hitToConnector(unsigned int hit) {
        for (int i = 0; i < 32; i++, hit>>=1)
        if (0x1&hit) return i;
        return 0;
    }


  private:
    int convertToBoard(unsigned int cfId, unsigned int fecId) const;
    unsigned int convertToCfId(int board) const;
    unsigned int convertToFecId(int board) const;
  };

  const int BaseFrequencyHz = int(40 * 1e6); // 40 MHz
  // Clock cycles relative to base frequency
  const int TdcCycles = 16;
  const int AdcCycles = 1;
  const int EsumCycles = 4;
  const int NhitCycles = 2;
  // Convenience Frequencies
  const int TdcFrequencyHz = BaseFrequencyHz * TdcCycles;
  const int AdcFrequencyHz = BaseFrequencyHz * AdcCycles;
  const int EsumFrequencyHz = BaseFrequencyHz * EsumCycles;
  const int NhitFrequencyHz = BaseFrequencyHz * NhitCycles;

  const int FadcFrequencyHz = int(1 * 1e9); // 1 GHz

  // Time tolerances - amount of time to extend ElecHeader time window
  //                   (extending from SimHeader time window)
  // preTimeTolerance based on width of ADC widened shaped pulse
  // postTimeTolerance based on timing of after pulses
  const double preTimeTolerance  = 300.0*CLHEP::nanosecond;
  const double postTimeTolerance = 10.0*CLHEP::microsecond;

  // Number of trigger window cycles - default value
  const int TriggerWindowCycles = 8;

  namespace FeeGain
  {
    enum FeeGain_t {
      kUnknown = 0,
      kHigh,
      kLow
    };

    // FIXME: Add these functions to Electronics.cc
    // Convert type enum back and forth to string.
    //const char* AsString(FeeGain_t gain);
    //FeeGain_t FromString(const char* str);
  }

  namespace Threshold
  {
    enum Threshold_t {
      kUnknown = 0,
      kCrossing,
      kAbove
    };
  }

  namespace ESumComp
  {
    enum ESumComp_t {
      kUnknown  = 0,
      kESumLow  = 0x01,
      kESumHigh = 0x02,
      kESumTotal= 0x04,
      kESumNone = 0x08,
    };
  }

  std::ostream& operator<<(std::ostream& str,
                           const DayaBay::ElecChannelId& elecChannel);

}

#endif // CONVENTIONS_ELECTRONICS_H

// Local Variables: **
// c-basic-offset:2 **
// End: **