QwScaler Class Reference

Subsystem managing scaler modules and derived rates. More...

#include <QwScaler.h>

Inheritance diagram for QwScaler:

Collaboration diagram for QwScaler:

Public Member Functions
	QwScaler (const TString &name)
	Constructor with name.
	QwScaler (const QwScaler &source)
	Copy constructor.
	~QwScaler () override
	Destructor.
void	ProcessOptions (QwOptions &options) override
Int_t	LoadChannelMap (TString mapfile) override
Int_t	LoadInputParameters (TString pedestalfile) override
void	ClearEventData () override
Int_t	ProcessConfigurationBuffer (const ROCID_t roc_id, const BankID_t bank_id, UInt_t *buffer, UInt_t num_words) override
Int_t	ProcessEvBuffer (const ROCID_t roc_id, const BankID_t bank_id, UInt_t *buffer, UInt_t num_words) override
void	ProcessEvent () override
void	ConstructHistograms (TDirectory *folder, TString &prefix) override
void	FillHistograms () override
void	ConstructBranchAndVector (TTree *tree, TString &prefix, QwRootTreeBranchVector &values) override
void	ConstructBranch (TTree *tree, TString &prefix) override
	Construct the branch and tree vector.
void	ConstructBranch (TTree *tree, TString &prefix, QwParameterFile &trim_file) override
	Construct the branch and tree vector based on the trim file.
void	FillTreeVector (QwRootTreeBranchVector &values) const override
Bool_t	Compare (VQwSubsystem *source)
VQwSubsystem &	operator= (VQwSubsystem *value) override
VQwSubsystem &	operator+= (VQwSubsystem *value) override
VQwSubsystem &	operator-= (VQwSubsystem *value) override
void	Ratio (VQwSubsystem *value1, VQwSubsystem *value2) override
void	Scale (Double_t factor) override
void	AccumulateRunningSum (VQwSubsystem *value, Int_t count=0, Int_t ErrorMask=0xFFFFFFF) override
void	DeaccumulateRunningSum (VQwSubsystem *value, Int_t ErrorMask=0xFFFFFFF) override
void	CalculateRunningAverage () override
Int_t	LoadEventCuts (TString filename) override
	Optional event cut file.
Bool_t	SingleEventCuts ()
Bool_t	ApplySingleEventCuts () override
	Apply the single event cuts.
Bool_t	CheckForBurpFail (const VQwSubsystem *subsys) override
	Report the number of events failed due to HW and event cut failures.
void	IncrementErrorCounters () override
	Increment the error counters.
void	PrintErrorCounters () const override
UInt_t	GetEventcutErrorFlag () override
	Return the error flag to the top level routines related to stability checks and ErrorFlag updates.
void	UpdateErrorFlag (const VQwSubsystem *ev_error) override
	update the error flag in the subsystem level from the top level routines related to stability checks. This will uniquely update the errorflag at each channel based on the error flag in the corresponding channel in the ev_error subsystem
void	PrintValue () const override
void	PrintInfo () const override
Double_t *	GetRawChannelArray ()
Double_t	GetDataForChannelInModule (Int_t modnum, Int_t channum)
Int_t	GetChannelIndex (TString channelName, UInt_t module_number)
virtual void	ConstructHistograms ()
	Construct the histograms for this subsystem.
virtual void	ConstructHistograms (TDirectory *folder)
	Construct the histograms for this subsystem in a folder.
virtual void	ConstructHistograms (TString &prefix)
	Construct the histograms for this subsystem with a prefix.
virtual void	ConstructBranchAndVector (TTree *tree, QwRootTreeBranchVector &values)
	Construct the branch and tree vector.
Public Member Functions inherited from VQwSubsystemParity
	VQwSubsystemParity (const TString &name)
	Constructor with name.
	VQwSubsystemParity (const VQwSubsystemParity &source)
	Copy constructor.
	~VQwSubsystemParity () override
	Default destructor.
virtual void	FillDB_MPS (QwParityDB *, TString)
	Fill the database with MPS-based variables Note that most subsystems don't need to do this.
virtual void	FillDB (QwParityDB *, TString)
	Fill the database.
virtual void	FillErrDB (QwParityDB *, TString)
virtual void	Sum (VQwSubsystem *value1, VQwSubsystem *value2)
virtual void	Difference (VQwSubsystem *value1, VQwSubsystem *value2)
Int_t	LoadEventCuts (TString filename) override
	Load the event cuts file.
virtual void	LoadEventCuts_Init ()
virtual void	LoadEventCuts_Line (QwParameterFile &, TString &, Int_t &)
virtual void	LoadEventCuts_Fin (Int_t &)
virtual UInt_t	UpdateErrorFlag ()
	Uses the error flags of contained data elements to update Returns the error flag to the top level routines related to stability checks and ErrorFlag updates.
virtual void	Blind (const QwBlinder *)
	Blind the asymmetry of this subsystem.
virtual void	Blind (const QwBlinder *, const VQwSubsystemParity *)
	Blind the difference of this subsystem.
virtual void	WritePromptSummary (QwPromptSummary *, TString)
virtual Bool_t	CheckForEndOfBurst () const
virtual void	LoadMockDataParameters (TString)
Public Member Functions inherited from VQwSubsystem
	VQwSubsystem (const TString &name)
	Constructor with name.
	VQwSubsystem (const VQwSubsystem &orig)
	Copy constructor by object.
	~VQwSubsystem () override
	Default destructor.
TString	GetName () const
Bool_t	HasDataLoaded () const
VQwSubsystem *	GetSibling (const std::string &name) const
	Get the sibling with specified name.
virtual std::vector< TString >	GetParamFileNameList ()
virtual std::map< TString, TString >	GetDetectorMaps ()
Bool_t	PublishByRequest (TString) override
	Try to publish an internal variable matching the submitted name.
Bool_t	PublishInternalValues () const override
	Publish all variables of the subsystem.
