key.h

Go to the documentation of this file.

/*****************************************************************************
 * Copyright 2015 Haye Hinrichsen, Christoph Wick
 *
 * This file is part of Entropy Piano Tuner.
 *
 * Entropy Piano Tuner is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * Entropy Piano Tuner is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * Entropy Piano Tuner. If not, see http://www.gnu.org/licenses/.
 *****************************************************************************/

//=============================================================================
//                   Class describing a single piano key
//=============================================================================

#ifndef KEY_H
#define KEY_H

#include <vector>
#include <map>


class Key
{
public:
    // Charactereistics of the logarithmically binned spectrum

    static const int NumberOfBins;                  
    static const int BinsPerOctave;                 
    static const double fmin;                       

    using SpectrumType = std::vector<double>;       
    using PeakListType = std::map<double,double>;   

    // Conversion function in the context of the logarithmically binned spectrum

    static int FrequencyToIndex(double f);          
    static double FrequencyToRealIndex (double f);  
    static double IndexToFrequency (double m);      

public:

    Key()  { clear(); }                             
    ~Key() {}                                       
    void clear();                                   

    void setSpectrum (const SpectrumType &s);       
    const SpectrumType &getSpectrum() const;        
    SpectrumType &getSpectrum();                    

    void setPeaks (const PeakListType &s);          
    const PeakListType &getPeaks() const;           
    PeakListType &getPeaks();                       

    void    setRecordedFrequency (const double f);  
    double  getRecordedFrequency () const;          
    double &getRecordedFrequency ();                

    void    setMeasuredInharmonicity(double f);     
    double  getMeasuredInharmonicity () const;      
    double &getMeasuredInharmonicity ();            

    void    setRecognitionQuality(double f);        
    double  getRecognitionQuality () const;         
    double &getRecognitionQuality ();               

    void    setComputedFrequency (double f);        
    double  getComputedFrequency () const;          
    double &getComputedFrequency ();                

    void    setTunedFrequency (double f);           
    double  getTunedFrequency () const;             
    double &getTunedFrequency ();                   

    void    setOverpull (double cents);             
    double  getOverpull () const;                   
    double &getOverpull ();                         

    void    setRecorded(bool r) {mRecorded = r;}    
    bool    isRecorded() const {return mRecorded;}  
    bool   &isRecorded() {return mRecorded;}        

private:
    SpectrumType mSpectrum;             
    PeakListType mPeaks;                
    double mRecordedFrequency;          
    double mMeasuredInharmonicity;      
    double mRecognitionQuality;         
    double mComputedFrequency;          
    double mTunedFrequency;             
    double mOverpull;                   
    bool   mRecorded;                   
};

#endif // KEY_H