OptoScanAnalysis Class Reference

Histogram-based analysis for opto bias/gain scan. More...

#include <OptoScanAnalysis.h>

Inheritance diagram for OptoScanAnalysis:

Public Member Functions
const VFloat &	baseSlope () const
const VInt &	bias () const
const uint16_t &	gain () const
bool	isValid () const override
const VFloat &	liftOff () const
const VFloat &	linkNoise () const
const VFloat &	measGain () const
	OptoScanAnalysis (const uint32_t &key)
	OptoScanAnalysis ()
void	print (std::stringstream &, uint32_t gain_setting=sistrip::invalid_) override
void	reset () override
void	summary (std::stringstream &) const override
const VFloat &	threshold () const
const VFloat &	tickHeight () const
const VFloat &	zeroLight () const
	~OptoScanAnalysis () override
Public Member Functions inherited from CommissioningAnalysis
virtual void	addErrorCode (const std::string &error)
	CommissioningAnalysis (const uint32_t &key, const std::string &my_name)
	CommissioningAnalysis (const std::string &my_name)
const uint32_t &	dcuId () const
void	dcuId (const uint32_t &)
const uint32_t &	detId () const
void	detId (const uint32_t &)
const uint32_t &	fecKey () const
void	fecKey (const uint32_t &)
const uint32_t &	fedKey () const
void	fedKey (const uint32_t &)
const VString &	getErrorCodes () const
virtual void	header (std::stringstream &) const
const std::string &	myName () const
void	setErrorCodes (const VString &errors)
virtual	~CommissioningAnalysis ()

Static Public Attributes
static const uint16_t	defaultBiasSetting_ = sistrip::invalid_
static const uint16_t	defaultGainSetting_ = sistrip::invalid_
static const float	fedAdcGain_ = 1.024 / 1024.

Private Attributes
VFloat	baseSlope_
VInt	bias_
uint16_t	gain_
VFloat	liftOff_
VFloat	linkNoise_
VFloat	measGain_
VFloat	threshold_
VFloat	tickHeight_
VFloat	zeroLight_

Friends
class	OptoScanAlgorithm

Additional Inherited Members
Public Types inherited from CommissioningAnalysis
typedef std::vector< bool >	VBool
typedef std::vector< float >	VFloat
typedef std::vector< uint16_t >	VInt
typedef std::vector< std::string >	VString
typedef std::vector< VBool >	VVBool
typedef std::vector< VFloat >	VVFloat
typedef std::vector< VInt >	VVInt

Detailed Description

Histogram-based analysis for opto bias/gain scan.

Author

M. Wingham, R.Bainbridge

Definition at line 15 of file OptoScanAnalysis.h.

Constructor & Destructor Documentation

OptoScanAnalysis() [1/2]

OptoScanAnalysis::OptoScanAnalysis

(

const uint32_t &

key

)

Definition at line 26 of file OptoScanAnalysis.cc.

    : CommissioningAnalysis(key, sistrip::optoScanAnalysis_),
      gain_(sistrip::invalid_),
      bias_(4, sistrip::invalid_),
      measGain_(4, sistrip::invalid_),
      zeroLight_(4, sistrip::invalid_),
      linkNoise_(4, sistrip::invalid_),
      liftOff_(4, sistrip::invalid_),
      threshold_(4, sistrip::invalid_),
      tickHeight_(4, sistrip::invalid_),
      baseSlope_(4, sistrip::invalid_) {
  ;
}

OptoScanAnalysis() [2/2]

OptoScanAnalysis::OptoScanAnalysis

(

)

Definition at line 42 of file OptoScanAnalysis.cc.

    : CommissioningAnalysis(sistrip::optoScanAnalysis_),
      gain_(sistrip::invalid_),
      bias_(4, sistrip::invalid_),
      measGain_(4, sistrip::invalid_),
      zeroLight_(4, sistrip::invalid_),
      linkNoise_(4, sistrip::invalid_),
      liftOff_(4, sistrip::invalid_),
      threshold_(4, sistrip::invalid_),
      tickHeight_(4, sistrip::invalid_),
      baseSlope_(4, sistrip::invalid_) {
  ;
}

~OptoScanAnalysis()

OptoScanAnalysis::~OptoScanAnalysis ( )

inlineoverride

Definition at line 23 of file OptoScanAnalysis.h.

