#include <QwPMT_Channel.h>

Inheritance diagram for QwPMT_Channel:

Collaboration diagram for QwPMT_Channel:

Public Member Functions
	QwPMT_Channel ()
	Default constructor. More...

	QwPMT_Channel (const QwPMT_Channel &source)
	Copy constructor. More...

	QwPMT_Channel (TString name)
	Constructor with name. More...

virtual	~QwPMT_Channel ()
	Virtual destructor. More...

void	InitializeChannel (TString name)

void	ClearEventData ()
	Clear the event data in this element. More...

void	RandomizeEventData (int helicity, int SlotNum, int ChanNum)

void	EncodeEventData (std::vector< UInt_t > &TrigBuffer)

Int_t	ProcessEvBuffer (UInt_t *buffer, UInt_t num_words_left, UInt_t subelement=0)
	Process the CODA event buffer for this element. More...

void	SetValue (Double_t data)

Double_t	GetValue () const

void	SetSubbankID (const Int_t bank_index)

void	SetModule (const Int_t slot_num)

Int_t	GetSubbankID () const

Int_t	GetModule () const

void	ProcessEvent ()

QwPMT_Channel &	operator= (const QwPMT_Channel &value)

void	ConstructHistograms (TDirectory *folder, TString &prefix)
	Construct the histograms for this data element. More...

void	FillHistograms ()
	Fill the histograms for this data element. More...

void	ConstructBranchAndVector (TTree *tree, TString &prefix, std::vector< Double_t > &values)

void	FillTreeVector (std::vector< Double_t > &values) const

void	PrintValue () const
	Print single line of value and error of this data element. More...

void	PrintInfo () const
	Print multiple lines of information about this data element. More...

void	PrintErrorCounters () const
	report number of events failed due to HW and event cut failure More...

Public Member Functions inherited from VQwDataElement
	VQwDataElement ()
	Default constructor. More...

	VQwDataElement (const VQwDataElement &value)
	Copy constructor. More...

virtual	~VQwDataElement ()
	Virtual destructor. More...

Bool_t	IsNameEmpty () const
	Is the name of this element empty? More...

void	SetElementName (const TString &name)
	Set the name of this element. More...

virtual const TString &	GetElementName () const
	Get the name of this element. More...

virtual void	LoadChannelParameters (QwParameterFile &paramfile)

size_t	GetNumberOfDataWords ()
	Get the number of data words in this data element. More...

UInt_t	GetGoodEventCount () const

virtual void	AssignValueFrom (const VQwDataElement *valueptr)

virtual VQwDataElement &	operator+= (const VQwDataElement &value)
	Addition-assignment operator. More...

virtual VQwDataElement &	operator-= (const VQwDataElement &value)
	Subtraction-assignment operator. More...

virtual void	Sum (const VQwDataElement &value1, const VQwDataElement &value2)
	Sum operator. More...

virtual void	Difference (const VQwDataElement &value1, const VQwDataElement &value2)
	Difference operator. More...

virtual void	Ratio (const VQwDataElement &numer, const VQwDataElement &denom)
	Ratio operator. More...

virtual void	SetSingleEventCuts (UInt_t errorflag, Double_t min, Double_t max, Double_t stability)
	set the upper and lower limits (fULimit and fLLimit), stability % and the error flag on this channel More...

virtual UInt_t	GetEventcutErrorFlag ()
	return the error flag on this channel/device More...

virtual UInt_t	UpdateErrorFlag ()
	Update the error flag based on the error flags of internally contained objects Return paramter is the "Eventcut Error Flag". More...

virtual void	SetNeedsExternalClock (Bool_t needed)

virtual Bool_t	NeedsExternalClock ()

virtual std::string	GetExternalClockName ()

virtual void	SetExternalClockPtr (const VQwHardwareChannel *clock)

virtual void	SetExternalClockName (const std::string name)

virtual Double_t	GetNormClockValue ()

TString	GetSubsystemName () const
	Return the name of the inheriting subsystem name. More...

void	SetSubsystemName (TString sysname)
	Set the name of the inheriting subsystem name. More...

TString	GetModuleType () const
	Return the type of the beam instrument. More...

void	SetModuleType (TString ModuleType)
	set the type of the beam instrument More...

Public Member Functions inherited from MQwHistograms
void	ShareHistograms (const MQwHistograms *source)
	Share histogram pointers between objects. More...

Private Attributes
size_t	fTreeArrayIndex

size_t	fTreeArrayNumEntries

Double_t	fValue

Int_t	fCrate
	ROC number. More...