virtual Int_t	LoadDetectorMaps (QwParameterFile &file)
	Parse parameter file to find the map files.
virtual Int_t	LoadGeometryDefinition (TString)
	Optional geometry definition.
virtual Int_t	LoadCrosstalkDefinition (TString)
	Optional crosstalk definition.
void	SetEventTypeMask (const UInt_t mask)
	Set event type mask.
UInt_t	GetEventTypeMask () const
	Get event type mask.
virtual Int_t	ProcessEvBuffer (const UInt_t event_type, const ROCID_t roc_id, const BankID_t bank_id, UInt_t *buffer, UInt_t num_words)
virtual void	ExchangeProcessedData ()
	Request processed data from other subsystems for internal use in the second event processing stage. Not all derived classes will require data from other subsystems.
virtual void	ProcessEvent_2 ()
	Process the event data again, including data from other subsystems. Not all derived classes will require a second stage of event data processing.
virtual void	AtEndOfEventLoop ()
	Perform actions at the end of the event loop.
virtual void	RandomizeEventData (int=0, double=0.0)
virtual void	EncodeEventData (std::vector< UInt_t > &)
virtual void	ConstructObjects ()
	Construct the objects for this subsystem.
virtual void	ConstructObjects (TDirectory *folder)
	Construct the objects for this subsystem in a folder.
virtual void	ConstructObjects (TString &prefix)
	Construct the objects for this subsystem with a prefix.
virtual void	ConstructObjects (TDirectory *, TString &)
	Construct the objects for this subsystem in a folder with a prefix.
virtual void	ConstructTree ()
	Construct the tree for this subsystem.
virtual void	ConstructTree (TDirectory *folder)
	Construct the tree for this subsystem in a folder.
virtual void	ConstructTree (TString &prefix)
	Construct the tree for this subsystem with a prefix.
virtual void	ConstructTree (TDirectory *, TString &)
	Construct the tree for this subsystem in a folder with a prefix.
virtual void	FillTree ()
	Fill the tree for this subsystem.
virtual void	DeleteTree ()
	Delete the tree for this subsystem.
virtual void	PrintDetectorMaps (Bool_t status) const
void	GetMarkerWordList (const ROCID_t roc_id, const BankID_t bank_id, std::vector< UInt_t > &marker) const
std::vector< ROCID_t >	GetROCIds () const
Public Member Functions inherited from MQwHistograms
void	ShareHistograms (const MQwHistograms *source)
	Share histogram pointers between objects.
Public Member Functions inherited from MQwPublishable_child< QwSubsystemArray, VQwSubsystem >
	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 (QwSubsystemArray *parent)
	Set the parent container for this child object.
QwSubsystemArray *	GetParent () const
	Get the parent container for this child object.
Public Member Functions inherited from MQwCloneable< VQwSubsystem, QwScaler >
	~MQwCloneable () override
	Virtual destructor.
VQwSubsystem *	Clone () const override
	Concrete clone method.
const VQwFactory< VQwSubsystem > *	Factory () const override
	Factory getter.
Public Member Functions inherited from VQwCloneable< VQwSubsystem >
virtual	~VQwCloneable ()
	Virtual destructor.
std::string	GetClassName () const
	Get demangled name of this class.

Static Public Member Functions
static void	DefineOptions (QwOptions &options)
Static Public Member Functions inherited from VQwSubsystem
static void	DefineOptions ()
	Define options function (note: no virtual static functions in C++)
Static Public Member Functions inherited from MQwCloneable< VQwSubsystem, QwScaler >
static VQwSubsystem *	Create (const std::string &name)
	Object creation.
static QwScaler *	Cast (QwScaler *type)
	Object dynamic cast.

Private Types
typedef std::map< Int_t, std::vector< std::vector< Int_t > > >	Subbank_to_Scaler_Map_t
typedef std::map< std::pair< Int_t, Int_t >, Int_t >	Module_Channel_to_Scaler_Map_t
typedef std::map< TString, Int_t >	Name_to_Scaler_Map_t

Private Member Functions
	QwScaler ()
	Private default constructor (not implemented, will throw linker error on use)

Private Attributes
Int_t	fGoodEventCount
Subbank_to_Scaler_Map_t	fSubbank_Map
Module_Channel_to_Scaler_Map_t	fModuleChannel_Map
Name_to_Scaler_Map_t	fName_Map
std::vector< VQwScaler_Channel * >	fScaler
std::vector< UInt_t >	fBufferOffset
std::vector< std::pair< VQwScaler_Channel *, double > >	fNorm

Additional Inherited Members
void	ClearAllBankRegistrations ()
	Clear all registration of ROC and Bank IDs for this subsystem.
virtual Int_t	RegisterROCNumber (const ROCID_t roc_id, const BankID_t bank_id=0)
	Tell the object that it will decode data from this ROC and sub-bank.
Int_t	RegisterSubbank (const BankID_t bank_id)
	Tell the object that it will decode data from this sub-bank in the ROC currently open for registration.
Int_t	RegisterMarkerWord (const UInt_t markerword)
void	RegisterRocBankMarker (QwParameterFile &mapstr)
Int_t	GetSubbankIndex () const
Int_t	GetSubbankIndex (const ROCID_t roc_id, const BankID_t bank_id) const
void	SetDataLoaded (Bool_t flag)
template<class T>
Int_t	FindIndex (const std::vector< T > &myvec, const T value) const
Bool_t	Compare (VQwSubsystem *source)
Protected Member Functions inherited from MQwHistograms
	MQwHistograms ()
	Default constructor.
	MQwHistograms (const MQwHistograms &source)
	Copy constructor.
virtual	~MQwHistograms ()
	Virtual destructor.
MQwHistograms &	operator= (const MQwHistograms &value)
void	Fill_Pointer (TH1_ptr hist_ptr, Double_t value)
void	AddHistogram (TH1 *h)
	Register a histogram.
