BinnedSpectrum.h

Go to the documentation of this file.

// --------------------------------------------------------------------------
//                   OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2012.
//
// This software is released under a three-clause BSD license:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of any author or any participating institution
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
// For a full list of authors, refer to the file AUTHORS.
// --------------------------------------------------------------------------
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// --------------------------------------------------------------------------
// $Maintainer: Mathias Walzer $
// $Authors: $
// --------------------------------------------------------------------------
//
#ifndef OPENMS_COMPARISON_SPECTRA_BINNEDSPECTRUM_H
#define OPENMS_COMPARISON_SPECTRA_BINNEDSPECTRUM_H

#include <OpenMS/KERNEL/StandardTypes.h>
#include <OpenMS/KERNEL/MSSpectrum.h>
#include <OpenMS/DATASTRUCTURES/SparseVector.h>
#include <OpenMS/CONCEPT/Exception.h>


#include <cmath>

namespace OpenMS
{

  class OPENMS_DLLAPI BinnedSpectrum :
    public MSSpectrum<>
  {

private:

    UInt bin_spread_;
    Real bin_size_;
    SparseVector<Real> bins_;

public:

    class OPENMS_DLLAPI NoSpectrumIntegrated :
      public Exception::BaseException
    {
public:
      NoSpectrumIntegrated(const char * file, int line, const char * function, const char * message = "BinnedSpectrum hasn't got a PeakSpectrum to base on yet") throw();

      virtual ~NoSpectrumIntegrated() throw();
    };

    typedef SparseVector<Real>::const_iterator const_bin_iterator;
    typedef SparseVector<Real>::iterator bin_iterator;

    BinnedSpectrum();

    BinnedSpectrum(Real size, UInt spread, PeakSpectrum ps);

    BinnedSpectrum(const BinnedSpectrum & source);

    virtual ~BinnedSpectrum();

    BinnedSpectrum & operator=(const BinnedSpectrum & source)
    {
      if (&source != this)
      {
        setBinSize(source.getBinSize());
        setBinSpread(source.getBinSpread());
        bins_ = source.getBins();
        MSSpectrum<>::operator=(source);
      }
      return *this;
    }

    BinnedSpectrum & operator=(const PeakSpectrum & source)
    {
      if (!MSSpectrum<>::operator==(source))
      {
        MSSpectrum<>::operator=(source);
        setBinning();
      }
      return *this;
    }

    bool operator==(const BinnedSpectrum & rhs) const
    {
      return MSSpectrum<>::operator==(rhs) &&
             rhs.getBinSize() == this->bin_size_ &&
             rhs.getBinSpread() == this->bin_spread_;
    }

    bool operator!=(const BinnedSpectrum & rhs) const
    {
      return !(operator==(rhs));
    }

    bool operator==(const PeakSpectrum & rhs) const
    {
      return MSSpectrum<>::operator==(rhs);
    }

    bool operator!=(const PeakSpectrum & rhs) const
    {
      return !(operator==(rhs));
    }

    inline double getBinSize() const
    {
      return this->bin_size_;
    }

    inline UInt getBinSpread() const
    {
      return this->bin_spread_;
    }

    inline UInt getBinNumber() const
    {
      return (UInt) this->bins_.size();
    }

    inline UInt getFilledBinNumber() const
    {
      return (UInt) this->bins_.nonzero_size();
    }

    inline const SparseVector<Real> & getBins() const
    {
      if (bins_.empty())
      {
        throw BinnedSpectrum::NoSpectrumIntegrated(__FILE__, __LINE__, __PRETTY_FUNCTION__);
      }
      return bins_;
    }

    inline SparseVector<Real> & getBins()
    {
      if (bins_.empty())
      {
        try
        {
          this->setBinning();
        }
        catch (...)
        {
          throw BinnedSpectrum::NoSpectrumIntegrated(__FILE__, __LINE__, __PRETTY_FUNCTION__);
        }
      }
      return bins_;
    }

    inline const_bin_iterator begin() const
    {
      return bins_.begin();
    }

    inline const_bin_iterator end() const
    {
      return bins_.end();
    }

    inline bin_iterator begin()
    {
      return bins_.begin();
    }

    inline bin_iterator end()
    {
      return bins_.end();
    }

    inline void setBinSize(double s)
    {
      if (this->bin_size_ != s)
      {
        this->bin_size_ = s;
        try
        {
          this->setBinning();
        }
        catch (...)
        {
          throw BinnedSpectrum::NoSpectrumIntegrated(__FILE__, __LINE__, __PRETTY_FUNCTION__);
        }
      }
    }

    inline void setBinSpread(UInt s)
    {
      if (this->bin_spread_ != s)
      {
        this->bin_spread_ = s;
        try
        {
          this->setBinning();
        }
        catch (...)
        {
          throw BinnedSpectrum::NoSpectrumIntegrated(__FILE__, __LINE__, __PRETTY_FUNCTION__);
        }
      }
    }

    void setBinning();

    bool checkCompliance(const BinnedSpectrum & bs) const;


protected:
    // docu in base class
    virtual void clearChildIds_()
    {
      //TODO Persistence
    }

  };

}
#endif //OPENMS_COMPARISON_SPECTRA_BINNEDSPECTRUM_H