DenseThreeDimensionalModel.h

Go to the documentation of this file.

/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */

/*
    Sonic Visualiser
    An audio file viewer and annotation editor.
    Centre for Digital Music, Queen Mary, University of London.
    This file copyright 2006 Chris Cannam and QMUL.
    
    This program 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 2 of the
    License, or (at your option) any later version.  See the file
    COPYING included with this distribution for more information.
*/

#ifndef _DENSE_THREE_DIMENSIONAL_MODEL_H_
#define _DENSE_THREE_DIMENSIONAL_MODEL_H_

#include "Model.h"
#include "base/ZoomConstraint.h"

#include <QMutex>
#include <vector>

class DenseThreeDimensionalModel : public Model
{
    Q_OBJECT

public:
    virtual size_t getResolution() const = 0;

    virtual size_t getWidth() const = 0;

    virtual size_t getHeight() const = 0; 

    virtual float getMinimumLevel() const = 0;

    virtual float getMaximumLevel() const = 0;

    virtual bool isColumnAvailable(size_t column) const = 0;

    typedef std::vector<float> Column;

    virtual void getColumn(size_t column, Column &result) const = 0;

    virtual float getValueAt(size_t column, size_t n) const = 0;

    virtual QString getBinName(size_t n) const = 0;

    bool isLocalPeak(size_t x, size_t y) {
        float value = getValueAt(x, y);
        if (y > 0 && value < getValueAt(x, y - 1)) return false;
        if (y < getHeight() - 1 && value < getValueAt(x, y + 1)) return false;
        return true;
    }

    bool isOverThreshold(size_t x, size_t y, float threshold) {
        return getValueAt(x, y) > threshold;
    }

    QString getTypeName() const { return tr("Dense 3-D"); }

    virtual int getCompletion() const = 0;

protected:
    DenseThreeDimensionalModel() { }
};

#endif

---