Protected Member Functions inherited from MQwPublishable_child< QwSubsystemArray, VQwSubsystem >
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 inherited from VQwSubsystem
std::vector< std::vector< TString > >	fPublishList
TString	fSystemName
	Name of this subsystem.
UInt_t	fEventTypeMask
	Mask of event types.
Bool_t	fIsDataLoaded
	Has this subsystem gotten data to be processed?
std::vector< TString >	fDetectorMapsNames
	Names of loaded detector map files.
std::map< TString, TString >	fDetectorMaps
	Map of file name to full path or content.
ROCID_t	fCurrentROC_ID
	ROC ID that is currently being processed.
BankID_t	fCurrentBank_ID
	Bank ID (and Marker word) that is currently being processed;.
std::vector< ROCID_t >	fROC_IDs
	Vector of ROC IDs associated with this subsystem.
std::vector< std::vector< BankID_t > >	fBank_IDs
	Vector of Bank IDs per ROC ID associated with this subsystem.
std::vector< std::vector< std::vector< UInt_t > > >	fMarkerWords
	Vector of marker words per ROC & subbank associated with this subsystem.
Protected Attributes inherited from MQwHistograms
std::vector< TH1_ptr >	fHistograms
	Histograms associated with this data element.

Detailed Description

Subsystem managing scaler modules and derived rates.

Wraps hardware scaler channels, provides per-MPS processing, histogram and tree output, and utilities for normalization and cuts.

Definition at line 30 of file QwScaler.h.

Member Typedef Documentation

Module_Channel_to_Scaler_Map_t

typedef std::map< std::pair<Int_t,Int_t>, Int_t > QwScaler::Module_Channel_to_Scaler_Map_t

private

Definition at line 140 of file QwScaler.h.

Name_to_Scaler_Map_t

typedef std::map< TString, Int_t> QwScaler::Name_to_Scaler_Map_t

private

Definition at line 144 of file QwScaler.h.

Subbank_to_Scaler_Map_t

typedef std::map< Int_t, std::vector< std::vector<Int_t> > > QwScaler::Subbank_to_Scaler_Map_t

private

Definition at line 136 of file QwScaler.h.

Constructor & Destructor Documentation

QwScaler() [1/3]

QwScaler::QwScaler ( )

private

Private default constructor (not implemented, will throw linker error on use)

Referenced by AccumulateRunningSum(), Compare(), DeaccumulateRunningSum(), operator+=(), operator-=(), operator=(), QwScaler(), and Ratio().

Here is the caller graph for this function:

QwScaler() [2/3]

QwScaler::QwScaler

(

const TString &

name

)

Constructor with name.

Constructor: initialize scaler subsystem with name.

Definition at line 41 of file QwScaler.cc.

: VQwSubsystem(name),VQwSubsystemParity(name)
{
  // Nothing, really
}

References VQwSubsystem::VQwSubsystem(), and VQwSubsystemParity::VQwSubsystemParity().

Here is the call graph for this function:

QwScaler() [3/3]

QwScaler::QwScaler ( const QwScaler & source )

inline

Copy constructor.

Definition at line 41 of file QwScaler.h.

    : VQwSubsystem(source),VQwSubsystemParity(source)
    {
      fScaler.resize(source.fScaler.size());
      for (size_t i = 0; i < fScaler.size(); i++) {
        VQwScaler_Channel* scaler_tmp = 0;
        if ((scaler_tmp = dynamic_cast<QwSIS3801D24_Channel*>(source.fScaler.at(i)))) {
          QwSIS3801D24_Channel* scaler = dynamic_cast<QwSIS3801D24_Channel*>(source.fScaler.at(i));
          fScaler.at(i) = new QwSIS3801D24_Channel(*scaler);
        } else if ((scaler_tmp = dynamic_cast<QwSIS3801D32_Channel*>(source.fScaler.at(i)))) {
          QwSIS3801D32_Channel* scaler = dynamic_cast<QwSIS3801D32_Channel*>(source.fScaler.at(i));
          fScaler.at(i) = new QwSIS3801D32_Channel(*scaler);
        }
      }
    }

References fScaler, QwScaler(), VQwSubsystem::VQwSubsystem(), and VQwSubsystemParity::VQwSubsystemParity().

Here is the call graph for this function:

~QwScaler()

QwScaler::~QwScaler ( )

override

Destructor.

Destructor: clean up all owned scaler channel objects.

Definition at line 50 of file QwScaler.cc.

{
  // Delete scalers
  for (size_t i = 0; i < fScaler.size(); i++) {
    delete fScaler.at(i);
  }
  fScaler.clear();
}

References fScaler.

Member Function Documentation

AccumulateRunningSum()

void QwScaler::AccumulateRunningSum ( VQwSubsystem * value, Int_t count = 0, Int_t ErrorMask = 0xFFFFFFF )

overridevirtual

Accumulate running sums for all scaler channels.

Implements VQwSubsystemParity.

Definition at line 478 of file QwScaler.cc.

{
  if (Compare(value)) {
    QwScaler* scaler = dynamic_cast<QwScaler*>(value);
    for (size_t i = 0; i < fScaler.size(); i++) {
      fScaler.at(i)->AccumulateRunningSum(scaler->fScaler.at(i), count, ErrorMask);
    }
  }
}

References Compare(), fScaler, QwScaler(), and VQwSubsystem::VQwSubsystem().

Here is the call graph for this function:

ApplySingleEventCuts()

Bool_t QwScaler::ApplySingleEventCuts ( )

overridevirtual

Apply the single event cuts.

Implements VQwSubsystemParity.

Definition at line 516 of file QwScaler.cc.

{
  return true;
}

CalculateRunningAverage()

void QwScaler::CalculateRunningAverage ( )

overridevirtual

Calculate running averages for all scaler channels.

Implements VQwSubsystemParity.

Definition at line 504 of file QwScaler.cc.