{ ; }

Member Function Documentation

baseSlope()

const OptoScanAnalysis::VFloat & OptoScanAnalysis::baseSlope ( ) const

inline

Baseline slope [ADC/I2C]

Definition at line 122 of file OptoScanAnalysis.h.

References baseSlope_.

{ return baseSlope_; }

bias()

const OptoScanAnalysis::VInt & OptoScanAnalysis::bias ( ) const

inline

LLD bias value for each gain setting

Definition at line 115 of file OptoScanAnalysis.h.

References bias_.

{ return bias_; }

gain()

const uint16_t & OptoScanAnalysis::gain ( ) const

inline

Optimum LLD gain setting

Definition at line 114 of file OptoScanAnalysis.h.

References gain_.

Referenced by print(), and summary().

{ return gain_; }

isValid()

bool OptoScanAnalysis::isValid ( void  ) const

overridevirtual

Identifies if analysis is valid or not.

Reimplemented from CommissioningAnalysis.

Definition at line 72 of file OptoScanAnalysis.cc.

References bias_, relativeConstraints::empty, gain_, CommissioningAnalysis::getErrorCodes(), and sistrip::maximum_.

Referenced by ntupleDataFormat._Object::_checkIsValid(), print(), core.AutoHandle.AutoHandle::ReallyLoad(), and summary().

                                     {
  return (gain_ < sistrip::maximum_ && bias_[gain_] < sistrip::maximum_ && getErrorCodes().empty());
}

liftOff()

const OptoScanAnalysis::VFloat & OptoScanAnalysis::liftOff ( ) const

inline

Baseline "lift-off" values [mA]

Definition at line 119 of file OptoScanAnalysis.h.

References liftOff_.

{ return liftOff_; }

linkNoise()

const OptoScanAnalysis::VFloat & OptoScanAnalysis::linkNoise ( ) const

inline

Noise value at "zero light" levels [ADC]

Definition at line 118 of file OptoScanAnalysis.h.

References linkNoise_.

{ return linkNoise_; }

measGain()

const OptoScanAnalysis::VFloat & OptoScanAnalysis::measGain ( ) const

inline

Measured gains for each setting [V/V].

Definition at line 116 of file OptoScanAnalysis.h.

References measGain_.

{ return measGain_; }

print()

void OptoScanAnalysis::print ( std::stringstream &  ss, uint32_t  gain_setting = sistrip::invalid_  )

overridevirtual

Prints analysis results.

Implements CommissioningAnalysis.

Definition at line 125 of file OptoScanAnalysis.cc.

References baseSlope_, bias_, relativeConstraints::empty, alignBH_cfg::fixed, gain(), gain_, CommissioningAnalysis::getErrorCodes(), CommissioningAnalysis::header(), isValid(), liftOff_, linkNoise_, measGain_, sistrip::mlCommissioning_, CommissioningAnalysis::myName(), contentValuesCheck::ss, threshold_, tickHeight_, and zeroLight_.

                                                               {
  if (gain >= 4) {
    gain = gain_;
  }

  if (gain >= bias_.size()) {
    edm::LogWarning(mlCommissioning_) << "[" << myName() << "::" << __func__ << "]"
                                      << " Unexpected gain setting: " << gain;
    return;
  }

  header(ss);
  ss << std::fixed << std::setprecision(2) << " Optimum LLD gain setting : " << gain_ << std::endl
     << " LLD gain setting         : " << gain << std::endl
     << " LLD bias setting         : " << bias_[gain] << std::endl
     << " Measured gain      [V/V] : " << measGain_[gain] << std::endl
     << " Zero light level   [ADC] : " << zeroLight_[gain] << std::endl
     << " Link noise [ADC]         : " << linkNoise_[gain] << std::endl
     << " Baseline 'lift off' [mA] : " << liftOff_[gain] << std::endl
     << " Laser threshold     [mA] : " << threshold_[gain] << std::endl
     << " Tick mark height   [ADC] : " << tickHeight_[gain] << std::endl
     << " Baseline slope [ADC/I2C] : " << baseSlope_[gain] << std::endl
     << std::boolalpha << " isValid                  : " << isValid() << std::endl
     << std::noboolalpha << " Error codes (found " << std::setw(2) << std::setfill(' ') << getErrorCodes().size()
     << ")   : ";
  if (getErrorCodes().empty()) {
    ss << "(none)";
  } else {
    VString::const_iterator istr = getErrorCodes().begin();
    VString::const_iterator jstr = getErrorCodes().end();
    for (; istr != jstr; ++istr) {
      ss << *istr << " ";
    }
  }
  ss << std::endl;
}

