|  | 
|  | BinnedSpectrum () | 
|  | default constructor  More... 
 | 
|  | 
|  | BinnedSpectrum (Real size, UInt spread, PeakSpectrum ps) | 
|  | detailed constructor  More... 
 | 
|  | 
|  | BinnedSpectrum (const BinnedSpectrum &source) | 
|  | copy constructor  More... 
 | 
|  | 
| virtual | ~BinnedSpectrum () | 
|  | destructor  More... 
 | 
|  | 
| BinnedSpectrum & | operator= (const BinnedSpectrum &source) | 
|  | assignment operator  More... 
 | 
|  | 
| BinnedSpectrum & | operator= (const PeakSpectrum &source) | 
|  | assignment operator for PeakSpectra  More... 
 | 
|  | 
| bool | operator== (const BinnedSpectrum &rhs) const | 
|  | equality operator  More... 
 | 
|  | 
| bool | operator!= (const BinnedSpectrum &rhs) const | 
|  | inequality operator  More... 
 | 
|  | 
| bool | operator== (const PeakSpectrum &rhs) const | 
|  | equality operator for PeakSpectra  More... 
 | 
|  | 
| bool | operator!= (const PeakSpectrum &rhs) const | 
|  | inequality operator for PeakSpectra  More... 
 | 
|  | 
| double | getBinSize () const | 
|  | get the BinSize  More... 
 | 
|  | 
| UInt | getBinSpread () const | 
|  | get the BinSpread  More... 
 | 
|  | 
| UInt | getBinNumber () const | 
|  | get the BinNumber, number of Bins  More... 
 | 
|  | 
| UInt | getFilledBinNumber () const | 
|  | get the FilledBinNumber, number of filled Bins  More... 
 | 
|  | 
| const SparseVector< Real > & | getBins () const | 
|  | 
| SparseVector< Real > & | getBins () | 
|  | 
| const_bin_iterator | begin () const | 
|  | returns the const begin iterator of the container  More... 
 | 
|  | 
| const_bin_iterator | end () const | 
|  | returns the const end iterator of the container  More... 
 | 
|  | 
| bin_iterator | begin () | 
|  | returns the begin iterator of the container  More... 
 | 
|  | 
| bin_iterator | end () | 
|  | returns the end iterator of the container  More... 
 | 
|  | 
| void | setBinSize (double s) | 
|  | 
| void | setBinSpread (UInt s) | 
|  | 
| void | setBinning () | 
|  | 
| bool | checkCompliance (const BinnedSpectrum &bs) const | 
|  | function to check comparability of two BinnedSpectrum objects, i.e. if they have equal bin size and spread  More... 
 | 
|  | 
|  | MSSpectrum () | 
|  | Constructor.  More... 
 | 
|  | 
|  | MSSpectrum (const MSSpectrum &source) | 
|  | Copy constructor.  More... 
 | 
|  | 
|  | ~MSSpectrum () | 
|  | Destructor.  More... 
 | 
|  | 
| MSSpectrum & | operator= (const MSSpectrum &source) | 
|  | Assignment operator.  More... 
 | 
|  | 
| bool | operator== (const MSSpectrum &rhs) const | 
|  | Equality operator.  More... 
 | 
|  | 
| bool | operator!= (const MSSpectrum &rhs) const | 
|  | Equality operator.  More... 
 | 
|  | 
| virtual void | updateRanges () | 
|  | Updates minimum and maximum position/intensity.  More... 
 | 
|  | 
| void | clear (bool clear_meta_data) | 
|  | Clears all data and meta data.  More... 
 | 
|  | 
| DoubleReal | getRT () const | 
|  | 
| void | setRT (DoubleReal rt) | 
|  | Sets the absolute retention time (is seconds)  More... 
 | 
|  | 
| UInt | getMSLevel () const | 
|  | Returns the MS level.  More... 
 | 
|  | 
| void | setMSLevel (UInt ms_level) | 
|  | Sets the MS level.  More... 
 | 
|  | 
| const String & | getName () const | 
|  | Returns the name.  More... 
 | 
|  | 
| void | setName (const String &name) | 
|  | Sets the name.  More... 
 | 