{
  for (size_t i = 0; i < fScaler.size(); i++) {
    fScaler.at(i)->CalculateRunningAverage();
  }
}

References fScaler.

CheckForBurpFail()

Bool_t QwScaler::CheckForBurpFail ( const VQwSubsystem * subsys )

inlineoverridevirtual

Report the number of events failed due to HW and event cut failures.

Implements VQwSubsystemParity.

Definition at line 105 of file QwScaler.h.

                                                                {
        //QwError << "************* test inside Scaler *****************" << QwLog::endl;
        return kFALSE;
    };

References VQwSubsystem::VQwSubsystem().

Here is the call graph for this function:

ClearEventData()

void QwScaler::ClearEventData ( )

overridevirtual

Clear event data for all scaler channels and reset good event count.

Implements VQwSubsystem.

Definition at line 281 of file QwScaler.cc.

{
  // Clear all scaler channels
  for (size_t i = 0; i < fScaler.size(); i++) {
    fScaler.at(i)->ClearEventData();
  }
  // Reset good event count
  fGoodEventCount = 0;
}

References fGoodEventCount, and fScaler.

Compare()

Bool_t QwScaler::Compare

(

VQwSubsystem *

value

)

Compare two scaler objects

Parameters

value

Object to compare with

Returns

kTRUE if the object is equal

Definition at line 558 of file QwScaler.cc.

{
  // Immediately fail on null objects
  if (value == 0) return kFALSE;
 
  // Continue testing on actual object
  Bool_t result = kTRUE;
  if (typeid(*value) != typeid(*this)) {
    result = kFALSE;
 
  } else {
    QwScaler* input = dynamic_cast<QwScaler*> (value);
    if (input->fScaler.size() != fScaler.size()) {
      result = kFALSE;
    }
  }
  return result;
}

References fScaler, QwScaler(), and VQwSubsystem::VQwSubsystem().

Referenced by AccumulateRunningSum(), DeaccumulateRunningSum(), operator+=(), operator-=(), operator=(), and Ratio().

Here is the call graph for this function:

Here is the caller graph for this function:

ConstructBranch() [1/2]

void QwScaler::ConstructBranch ( TTree * tree, TString & prefix )

inlineoverridevirtual

Construct the branch and tree vector.

Construct the branches for this subsystem.

Parameters

tree	Output ROOT tree.
prefix	Name prefix for all branch names.

Implements VQwSubsystem.

Definition at line 78 of file QwScaler.h.

{ };

ConstructBranch() [2/2]

void QwScaler::ConstructBranch ( TTree * tree, TString & prefix, QwParameterFile & trim_file )

inlineoverridevirtual

Construct the branch and tree vector based on the trim file.

Construct the branches for this subsystem using a trim file.

Parameters

tree	Output ROOT tree.
prefix	Name prefix for all branch names.
trim_file	Trim file describing which branches to construct.

Implements VQwSubsystem.

Definition at line 79 of file QwScaler.h.

{ };

ConstructBranchAndVector() [1/2]

virtual void VQwSubsystem::ConstructBranchAndVector ( TTree * tree, QwRootTreeBranchVector & values )

inlinevirtual

Construct the branch and tree vector.

Reimplemented from VQwSubsystem.

Definition at line 303 of file VQwSubsystem.h.

                                                                                     {
    TString tmpstr("");
    ConstructBranchAndVector(tree,tmpstr,values);
  };

ConstructBranchAndVector() [2/2]

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

overridevirtual

Construct TTree branches and backing vectors for all scaler channels.

Implements VQwSubsystem.

Definition at line 376 of file QwScaler.cc.

{
  for (size_t i = 0; i < fScaler.size(); i++) {
    fScaler.at(i)->ConstructBranchAndVector(tree, prefix, values);
  }
}

References fScaler.

ConstructHistograms() [1/4]

virtual void VQwSubsystem::ConstructHistograms ( )

inlinevirtual

Construct the histograms for this subsystem.

Reimplemented from VQwSubsystem.

Definition at line 270 of file VQwSubsystem.h.

                                      {
    TString tmpstr("");
    ConstructHistograms((TDirectory*) NULL, tmpstr);
  };

ConstructHistograms() [2/4]

virtual void VQwSubsystem::ConstructHistograms ( TDirectory * folder )

inlinevirtual

Construct the histograms for this subsystem in a folder.

Reimplemented from VQwSubsystem.

Definition at line 275 of file VQwSubsystem.h.

                                                        {
    TString tmpstr("");
    ConstructHistograms(folder, tmpstr);
  };

ConstructHistograms() [3/4]

void QwScaler::ConstructHistograms ( TDirectory * folder, TString & prefix )

overridevirtual

Construct histograms for all scaler channels.

Implements VQwSubsystem.

Definition at line 360 of file QwScaler.cc.

{
  for(size_t i = 0; i < fScaler.size(); i++) {
    fScaler.at(i)->ConstructHistograms(folder, prefix);
  }
}

References fScaler.

ConstructHistograms() [4/4]

virtual void VQwSubsystem::ConstructHistograms ( TString & prefix )

inlinevirtual

Construct the histograms for this subsystem with a prefix.

Reimplemented from VQwSubsystem.

Definition at line 280 of file VQwSubsystem.h.

                                                     {
    ConstructHistograms((TDirectory*) NULL, prefix);
  };

DeaccumulateRunningSum()

void QwScaler::DeaccumulateRunningSum ( VQwSubsystem * value, Int_t ErrorMask = 0xFFFFFFF )

overridevirtual

Deaccumulate running sums for all scaler channels.

Implements VQwSubsystemParity.

Definition at line 491 of file QwScaler.cc.

{
  if (Compare(value)) {
    QwScaler* scaler = dynamic_cast<QwScaler*>(value);
    for (size_t i = 0; i < fScaler.size(); i++) {
      fScaler.at(i)->DeaccumulateRunningSum(scaler->fScaler.at(i), ErrorMask);
    }
  }
}

