Linear-regression corrector applying per-burst slopes to data. More...

#include <LRBCorrector.h>

Inheritance diagram for LRBCorrector:

Collaboration diagram for LRBCorrector:

Public Member Functions
	LRBCorrector (const TString &name)
	Constructor with name.

void	ParseConfigFile (QwParameterFile &file) override

Int_t	LoadChannelMap (const std::string &mapfile) override

Int_t	ConnectChannels (QwSubsystemArrayParity &asym, QwSubsystemArrayParity &diff) override

void	ProcessData () override

void	UpdateBurstCounter (Short_t burstcounter) override

Public Member Functions inherited from VQwDataHandler
	VQwDataHandler (const TString &name)

	VQwDataHandler (const VQwDataHandler &source)

void	SetPointer (QwHelicityPattern *ptr)

void	SetPointer (QwSubsystemArrayParity *ptr)

virtual Int_t	ConnectChannels (QwSubsystemArrayParity &, QwSubsystemArrayParity &asym, QwSubsystemArrayParity &diff)

virtual Int_t	ConnectChannels (QwSubsystemArrayParity &)

Int_t	ConnectChannels (QwHelicityPattern &helicitypattern)

virtual void	FinishDataHandler ()

	~VQwDataHandler () override

TString	GetName ()

virtual void	ClearEventData ()

void	InitRunningSum ()

void	AccumulateRunningSum ()

virtual void	AccumulateRunningSum (VQwDataHandler &value, Int_t count=0, Int_t ErrorMask=0xFFFFFFF)

void	CalculateRunningAverage ()

void	PrintValue () const

void	WritePromptSummary (QwPromptSummary *ps, TString type)

virtual void	ConstructTreeBranches (QwRootFile *treerootfile, const std::string &treeprefix="", const std::string &branchprefix="")

virtual void	FillTreeBranches (QwRootFile *treerootfile)

virtual void	ConstructNTupleFields (QwRootFile *treerootfile, const std::string &treeprefix="", const std::string &branchprefix="")
	RNTuple methods.

virtual void	FillNTupleFields (QwRootFile *treerootfile)

virtual void	ConstructHistograms (TDirectory *, TString &)
	Construct the histograms in a folder with a prefix.

virtual void	FillHistograms ()
	Fill the histograms.

void	FillTreeVector (QwRootTreeBranchVector &values) const

void	ConstructBranchAndVector (TTree *tree, TString &prefix, QwRootTreeBranchVector &values)

void	SetRunLabel (TString x)

Int_t	LoadChannelMap ()

Bool_t	PublishInternalValues () const override
	Publish all variables of the subsystem.

Bool_t	PublishByRequest (TString device_name) override
	Try to publish an internal variable matching the submitted name.

Public Member Functions inherited from MQwPublishable_child< QwDataHandlerArray, VQwDataHandler >
	MQwPublishable_child ()
	Default constructor Initializes the child object and sets up self-reference for publishing.

	MQwPublishable_child (const MQwPublishable_child &source)
	Copy constructor.

virtual	~MQwPublishable_child ()
	Virtual destructor.

void	SetParent (QwDataHandlerArray *parent)
	Set the parent container for this child object.

QwDataHandlerArray *	GetParent () const
	Get the parent container for this child object.

Public Member Functions inherited from MQwCloneable< VQwDataHandler, LRBCorrector >
	~MQwCloneable () override
	Virtual destructor.

VQwDataHandler *	Clone () const override
	Concrete clone method.

const VQwFactory< VQwDataHandler > *	Factory () const override
	Factory getter.

Public Member Functions inherited from VQwCloneable< VQwDataHandler >
virtual	~VQwCloneable ()
	Virtual destructor.

std::string	GetClassName () const
	Get demangled name of this class.

Protected Member Functions
	LRBCorrector ()

Protected Member Functions inherited from VQwDataHandler
	VQwDataHandler ()

void	SetEventcutErrorFlagPointer (const UInt_t *errorflagptr)

UInt_t	GetEventcutErrorFlag () const

std::pair< EQwHandleType, std::string >	ParseHandledVariable (const std::string &variable)

void	CalcOneOutput (const VQwHardwareChannel dv, VQwHardwareChannel output, std::vector< const VQwHardwareChannel * > &ivs, std::vector< Double_t > &sens)

