pwiz::analysis::MSDataAnalyzer Class Reference

Interface for MSData analyzers. More...

#include <MSDataAnalyzer.hpp>

Inheritance diagram for pwiz::analysis::MSDataAnalyzer:

List of all members.

Classes
struct	DataInfo
	information about the data to be analyzed More...

Public Member Functions
virtual	~MSDataAnalyzer ()
Event Handling
virtual void	open (const DataInfo &dataInfo)
	start analysis of the data
virtual UpdateRequest	updateRequested (const DataInfo &dataInfo, const SpectrumIdentity &spectrumIdentity) const
	ask analyzer if it wants an update
virtual void	update (const DataInfo &dataInfo, const Spectrum &spectrum)
	analyze a single spectrum
virtual void	close (const DataInfo &dataInfo)
	end analysis of the data

---

Detailed Description

Interface for MSData analyzers.

MSDataAnalyzer encapsulates a passive update strategy. The MSDataAnalyzer expects to handle events generated from an outside driver. This allows the driver to control access to the MSData object – in particular, the driver can ensure that scans are read from file only once.

Event sequence:

• open
• loop:
  • updateReqested
  • update
• close

UpdateRequest_Ok handles the following use case: a spectrum cache wants to cache only those spectra that are requested by other MSDataAnalyzers; it won't request any updates, but it needs to see any update requested by someone else.

Definition at line 59 of file MSDataAnalyzer.hpp.

---

Constructor & Destructor Documentation

virtual pwiz::analysis::MSDataAnalyzer::~MSDataAnalyzer ( )

inlinevirtual

Definition at line 103 of file MSDataAnalyzer.hpp.

{}

---

Member Function Documentation

virtual void pwiz::analysis::MSDataAnalyzer::open ( const DataInfo &  dataInfo )

inlinevirtual

start analysis of the data

Reimplemented in pwiz::analysis::MSDataAnalyzerContainer, pwiz::analysis::Pseudo2DGel, pwiz::analysis::RegionAnalyzer, pwiz::analysis::MSDataCache, pwiz::analysis::RegionSIC, pwiz::analysis::RegionTIC, pwiz::analysis::RegionSlice, SimpleAnalyzer, and pwiz::analysis::MetadataReporter.

Definition at line 86 of file MSDataAnalyzer.hpp.

{}

virtual UpdateRequest pwiz::analysis::MSDataAnalyzer::updateRequested ( const DataInfo &  dataInfo, const SpectrumIdentity &  spectrumIdentity  ) const

inlinevirtual

ask analyzer if it wants an update

Reimplemented in pwiz::analysis::MSDataAnalyzerContainer, pwiz::analysis::Pseudo2DGel, pwiz::analysis::MSDataCache, pwiz::analysis::RegionAnalyzer, pwiz::analysis::RegionSIC, pwiz::analysis::RegionTIC, pwiz::analysis::RunSummary, pwiz::analysis::SpectrumBinaryData, pwiz::analysis::RegionSlice, and pwiz::analysis::SpectrumTable.

Definition at line 89 of file MSDataAnalyzer.hpp.

References UpdateRequest_None.

    {   
        return UpdateRequest_None;
    }

virtual void pwiz::analysis::MSDataAnalyzer::update ( const DataInfo &  dataInfo, const Spectrum &  spectrum  )

inlinevirtual

analyze a single spectrum

Reimplemented in pwiz::analysis::MSDataAnalyzerContainer, pwiz::analysis::Pseudo2DGel, pwiz::analysis::MSDataCache, pwiz::analysis::RegionAnalyzer, pwiz::analysis::RegionSIC, pwiz::analysis::RegionTIC, pwiz::analysis::SpectrumBinaryData, and pwiz::analysis::RegionSlice.

Definition at line 96 of file MSDataAnalyzer.hpp.

                                                  {}

virtual void pwiz::analysis::MSDataAnalyzer::close ( const DataInfo &  dataInfo )

inlinevirtual

end analysis of the data

Reimplemented in pwiz::analysis::MSDataAnalyzerContainer, pwiz::analysis::Pseudo2DGel, pwiz::analysis::RegionAnalyzer, SimpleAnalyzer, pwiz::analysis::RegionSIC, pwiz::analysis::RegionTIC, pwiz::analysis::RegionSlice, pwiz::analysis::RunSummary, and pwiz::analysis::SpectrumTable.

Definition at line 100 of file MSDataAnalyzer.hpp.

{} 

---

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

• /Users/parag/_Research/pwiz/svn/trunk/pwiz/pwiz/analysis/passive/MSDataAnalyzer.hpp