GoldenCheetah/src/AllPlot.cpp

/* 
 * Copyright (c) 2006 Sean C. Rhea (srhea@srhea.net)
 *
 * 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.
 * 
 * This program 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 this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

#include "AllPlot.h"
#include "RideFile.h"
#include "RideItem.h"
#include "Settings.h"
#include "Zones.h"

#include <assert.h>
#include <qwt_plot_curve.h>
#include <qwt_plot_grid.h>
#include <qwt_plot_marker.h>
#include <qwt_text.h>
#include <qwt_legend.h>
#include <qwt_data.h>


// define a background class to handle shading of power zones
// draws power zone bands IF zones are defined and the option
// to draw bonds has been selected
class AllPlotBackground: public QwtPlotItem
{
    private:
        AllPlot *parent;

    public:
        AllPlotBackground(AllPlot *_parent)
        {
	    setZ(0.0);
	    parent = _parent;
	}

    virtual int rtti() const
    {
        return QwtPlotItem::Rtti_PlotUserItem;
    }

    virtual void draw(QPainter *painter,
		      const QwtScaleMap &, const QwtScaleMap &yMap,
		      const QRect &rect) const
    {
	RideItem *rideItem = parent->rideItem;

	if (! rideItem)
	    return;

	Zones **zones      = rideItem->zones;
	int zone_range     = rideItem->zoneRange();

	if (parent->shadeZones() && zones && *zones && (zone_range >= 0)) {
	    QList <int> zone_lows = (*zones)->getZoneLows(zone_range);
	    int num_zones = zone_lows.size();
	    if (num_zones > 0) {
		for (int z = 0; z < num_zones; z ++) {
		    QRect r = rect;

		    QColor shading_color = zoneColor(z, num_zones);
		    shading_color.setHsv(
					 shading_color.hue(),
					 shading_color.saturation() / 4,
					 shading_color.value()
					 );
		    r.setBottom(yMap.transform(zone_lows[z]));
		    if (z + 1 < num_zones)
			r.setTop(yMap.transform(zone_lows[z + 1]));
		    if (r.top() <= r.bottom())
			painter->fillRect(r, shading_color);
		}
	    }
	}
    }
};

// Zone labels are drawn if power zone bands are enabled, automatically
// at the center of the plot
class AllPlotZoneLabel: public QwtPlotItem
{
    private:
        AllPlot *parent;
        int zone_number;
        double watts;
        QwtText text;

    public:
        AllPlotZoneLabel(AllPlot *_parent, int _zone_number)
        {
	    parent = _parent;
	    zone_number = _zone_number;

	    RideItem *rideItem = parent->rideItem;


	    if (! rideItem)
		return;
	

	    Zones **zones      = rideItem->zones;
	    int zone_range     = rideItem->zoneRange();

	    // create new zone labels if we're shading
	    if (parent->shadeZones() && zones && *zones && (zone_range >= 0)) {
		QList <int> zone_lows = (*zones)->getZoneLows(zone_range);
		QList <QString> zone_names = (*zones)->getZoneNames(zone_range);
		int num_zones = zone_lows.size();
		assert(zone_names.size() == num_zones);
		if (zone_number < num_zones) {
		    watts =
			(
			 (zone_number + 1 < num_zones) ?
			 0.5 * (zone_lows[zone_number] + zone_lows[zone_number + 1]) :
			 (
			  (zone_number > 0) ?
			  (1.5 * zone_lows[zone_number] - 0.5 * zone_lows[zone_number - 1]) :
			  2.0 * zone_lows[zone_number]
			  )
			 );

		    text = QwtText(zone_names[zone_number]);
		    text.setFont(QFont("Helvetica",24, QFont::Bold));
		    QColor text_color = zoneColor(zone_number, num_zones);
		    text_color.setAlpha(64);
		    text.setColor(text_color);
		}
	    }

	    setZ(1.0 + zone_number / 100.0);
	}
    virtual int rtti() const
    {
	return QwtPlotItem::Rtti_PlotUserItem;
    }

    void draw(QPainter *painter,
				const QwtScaleMap &, const QwtScaleMap &yMap,
				const QRect &rect) const
    {
	if (parent->shadeZones()) {
	    int x = (rect.left() + rect.right()) / 2;
	    int y = yMap.transform(watts);

	    // the following code based on source for QwtPlotMarker::draw()
	    QRect tr(QPoint(0, 0), text.textSize(painter->font()));
	    tr.moveCenter(QPoint(x, y));
	    text.draw(painter, tr);
	}
    }
};


static inline double
max(double a, double b) { if (a > b) return a; else return b; }

#define MILES_PER_KM 0.62137119

AllPlot::AllPlot():
    settings(GC_SETTINGS_CO, GC_SETTINGS_APP),
    unit(settings.value(GC_UNIT)),
    d_mrk(NULL), rideItem(NULL),
    hrArray(NULL), wattsArray(NULL), 
    speedArray(NULL), cadArray(NULL), timeArray(NULL),
    distanceArray(NULL), interArray(NULL), smooth(30), bydist(false),
    shade_zones(false)
{
    useMetricUnits = (unit.toString() == "Metric");

    // create a background object for shading
    bg = new AllPlotBackground(this);
    bg->attach(this);

    insertLegend(new QwtLegend(), QwtPlot::BottomLegend);
    setCanvasBackground(Qt::white);

    setXTitle();

    wattsCurve = new QwtPlotCurve("Power");
    // wattsCurve->setRenderHint(QwtPlotItem::RenderAntialiased);
    QPen *wattsPen  = new QPen(Qt::red);
    wattsPen->setWidth(2);
    wattsCurve->setPen(*wattsPen);
    delete wattsPen;

    hrCurve = new QwtPlotCurve("Heart Rate");
    // hrCurve->setRenderHint(QwtPlotItem::RenderAntialiased);
    QPen *hrPen  = new QPen(Qt::blue);
    hrPen->setWidth(2);
    hrCurve->setPen(*hrPen);
    delete hrPen;

    speedCurve = new QwtPlotCurve("Speed");
    // speedCurve->setRenderHint(QwtPlotItem::RenderAntialiased);
    QPen *speedPen  = new QPen(QColor(0, 204, 0));
    speedPen->setWidth(2);
    speedCurve->setPen(*speedPen);
    speedCurve->setYAxis(yRight);
    delete speedPen;

    cadCurve = new QwtPlotCurve("Cadence");
    // cadCurve->setRenderHint(QwtPlotItem::RenderAntialiased);
    QPen *cadPen  = new QPen(QColor(0, 204, 204));
    cadPen->setWidth(2);
    cadCurve->setPen(*cadPen);
    delete cadPen;

    grid = new QwtPlotGrid();
    grid->enableX(false);
    QPen gridPen;
    gridPen.setStyle(Qt::DotLine);
    grid->setPen(gridPen);
    grid->attach(this);

    zoneLabels = QList <AllPlotZoneLabel *>::QList();
}

struct DataPoint {
    double time, hr, watts, speed, cad;
    int inter;
    DataPoint(double t, double h, double w, double s, double c, int i) : 
        time(t), hr(h), watts(w), speed(s), cad(c), inter(i) {}
};

bool AllPlot::shadeZones() const
{
    return (shade_zones && wattsArray);
}

void AllPlot::refreshZoneLabels()
{
    // delete any existing power zone labels
    if (zoneLabels.size()) {
	QListIterator<AllPlotZoneLabel *> i(zoneLabels); 
	while (i.hasNext()) {
	    AllPlotZoneLabel *label = i.next();
	    label->detach();
	    delete label;
	}
    }

    zoneLabels.clear();

    if (rideItem) {
	int zone_range = rideItem->zoneRange();
	Zones **zones  = rideItem->zones;

	// generate labels for existing zones
	if (zones && *zones && (zone_range >= 0)) {
	int num_zones = (*zones)->numZones(zone_range);
	for (int z = 0; z < num_zones; z ++) {
	    AllPlotZoneLabel *label = new AllPlotZoneLabel(this, z);
	    label->attach(this);
	    zoneLabels.append(label);
	}
	}
    }
}


void
AllPlot::recalc()
{
    if (!timeArray)
        return;
    int rideTimeSecs = (int) ceil(timeArray[arrayLength - 1]);
    if (rideTimeSecs > 7*24*60*60) {
        QwtArray<double> data;
	if (wattsArray)
	    wattsCurve->setData(data, data);
	if (hrArray)
	    hrCurve->setData(data, data);
	if (speedArray)
	    speedCurve->setData(data, data);
	if (cadArray)
	    cadCurve->setData(data, data);
        return;
    }
    double totalWatts = 0.0;
    double totalHr = 0.0;
    double totalSpeed = 0.0;
    double totalCad = 0.0;
    double totalDist = 0.0;

    QList<DataPoint*> list;

    double *smoothWatts     = new double[rideTimeSecs + 1];
    double *smoothHr        = new double[rideTimeSecs + 1];
    double *smoothSpeed     = new double[rideTimeSecs + 1];
    double *smoothCad       = new double[rideTimeSecs + 1];
    double *smoothTime      = new double[rideTimeSecs + 1];
    double *smoothDistance  = new double[rideTimeSecs + 1];

    delete [] d_mrk;
    QList<double> interList; //Just store the time that it happened.
                             //Intervals are sequential.

    int lastInterval = 0; //Detect if we hit a new interval

    for (int secs = 0; ((secs < smooth) 
                        && (secs < rideTimeSecs)); ++secs) {
        smoothWatts[secs] = 0.0;
        smoothHr[secs]    = 0.0;
        smoothSpeed[secs] = 0.0;
        smoothCad[secs]   = 0.0;
        smoothTime[secs]  = secs / 60.0;
        smoothDistance[secs]  = 0.0;
    }

    int i = 0;
    for (int secs = smooth; secs <= rideTimeSecs; ++secs) {
        while ((i < arrayLength) && (timeArray[i] <= secs)) {
            DataPoint *dp = 
                new DataPoint(
			      timeArray[i],
			      (hrArray ? hrArray[i] : 0),
			      (wattsArray ? wattsArray[i] : 0),
                              (speedArray ? speedArray[i] : 0),
			      (cadArray ? cadArray[i] : 0),
			      interArray[i]
			      );
	    if (wattsArray)
		totalWatts += wattsArray[i];
	    if (hrArray)
		totalHr    += hrArray[i];
	    if (speedArray)
		totalSpeed += speedArray[i];
	    if (cadArray)
		totalCad   += cadArray[i];
            totalDist   = distanceArray[i];
            list.append(dp);
            //Figure out when and if we have a new interval..
            if(lastInterval != interArray[i]) {
                lastInterval = interArray[i];
                interList.append(secs/60.0);
            }
            ++i;
        }
        while (!list.empty() && (list.front()->time < secs - smooth)) {
            DataPoint *dp = list.front();
            list.removeFirst();
            totalWatts -= dp->watts;
            totalHr    -= dp->hr;
            totalSpeed -= dp->speed;
            totalCad   -= dp->cad;
            delete dp;
        }
        // TODO: this is wrong.  We should do a weighted average over the
        // seconds represented by each point...
        if (list.empty()) {
            smoothWatts[secs] = 0.0;
            smoothHr[secs]    = 0.0;
            smoothSpeed[secs] = 0.0;
            smoothCad[secs]   = 0.0;
        }
        else {
            smoothWatts[secs]    = totalWatts / list.size();
            smoothHr[secs]       = totalHr / list.size();
            smoothSpeed[secs]    = totalSpeed / list.size();
            smoothCad[secs]      = totalCad / list.size();
        }
        smoothDistance[secs] = totalDist;
        smoothTime[secs]  = secs / 60.0;
    }

    double *xaxis = bydist ? smoothDistance : smoothTime;

    // set curves
    if (wattsArray)
	wattsCurve->setData(xaxis, smoothWatts, rideTimeSecs + 1);
    if (hrArray)
	hrCurve->setData(xaxis, smoothHr, rideTimeSecs + 1);
    if (speedArray)
        speedCurve->setData(xaxis, smoothSpeed, rideTimeSecs + 1);
    if (cadArray)
        cadCurve->setData(xaxis, smoothCad, rideTimeSecs + 1);

    setAxisScale(xBottom, 0.0, bydist ? totalDist : smoothTime[rideTimeSecs]);
    setYMax();

    refreshZoneLabels();
    
    QString label[interList.size()];
    QwtText text[interList.size()];
    d_mrk = new QwtPlotMarker[interList.size()];

    for(int x = 0; x < interList.size(); x++) {
        // marker
        d_mrk[x].setValue(0,0);
        d_mrk[x].setLineStyle(QwtPlotMarker::VLine);
        d_mrk[x].setLabelAlignment(Qt::AlignRight | Qt::AlignTop);
        d_mrk[x].setLinePen(QPen(Qt::black, 0, Qt::DashDotLine));
        d_mrk[x].attach(this);
        label[x].setNum(x+1);
        text[x] = QwtText(label[x]);
        text[x].setFont(QFont("Helvetica", 10, QFont::Bold));
        text[x].setColor(Qt::black);
        if (!bydist)
            d_mrk[x].setValue(interList.at(x), 0.0);
        else
            d_mrk[x].setValue(smoothDistance[int(ceil(60*interList.at(x)))], 0.0);
        d_mrk[x].setLabel(text[x]);
    }

    replot();
    
    if(smoothWatts != NULL)
        delete [] smoothWatts;
    if(smoothHr != NULL)
        delete [] smoothHr;
    if(smoothSpeed != NULL)
        delete [] smoothSpeed;
    if(smoothCad != NULL)
        delete [] smoothCad;
    if(smoothTime != NULL)
        delete [] smoothTime;
    if(smoothDistance != NULL)
       delete [] smoothDistance;
}

void
AllPlot::setYMax() 
{
    double ymax = 0;
    QString ylabel = "";
    if (wattsCurve->isVisible()) {
        ymax = max(ymax, wattsCurve->maxYValue());
        ylabel += QString((ylabel == "") ? "" : " / ") + "Watts";
    }
    if (hrCurve->isVisible()) {
        ymax = max(ymax, hrCurve->maxYValue());
        ylabel += QString((ylabel == "") ? "" : " / ") + "BPM";
    }
    if (cadCurve->isVisible()) {
        ymax = max(ymax, cadCurve->maxYValue());
        ylabel += QString((ylabel == "") ? "" : " / ") + "RPM";
    }
    setAxisScale(yLeft, 0.0, ymax * 1.1);
    setAxisTitle(yLeft, ylabel);

    enableAxis(yRight, speedCurve->isVisible());
    setAxisTitle(yRight, (useMetricUnits ? "KPH" : "MPH"));
}

void
AllPlot::setXTitle()
{
    if (bydist)
        setAxisTitle(xBottom, "Distance "+QString(unit.toString() == "Metric"?"(km)":"(miles)"));
    else
        setAxisTitle(xBottom, "Time (minutes)");
}

void
AllPlot::setData(RideItem *_rideItem)
{
    rideItem = _rideItem;

    if(wattsArray != NULL)
        delete [] wattsArray;
    if(hrArray != NULL)
        delete [] hrArray;
    if(speedArray != NULL)
        delete [] speedArray;
    if(cadArray != NULL)
        delete [] cadArray;
    if(timeArray != NULL)
        delete [] timeArray;
    if(interArray != NULL)
        delete [] interArray;
    if(distanceArray != NULL)
        delete [] distanceArray;

    RideFile *ride = rideItem->ride;
    if (ride) {
	setTitle(ride->startTime().toString(GC_DATETIME_FORMAT));

	RideFileDataPresent *dataPresent = ride->areDataPresent();
	int npoints = ride->dataPoints().size();
	wattsArray = dataPresent->watts ? new double[npoints] : NULL;
	hrArray    = dataPresent->hr ? new double[npoints] : NULL;
	speedArray = dataPresent->kph ? new double[npoints] : NULL;
	cadArray   = dataPresent->cad ? new double[npoints] : NULL;
	timeArray  = new double[npoints];
	interArray = new int[npoints];
	distanceArray = new double[npoints];

	// attach appropriate curves
	wattsCurve->detach();
	hrCurve->detach();
	speedCurve->detach();
	cadCurve->detach();
	if (wattsArray) wattsCurve->attach(this);
	if (hrArray) hrCurve->attach(this);
	if (speedArray) speedCurve->attach(this);
	if (cadArray) cadCurve->attach(this);

	arrayLength = 0;
	QListIterator<RideFilePoint*> i(ride->dataPoints()); 
	while (i.hasNext()) {
	    RideFilePoint *point = i.next();
	    timeArray[arrayLength]  = point->secs;
	    if (wattsArray)
		wattsArray[arrayLength] = max(0, point->watts);
	    if (hrArray)
		hrArray[arrayLength]    = max(0, point->hr);
	    if (speedArray)
		speedArray[arrayLength] = max(0, 
					      (useMetricUnits
					       ? point->kph
					       : point->kph * MILES_PER_KM));
	    if (cadArray)
		cadArray[arrayLength]   = max(0, point->cad);
	    interArray[arrayLength] = point->interval;
	    distanceArray[arrayLength] = max(0,
					     (useMetricUnits
					      ? point->km
					      : point->km * MILES_PER_KM));
	    ++arrayLength;
	}

	recalc();
    }
    else {
	setTitle("no data");
	wattsCurve->detach();
	hrCurve->detach();
	speedCurve->detach();
	cadCurve->detach();
    }
}

void
AllPlot::showPower(int id) 
{
    wattsCurve->setVisible(id < 2);
    shade_zones = (id == 0);
    setYMax();
    recalc();
}

void
AllPlot::showHr(int state) 
{
    assert(state != Qt::PartiallyChecked);
    hrCurve->setVisible(state == Qt::Checked);
    setYMax();
    replot();
}

void
AllPlot::showSpeed(int state) 
{
    assert(state != Qt::PartiallyChecked);
    speedCurve->setVisible(state == Qt::Checked);
    setYMax();
    replot();
}

void
AllPlot::showCad(int state) 
{
    assert(state != Qt::PartiallyChecked);
    cadCurve->setVisible(state == Qt::Checked);
    setYMax();
    replot();
}

void
AllPlot::showGrid(int state) 
{
    assert(state != Qt::PartiallyChecked);
    grid->setVisible(state == Qt::Checked);
    replot();
}

void
AllPlot::setSmoothing(int value)
{
    smooth = value;
    recalc();
}

void
AllPlot::setByDistance(int id)
{
    bydist = (id == 1);
    setXTitle();
    recalc();
}