SctAnalysis::RxThresholdAlgorithm Class Reference

Algorithm for finding best Rx Threshold. More...

#include <RxThresholdAlgorithm.h>

Inheritance diagram for SctAnalysis::RxThresholdAlgorithm:

[legend]Collaboration diagram for SctAnalysis::RxThresholdAlgorithm:

[legend]

Public Member Functions
virtual void	analyze ()
	finds the optimum - a fractions of the way from the mid-rise to the mid-fall of the function.
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 bool	canAnalyze () const
	Should check to see if the analysis can be performed.
virtual shared_ptr< SctData::TestResult >	createTestResult () const
	Called if the TestResult needs to be created.
virtual boost::shared_ptr< AnalysisAlgorithm >	clone (const TestData &testData, const string &moduleName) const throw ()
	Must be overridden by sub-classes.
	RxThresholdAlgorithm (const TestData &testData, const string &moduleName, const AnalysisAlgorithm &alg) throw ()
	constructor
virtual	~RxThresholdAlgorithm () throw ()
	destructor
Static Private Attributes
bool	inMap

---

Detailed Description

Algorithm for finding best Rx Threshold.

Find the region for which the average occupancy is between 0.25 and 0.75. Take the mid-point of this region.

Definition at line 17 of file RxThresholdAlgorithm.h.

---

Constructor & Destructor Documentation

SctAnalysis::RxThresholdAlgorithm::RxThresholdAlgorithm (  const TestData &  testData, const string &  moduleName, const AnalysisAlgorithm &  alg )  throw () [inline]

constructor Definition at line 31 of file RxThresholdAlgorithm.h.

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

destructor Definition at line 35 of file RxThresholdAlgorithm.h.

---

Member Function Documentation

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

finds the optimum - a fractions of the way from the mid-rise to the mid-fall of the function. Implements SctAnalysis::AnalysisAlgorithm. Definition at line 37 of file RxThresholdAlgorithm.cpp. References SctData::ScanPoints::ascending(), SctData::ScanResult::getHeader(), SctData::ScanPoints::getNEvents(), SctData::ScanResult::getPoints(), SctAnalysis::AnalysisAlgorithm::getRaw(), SctData::RawScanResult::getScanData(), SctAnalysis::AnalysisAlgorithm::getTestResult(), SctData::ResultHeader::getVariable(), SctData::SingleVariableTestResult::setNOptima(), SctData::SingleVariableTestResult::setOptimum(), SctData::TestResult::setPassed(), and SctData::TestResult::setScanVariable().

Here is the call graph for this function:

bool SctAnalysis::RxThresholdAlgorithm::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 33 of file RxThresholdAlgorithm.cpp. References SctAnalysis::AnalysisAlgorithm::hasAllRaws().

Here is the call graph for this function:

shared_ptr< AnalysisAlgorithm > SctAnalysis::RxThresholdAlgorithm::clone (  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 21 of file RxThresholdAlgorithm.cpp.

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

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

void SctAnalysis::RxThresholdAlgorithm::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 29 of file RxThresholdAlgorithm.cpp. References SctAnalysis::AnalysisAlgorithm::loadAllRaws().

Here is the call graph for this function:

---

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

• RxThresholdAlgorithm.h
• RxThresholdAlgorithm.cpp

---