Int_t	fModule
	slot number More...

Static Private Attributes
static const Bool_t	kDEBUG = kFALSE

static const Double_t	kPMT_VoltsPerBit = (20./(1<<18))

Additional Inherited Members
Public Types inherited from VQwDataElement
enum	EDataToSave { kRaw = 0, kDerived }

Protected Member Functions inherited from VQwDataElement
void	SetNumberOfDataWords (const UInt_t &numwords)
	Set the number of data words in this data element. More...

virtual VQwDataElement &	operator= (const VQwDataElement &value)
	Arithmetic assignment operator: Should only copy event-based data. More...

virtual void	UpdateErrorFlag (const UInt_t &error)

Protected Member Functions inherited from MQwHistograms
	MQwHistograms ()
	Default constructor. More...

	MQwHistograms (const MQwHistograms &source)
	Copy constructor. More...

virtual	~MQwHistograms ()
	Virtual destructor. More...

virtual MQwHistograms &	operator= (const MQwHistograms &value)

void	Fill_Pointer (TH1_ptr hist_ptr, Double_t value)

void	AddHistogram (TH1 *h)
	Register a histogram. More...

Protected Attributes inherited from VQwDataElement
TString	fElementName
	Name of this data element. More...

UInt_t	fNumberOfDataWords
	Number of raw data words in this data element. More...

Int_t	fGoodEventCount
	Number of good events accumulated in this element. More...

TString	fSubsystemName

TString	fModuleType

UInt_t	fErrorFlag
	This the standard error code generated for the channel that contains the global/local/stability flags and the Device error code (Unique error code for HW failures) More...

UInt_t	fErrorConfigFlag
	contains the global/local/stability flags More...

Protected Attributes inherited from MQwHistograms
std::vector< TH1_ptr >	fHistograms
	Histograms associated with this data element. More...

Detailed Description

Definition at line 24 of file QwPMT_Channel.h.

Constructor & Destructor Documentation

QwPMT_Channel::QwPMT_Channel ( )

inline

Default constructor.

Definition at line 31 of file QwPMT_Channel.h.

                   {
     // Prepare the random number generator.
     gRandom->SetSeed();
   };

QwPMT_Channel::QwPMT_Channel ( const QwPMT_Channel & source )

inline

Copy constructor.

Definition at line 36 of file QwPMT_Channel.h.

37 : VQwDataElement(source)

38 { };

VQwDataElement::VQwDataElement

VQwDataElement()

Default constructor.

Definition: VQwDataElement.h:61

QwPMT_Channel::QwPMT_Channel ( TString name )

inline

Constructor with name.

Definition at line 40 of file QwPMT_Channel.h.

References InitializeChannel().

                               {
     InitializeChannel(name);
   };

Here is the call graph for this function:

virtual QwPMT_Channel::~QwPMT_Channel ( )

inlinevirtual

Virtual destructor.

Definition at line 44 of file QwPMT_Channel.h.

44 { };

Member Function Documentation

void QwPMT_Channel::ClearEventData ( )

virtual

Clear the event data in this element.

Reimplemented from VQwDataElement.

Definition at line 26 of file QwPMT_Channel.cc.

References fValue.

Referenced by InitializeChannel().

                                   {
   fValue   = 0;
 }

Here is the caller graph for this function:

void QwPMT_Channel::ConstructBranchAndVector	(	TTree *	tree,
		TString &	prefix,
		std::vector< Double_t > &	values
	)

Definition at line 98 of file QwPMT_Channel.cc.

References fTreeArrayIndex, fTreeArrayNumEntries, and VQwDataElement::GetElementName().

 {
   if (GetElementName() == "") {
     //  This channel is not used, so skip setting up the tree.
   } else {
     TString basename = prefix + GetElementName();
     fTreeArrayIndex  = values.size();
 
     values.push_back(0.0);
     TString list = basename + "/D";
 
     fTreeArrayNumEntries = values.size() - fTreeArrayIndex;
     tree->Branch(basename, &(values[fTreeArrayIndex]), list);
   }
 }

Here is the call graph for this function:

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

virtual

Construct the histograms for this data element.

Implements VQwDataElement.

Definition at line 67 of file QwPMT_Channel.cc.

References QwHistogramHelper::Construct1DHist(), MQwHistograms::fHistograms, VQwDataElement::GetElementName(), and gQwHists.

 {
   //  If we have defined a subdirectory in the ROOT file, then change into it.
   if (folder != NULL) folder->cd();
 
   if (GetElementName() == "") {
     //  This channel is not used, so skip filling the histograms.
   } else {
     //  Now create the histograms.
     TString basename, fullname;
     basename = prefix + GetElementName();
 
     fHistograms.resize(1, NULL);
     size_t index = 0;
     fHistograms[index] = gQwHists.Construct1DHist(basename);
     index++;
   }
 }