Protected Member Functions inherited from MQwPublishable_child< QwDataHandlerArray, VQwDataHandler >
Bool_t	RequestExternalValue (const TString &name, VQwHardwareChannel *value) const
	Retrieve the variable name from other subsystem arrays Get the value corresponding to some variable name from a different data array.

const VQwHardwareChannel *	RequestExternalPointer (const TString &name) const
	Retrieve a pointer to an external variable by name Requests a direct pointer to a variable from sibling subsystems via the parent container.

Bool_t	PublishInternalValue (const TString name, const TString desc, const VQwHardwareChannel *element) const
	Publish a variable from this child into the parent container.

Protected Attributes
std::string	fAlphaFileBase

std::string	fAlphaFileSuff

std::string	fAlphaFilePath

std::vector< EQwHandleType >	fIndependentType

std::vector< std::string >	fIndependentName

std::vector< std::string >	fIndependentFull

std::vector< const VQwHardwareChannel * >	fIndependentVar

std::vector< Double_t >	fIndependentValues

Short_t	fLastCycle

std::map< Short_t, std::vector< std::vector< Double_t > > >	fSensitivity

Protected Attributes inherited from VQwDataHandler
Int_t	fPriority

Short_t	fBurstCounter
	When a datahandler array is processed, handlers with lower priority will be processed before handlers with higher priority.

TString	fName

std::string	fMapFile

std::string	fTreeName

std::string	fTreeComment

std::string	fPrefix

TString	run_label

const UInt_t *	fErrorFlagPtr
	Error flag pointer.

QwSubsystemArrayParity *	fSubsystemArray
	Single event pointer.

QwHelicityPattern *	fHelicityPattern
	Helicity pattern pointer.

std::vector< std::string >	fDependentFull

std::vector< EQwHandleType >	fDependentType

std::vector< std::string >	fDependentName

std::vector< const VQwHardwareChannel * >	fDependentVar

std::vector< Double_t >	fDependentValues

std::vector< VQwHardwareChannel * >	fOutputVar

std::vector< Double_t >	fOutputValues

std::vector< std::vector< TString > >	fPublishList

std::string	ParseSeparator

Bool_t	fKeepRunningSum

Bool_t	fRunningsumFillsTree

VQwDataHandler *	fRunningsum

Additional Inherited Members
Public Types inherited from VQwDataHandler
enum	EQwHandleType { kHandleTypeUnknown =0 , kHandleTypeMps , kHandleTypeAsym , kHandleTypeDiff , kHandleTypeYield }

typedef std::vector< VQwHardwareChannel * >::iterator	Iterator_HdwChan

typedef std::vector< VQwHardwareChannel * >::const_iterator	ConstIterator_HdwChan

Static Public Member Functions inherited from MQwCloneable< VQwDataHandler, LRBCorrector >
static VQwDataHandler *	Create (const std::string &name)
	Object creation.

static LRBCorrector *	Cast (LRBCorrector *type)
	Object dynamic cast.

Detailed Description

Linear-regression corrector applying per-burst slopes to data.

Loads cycle-dependent sensitivities and applies linear regression corrections to monitored channels, selecting the appropriate set based on the current burst counter.

Definition at line 23 of file LRBCorrector.h.

Constructor & Destructor Documentation

◆ LRBCorrector() [1/2]

LRBCorrector::LRBCorrector ( const TString & name )

Constructor with name.

Definition at line 31 of file LRBCorrector.cc.

                                             :VQwDataHandler(name),
                        fLastCycle(0)
{
  ParseSeparator = "_";
  fKeepRunningSum = kTRUE;
}

References VQwDataHandler::fKeepRunningSum, fLastCycle, VQwDataHandler::ParseSeparator, and VQwDataHandler::VQwDataHandler().

Here is the call graph for this function:

◆ LRBCorrector() [2/2]

LRBCorrector::LRBCorrector ( )

inlineprotected

Definition at line 53 of file LRBCorrector.h.

53{ }

Member Function Documentation

◆ ConnectChannels()

Int_t LRBCorrector::ConnectChannels	(	QwSubsystemArrayParity &	asym,
		QwSubsystemArrayParity &	diff )

overridevirtual

Connect to external pointers for dependent variables from asym/diff subsystem arrays, creating corresponding output variables as clones.

Fill vector of pointers to the relevant data elements

Reimplemented from VQwDataHandler.

Definition at line 182 of file LRBCorrector.cc.

