SctAnalysis::MarkSpaceRatioAlgorithm Class Reference

Algorithm for MarkSpaceRatio Test. More...

#include <MarkSpaceRatioAlgorithm.h>

Inheritance diagram for SctAnalysis::MarkSpaceRatioAlgorithm:

[legend]Collaboration diagram for SctAnalysis::MarkSpaceRatioAlgorithm:

[legend]

Public Member Functions
virtual bool	canAnalyze () const
	Should check to see if the analysis can be performed.
virtual void	analyze ()
	Does the analysis.
virtual void	loadData ()
	Called to indicate the algorithm should try and load as much data as it can - perhaps by calling loadAllFits or loadAllRaws().
virtual shared_ptr< SctData::TestResult >	createTestResult () const
	Called if the TestResult needs to be created.
virtual boost::shared_ptr< AnalysisAlgorithm >	clone (shared_ptr< const TestData > testData, const string &moduleName) const throw ()
	Must be overridden by sub-classes.
	MarkSpaceRatioAlgorithm (shared_ptr< const TestData > testData, const string &moduleName, const AnalysisAlgorithm &alg) throw ()
	constructor
virtual	~MarkSpaceRatioAlgorithm () throw ()
	destructor
Protected Member Functions
virtual double	getAverageOccupancy (const SctData::RawScanResult &raw, unsigned short ilink)
Private Member Functions
	MarkSpaceRatioAlgorithm ()
void	fixOptimum (SctData::MarkSpaceRatioTestResult &r)
Static Private Attributes
static bool	inMap

---

Detailed Description

Algorithm for MarkSpaceRatio Test.

Definition at line 11 of file MarkSpaceRatioAlgorithm.h.

---

Constructor & Destructor Documentation

SctAnalysis::MarkSpaceRatioAlgorithm::MarkSpaceRatioAlgorithm (  shared_ptr< const TestData >  testData, const string &  moduleName, const AnalysisAlgorithm &  alg )  throw () [inline]

constructor Definition at line 21 of file MarkSpaceRatioAlgorithm.h.

virtual SctAnalysis::MarkSpaceRatioAlgorithm::~MarkSpaceRatioAlgorithm (   )  throw () [inline, virtual]

destructor Definition at line 25 of file MarkSpaceRatioAlgorithm.h.

---

Member Function Documentation

void SctAnalysis::MarkSpaceRatioAlgorithm::analyze (   )  [virtual]

Does the analysis. Should only be called after canAnalyze() returns true. Should not be called is isDone() returns true. It should also do any final initialization of the TestResult which requires data to be present Exceptions: any  Exception Implements SctAnalysis::AnalysisAlgorithm. Definition at line 36 of file MarkSpaceRatioAlgorithm.cpp. References SctData::MarkSpaceRatioTestResult::addPoint(), getAverageOccupancy(), SctData::TestResult::getNScans(), SctAnalysis::AnalysisAlgorithm::getRaw(), SctData::TestResult::getTestPointAt(), and SctAnalysis::AnalysisAlgorithm::getTestResult(). Here is the call graph for this function:

bool SctAnalysis::MarkSpaceRatioAlgorithm::canAnalyze (   )  const [virtual]

Should check to see if the analysis can be performed. Probably wants to call hasAllRaws() or hasAllFits(). Exceptions: no  exceotions. Implements SctAnalysis::AnalysisAlgorithm. Definition at line 28 of file MarkSpaceRatioAlgorithm.cpp. References SctAnalysis::AnalysisAlgorithm::hasAllRaws(). Here is the call graph for this function:

shared_ptr< AnalysisAlgorithm > SctAnalysis::MarkSpaceRatioAlgorithm::clone (  shared_ptr< const TestData >  testData, const string &  moduleName )  const throw () [virtual]

Must be overridden by sub-classes. Returns a shared pointer to a concrete AnalysisAlgorithm of the correct type. Primarily used by the map to get an AnalysisAlgorithm of the correct type. Implements SctAnalysis::AnalysisAlgorithm. Definition at line 19 of file MarkSpaceRatioAlgorithm.cpp.

shared_ptr< TestResult > SctAnalysis::MarkSpaceRatioAlgorithm::createTestResult (   )  const [virtual]

Called if the TestResult needs to be created. Exceptions: nothing.  Implements SctAnalysis::AnalysisAlgorithm. Definition at line 32 of file MarkSpaceRatioAlgorithm.cpp.

double SctAnalysis::MarkSpaceRatioAlgorithm::getAverageOccupancy (  const SctData::RawScanResult &  raw, unsigned short  ilink )  [protected, virtual]

ignore first few bins as ROD may not be correctly set up for these. Definition at line 136 of file MarkSpaceRatioAlgorithm.cpp. References SctData::ScanResult::getPoints(), and SctData::RawScanResult::getScanData(). Referenced by analyze(). Here is the call graph for this function:

void SctAnalysis::MarkSpaceRatioAlgorithm::loadData (   )  [virtual]

Called to indicate the algorithm should try and load as much data as it can - perhaps by calling loadAllFits or loadAllRaws(). This is guarenteed to be called shortly before analyze(). Implements SctAnalysis::AnalysisAlgorithm. Definition at line 23 of file MarkSpaceRatioAlgorithm.cpp. References SctAnalysis::AnalysisAlgorithm::loadAllRaws(). Here is the call graph for this function:

---

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

• MarkSpaceRatioAlgorithm.h
• MarkSpaceRatioAlgorithm.cpp

---