|  | 
| const FloatDataArrays & | getFloatDataArrays () const | 
|  | Returns a const reference to the float meta data arrays.  More... 
 | 
|  | 
| FloatDataArrays & | getFloatDataArrays () | 
|  | Returns a mutable reference to the float meta data arrays.  More... 
 | 
|  | 
| const StringDataArrays & | getStringDataArrays () const | 
|  | Returns a const reference to the string meta data arrays.  More... 
 | 
|  | 
| StringDataArrays & | getStringDataArrays () | 
|  | Returns a mutable reference to the string meta data arrays.  More... 
 | 
|  | 
| const IntegerDataArrays & | getIntegerDataArrays () const | 
|  | Returns a const reference to the integer meta data arrays.  More... 
 | 
|  | 
| IntegerDataArrays & | getIntegerDataArrays () | 
|  | Returns a mutable reference to the integer meta data arrays.  More... 
 | 
|  | 
| void | sortByIntensity (bool reverse=false) | 
|  | Lexicographically sorts the peaks by their intensity.  More... 
 | 
|  | 
| void | sortByPosition () | 
|  | Lexicographically sorts the peaks by their position.  More... 
 | 
|  | 
| bool | isSorted () const | 
|  | Checks if all peaks are sorted with respect to ascending m/z.  More... 
 | 
|  | 
| Size | findNearest (CoordinateType mz) const | 
|  | Binary search for the peak nearest to a specific m/z.  More... 
 | 
|  | 
| Iterator | MZBegin (CoordinateType mz) | 
|  | Binary search for peak range begin.  More... 
 | 
|  | 
| Iterator | MZBegin (Iterator begin, CoordinateType mz, Iterator end) | 
|  | Binary search for peak range begin.  More... 
 | 
|  | 
| ConstIterator | MZBegin (CoordinateType mz) const | 
|  | Binary search for peak range begin.  More... 
 | 
|  | 
| ConstIterator | MZBegin (ConstIterator begin, CoordinateType mz, ConstIterator end) const | 
|  | Binary search for peak range begin.  More... 
 | 
|  | 
| Iterator | MZEnd (CoordinateType mz) | 
|  | Binary search for peak range end (returns the past-the-end iterator)  More... 
 | 
|  | 
| Iterator | MZEnd (Iterator begin, CoordinateType mz, Iterator end) | 
|  | Binary search for peak range end (returns the past-the-end iterator)  More... 
 | 
|  | 
| ConstIterator | MZEnd (CoordinateType mz) const | 
|  | Binary search for peak range end (returns the past-the-end iterator)  More... 
 | 
|  | 
| ConstIterator | MZEnd (ConstIterator begin, CoordinateType mz, ConstIterator end) const | 
|  | Binary search for peak range end (returns the past-the-end iterator)  More... 
 | 
|  | 
|  | RangeManager () | 
|  | Default constructor.  More... 
 | 
|  | 
|  | RangeManager (const RangeManager &rhs) | 
|  | Copy constructor.  More... 
 | 
|  | 
| virtual | ~RangeManager () | 
|  | Destructor.  More... 
 | 
|  | 
| RangeManager & | operator= (const RangeManager &rhs) | 
|  | Assignment operator.  More... 
 | 
|  | 
| bool | operator== (const RangeManager &rhs) const | 
|  | Equality operator.  More... 
 | 
|  | 
| bool | operator!= (const RangeManager &rhs) const | 
|  | Equality operator.  More... 
 | 
|  | 
| const PositionType & | getMin () const | 
|  | Returns the minimum position.  More... 
 | 
|  | 
| const PositionType & | getMax () const | 
|  | Returns the maximum position.  More... 
 | 
|  | 
| DoubleReal | getMinInt () const | 
|  | Returns the minimum intensity.  More... 
 | 
|  | 
| DoubleReal | getMaxInt () const | 
|  | Returns the maximum intensity.  More... 
 | 
|  | 
| void | clearRanges () | 
|  | Resets the ranges.  More... 
 | 
|  | 
|  | SpectrumSettings () | 
|  | Constructor.  More... 
 | 