{
  VQwDataHandler::ConnectChannels(asym, diff);
 
  // Add independent variables
  for (size_t iv = 0; iv < fIndependentName.size(); iv++) {
    // Get the independent variables
    const VQwHardwareChannel* iv_ptr = 0;
    iv_ptr = this->RequestExternalPointer(fIndependentFull.at(iv));
    if (iv_ptr==NULL){
      switch (fIndependentType.at(iv)) {
      case kHandleTypeAsym:
        iv_ptr = asym.RequestExternalPointer(fIndependentName.at(iv));
        break;
      case kHandleTypeDiff:
        iv_ptr = diff.RequestExternalPointer(fIndependentName.at(iv));
        break;
      default:
        QwWarning << "Independent variable for corrector has unknown type."
                  << QwLog::endl;
        break;
      }
    }
    if (iv_ptr) {
      //QwMessage << " iv: " << fIndependentName.at(iv) /*<< " (sens = " << fSensitivity.at(dv).at(iv) << ")"*/ << QwLog::endl;
      fIndependentVar.push_back(iv_ptr);
    } else {
      QwWarning << "Independent variable " << fIndependentName.at(iv) << " could not be found."
                << QwLog::endl;
    }
  }
 
  QwMessage << "In LRBCorrector::ConnectChannels; Number of IVs: " << fIndependentVar.size()
            << " Number of DVs: " << fDependentVar.size() << QwLog::endl;
  return 0;
}

References VQwDataHandler::ConnectChannels(), QwLog::endl(), VQwDataHandler::fDependentVar, fIndependentFull, fIndependentName, fIndependentType, fIndependentVar, VQwDataHandler::kHandleTypeAsym, VQwDataHandler::kHandleTypeDiff, QwMessage, QwWarning, MQwPublishable< U, T >::RequestExternalPointer(), and MQwPublishable_child< QwDataHandlerArray, VQwDataHandler >::RequestExternalPointer().

Here is the call graph for this function:

◆ LoadChannelMap()

Int_t LRBCorrector::LoadChannelMap ( const std::string & mapfile )

overridevirtual

Reimplemented from VQwDataHandler.

Definition at line 46 of file LRBCorrector.cc.

