SctData::FitScanResult Class Reference

Class for the various fitted ROD scan result objects. More...

#include <FitScanResult.h>

Inheritance diagram for SctData::FitScanResult:

[legend]Collaboration diagram for SctData::FitScanResult:

[legend]


Public Member Functions
	FitScanResult (const ResultHeader &header, const ModuleConfiguration &config, const ScanPoints &points) throw ()
	Create a FitScanResult from the objects that are needed to initialize the base class. Is this really necessary?
	FitScanResult (const RawScanResult &raw) throw ()
	Create a FitScanResult object from a given RawScanResult Object.
virtual	~FitScanResult () throw ()
	Destroy the FitScanResult object and all of its FitObject members.
FitObject &	getChannelFit (const unsigned ilink, const unsigned ichip) const throw (LogicError)
	get channel fit by : link 0 or 1, channel 0 -> 767
unsigned	getNHist () const throw ()
	get number of summary histograms
const TH1D &	getHist (unsigned i) const throw (LogicError)
	get an existing summary histogram

virtual string	getClassName () const throw ()
	Serializable overrides.
virtual Sct::UniqueID	getUniqueID () const throw ()
	Serializable overrides.

const DefectList &	getDefects () const throw ()
	Get the DefectList associated with this FitScanResult.
DefectList &	getDefects () throw ()
	Get the DefectList associated with this FitScanResult.

FitObject &	getLinkFit (const unsigned ilink) const throw (LogicError)
	Functions to retrieve the FitObjects, by link, chip or channel get link fit by : link 0 or 1.
FitObject &	getChipFit (const unsigned ilink, const unsigned ichip) const throw (LogicError)
	get chip fit by : link 0 or 1, chip 0 -> 5
FitObject &	getChipFit (const unsigned ichip) const throw (LogicError)
	get chip fit by : chip 0 -> 11, with 6->11 on link 1
FitObject &	getChannelFit (const unsigned ichannel) const throw (LogicError)
	get channel fit by : channel 0 -> 1535 (with 768->1535 on link 1)

unsigned	getNLinkFits () const throw ()
	Largely included for bug-checking, the following functions should return 2 if the object has been correctly initialized.
unsigned	getNChipFits () const throw ()
	Largely included for bug-checking, the following functions should return 12 if the object has been correctly initialized.
unsigned	getNChannelFits () const throw ()
	Largely included for bug-checking, the following functions should return 1536 if the object has been correctly initialized.
void	setNChannelFits (unsigned int n=Sct::nChannelModule) throw ()
	Set the number of channel fits that are stored.
void	setNChipFits (unsigned int n=Sct::nChipModule) throw ()
	Set the number of chip fits that are stored.
void	setNLinkFits (unsigned int n=Sct::nLinkModule) throw ()
	Set the number of channel fits that are stored.
void	initializeChannelFits (const FitObject &prototype) throw ()
	Initializes this so that it can store channel fits.
void	initializeChipFits (const FitObject &prototype) throw ()
	set the number of chip fits
void	initializeLinkFits (const FitObject &prototype) throw ()
	set the number of link fits
void	setChannelFit (unsigned int channel, shared_ptr< FitObject > fit) throw (LogicError)
	Set a channel fit.
void	setChipFit (unsigned int chip, shared_ptr< FitObject > fit) throw (LogicError)
	Set a chip fit.
void	setLinkFit (unsigned int link, shared_ptr< FitObject > fit) throw (LogicError)
	Set a link fit.
Static Public Member Functions
static Sct::UniqueID	getUniqueID (const ResultHeader &header) throw ()
	Returns the uniqueID a FitScanResult would have if it included the given ScanHeader.
Protected Attributes
RangedVector< shared_ptr< FitObject > >	m_channelFits
	fits for each channel
RangedVector< shared_ptr< FitObject > >	m_chipFits
	fits for each chip
RangedVector< shared_ptr< FitObject > >	m_linkFits
	fits for each link
RangedVector< TH1D * >	m_summaryHist
	summary histograms
DefectList	defects
	Contains all the defects discovered in doing the fits.
Private Member Functions
	FitScanResult () throw ()
	Default constructor - only for IO purposes.
Static Private Member Functions
template<class T>
static void	resizeAndFill (std::vector< shared_ptr< T > > &v, unsigned newSize, const T &prototype) throw ()
	utility function;
Friends
class	FitScanResultIOHelper
	The IOHelper class.

Detailed Description