|  | 
|  | SpectrumSettings (const SpectrumSettings &source) | 
|  | Copy constructor.  More... 
 | 
|  | 
|  | ~SpectrumSettings () | 
|  | Destructor.  More... 
 | 
|  | 
| SpectrumSettings & | operator= (const SpectrumSettings &source) | 
|  | 
| bool | operator== (const SpectrumSettings &rhs) const | 
|  | Equality operator.  More... 
 | 
|  | 
| bool | operator!= (const SpectrumSettings &rhs) const | 
|  | Equality operator.  More... 
 | 
|  | 
| void | unify (const SpectrumSettings &rhs) | 
|  | merge another spectrum setting into this one (data is usually appended, except for spectrum type which needs to be unambiguous to be kept)  More... 
 | 
|  | 
| SpectrumType | getType () const | 
|  | returns the spectrum type  More... 
 | 
|  | 
| void | setType (SpectrumType type) | 
|  | sets the spectrum type  More... 
 | 
|  | 
| const String & | getNativeID () const | 
|  | returns the native identifier for the spectrum, used by the acquisition software.  More... 
 | 
|  | 
| void | setNativeID (const String &native_id) | 
|  | sets the native identifier for the spectrum, used by the acquisition software.  More... 
 | 
|  | 
| const String & | getComment () const | 
|  | returns the free-text comment  More... 
 | 
|  | 
| void | setComment (const String &comment) | 
|  | sets the free-text comment  More... 
 | 
|  | 
| const InstrumentSettings & | getInstrumentSettings () const | 
|  | returns a const reference to the instrument settings of the current spectrum  More... 
 | 
|  | 
| InstrumentSettings & | getInstrumentSettings () | 
|  | returns a mutable reference to the instrument settings of the current spectrum  More... 
 | 
|  | 
| void | setInstrumentSettings (const InstrumentSettings &instrument_settings) | 
|  | sets the instrument settings of the current spectrum  More... 
 | 
|  | 
| const AcquisitionInfo & | getAcquisitionInfo () const | 
|  | returns a const reference to the acquisition info  More... 
 | 
|  | 
| AcquisitionInfo & | getAcquisitionInfo () | 
|  | returns a mutable reference to the acquisition info  More... 
 | 
|  | 
| void | setAcquisitionInfo (const AcquisitionInfo &acquisition_info) | 
|  | sets the acquisition info  More... 
 | 
|  | 
| const SourceFile & | getSourceFile () const | 
|  | returns a const reference to the source file  More... 
 | 
|  | 
| SourceFile & | getSourceFile () | 
|  | returns a mutable reference to the source file  More... 
 | 
|  | 
| void | setSourceFile (const SourceFile &source_file) | 
|  | sets the source file  More... 
 | 
|  | 
| const std::vector< Precursor > & | getPrecursors () const | 
|  | returns a const reference to the precursors  More... 
 | 
|  | 
| std::vector< Precursor > & | getPrecursors () | 
|  | returns a mutable reference to the precursors  More... 
 | 
|  | 
| void | setPrecursors (const std::vector< Precursor > &precursors) | 
|  | sets the precursors  More... 
 | 
|  | 
| const std::vector< Product > & | getProducts () const | 
|  | returns a const reference to the products  More... 
 | 
|  | 
| std::vector< Product > & | getProducts () | 
|  | returns a mutable reference to the products  More... 
 | 
|  | 
| void | setProducts (const std::vector< Product > &products) | 
|  | sets the products  More... 
 | 
|  | 
| const std::vector < PeptideIdentification > &
 | getPeptideIdentifications () const | 
|  | returns a const reference to the PeptideIdentification vector  More... 
 | 
|  | 
| std::vector < PeptideIdentification > &
 | getPeptideIdentifications () | 
|  | returns a mutable reference to the PeptideIdentification vector  More... 
 | 
|  | 
| void | setPeptideIdentifications (const std::vector< PeptideIdentification > &identifications) | 
|  | sets the PeptideIdentification vector  More... 
 | 
|  | 
| const std::vector < DataProcessing > &
 | getDataProcessing () const | 
|  | returns a const reference to the description of the applied processing  More... 
 | 