{
  // Open the file
  QwParameterFile map(mapfile);
 
  // Read the sections of dependent variables
  std::pair<EQwHandleType,std::string> type_name;
 
  // Add independent variables and sensitivities
  while (map.ReadNextLine()) {
    // Throw away comments, whitespace, empty lines
    map.TrimComment();
    map.TrimWhitespace();
    if (map.LineIsEmpty()) continue;
    // Get first token: label (dv or iv), second token is the name like "asym_blah"
    string primary_token = map.GetNextToken(" ");
    string current_token = map.GetNextToken(" ");
    // Parse current token into independent variable type and name
    type_name = ParseHandledVariable(current_token);
 
    if (primary_token == "iv") {
      fIndependentType.push_back(type_name.first);
      fIndependentName.push_back(type_name.second);
      fIndependentFull.push_back(current_token);
    }
    else if (primary_token == "dv") {
      fDependentType.push_back(type_name.first);
      fDependentName.push_back(type_name.second);
      fDependentFull.push_back(current_token);
    }
    else if (primary_token == "treetype") {
      QwMessage << "Tree Type read, ignoring." << QwLog::endl;
    }
    else {
      QwError << "Function LoadChannelMap in LRBCorrector.cc read in invalid primary_token." << QwLog::endl;
    }
  }
 
  // Construct slope file name
  std::string SlopeFileName = fAlphaFileBase + run_label.Data() + fAlphaFileSuff;
  std::string SlopeFilePath = fAlphaFilePath + "/";
  std::string SlopeFile = SlopeFilePath + SlopeFileName;
  TString corFileName(SlopeFile);
 
  QwMessage << "Trying to open " << corFileName << QwLog::endl;
  TFile* corFile = new TFile(corFileName);
  if (! corFile->IsOpen()) {
    QwWarning << "Failed to open " << corFileName << ", slopes NOT found" << QwLog::endl;
    return 0;
  }
 
  // DV names
  TH1 *dvnames = (TH1 *) corFile->Get("DVname");
  if (dvnames == 0) {
    QwWarning << "DV names matrix is null" << QwLog::endl;
    corFile->Close();
    return 0;
  }
  for (size_t i = 0; i != fDependentName.size(); i++) {
    TString name = dvnames->GetXaxis()->GetBinLabel(i+1);
    name.Remove(0, name.First("_") + 1);
    if (fDependentName[i] != name) {
      QwWarning << "DV name expected differs from found: "
                << fDependentName[i] << " != " << name
                << QwLog::endl;
      corFile->Close();
      return 0;
    }
  }
 
  // IV names
  TH1 *ivnames = (TH1 *) corFile->Get("IVname");
  if (ivnames == 0) {
    QwWarning << "IV names matrix is null" << QwLog::endl;
    corFile->Close();
    return 0;
  }
  for (size_t i = 0; i != fIndependentName.size(); i++) {
    TString name = ivnames->GetXaxis()->GetBinLabel(i+1);
    name.Remove(0, name.First("_") + 1);
    if (fIndependentName[i] != name) {
      QwWarning << "IV name expected differs from found: "
                << fIndependentName[i] << " != " << name
                << QwLog::endl;
      corFile->Close();
      return 0;
    }
  }
 
  // Slope matrix
  TKey* key = corFile->GetKey("slopes");
  if (key == 0) {
    QwWarning << "No slope matrix found" << QwLog::endl;
    corFile->Close();
    return 0;
  }
  QwMessage << "Slope matrix has " << key->GetCycle() << " cycle(s)." << QwLog::endl;
  fLastCycle = key->GetCycle(); // last cycle
  for (Short_t cycle=1; cycle<=fLastCycle; cycle++){
    TKey* key_cycle = corFile->GetKey("slopes", cycle);
    TMatrixD *alphasM = (TMatrixD *) key_cycle->ReadObj();
    if (alphasM == 0) {
      QwWarning << "Slope matrix is null" << QwLog::endl;
      corFile->Close();
      return 0;
    }
    if (alphasM->GetNrows() != Int_t(fIndependentType.size())) {
      QwWarning << "Slope matrix has wrong number of rows: "
        << alphasM->GetNrows() << " != " << fIndependentType.size()
        << QwLog::endl;
      corFile->Close();
      return 0;
    }
    if (alphasM->GetNcols() != Int_t(fDependentType.size())) {
      QwWarning << "Slope matrix has wrong number of cols: "
        << alphasM->GetNcols() << " != " << fDependentType.size()
        << QwLog::endl;
      corFile->Close();
      return 0;
    }
 
    // Assign sensitivities
    fSensitivity[cycle].resize(fDependentType.size());
    for (size_t i = 0; i != fDependentType.size(); ++i) {
      fSensitivity[cycle].at(i).resize(fIndependentType.size());
      for (size_t j = 0; j != fIndependentType.size(); ++j) {
    fSensitivity[cycle].at(i).at(j) = -1.0*(*alphasM)(j,i);
      }
    }
  }
 
  corFile->Close();
  return 0;
}

References QwLog::endl(), fAlphaFileBase, fAlphaFilePath, fAlphaFileSuff, VQwDataHandler::fDependentFull, VQwDataHandler::fDependentName, VQwDataHandler::fDependentType, fIndependentFull, fIndependentName, fIndependentType, fLastCycle, fSensitivity, QwParameterFile::GetNextToken(), QwParameterFile::LineIsEmpty(), VQwDataHandler::ParseHandledVariable(), QwError, QwMessage, QwWarning, QwParameterFile::ReadNextLine(), VQwDataHandler::run_label, QwParameterFile::TrimComment(), and QwParameterFile::TrimWhitespace().

Here is the call graph for this function:

◆ ParseConfigFile()

void LRBCorrector::ParseConfigFile ( QwParameterFile & file )

overridevirtual

Parse configuration file for map file, priority, tree settings.

Reimplemented from VQwDataHandler.

Definition at line 38 of file LRBCorrector.cc.

{
  VQwDataHandler::ParseConfigFile(file);
  file.PopValue("slope-file-base", fAlphaFileBase);
  file.PopValue("slope-file-suff", fAlphaFileSuff);
  file.PopValue("slope-path", fAlphaFilePath);
}

References fAlphaFileBase, fAlphaFilePath, fAlphaFileSuff, VQwDataHandler::ParseConfigFile(), and QwParameterFile::PopValue().

Here is the call graph for this function:

◆ ProcessData()

void LRBCorrector::ProcessData ( )

overridevirtual

Copy dependent variables to output variables (default processing).

Reimplemented from VQwDataHandler.