reset()

void OptoScanAnalysis::reset ( void  )

overridevirtual

Resets analysis member data.

Implements CommissioningAnalysis.

Definition at line 58 of file OptoScanAnalysis.cc.

References baseSlope_, bias_, gain_, sistrip::invalid_, liftOff_, linkNoise_, measGain_, threshold_, tickHeight_, and zeroLight_.

Referenced by MatrixReader.MatrixReader::__init__(), and MatrixReader.MatrixReader::showRaw().

                             {
  gain_ = sistrip::invalid_;
  bias_ = VInt(4, sistrip::invalid_);
  measGain_ = VFloat(4, sistrip::invalid_);
  zeroLight_ = VFloat(4, sistrip::invalid_);
  linkNoise_ = VFloat(4, sistrip::invalid_);
  liftOff_ = VFloat(4, sistrip::invalid_);
  threshold_ = VFloat(4, sistrip::invalid_);
  tickHeight_ = VFloat(4, sistrip::invalid_);
  baseSlope_ = VFloat(4, sistrip::invalid_);
}

summary()

void OptoScanAnalysis::summary ( std::stringstream &  ss ) const

overridevirtual

Overrides base method.

Reimplemented from CommissioningAnalysis.

Definition at line 78 of file OptoScanAnalysis.cc.

References sistrip::extrainfo::baselineRms_, SiStripFecKey::ccuAddr(), SiStripFecKey::ccuChan(), sistrip::controlView_, sistrip::extrainfo::digital_, sistrip::dir_, sistrip::dqmRoot_, sistrip::EXPERT_HISTO, SiStripFecKey::fecCrate(), CommissioningAnalysis::fecKey(), SiStripFecKey::fecRing(), SiStripFecKey::fecSlot(), sistrip::FED_KEY, CommissioningAnalysis::fedKey(), gain(), sistrip::extrainfo::gain_, isValid(), SiStripKey::key(), sistrip::LLD_CHAN, SiStripFecKey::lldChan(), CommissioningAnalysis::myName(), castor_dqm_sourceclient_file_cfg::path, SiStripEnumsAndStrings::runType(), contentValuesCheck::ss, AlCaHLTBitMon_QueryRunRegistry::string, and runGCPTkAlMap::title.

                                                        {
  SiStripFecKey fec_key(fecKey());
  SiStripFedKey fed_key(fedKey());

  sistrip::RunType type = SiStripEnumsAndStrings::runType(myName());

  std::stringstream extra1, extra2, extra3;
  extra1 << sistrip::extrainfo::gain_ << gain() << sistrip::extrainfo::digital_ << "0";
  extra2 << sistrip::extrainfo::gain_ << gain() << sistrip::extrainfo::digital_ << "1";
  extra3 << sistrip::extrainfo::gain_ << gain() << sistrip::extrainfo::baselineRms_;

  std::string title1 = SiStripHistoTitle(sistrip::EXPERT_HISTO,
                                         type,
                                         sistrip::FED_KEY,
                                         fed_key.key(),
                                         sistrip::LLD_CHAN,
                                         fec_key.lldChan(),
                                         extra1.str())
                           .title();
  std::string title2 = SiStripHistoTitle(sistrip::EXPERT_HISTO,
                                         type,
                                         sistrip::FED_KEY,
                                         fed_key.key(),
                                         sistrip::LLD_CHAN,
                                         fec_key.lldChan(),
                                         extra2.str())
                           .title();
  std::string title3 = SiStripHistoTitle(sistrip::EXPERT_HISTO,
                                         type,
                                         sistrip::FED_KEY,
                                         fed_key.key(),
                                         sistrip::LLD_CHAN,
                                         fec_key.lldChan(),
                                         extra3.str())
                           .title();

  ss << " Summary"
     << ":" << (isValid() ? "Valid" : "Invalid") << ":" << sistrip::controlView_ << ":" << fec_key.fecCrate() << "/"
     << fec_key.fecSlot() << "/" << fec_key.fecRing() << "/" << fec_key.ccuAddr() << "/" << fec_key.ccuChan() << ":"
     << sistrip::dqmRoot_ << sistrip::dir_ << "Collate" << sistrip::dir_
     << SiStripFecKey(fec_key.fecCrate(), fec_key.fecSlot(), fec_key.fecRing(), fec_key.ccuAddr(), fec_key.ccuChan())
            .path()
     << ":" << title1 << ";" << title2 << ";" << title3 << std::endl;
}