References Compare(), fScaler, QwScaler(), and VQwSubsystem::VQwSubsystem().

Here is the call graph for this function:

DefineOptions()

void QwScaler::DefineOptions ( QwOptions & options )

static

Define command-line options for scaler subsystem (placeholder).

Definition at line 26 of file QwScaler.cc.

{
  // Define command line options
}

FillHistograms()

void QwScaler::FillHistograms ( )

overridevirtual

Fill histograms for all scaler channels.

Implements VQwSubsystem.

Definition at line 368 of file QwScaler.cc.

{
  for(size_t i = 0; i < fScaler.size(); i++) {
    fScaler.at(i)->FillHistograms();
  }
}

References fScaler.

FillTreeVector()

void QwScaler::FillTreeVector ( QwRootTreeBranchVector & values ) const

overridevirtual

Fill tree vector with current scaler channel values.

Implements VQwSubsystem.

Definition at line 384 of file QwScaler.cc.

{
  for(size_t i = 0; i < fScaler.size(); i++) {
    fScaler.at(i)->FillTreeVector(values);
  }
}

References fScaler.

GetChannelIndex()

Int_t QwScaler::GetChannelIndex	(	TString	channelName,
		UInt_t	module_number )

Definition at line 547 of file QwScaler.cc.

{
  return 0;
}

GetDataForChannelInModule()

Double_t QwScaler::GetDataForChannelInModule ( Int_t modnum, Int_t channum )

inline

Definition at line 123 of file QwScaler.h.

                                                                    {
      Int_t index = fModuleChannel_Map[std::pair<Int_t,Int_t>(modnum,channum)];
      return fScaler.at(index)->GetValue();
    }

References fModuleChannel_Map, and fScaler.

GetEventcutErrorFlag()

UInt_t QwScaler::GetEventcutErrorFlag ( )

overridevirtual

Return the error flag to the top level routines related to stability checks and ErrorFlag updates.

Implements VQwSubsystemParity.

Definition at line 542 of file QwScaler.cc.

{
  return 0;
}

GetRawChannelArray()

Double_t * QwScaler::GetRawChannelArray

(

)

IncrementErrorCounters()

void QwScaler::IncrementErrorCounters ( )

overridevirtual

Increment the error counters.

Implements VQwSubsystemParity.

Definition at line 534 of file QwScaler.cc.

{
}

LoadChannelMap()

Int_t QwScaler::LoadChannelMap ( TString mapfile )

overridevirtual

Load scaler channel map from file, creating channels and configuring normalization, headers, differential mode, and buffer offsets.

Parameters

mapfile

Path to the channel map file.

Returns

0 on success.

Implements VQwSubsystem.

Definition at line 67 of file QwScaler.cc.