Definition at line 222 of file LRBCorrector.cc.

                               {
  Short_t cycle = fBurstCounter+1;
  if (fSensitivity.count(cycle) == 0) return;
  for (size_t i = 0; i < fDependentVar.size(); ++i) {
    CalcOneOutput(fDependentVar[i], fOutputVar[i], fIndependentVar, fSensitivity[cycle][i]);
  }
}

References VQwDataHandler::CalcOneOutput(), VQwDataHandler::fBurstCounter, VQwDataHandler::fDependentVar, fIndependentVar, VQwDataHandler::fOutputVar, and fSensitivity.

Here is the call graph for this function:

◆ UpdateBurstCounter()

void LRBCorrector::UpdateBurstCounter ( Short_t burstcounter )

inlineoverridevirtual

Reimplemented from VQwDataHandler.

Definition at line 36 of file LRBCorrector.h.

                                                          {
      if (burstcounter<fLastCycle){
    fBurstCounter=burstcounter;
      } else if (fLastCycle==1){
    //  If we have a single cycle of slopes, don't throw a warning.
    fBurstCounter = 0;
      } else {
    fBurstCounter = fLastCycle-1;
    QwWarning << "LRBCorrector, " << GetName()
          << ": Burst counter, " << burstcounter
          << ", is greater than the stored number of sets of slopes.  "
          << "Using the last set of slopes (cycle=" << fLastCycle
          << ")" << QwLog::endl;
      }
    };

References QwLog::endl(), VQwDataHandler::fBurstCounter, fLastCycle, VQwDataHandler::GetName(), and QwWarning.

Here is the call graph for this function:

Field Documentation

◆ fAlphaFileBase

std::string LRBCorrector::fAlphaFileBase

protected

Definition at line 55 of file LRBCorrector.h.

Referenced by LoadChannelMap(), and ParseConfigFile().

◆ fAlphaFilePath

std::string LRBCorrector::fAlphaFilePath

protected

Definition at line 57 of file LRBCorrector.h.

Referenced by LoadChannelMap(), and ParseConfigFile().

◆ fAlphaFileSuff

std::string LRBCorrector::fAlphaFileSuff

protected

Definition at line 56 of file LRBCorrector.h.

Referenced by LoadChannelMap(), and ParseConfigFile().

◆ fIndependentFull

std::vector< std::string > LRBCorrector::fIndependentFull

protected

Definition at line 61 of file LRBCorrector.h.

Referenced by ConnectChannels(), and LoadChannelMap().

◆ fIndependentName

std::vector< std::string > LRBCorrector::fIndependentName

protected

Definition at line 60 of file LRBCorrector.h.

Referenced by ConnectChannels(), and LoadChannelMap().

◆ fIndependentType

std::vector< EQwHandleType > LRBCorrector::fIndependentType

protected

Definition at line 59 of file LRBCorrector.h.

Referenced by ConnectChannels(), and LoadChannelMap().

◆ fIndependentValues

std::vector< Double_t > LRBCorrector::fIndependentValues

protected

Definition at line 64 of file LRBCorrector.h.

◆ fIndependentVar

std::vector< const VQwHardwareChannel* > LRBCorrector::fIndependentVar

protected

Definition at line 63 of file LRBCorrector.h.

Referenced by ConnectChannels(), and ProcessData().

◆ fLastCycle

Short_t LRBCorrector::fLastCycle

protected

Definition at line 66 of file LRBCorrector.h.

Referenced by LoadChannelMap(), LRBCorrector(), and UpdateBurstCounter().

◆ fSensitivity

std::map<Short_t,std::vector<std::vector<Double_t> > > LRBCorrector::fSensitivity

protected

Definition at line 67 of file LRBCorrector.h.

Referenced by LoadChannelMap(), and ProcessData().

The documentation for this class was generated from the following files:

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LRBCorrector() [1/2]

◆ LRBCorrector() [2/2]

Member Function Documentation

◆ ConnectChannels()

◆ LoadChannelMap()

◆ ParseConfigFile()

◆ ProcessData()

◆ UpdateBurstCounter()

Field Documentation

◆ fAlphaFileBase

◆ fAlphaFilePath

◆ fAlphaFileSuff

◆ fIndependentFull

◆ fIndependentName

◆ fIndependentType

◆ fIndependentValues

◆ fIndependentVar

◆ fLastCycle

◆ fSensitivity