threshold()

const OptoScanAnalysis::VFloat & OptoScanAnalysis::threshold ( ) const

inline

Laser thresholds [mA]

Definition at line 120 of file OptoScanAnalysis.h.

References threshold_.

{ return threshold_; }

tickHeight()

const OptoScanAnalysis::VFloat & OptoScanAnalysis::tickHeight ( ) const

inline

Tick mark heights [ADC]

Definition at line 121 of file OptoScanAnalysis.h.

References tickHeight_.

{ return tickHeight_; }

zeroLight()

const OptoScanAnalysis::VFloat & OptoScanAnalysis::zeroLight ( ) const

inline

"Zero light" levels [ADC]

Definition at line 117 of file OptoScanAnalysis.h.

References zeroLight_.

{ return zeroLight_; }

Friends And Related Function Documentation

OptoScanAlgorithm

friend class OptoScanAlgorithm

friend

Definition at line 25 of file OptoScanAnalysis.h.

Member Data Documentation

baseSlope_

VFloat OptoScanAnalysis::baseSlope_

private

Slope of baseline [ADC/I2C]

Definition at line 109 of file OptoScanAnalysis.h.

Referenced by baseSlope(), print(), and reset().

bias_

VInt OptoScanAnalysis::bias_

private

LLD bias value for each gain setting

Definition at line 88 of file OptoScanAnalysis.h.

Referenced by bias(), isValid(), print(), and reset().

defaultBiasSetting_

const uint16_t OptoScanAnalysis::defaultBiasSetting_ = sistrip::invalid_

static

Default LLD bias setting if analysis fails.

Definition at line 76 of file OptoScanAnalysis.h.

Referenced by OptoScanAlgorithm::analyse().

defaultGainSetting_

const uint16_t OptoScanAnalysis::defaultGainSetting_ = sistrip::invalid_

static

Default LLD gain setting if analysis fails.

Definition at line 73 of file OptoScanAnalysis.h.

Referenced by OptoScanAlgorithm::analyse().

fedAdcGain_

const float OptoScanAnalysis::fedAdcGain_ = 1.024 / 1024.

static

Peak-to-peak voltage for FED A/D converter [V/ADC].

Definition at line 79 of file OptoScanAnalysis.h.

Referenced by OptoScanAlgorithm::analyse().

gain_

uint16_t OptoScanAnalysis::gain_

private

Optimum LLD gain setting

Definition at line 85 of file OptoScanAnalysis.h.

Referenced by gain(), isValid(), print(), and reset().

liftOff_

VFloat OptoScanAnalysis::liftOff_

private

Baseline "lift-off" values [mA]

Definition at line 100 of file OptoScanAnalysis.h.

Referenced by liftOff(), print(), and reset().

linkNoise_

VFloat OptoScanAnalysis::linkNoise_

private

Noise value at "zero light" levels [ADC]

Definition at line 97 of file OptoScanAnalysis.h.

Referenced by linkNoise(), print(), and reset().

measGain_

VFloat OptoScanAnalysis::measGain_

private

Measured gains for each setting [V/V].

Definition at line 91 of file OptoScanAnalysis.h.

Referenced by measGain(), print(), and reset().

threshold_

VFloat OptoScanAnalysis::threshold_

private

Laser thresholds [mA]

Definition at line 103 of file OptoScanAnalysis.h.

Referenced by print(), reset(), and threshold().

tickHeight_

VFloat OptoScanAnalysis::tickHeight_

private

Tick mark heights [ADC]

Definition at line 106 of file OptoScanAnalysis.h.

Referenced by print(), reset(), and tickHeight().

zeroLight_

VFloat OptoScanAnalysis::zeroLight_

private

"Zero light" levels [ADC]

Definition at line 94 of file OptoScanAnalysis.h.

Referenced by print(), reset(), and zeroLight().