Here is the call graph for this function:

void QwPMT_Channel::EncodeEventData ( std::vector< UInt_t > & TrigBuffer )

Definition at line 45 of file QwPMT_Channel.cc.

References fValue, and VQwDataElement::IsNameEmpty().

 {
 //  std::cout<<"QwPMT_Channel::EncodeEventData() not fully implemented yet."<<std::endl;
 
   Long_t localbuf;
 
   if (IsNameEmpty()) {
     //  This channel is not used, but is present in the data stream.
     //  Skip over this data.
   } else {
     localbuf = (Long_t) (this->fValue);
     TrigBuffer.push_back(localbuf);
   }
 
 }

Here is the call graph for this function:

void QwPMT_Channel::FillHistograms ( )

virtual

Fill the histograms for this data element.

Implements VQwDataElement.

Definition at line 86 of file QwPMT_Channel.cc.

References MQwHistograms::fHistograms, fValue, and VQwDataElement::GetElementName().

 {
   size_t index = 0;
   if (GetElementName() == "") {
     //  This channel is not used, so skip creating the histograms.
   } else {
     if (fHistograms[index] != NULL)
       fHistograms[index]->Fill(fValue);
     index++;
   }
 }

Here is the call graph for this function:

void QwPMT_Channel::FillTreeVector ( std::vector< Double_t > & values ) const

Definition at line 114 of file QwPMT_Channel.cc.

References fTreeArrayIndex, fTreeArrayNumEntries, fValue, and VQwDataElement::GetElementName().

 {
   if (GetElementName()==""){
     //  This channel is not used, so skip filling the tree vector.
   } else if (fTreeArrayNumEntries<=0){
     std::cerr << "QwPMT_Channel::FillTreeVector:  fTreeArrayNumEntries=="
         << fTreeArrayNumEntries << std::endl;
   } else if (values.size() < fTreeArrayIndex+fTreeArrayNumEntries){
     std::cerr << "QwPMT_Channel::FillTreeVector:  values.size()=="
         << values.size()
         << "; fTreeArrayIndex+fTreeArrayNumEntries=="
         << fTreeArrayIndex+fTreeArrayNumEntries
         << std::endl;
   } else {
     size_t index=fTreeArrayIndex;
     values[index++] = this->fValue;
   }
 }

Here is the call graph for this function:

Int_t QwPMT_Channel::GetModule ( ) const

inline

Definition at line 61 of file QwPMT_Channel.h.

References fModule.

61 { return fModule; };

QwPMT_Channel::fModule

Int_t fModule

slot number

Definition: QwPMT_Channel.h:98

Int_t QwPMT_Channel::GetSubbankID ( ) const

inline

Definition at line 60 of file QwPMT_Channel.h.

References fCrate.

60 { return fCrate; };

QwPMT_Channel::fCrate

Int_t fCrate

ROC number.

Definition: QwPMT_Channel.h:97

Double_t QwPMT_Channel::GetValue ( ) const

inline

Definition at line 57 of file QwPMT_Channel.h.

References fValue.

Referenced by PrintValue().

57 { return fValue; };

QwPMT_Channel::fValue

Double_t fValue

Definition: QwPMT_Channel.h:95

Here is the caller graph for this function:

void QwPMT_Channel::InitializeChannel ( TString name )

inline

Definition at line 46 of file QwPMT_Channel.h.

References ClearEventData(), and VQwDataElement::SetElementName().

Referenced by QwPMT_Channel().

                                        {
     SetElementName(name);
     ClearEventData();
   };

Here is the call graph for this function:

Here is the caller graph for this function:

QwPMT_Channel & QwPMT_Channel::operator= ( const QwPMT_Channel & value )

Definition at line 135 of file QwPMT_Channel.cc.

References fValue, and VQwDataElement::GetElementName().

                                                                   {
   if (GetElementName()!=""){
     this->fValue  = value.fValue;
   }
   return *this;
 }

Here is the call graph for this function:

void QwPMT_Channel::PrintErrorCounters ( ) const

inlinevirtual

report number of events failed due to HW and event cut failure

Reimplemented from VQwDataElement.

Definition at line 75 of file QwPMT_Channel.h.

75 {};

void QwPMT_Channel::PrintInfo ( ) const

