/usr/include/OpenMS/COMPARISON/SPECTRA/BinnedSpectralContrastAngle.h is in libopenms-dev 1.11.1-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 | // --------------------------------------------------------------------------
// OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2013.
//
// 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_BINNEDSPECTRALCONTRASTANGLE_H
#define OPENMS_COMPARISON_SPECTRA_BINNEDSPECTRALCONTRASTANGLE_H
#include <OpenMS/COMPARISON/SPECTRA/BinnedSpectrumCompareFunctor.h>
#include <cmath>
#include <cfloat>
namespace OpenMS
{
/**
@brief Compare functor scoring the spectral contrast angle for similarity measurement
The details of the score can be found in:
K. Wan, I. Vidavsky, and M. Gross. Comparing similar spectra: from
similarity index to spectral contrast angle. Journal of the American Society
for Mass Spectrometry, 13(1):85-88, January 2002.
@htmlinclude OpenMS_BinnedSpectralContrastAngle.parameters
@see BinnedSpectrumCompareFunctor @see BinnedSpectrum
@ingroup SpectraComparison
*/
class OPENMS_DLLAPI BinnedSpectralContrastAngle :
public BinnedSpectrumCompareFunctor
{
public:
/// default constructor
BinnedSpectralContrastAngle();
/// copy constructor
BinnedSpectralContrastAngle(const BinnedSpectralContrastAngle & source);
/// destructor
virtual ~BinnedSpectralContrastAngle();
/// assignment operator
BinnedSpectralContrastAngle & operator=(const BinnedSpectralContrastAngle & source);
/** function call operator, calculates the similarity of the given arguments
@param spec1 First spectrum given in a binned representation
@param spec2 Second spectrum ginve in a binned representation
@throw IncompatibleBinning is thrown if the binnings of the spectra are not the same
*/
double operator()(const BinnedSpectrum & spec1, const BinnedSpectrum & spec2) const;
/// function call operator, calculates self similarity
double operator()(const BinnedSpectrum & spec) const;
///
static BinnedSpectrumCompareFunctor * create() { return new BinnedSpectralContrastAngle(); }
/// get the identifier for this DefaultParamHandler
static const String getProductName()
{
return "BinnedSpectralContrastAngle";
}
};
}
#endif //OPENMS_COMPARISON_SPECTRA_BINNEDSPECTRALCONTRASTANGLE_H
|