|  | 
| std::vector< DataProcessing > & | getDataProcessing () | 
|  | returns a mutable reference to the description of the applied processing  More... 
 | 
|  | 
| void | setDataProcessing (const std::vector< DataProcessing > &data_processing) | 
|  | sets the description of the applied processing  More... 
 | 
|  | 
|  | MetaInfoInterface () | 
|  | constructor  More... 
 | 
|  | 
|  | MetaInfoInterface (const MetaInfoInterface &rhs) | 
|  | copy constructor  More... 
 | 
|  | 
|  | ~MetaInfoInterface () | 
|  | destructor  More... 
 | 
|  | 
| MetaInfoInterface & | operator= (const MetaInfoInterface &rhs) | 
|  | assignment operator  More... 
 | 
|  | 
| bool | operator== (const MetaInfoInterface &rhs) const | 
|  | Equality operator.  More... 
 | 
|  | 
| bool | operator!= (const MetaInfoInterface &rhs) const | 
|  | Equality operator.  More... 
 | 
|  | 
| const DataValue & | getMetaValue (const String &name) const | 
|  | returns the value corresponding to a string  More... 
 | 
|  | 
| const DataValue & | getMetaValue (UInt index) const | 
|  | returns the value corresponding to an index  More... 
 | 
|  | 
| bool | metaValueExists (const String &name) const | 
|  | returns if this MetaInfo is set  More... 
 | 
|  | 
| bool | metaValueExists (UInt index) const | 
|  | returns if this MetaInfo is set  More... 
 | 
|  | 
| void | setMetaValue (const String &name, const DataValue &value) | 
|  | sets the DataValue corresponding to a name  More... 
 | 
|  | 
| void | setMetaValue (UInt index, const DataValue &value) | 
|  | sets the DataValue corresponding to an index  More... 
 | 
|  | 
| void | removeMetaValue (const String &name) | 
|  | Removes the DataValue corresponding to nameif it exists.  More...
 | 
|  | 
| void | removeMetaValue (UInt index) | 
|  | Removes the DataValue corresponding to indexif it exists.  More...
 | 
|  | 
| void | getKeys (std::vector< String > &keys) const | 
|  | fills the given vector with a list of all keys for which a value is set  More... 
 | 
|  | 
| void | getKeys (std::vector< UInt > &keys) const | 
|  | fills the given vector with a list of all keys for which a value is set  More... 
 | 
|  | 
| bool | isMetaEmpty () const | 
|  | returns if the MetaInfo is empty  More... 
 | 
|  | 
| void | clearMetaInfo () | 
|  | removes all meta values  More... 
 | 
|  | 
|  | PersistentObject () | 
|  | Default constructor.  More... 
 | 
|  | 
| virtual | ~PersistentObject () | 
|  | Destructor.  More... 
 | 
|  | 
| PersistentObject & | operator= (const PersistentObject &rhs) | 
|  | Assignment operator.  More... 
 | 
|  | 
| const UID & | getPersistenceId () const | 
|  | Returns the persistence id.  More... 
 | 
|  | 
| void | setPersistenceId (const UID &persistence_id) | 
|  | Sets the persistence id.  More... 
 | 
|  | 
| void | clearId (bool deep=true) | 
|  | Clears the persistence id.  More... 
 | 
|  | 
This is a binned representation of a PeakSpectrum. 
- Parameters
- 
  
    | sz | the size of the bins and |  | sp | number of neighboring bins to both sides affected by a peak contribution |  | ps | the peakspectrum, that shall be represented |  
 
sz denotes the size of a bin in Th, thereby deciding the number of bins(all of size sz) the spectrum is discretized to. Each bin will represent a certain Th range and the peaks will be put in the respective bins and sum up inside. sp denotes the number of neighboring bins to the left and the number of neighboring bins to the right a peak is also added to. E.g. a BinnedSpectrum with binsize of 0.5 Th will have a peak at 100 Th in bin no. 200, a peak at 100.1 Th will be in bin no. 201. If the binspread is 1, the peak at 100 Th will be added to bin no. 199, 200 and 201. If the binspread is 2, the peak at 100 Th will also be added to bin no. 198 and 202, and so on.