{
  // Normalization channel (register default token "1")
  const TString default_norm_channel = "1";
  fName_Map[default_norm_channel] = -1;
  Name_to_Scaler_Map_t::iterator current_norm_channel = fName_Map.find(default_norm_channel);
  double current_norm_factor = 1;
  // Map with normalizations
  std::vector<Name_to_Scaler_Map_t::iterator> norm_channel;
  std::vector<double> norm_factor;
 
  // Include header for this scaler bank
  UInt_t header = 1;
  UInt_t buffer_offset = 0;
 
  // By default the scalers are not differential
  Bool_t differential = false;
 
  // Open the file
  QwParameterFile mapstr(mapfile.Data());
  fDetectorMaps.insert(mapstr.GetParamFileNameContents());
  mapstr.EnableGreediness();
  mapstr.SetCommentChars("!");
  mapstr.AddBreakpointKeyword("norm");
  mapstr.AddBreakpointKeyword("header");
  mapstr.AddBreakpointKeyword("differential");
  mapstr.AddBreakpointKeyword("scaler_buffer_offset");
 
  while (mapstr.ReadNextLine()) {
    RegisterRocBankMarker(mapstr);
 
    mapstr.TrimComment();       // Remove everything after a comment character.
    mapstr.TrimWhitespace();    // Get rid of leading and trailing whitespace
    if (mapstr.LineIsEmpty())  continue;
 
    TString varname, varvalue;
    if (mapstr.HasVariablePair("=", varname, varvalue)) {
      // This is a declaration line.  Decode it.
      varname.ToLower();
      UInt_t value = QwParameterFile::GetUInt(varvalue);
      if (varname == "norm") {
        // Normalization line of format: norm = [ 1 | channel / factor ]
        string dummy = mapstr.GetNextToken("=");
        string channame = mapstr.GetNextToken("/");
        string channorm = mapstr.GetNextToken("/");
        if (fName_Map.count(channame) == 0) {
          // assign a temporarily pointer
          fName_Map[channame] = -1;
        }
        current_norm_channel = fName_Map.find(channame);
        try {
          current_norm_factor = lexical_cast<double>(channorm);
        } catch (boost::bad_lexical_cast&) {
          current_norm_factor = 1;
        }
        QwMessage << "Normalization channel: " << channame << QwLog::endl;
        QwMessage << "Normalization factor: " << current_norm_factor << QwLog::endl;
      } else if (varname == "scaler_buffer_offset") {
        // Buffer offset
        buffer_offset = value;
      } else if (varname == "header") {
        // Header for this block of channels
        header = value;
        QwMessage << "Number of scaler header words: " << header << QwLog::endl;
        if (header > 32)
          QwError << "Is that really what you want?" << QwLog::endl;
      } else if (varname == "differential") {
        // Differential scaler
        try {
          differential = lexical_cast<bool>(varvalue);
        } catch (boost::bad_lexical_cast&) {
          differential = false;
        }
        if (differential)
          QwMessage << "Subsequent scalers will be differential." << QwLog::endl;
        else
          QwMessage << "Subsequent scalers will not be differential." << QwLog::endl;
      }
 
    } else {
 
      //  Break this line into tokens to process it.
      TString modtype = mapstr.GetTypedNextToken<TString>();
      UInt_t  modnum  = mapstr.GetTypedNextToken<UInt_t>();
      UInt_t  channum = mapstr.GetTypedNextToken<UInt_t>();
      TString dettype = mapstr.GetTypedNextToken<TString>();
      TString keyword = mapstr.GetTypedNextToken<TString>();
      modtype.ToUpper();
      dettype.ToUpper();
 
      UInt_t offset = 0;
      if (modtype == "SIS3801" || modtype == "SIS3801D24" || modtype == "SIS3801D32") {
        offset = QwSIS3801D24_Channel::GetBufferOffset(modnum, channum, header)+buffer_offset;
      } else if (modtype == "STR7200") {
        offset = QwSIS3801D32_Channel::GetBufferOffset(modnum, channum, header)+buffer_offset;
      } else {
        QwError << "Unrecognized module type " << modtype << QwLog::endl;
        continue;
      }
 
      // Register data channel type
      Int_t subbank = GetSubbankIndex(fCurrentROC_ID,fCurrentBank_ID);
      if (modnum >= fSubbank_Map[subbank].size())
        fSubbank_Map[subbank].resize(modnum+1);
      if (channum >= fSubbank_Map[subbank].at(modnum).size())
        fSubbank_Map[subbank].at(modnum).resize(channum+1,-1);
      // Add scaler channel
      if (fSubbank_Map[subbank].at(modnum).at(channum) < 0) {
        QwVerbose << "Registering " << modtype << " " << keyword
                  << std::hex
                  << " in ROC 0x" << fCurrentROC_ID << ", bank 0x" << fCurrentBank_ID
                  << std::dec
                  << " at mod " << modnum << ", chan " << channum
                  << QwLog::endl;
        size_t index = fScaler.size();
        VQwScaler_Channel* scaler = 0;
        if (modtype == "SIS3801" || modtype == "SIS3801D24")
          scaler = new QwSIS3801D24_Channel(keyword);
        else if (modtype == "SIS3801D32")
          scaler = new QwSIS3801D32_Channel(keyword);
        else if (modtype == "STR7200")
          scaler = new QwSTR7200_Channel(keyword);
        else {
          QwError << "Unrecognized module type " << modtype << QwLog::endl;
          continue;
        }
 
        // Differential scaler
        scaler->SetDifferentialScaler(differential);
 
        // Register keyword to scaler channel
        fName_Map[keyword] = index;
        fSubbank_Map[subbank].at(modnum).at(channum) = index;
        fModuleChannel_Map[std::pair<Int_t,Int_t>(modnum,channum)] = index;
        // Store scaler
        fScaler.push_back(scaler);
        fNorm.push_back(std::pair<VQwScaler_Channel*,double>(0,1));
        fBufferOffset.push_back(offset);
        // Store current normalization
        norm_channel.push_back(current_norm_channel);
        norm_factor.push_back(current_norm_factor);
      }
    }
  }
 
  // Check for normalization names without actual channels
  for (Name_to_Scaler_Map_t::iterator iter = fName_Map.begin(); iter != fName_Map.end(); iter++) {
    if (iter->second == -1 && iter->first != default_norm_channel) {
      QwError << "Normalization channel " << iter->first << " not found!" << QwLog::endl;
    }
  }
 
  // Fill normalization structure
  fNorm.resize(fScaler.size());
  for (size_t i = 0; i < fScaler.size(); i++) {
    Int_t norm_index = norm_channel.at(i)->second;
    if (norm_index < 0) {
      // No normalization
      fNorm.at(i).first = 0;
      fNorm.at(i).second = 1;
    } else {
      // Normalization
      fNorm.at(i).first = fScaler.at(norm_index);
      fNorm.at(i).second = norm_factor.at(i);
      // Prevent corruption of normalization channel itself
      fNorm.at(norm_index).first = 0;
      fNorm.at(norm_index).second = 1;
    }
  }
 
  mapstr.Close(); // Close the file (ifstream)
  return 0;
}

References QwParameterFile::AddBreakpointKeyword(), QwParameterFile::Close(), QwParameterFile::EnableGreediness(), QwLog::endl(), fBufferOffset, VQwSubsystem::fCurrentBank_ID, VQwSubsystem::fCurrentROC_ID, VQwSubsystem::fDetectorMaps, fModuleChannel_Map, fName_Map, fNorm, fScaler, fSubbank_Map, QwParameterFile::GetNextToken(), QwParameterFile::GetParamFileNameContents(), VQwSubsystem::GetSubbankIndex(), QwParameterFile::GetTypedNextToken(), QwParameterFile::GetUInt(), QwParameterFile::HasVariablePair(), QwParameterFile::LineIsEmpty(), QwError, QwMessage, QwVerbose, QwParameterFile::ReadNextLine(), VQwSubsystem::RegisterRocBankMarker(), QwParameterFile::SetCommentChars(), VQwScaler_Channel::SetDifferentialScaler(), QwParameterFile::TrimComment(), and QwParameterFile::TrimWhitespace().

Here is the call graph for this function:

LoadEventCuts()

Int_t QwScaler::LoadEventCuts ( TString )

overridevirtual

Optional event cut file.

Reimplemented from VQwSubsystem.

Definition at line 511 of file QwScaler.cc.

{
  return 0;
}

LoadInputParameters()

Int_t QwScaler::LoadInputParameters ( TString mapfile )

overridevirtual

Load pedestals and calibration factors for scaler channels.

Returns

0 on success.

Implements VQwSubsystem.

Definition at line 246 of file QwScaler.cc.