Class for the various fitted ROD scan result objects.

Author:: Alan Barr

Date:: 6 December 2002

Definition at line 33 of file FitScanResult.h.

Constructor & Destructor Documentation

SctData::FitScanResult::FitScanResult ( const ResultHeader & header,

const ModuleConfiguration & config,

const ScanPoints & points

) throw ()

Create a FitScanResult from the objects that are needed to initialize the base class. Is this really necessary?

Definition at line 19 of file FitScanResult.cpp.

SctData::FitScanResult::FitScanResult ( const RawScanResult & raw ) throw ()

Create a FitScanResult object from a given RawScanResult Object.

Definition at line 23 of file FitScanResult.cpp.

SctData::FitScanResult::~FitScanResult ( ) throw () [virtual]

Destroy the FitScanResult object and all of its FitObject members.

Definition at line 26 of file FitScanResult.cpp.
References m_summaryHist.

SctData::FitScanResult::FitScanResult ( ) throw () [private]

Default constructor - only for IO purposes.

Definition at line 16 of file FitScanResult.cpp.

Member Function Documentation

FitObject & SctData::FitScanResult::getChannelFit ( const unsigned ilink,

const unsigned ichip

) const throw (LogicError)

get channel fit by : link 0 or 1, channel 0 -> 767

Definition at line 67 of file FitScanResult.cpp.
References Sct::nChannelLink.

FitObject & SctData::FitScanResult::getChannelFit ( const unsigned ichannel ) const throw (LogicError)

get channel fit by : channel 0 -> 1535 (with 768->1535 on link 1)

Definition at line 71 of file FitScanResult.cpp.
Referenced by FitCompare::compare(), NagRootCompare::compareFits(), and SctDataDisplay::FitDisplayer::displayChannels().

FitObject & SctData::FitScanResult::getChipFit ( const unsigned ichip ) const throw (LogicError)

get chip fit by : chip 0 -> 11, with 6->11 on link 1

Definition at line 63 of file FitScanResult.cpp.

FitObject & SctData::FitScanResult::getChipFit ( const unsigned ilink,

const unsigned ichip

) const throw (LogicError)

get chip fit by : link 0 or 1, chip 0 -> 5

Definition at line 59 of file FitScanResult.cpp.
Referenced by SctDataDisplay::FitDisplayer::displayChips().

string SctData::FitScanResult::getClassName ( ) const throw () [virtual]

Serializable overrides.

Implements Sct::Streamable.
Definition at line 32 of file FitScanResult.cpp.

DefectList& SctData::FitScanResult::getDefects ( ) throw () [inline]

Get the DefectList associated with this FitScanResult.

Definition at line 58 of file FitScanResult.h.
References defects.

const DefectList& SctData::FitScanResult::getDefects ( ) const throw () [inline]

Get the DefectList associated with this FitScanResult.

Definition at line 55 of file FitScanResult.h.
References defects.
Referenced by SctDataDisplay::FitDisplayer::displayChips().

const TH1D & SctData::FitScanResult::getHist ( unsigned i ) const throw (LogicError)

get an existing summary histogram

Definition at line 112 of file FitScanResult.cpp.

FitObject & SctData::FitScanResult::getLinkFit ( const unsigned ilink ) const throw (LogicError)

Functions to retrieve the FitObjects, by link, chip or channel get link fit by : link 0 or 1.

Definition at line 55 of file FitScanResult.cpp.
Referenced by SctData::IO::FitScanResultStreamer_v1::write().

unsigned SctData::FitScanResult::getNChannelFits ( ) const throw ()

Largely included for bug-checking, the following functions should return 1536 if the object has been correctly initialized.

Definition at line 95 of file FitScanResult.cpp.
References m_channelFits.

unsigned SctData::FitScanResult::getNChipFits ( ) const throw ()

Largely included for bug-checking, the following functions should return 12 if the object has been correctly initialized.

Definition at line 91 of file FitScanResult.cpp.
References m_chipFits.

unsigned SctData::FitScanResult::getNHist ( ) const throw () [inline]

get number of summary histograms

Definition at line 95 of file FitScanResult.h.
References m_summaryHist.

unsigned SctData::FitScanResult::getNLinkFits ( ) const throw ()

Largely included for bug-checking, the following functions should return 2 if the object has been correctly initialized.

Definition at line 87 of file FitScanResult.cpp.
References m_linkFits.
Referenced by SctData::IO::FitScanResultStreamer_v1::write().

