QwBlindDetectorArray Class Reference

Detector array wrapper that applies blinding to asymmetries. More...

#include <QwBlindDetectorArray.h>

Inheritance diagram for QwBlindDetectorArray:

Collaboration diagram for QwBlindDetectorArray:

Public Member Functions
	QwBlindDetectorArray (const TString &name)
	Constructor with name.
	QwBlindDetectorArray (const QwBlindDetectorArray &source)
	Copy constructor.
	~QwBlindDetectorArray () override
	Virtual destructor.
void	Blind (const QwBlinder *blinder) override
	Blind the asymmetry.
void	Blind (const QwBlinder *blinder, const VQwSubsystemParity *subsys) override
	Blind the difference using the yield.
Public Member Functions inherited from VQwDetectorArray
	VQwDetectorArray (const TString &name)
	Constructor with name.
	VQwDetectorArray (const VQwDetectorArray &source)
	Copy constructor.
	~VQwDetectorArray () override
	Virtual destructor.
void	ProcessOptions (QwOptions &options) override
Int_t	LoadChannelMap (TString mapfile) override
Int_t	LoadInputParameters (TString pedestalfile) override
	Mandatory parameter file definition.
void	LoadEventCuts_Init () override
void	LoadEventCuts_Line (QwParameterFile &mapstr, TString &varvalue, Int_t &eventcut_flag) override
void	LoadEventCuts_Fin (Int_t &eventcut_flag) override
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
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
	TODO: The non-event-type-aware ProcessEvBuffer routine should be replaced with the event-type-aware version.
void	ClearEventData () override
Bool_t	IsGoodEvent ()
void	ProcessEvent () override
void	ExchangeProcessedData () override
void	ProcessEvent_2 () override
	Process the event data again, including data from other subsystems. Not all derived classes will require a second stage of event data processing.
Bool_t	PublishInternalValues () const override
Bool_t	PublishByRequest (TString device_name) override
void	SetRandomEventParameters (Double_t mean, Double_t sigma)
void	SetRandomEventAsymmetry (Double_t asymmetry)
void	RandomizeEventData (int helicity=0, Double_t time=0.0) override
void	EncodeEventData (std::vector< UInt_t > &buffer) override
void	RandomizeMollerEvent (int helicity)
void	ConstructHistograms (TDirectory *folder) override
	Construct the histograms for this subsystem in a folder.
void	ConstructHistograms (TDirectory *folder, TString &prefix) override
	Construct the histograms for this subsystem in a folder with a prefix.
void	FillHistograms () override
	Fill the histograms for this subsystem.
void	ConstructBranchAndVector (TTree *tree, TString &prefix, QwRootTreeBranchVector &values) override
	Construct the branch and tree vector.
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
	Fill the tree vector.
const QwIntegrationPMT *	GetChannel (const TString name) const
Bool_t	Compare (VQwSubsystem *source)
VQwSubsystem &	operator= (VQwSubsystem *value) override
	Assignment Note: Must be called at the beginning of all subsystems routine call to operator=(VQwSubsystem *value) by VQwSubsystem::operator=(value)
VQwSubsystem &	operator+= (VQwSubsystem *value) override
VQwSubsystem &	operator-= (VQwSubsystem *value) override
void	Ratio (VQwSubsystem *numer, VQwSubsystem *denom) override
void	Scale (Double_t factor) override
void	Normalize (VQwDataElement *denom)
void	AccumulateRunningSum (VQwSubsystem *value, Int_t count=0, Int_t ErrorMask=0xFFFFFFF) override
	Update the running sums for devices.
void	DeaccumulateRunningSum (VQwSubsystem *value, Int_t ErrorMask=0xFFFFFFF) override
	remove one entry from the running sums for devices
void	CalculateRunningAverage () override
	Calculate the average for all good events.
const QwIntegrationPMT *	GetIntegrationPMT (const TString name) const
const QwCombinedPMT *	GetCombinedPMT (const TString name) const
void	DoNormalization (Double_t factor=1.0)
Bool_t	ApplyHWChecks ()
void	LoadMockDataParameters (TString pedestalfile) override
void	PrintValue () const override
	Print values of all channels.
void	WritePromptSummary (QwPromptSummary *ps, TString type) override
void	PrintInfo () const override
	Print some information about the subsystem.
void	PrintDetectorID () const
virtual void	ConstructHistograms ()
	Construct the histograms for this subsystem.
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 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 Bool_t	CheckForEndOfBurst () const
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	AtEndOfEventLoop ()
	Perform actions at the end of the event loop.
virtual void	RandomizeEventData (int=0, double=0.0)
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, QwBlindDetectorArray >
	~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.

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

Additional Inherited Members
Static Public Member Functions inherited from VQwDetectorArray
static void	DefineOptions (QwOptions &options)
	Define options function.
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, QwBlindDetectorArray >
static VQwSubsystem *	Create (const std::string &name)
	Object creation.
static QwBlindDetectorArray *	Cast (QwBlindDetectorArray *type)
	Object dynamic cast.
Protected Member Functions inherited from VQwDetectorArray
EQwPMTInstrumentType	GetDetectorTypeID (TString name)
Int_t	GetDetectorIndex (EQwPMTInstrumentType TypeID, TString name)
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 VQwDetectorArray
Bool_t	fDEBUG
std::vector< QwIntegrationPMT >	fIntegrationPMT
std::vector< QwCombinedPMT >	fCombinedPMT
std::vector< QwDetectorArrayID >	fMainDetID
QwBeamCharge	fTargetCharge
QwBeamPosition	fTargetX
QwBeamPosition	fTargetY
QwBeamAngle	fTargetXprime
QwBeamAngle	fTargetYprime
QwBeamEnergy	fTargetEnergy
Bool_t	bIsExchangedDataValid
Bool_t	bNormalization
Double_t	fNormThreshold
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

Detector array wrapper that applies blinding to asymmetries.

Aggregates multiple PMT-like detectors and provides methods to apply blinding strategies consistently to yields, differences, and asymmetries. Used for parity-violating detector analysis.

Definition at line 35 of file QwBlindDetectorArray.h.

Constructor & Destructor Documentation

QwBlindDetectorArray() [1/3]

QwBlindDetectorArray::QwBlindDetectorArray ( )

private

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

Referenced by Blind(), and QwBlindDetectorArray().

Here is the caller graph for this function:

QwBlindDetectorArray() [2/3]

QwBlindDetectorArray::QwBlindDetectorArray ( const TString & name )

inline

Constructor with name.

Definition at line 56 of file QwBlindDetectorArray.h.

  : VQwSubsystem(name), VQwSubsystemParity(name), VQwDetectorArray(name) {};

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

Here is the call graph for this function:

QwBlindDetectorArray() [3/3]

QwBlindDetectorArray::QwBlindDetectorArray ( const QwBlindDetectorArray & source )

inline

Copy constructor.

Definition at line 61 of file QwBlindDetectorArray.h.

  : VQwSubsystem(source),VQwSubsystemParity(source), VQwDetectorArray(source){};

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

Here is the call graph for this function:

~QwBlindDetectorArray()

QwBlindDetectorArray::~QwBlindDetectorArray ( )

inlineoverride

Virtual destructor.

Definition at line 66 of file QwBlindDetectorArray.h.

{};

Member Function Documentation

Blind() [1/2]

void QwBlindDetectorArray::Blind ( const QwBlinder * blinder )

overridevirtual

Blind the asymmetry.

Blind the asymmetry

Parameters

blinder

Blinder

Reimplemented from VQwSubsystemParity.

Definition at line 18 of file QwBlindDetectorArray.cc.

{
  for (size_t i = 0; i < fIntegrationPMT.size(); i++)
    fIntegrationPMT[i].Blind(blinder);
  for (size_t i = 0; i < fCombinedPMT.size(); i++)
    fCombinedPMT[i].Blind(blinder);
}

References Blind(), VQwDetectorArray::fCombinedPMT, and VQwDetectorArray::fIntegrationPMT.

Referenced by Blind(), and Blind().

Here is the call graph for this function:

Here is the caller graph for this function:

Blind() [2/2]

void QwBlindDetectorArray::Blind ( const QwBlinder * blinder, const VQwSubsystemParity * subsys )

overridevirtual

Blind the difference using the yield.

Blind the difference using the yield

Parameters

blinder	Blinder
subsys	Subsystem

Todo

TODO (wdc) At some point we should introduce const-correctness in the Compare() routine to ensure nothing funny happens. This const_casting is just an ugly stop-gap measure.

Reimplemented from VQwSubsystemParity.

Definition at line 32 of file QwBlindDetectorArray.cc.

{
  /// \todo TODO (wdc) At some point we should introduce const-correctness in
  /// the Compare() routine to ensure nothing funny happens.  This const_casting
  /// is just an ugly stop-gap measure.
  if (Compare(const_cast<VQwSubsystemParity*>(subsys))) {
 
    const QwBlindDetectorArray* yield = dynamic_cast<const QwBlindDetectorArray*>(subsys);
    if (yield == 0) return;
 
    for (size_t i = 0; i < fIntegrationPMT.size(); i++)
      fIntegrationPMT[i].Blind(blinder, yield->fIntegrationPMT[i]);
    for (size_t i = 0; i < fCombinedPMT.size(); i++)
      fCombinedPMT[i].Blind(blinder, yield->fCombinedPMT[i]);
  }
}

References Blind(), VQwDetectorArray::Compare(), VQwDetectorArray::fCombinedPMT, VQwDetectorArray::fIntegrationPMT, QwBlindDetectorArray(), and VQwSubsystemParity::VQwSubsystemParity().

Here is the call graph for this function:

---

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

• QwBlindDetectorArray.h
• QwBlindDetectorArray.cc