{
  // Open the file
  QwParameterFile mapstr(mapfile.Data());
  fDetectorMaps.insert(mapstr.GetParamFileNameContents());
  while (mapstr.ReadNextLine()) {
    mapstr.TrimComment();    // Remove everything after a comment character
    mapstr.TrimWhitespace(); // Get rid of leading and trailing spaces
    if (mapstr.LineIsEmpty())  continue;
 
    TString varname = mapstr.GetTypedNextToken<TString>();  // name of the channel
    varname.ToLower();
    varname.Remove(TString::kBoth,' ');
    Double_t varped = mapstr.GetTypedNextToken<Double_t>(); // value of the pedestal
    Double_t varcal = mapstr.GetTypedNextToken<Double_t>(); // value of the calibration factor
    QwVerbose << varname << ": " << QwLog::endl;
 
    if (fName_Map.count(varname) != 0) {
      Int_t index = fName_Map[varname];
      QwMessage << "Parameters scaler channel " << varname << ": "
                << "ped = " << varped << ", "
                << "cal = " << varcal << QwLog::endl;
      fScaler[index]->SetPedestal(varped);
      fScaler[index]->SetCalibrationFactor(varcal);
    }
 
  } // end of loop reading all lines of the pedestal file
 
  mapstr.Close(); // Close the file (ifstream)
  return 0;
}

References QwParameterFile::Close(), QwLog::endl(), VQwSubsystem::fDetectorMaps, fName_Map, fScaler, QwParameterFile::GetParamFileNameContents(), QwParameterFile::GetTypedNextToken(), QwParameterFile::LineIsEmpty(), QwMessage, QwVerbose, QwParameterFile::ReadNextLine(), QwParameterFile::TrimComment(), and QwParameterFile::TrimWhitespace().

Here is the call graph for this function:

operator+=()

VQwSubsystem & QwScaler::operator+= ( VQwSubsystem * value )

overridevirtual

Addition-assignment: element-wise addition of scaler channels.

Implements VQwSubsystemParity.

Definition at line 425 of file QwScaler.cc.

{
  if (Compare(value)) {
    QwScaler* input = dynamic_cast<QwScaler*>(value);
    for (size_t i = 0; i < fScaler.size(); i++) {
      *(fScaler.at(i)) += *(input->fScaler.at(i));
    }
  }
  return *this;
}

References Compare(), fScaler, QwScaler(), and VQwSubsystem::VQwSubsystem().

Here is the call graph for this function:

operator-=()

VQwSubsystem & QwScaler::operator-= ( VQwSubsystem * value )

overridevirtual

Subtraction-assignment: element-wise subtraction of scaler channels.

Implements VQwSubsystemParity.

Definition at line 439 of file QwScaler.cc.

{
  if (Compare(value)) {
    QwScaler* input = dynamic_cast<QwScaler *> (value);
    for (size_t i = 0; i < fScaler.size(); i++) {
      *(fScaler.at(i)) -= *(input->fScaler.at(i));
    }
  }
  return *this;
}

References Compare(), fScaler, QwScaler(), and VQwSubsystem::VQwSubsystem().

Here is the call graph for this function:

operator=()

VQwSubsystem & QwScaler::operator= ( VQwSubsystem * value )

overridevirtual

Assignment operator: copy all scaler channel values.

Implements VQwSubsystemParity.

Definition at line 410 of file QwScaler.cc.

{
  if (Compare(value)) {
    VQwSubsystem::operator=(value);
    QwScaler* input = dynamic_cast<QwScaler*>(value);
    for (size_t i = 0; i < fScaler.size(); i++) {
      *(fScaler.at(i)) = *(input->fScaler.at(i));
    }
  }
  return *this; 
}

References Compare(), fScaler, VQwSubsystem::operator=(), QwScaler(), and VQwSubsystem::VQwSubsystem().

Here is the call graph for this function:

PrintErrorCounters()

void QwScaler::PrintErrorCounters ( ) const

overridevirtual

Implements VQwSubsystemParity.

Definition at line 538 of file QwScaler.cc.

{
}

PrintInfo()

void QwScaler::PrintInfo ( ) const

overridevirtual

Print some debugging output for the subcomponents

Reimplemented from VQwSubsystem.

Definition at line 580 of file QwScaler.cc.

{
  VQwSubsystemParity::PrintInfo();
 
  QwOut << " there are " << fScaler.size() << " scaler channels" << QwLog::endl;
 
  for (size_t i = 0; i < fScaler.size(); i++) {
    QwOut << " scaler " << i << ": ";
    fScaler.at(i)->PrintInfo();
  }
}

References QwLog::endl(), fScaler, VQwSubsystem::PrintInfo(), and QwOut.

Here is the call graph for this function:

PrintValue()

void QwScaler::PrintValue ( ) const

overridevirtual

Print the value for the subcomponents

Reimplemented from VQwSubsystemParity.

Definition at line 595 of file QwScaler.cc.

{
  QwMessage << "=== QwScaler: " << GetName() << " ===" << QwLog::endl;
  for(size_t i = 0; i < fScaler.size(); i++) {
    fScaler.at(i)->PrintValue();
  }
}

References QwLog::endl(), fScaler, VQwSubsystem::GetName(), and QwMessage.

Here is the call graph for this function:

ProcessConfigurationBuffer()

Int_t QwScaler::ProcessConfigurationBuffer ( const ROCID_t roc_id, const BankID_t bank_id, UInt_t * buffer, UInt_t num_words )

overridevirtual

Process the configuration buffer for this subsystem

Parameters

roc_id	ROC ID
bank_id	Subbank ID
buffer	Buffer to read from
num_words	Number of words left in buffer

Returns

Number of words read

Implements VQwSubsystem.

Definition at line 299 of file QwScaler.cc.

{
  return 0;
}

ProcessEvBuffer()

Int_t QwScaler::ProcessEvBuffer ( const ROCID_t roc_id, const BankID_t bank_id, UInt_t * buffer, UInt_t num_words )

overridevirtual

Process raw buffer data, routing to registered scaler channels.

Returns

Number of words consumed from the buffer.

Implements VQwSubsystem.

Definition at line 309 of file QwScaler.cc.

{
  // TODO fix :-)
 
  UInt_t words_read = 0;
 
  // Get the subbank index (or -1 when no match)
  Int_t subbank = GetSubbankIndex(roc_id, bank_id);
 
  if (subbank >= 0 && num_words > 0) {
 
    // Read header word
    //UInt_t num_events = buffer[words_read];
    words_read++;
    // TODO Multiscaler functionality
 
    // Read scalers
    for (size_t modnum = 0; modnum < fSubbank_Map[subbank].size(); modnum++) {
      for (size_t channum = 0; channum < fSubbank_Map[subbank].at(modnum).size(); channum++) {
        Int_t index = fSubbank_Map[subbank].at(modnum).at(channum);
        if (index >= 0) {
          UInt_t offset = fBufferOffset.at(index);
          words_read += fScaler[index]->ProcessEvBuffer(&(buffer[offset]), num_words - offset);
        }
      }
    }
    words_read = num_words;
 
  }
 
  return words_read;
}

References fBufferOffset, fScaler, fSubbank_Map, and VQwSubsystem::GetSubbankIndex().

Here is the call graph for this function:

ProcessEvent()

void QwScaler::ProcessEvent ( )

overridevirtual

Process all scaler channels and apply normalization if configured.

Implements VQwSubsystem.

Definition at line 343 of file QwScaler.cc.

{
  // Process the event
  for (size_t i = 0; i < fScaler.size(); i++) {
    fScaler.at(i)->ProcessEvent();
  }
 
  // Normalization
  for (size_t i = 0; i < fScaler.size(); i++) {
    if (fNorm.at(i).first) {
      fScaler.at(i)->Scale(fNorm.at(i).second);
      fScaler.at(i)->DivideBy(*(fNorm.at(i).first));
    }
  }
}

References fNorm, and fScaler.

ProcessOptions()

void QwScaler::ProcessOptions ( QwOptions & options )

overridevirtual

Process command-line options for scaler subsystem (placeholder).

Reimplemented from VQwSubsystem.

Definition at line 32 of file QwScaler.cc.

{
  // Handle command line options
}

Ratio()

void QwScaler::Ratio ( VQwSubsystem * numer, VQwSubsystem * denom )

overridevirtual

Compute element-wise ratios of scaler channels.

Implements VQwSubsystemParity.

Definition at line 454 of file QwScaler.cc.

{
  if (Compare(numer) && Compare(denom)) {
    QwScaler* innumer = dynamic_cast<QwScaler*>(numer);
    QwScaler* indenom = dynamic_cast<QwScaler*>(denom);
    for (size_t i = 0; i < fScaler.size(); i++) {
      fScaler.at(i)->Ratio(*(innumer->fScaler.at(i)), *(indenom->fScaler.at(i)));
    }
  }
}

References Compare(), fScaler, QwScaler(), and VQwSubsystem::VQwSubsystem().

Here is the call graph for this function:

Scale()

void QwScaler::Scale ( Double_t factor )

overridevirtual

Scale all scaler channels by a common factor.

Implements VQwSubsystemParity.

Definition at line 468 of file QwScaler.cc.

{
  for (size_t i = 0; i < fScaler.size(); i++) {
    fScaler.at(i)->Scale(factor);
  }
}

References fScaler.

SingleEventCuts()

Bool_t QwScaler::SingleEventCuts

(

)

UpdateErrorFlag()

void QwScaler::UpdateErrorFlag ( const VQwSubsystem * ev_error )

inlineoverridevirtual

update the error flag in the subsystem level from the top level routines related to stability checks. This will uniquely update the errorflag at each channel based on the error flag in the corresponding channel in the ev_error subsystem

Implements VQwSubsystemParity.

Definition at line 115 of file QwScaler.h.

                                                               {
    };

References VQwSubsystem::VQwSubsystem().

Here is the call graph for this function:

Field Documentation

fBufferOffset

std::vector< UInt_t > QwScaler::fBufferOffset

private

Definition at line 149 of file QwScaler.h.

Referenced by LoadChannelMap(), and ProcessEvBuffer().

fGoodEventCount

Int_t QwScaler::fGoodEventCount

private

Definition at line 133 of file QwScaler.h.

Referenced by ClearEventData().

fModuleChannel_Map

Module_Channel_to_Scaler_Map_t QwScaler::fModuleChannel_Map

private

Definition at line 141 of file QwScaler.h.

Referenced by GetDataForChannelInModule(), and LoadChannelMap().

fName_Map

Name_to_Scaler_Map_t QwScaler::fName_Map

private

Definition at line 145 of file QwScaler.h.

Referenced by LoadChannelMap(), and LoadInputParameters().

fNorm

std::vector< std::pair< VQwScaler_Channel*, double > > QwScaler::fNorm

private

Definition at line 150 of file QwScaler.h.

Referenced by LoadChannelMap(), and ProcessEvent().

fScaler

std::vector< VQwScaler_Channel* > QwScaler::fScaler

private

Definition at line 148 of file QwScaler.h.

Referenced by AccumulateRunningSum(), CalculateRunningAverage(), ClearEventData(), Compare(), ConstructBranchAndVector(), ConstructHistograms(), DeaccumulateRunningSum(), FillHistograms(), FillTreeVector(), GetDataForChannelInModule(), LoadChannelMap(), LoadInputParameters(), operator+=(), operator-=(), operator=(), PrintInfo(), PrintValue(), ProcessEvBuffer(), ProcessEvent(), QwScaler(), Ratio(), Scale(), and ~QwScaler().

fSubbank_Map

Subbank_to_Scaler_Map_t QwScaler::fSubbank_Map

private

Definition at line 137 of file QwScaler.h.

Referenced by LoadChannelMap(), and ProcessEvBuffer().

---

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

• QwScaler.h
• QwScaler.cc