Sct::UniqueID SctData::FitScanResult::getUniqueID ( const ResultHeader & header ) throw () [static]

Returns the uniqueID a FitScanResult would have if it included the given ScanHeader.

Definition at line 40 of file FitScanResult.cpp.
References Sct::UniqueID::getUniqueID().
Here is the call graph for this function:

Sct::UniqueID SctData::FitScanResult::getUniqueID ( ) const throw () [virtual]

Serializable overrides.

Implements Sct::Serializable.
Definition at line 36 of file FitScanResult.cpp.
References SctData::ScanResult::getHeader(), and SctData::ResultHeader::getUniqueID().
Here is the call graph for this function:

void SctData::FitScanResult::initializeChannelFits ( const FitObject & prototype ) throw ()

Initializes this so that it can store channel fits.

Parameters:

prototype A prototypical FitObject that will be copied.

Definition at line 44 of file FitScanResult.cpp.
References Sct::nChannelModule.

void SctData::FitScanResult::initializeChipFits ( const FitObject & prototype ) throw ()

set the number of chip fits

Definition at line 48 of file FitScanResult.cpp.
References Sct::nChipModule.

void SctData::FitScanResult::initializeLinkFits ( const FitObject & prototype ) throw ()

set the number of link fits

Definition at line 51 of file FitScanResult.cpp.
References Sct::nLinkModule.

template<class T>

void SctData::FitScanResult::resizeAndFill ( std::vector< shared_ptr< T > > & v,

unsigned newSize,

const T & prototype

) throw () [static, private]

utility function;

Definition at line 187 of file FitScanResult.h.

void SctData::FitScanResult::setChannelFit ( unsigned int channel,

shared_ptr< FitObject > fit

) throw (LogicError)

Set a channel fit.
Must first call enableChannelFits
Definition at line 75 of file FitScanResult.cpp.

void SctData::FitScanResult::setChipFit ( unsigned int chip,

shared_ptr< FitObject > fit

) throw (LogicError)

Set a chip fit.
Must first call enableChipFits
Definition at line 79 of file FitScanResult.cpp.

void SctData::FitScanResult::setLinkFit ( unsigned int link,

shared_ptr< FitObject > fit

) throw (LogicError)

Set a link fit.
Must first call enableLinkFits
Definition at line 83 of file FitScanResult.cpp.
Referenced by SctData::IO::FitScanResultStreamer_v1::read().

void SctData::FitScanResult::setNChannelFits ( unsigned int n = Sct::nChannelModule ) throw ()

Set the number of channel fits that are stored.

Definition at line 99 of file FitScanResult.cpp.

void SctData::FitScanResult::setNChipFits ( unsigned int n = Sct::nChipModule ) throw ()

Set the number of chip fits that are stored.

Definition at line 103 of file FitScanResult.cpp.

void SctData::FitScanResult::setNLinkFits ( unsigned int n = Sct::nLinkModule ) throw ()

Set the number of channel fits that are stored.

Definition at line 107 of file FitScanResult.cpp.
Referenced by SctData::IO::FitScanResultStreamer_v1::read().

Friends And Related Function Documentation

friend class FitScanResultIOHelper [friend]

The IOHelper class.

Definition at line 182 of file FitScanResult.h.

Field Documentation

DefectList SctData::FitScanResult::defects [protected]

Contains all the defects discovered in doing the fits.

Definition at line 175 of file FitScanResult.h.
Referenced by getDefects().

RangedVector<shared_ptr<FitObject> > SctData::FitScanResult::m_channelFits [protected]

fits for each channel

Definition at line 171 of file FitScanResult.h.
Referenced by getNChannelFits().

RangedVector<shared_ptr<FitObject> > SctData::FitScanResult::m_chipFits [protected]

fits for each chip

Definition at line 172 of file FitScanResult.h.
Referenced by getNChipFits().

RangedVector<shared_ptr<FitObject> > SctData::FitScanResult::m_linkFits [protected]

fits for each link

Definition at line 173 of file FitScanResult.h.
Referenced by getNLinkFits().

RangedVector<TH1D*> SctData::FitScanResult::m_summaryHist [protected]

summary histograms

Definition at line 174 of file FitScanResult.h.
Referenced by getNHist(), and ~FitScanResult().

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

Generated on Mon Feb 6 14:07:18 2006 for SCT DAQ/DCS Software - C++ by

1.4.6

SctData::FitScanResult Class Reference

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Field Documentation