virtual

Print multiple lines of information about this data element.

Reimplemented from VQwDataElement.

Definition at line 150 of file QwPMT_Channel.cc.

 {
   std::cout << "QwPMT_Channel::Print() not implemented yet." << std::endl;
 }

void QwPMT_Channel::PrintValue ( ) const

virtual

Print single line of value and error of this data element.

Reimplemented from VQwDataElement.

Definition at line 142 of file QwPMT_Channel.cc.

References QwLog::endl(), VQwDataElement::GetElementName(), GetValue(), and QwMessage.

 {
   QwMessage << std::setprecision(4)
             << std::setw(18) << std::left << GetElementName() << ", "
             << std::setw(15) << std::left << GetValue()
             << QwLog::endl;
 }

Here is the call graph for this function:

Int_t QwPMT_Channel::ProcessEvBuffer	(	UInt_t *	buffer,
		UInt_t	num_words_left,
		UInt_t	subelement = `0`
	)

inlinevirtual

Process the CODA event buffer for this element.

Implements VQwDataElement.

Definition at line 54 of file QwPMT_Channel.h.

54 {return 0;};

void QwPMT_Channel::ProcessEvent ( )

Definition at line 61 of file QwPMT_Channel.cc.

 {
 
 }

void QwPMT_Channel::RandomizeEventData	(	int	helicity,
		int	SlotNum,
		int	ChanNum
	)

Definition at line 30 of file QwPMT_Channel.cc.

References fValue.

                                                                             {
 
   Double_t mean = 1500.0;
   Double_t sigma = 300.0;
   UInt_t fV775Dataword = abs( (Int_t)gRandom->Gaus(mean,sigma) );
 
   UInt_t fV775SlotNumber = SlotNum;
   UInt_t fV775ChannelNumber = ChanNum;
   const UInt_t fV775DataValidBit = 0x00004000;
 
   UInt_t word = fV775Dataword | (fV775SlotNumber<<27);
   word = word | (fV775ChannelNumber<<16) | fV775DataValidBit;
   fValue = word;
 }

void QwPMT_Channel::SetModule ( const Int_t slot_num )

inline

Definition at line 59 of file QwPMT_Channel.h.

References fModule.

59 { fModule = slot_num; };

QwPMT_Channel::fModule

Int_t fModule

slot number

Definition: QwPMT_Channel.h:98

void QwPMT_Channel::SetSubbankID ( const Int_t bank_index )

inline

Definition at line 58 of file QwPMT_Channel.h.

References fCrate.

58 { fCrate = bank_index; };

QwPMT_Channel::fCrate

Int_t fCrate

ROC number.

Definition: QwPMT_Channel.h:97

void QwPMT_Channel::SetValue ( Double_t data )

inline

Definition at line 56 of file QwPMT_Channel.h.

References fValue.

56 { fValue = data; };

QwPMT_Channel::fValue

Double_t fValue

Definition: QwPMT_Channel.h:95

Field Documentation

Int_t QwPMT_Channel::fCrate

private

ROC number.

Definition at line 97 of file QwPMT_Channel.h.

Referenced by GetSubbankID(), and SetSubbankID().

Int_t QwPMT_Channel::fModule

private

slot number

Definition at line 98 of file QwPMT_Channel.h.

Referenced by GetModule(), and SetModule().

size_t QwPMT_Channel::fTreeArrayIndex

private

Definition at line 91 of file QwPMT_Channel.h.

Referenced by ConstructBranchAndVector(), and FillTreeVector().

size_t QwPMT_Channel::fTreeArrayNumEntries

private

Definition at line 92 of file QwPMT_Channel.h.

Referenced by ConstructBranchAndVector(), and FillTreeVector().

Double_t QwPMT_Channel::fValue

private

Definition at line 95 of file QwPMT_Channel.h.

Referenced by ClearEventData(), EncodeEventData(), FillHistograms(), FillTreeVector(), GetValue(), operator=(), RandomizeEventData(), and SetValue().

const Bool_t QwPMT_Channel::kDEBUG = kFALSE

staticprivate

Definition at line 75 of file QwPMT_Channel.h.

const Double_t QwPMT_Channel::kPMT_VoltsPerBit = (20./(1<<18))

staticprivate

Conversion factor to translate the average bit count in an ADC channel into average voltage. The base factor is roughly 76 uV per count, and zero counts corresponds to zero voltage. Store as the exact value for 20 V range, 18 bit ADC.

Definition at line 85 of file QwPMT_Channel.h.

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

Public Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation