Plot1D.cpp

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/View/PlotComparison/Plot1D.cpp
//! @brief     Implements class Plot1D
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************

#include "GUI/View/PlotComparison/Plot1D.h"
#include "GUI/Model/Data/Data1DViewItem.h"
#include "GUI/Model/Data/DataItem.h"
#include "GUI/Model/Data/DataProperties.h"
#include "GUI/Model/Data/DataPropertyContainer.h"
#include "GUI/Model/Device/AxesItems.h"
#include "GUI/View/PlotUtil/PlotConstants.h"
#include "GUI/View/PlotUtil/PlotEventInfo.h"
#include "GUI/View/PlotUtil/RangeUtils.h"
#include "GUI/View/Tool/UpdateTimer.h"

namespace {

const int replot_update_interval = 10;

int bin(double x, const QCPGraph* graph);

} // namespace

Plot1D::Plot1D(QWidget* parent)
    : ScientificPlot(parent, PLOT_TYPE::Plot1D)
    , m_custom_plot(new QCustomPlot)
    , m_update_timer(new UpdateTimer(replot_update_interval, this))
    , m_block_update(false)
{
    auto* vlayout = new QVBoxLayout(this);
    vlayout->setContentsMargins(0, 0, 0, 0);
    vlayout->setSpacing(0);
    vlayout->addWidget(m_custom_plot);
    m_custom_plot->setAttribute(Qt::WA_NoMousePropagation, false);
    setLayout(vlayout);

    m_custom_plot->xAxis->setTickLabelFont(
        QFont(QFont().family(), GUI::Constants::plot_tick_label_size()));
    m_custom_plot->yAxis->setTickLabelFont(
        QFont(QFont().family(), GUI::Constants::plot_tick_label_size()));

    setMouseTrackingEnabled(true);
}

PlotEventInfo Plot1D::eventInfo(double xpos, double ypos) const
{
    PlotEventInfo result(plotType());
    if (!viewItem())
        return result;

    result.setX(xpos);
    result.setValue(ypos);

    result.setInAxesRange(axesRangeContains(xpos, ypos));
    result.setNx(bin(result.x(), m_custom_plot->graph()));

    return result;
}

void Plot1D::setLog(bool log)
{
    GUI::View::RangeUtils::setLogz(m_custom_plot->yAxis, log);
    GUI::View::RangeUtils::setLogz(m_custom_plot->yAxis2, log);
}

void Plot1D::resetView()
{
    viewItem()->resetView();
}

void Plot1D::onPropertyChanged(const QString& property_name)
{
    if (m_block_update)
        return;

    if (Data1DViewItem::isAxesUnitsPropertyName(property_name)) {
        setAxesRangeFromItem(viewItem());
        updateAllGraphs();
        replot();
    }
}

void Plot1D::onXaxisRangeChanged(QCPRange newRange)
{
    m_block_update = true;
    viewItem()->setLowerX(newRange.lower);
    viewItem()->setUpperX(newRange.upper);
    m_block_update = false;
}

void Plot1D::onYaxisRangeChanged(QCPRange newRange)
{
    m_block_update = true;
    viewItem()->setLowerY(newRange.lower);
    viewItem()->setUpperY(newRange.upper);
    m_block_update = false;
}

void Plot1D::onTimeToReplot()
{
    m_custom_plot->replot();
}

void Plot1D::subscribeToItem()
{
    initPlots();
    refreshPlotData();

    viewItem()->mapper()->setOnPropertyChange(
        [this](const QString& name) { onPropertyChanged(name); }, this);

    viewItem()->mapper()->setOnChildPropertyChange(
        [this](SessionItem* item, const QString name) {
            if (dynamic_cast<BasicAxisItem*>(item))
                modifyAxesProperties(item->itemName(), name);
        },
        this);

    std::for_each(m_graph_map.begin(), m_graph_map.end(), [caller = this](auto pair) {
#ifdef USE_MAPPERS
        auto property_item = pair.first;
        property_item->dataItem()->mapper()->setOnValueChange(
            [caller]() { caller->refreshPlotData(); }, caller);
#else
        DataItem* dataItem = pair.first->dataItem();
        connect(dataItem, &DataItem::datafieldChanged, caller,
                [caller]() { caller->refreshPlotData(); });
#endif
    });
    setConnected(true);
}

void Plot1D::unsubscribeFromItem()
{
    m_custom_plot->clearGraphs();
    std::for_each(m_graph_map.begin(), m_graph_map.end(), [caller = this](auto pair) {
#ifdef USE_MAPPERS
        pair.first->dataItem()->mapper()->unsubscribe(caller);
#else
        disconnect(pair.first->dataItem(), nullptr, caller, nullptr);
#endif
    });
    m_graph_map.clear();
    setConnected(false);
}

void Plot1D::initPlots()
{
    auto property_items = viewItem()->propertyContainerItem()->propertyItems();

    std::for_each(property_items.begin(), property_items.end(), [this](Data1DProperties* item) {
        auto* graph = m_custom_plot->addGraph();
        graph->setLineStyle(item->line());
        graph->setPen(QPen(item->color()));
        graph->setScatterStyle(item->scatter());
        m_graph_map[item] = graph;
    });
}

void Plot1D::setConnected(bool isConnected)
{
    setAxesRangeConnected(isConnected);
    setUpdateTimerConnected(isConnected);
}

void Plot1D::setAxesRangeConnected(bool isConnected)
{
    if (isConnected) {
        connect(m_custom_plot->xAxis,
                static_cast<void (QCPAxis::*)(const QCPRange&)>(&QCPAxis::rangeChanged), this,
                &Plot1D::onXaxisRangeChanged, Qt::UniqueConnection);

        connect(m_custom_plot->yAxis,
                static_cast<void (QCPAxis::*)(const QCPRange&)>(&QCPAxis::rangeChanged), this,
                &Plot1D::onYaxisRangeChanged, Qt::UniqueConnection);
    } else {
        disconnect(m_custom_plot->xAxis,
                   static_cast<void (QCPAxis::*)(const QCPRange&)>(&QCPAxis::rangeChanged), this,
                   &Plot1D::onXaxisRangeChanged);

        disconnect(m_custom_plot->yAxis,
                   static_cast<void (QCPAxis::*)(const QCPRange&)>(&QCPAxis::rangeChanged), this,
                   &Plot1D::onYaxisRangeChanged);
    }
}

void Plot1D::setUpdateTimerConnected(bool isConnected)
{
    if (isConnected)
        connect(m_update_timer, &UpdateTimer::timeToUpdate, this, &Plot1D::onTimeToReplot,
                Qt::UniqueConnection);
    else
        disconnect(m_update_timer, &UpdateTimer::timeToUpdate, this, &Plot1D::onTimeToReplot);
}

void Plot1D::refreshPlotData()
{
    if (m_block_update)
        return;

    m_block_update = true;

    auto* view_item = viewItem();
    ASSERT(view_item);

    setAxesRangeFromItem(view_item);
    setAxesLabelsFromItem(view_item);
    updateAllGraphs();

    replot();

    m_block_update = false;
}

void Plot1D::setAxesRangeFromItem(Data1DViewItem* item)
{
    m_custom_plot->setInteractions(QCP::iRangeDrag | QCP::iRangeZoom);
    m_custom_plot->axisRect()->setupFullAxesBox(true);

    setAxesRangeConnected(false);
    m_custom_plot->xAxis->setRange(item->getLowerX(), item->getUpperX());
    m_custom_plot->yAxis->setRange(item->getLowerY(), item->getUpperY());
    setLog(item->isLog());
    setAxesRangeConnected(true);
}

void Plot1D::setAxesLabelsFromItem(Data1DViewItem* item)
{
    setLabel(item->xAxisItem(), m_custom_plot->xAxis, item->getXaxisTitle());
    setLabel(item->yAxisItem(), m_custom_plot->yAxis, item->getYaxisTitle());
}

void Plot1D::setLabel(const BasicAxisItem* item, QCPAxis* axis, QString label)
{
    ASSERT(item && axis);
    if (item->isTitleVisible())
        axis->setLabel(label);
    else
        axis->setLabel(QString());
}

void Plot1D::updateAllGraphs()
{
    auto property_items = viewItem()->propertyContainerItem()->propertyItems();
    std::for_each(property_items.begin(), property_items.end(),
                  [this](Data1DProperties* item) { updateGraph(item); });
}

void Plot1D::updateGraph(Data1DProperties* item)
{
    auto data_points = viewItem()->graphData(item);

    auto* graph = m_graph_map.at(item);
    graph->setData(data_points.first, data_points.second, /*alreadySorted =*/true);
}

Data1DViewItem* Plot1D::viewItem()
{
    return const_cast<Data1DViewItem*>(static_cast<const Plot1D*>(this)->viewItem());
}

const Data1DViewItem* Plot1D::viewItem() const
{
    const auto* const result = dynamic_cast<const Data1DViewItem*>(currentItem());
    ASSERT(result);
    return result;
}

void Plot1D::modifyAxesProperties(const QString& axisName, const QString& propertyName)
{
    if (m_block_update)
        return;

    if (BasicAxisItem::isTitlePropertyName(propertyName)
        || BasicAxisItem::isTitleVisiblePropertyName(propertyName)) {
        setAxesLabelsFromItem(viewItem());
        replot();
    }

    if (Data1DViewItem::isXAxisPropertyName(axisName)) {
        if (BasicAxisItem::isBoundsPropertiesName(propertyName)) {
            setAxesRangeConnected(false);
            m_custom_plot->xAxis->setRange(viewItem()->getLowerX(), viewItem()->getUpperX());
            setAxesRangeConnected(true);
            replot();
        }
    } else if (Data1DViewItem::isYAxisPropertyName(axisName)) {
        if (BasicAxisItem::isBoundsPropertiesName(propertyName)) {
            setAxesRangeConnected(false);
            m_custom_plot->yAxis->setRange(viewItem()->getLowerY(), viewItem()->getUpperY());
            setAxesRangeConnected(true);
            replot();
        } else if (AmplitudeAxisItem::isLogScalePropertyName(propertyName)) {
            setLog(viewItem()->isLog());
            replot();
        }
    }
}

void Plot1D::replot()
{
    m_update_timer->scheduleUpdate();
}

namespace {

int bin(double x, const QCPGraph* graph)
{
    const int key_start = graph->findBegin(x);
    const int key_end = graph->findBegin(x, false); // false = do not expand range
    if (key_end == key_start || key_end == graph->dataCount())
        return key_start;
    return (x - graph->dataSortKey(key_start)) <= (graph->dataSortKey(key_end) - x) ? key_start
                                                                                    : key_end;
}

} // namespace