SpecularPlot.cpp

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/View/PlotSpecular/SpecularPlot.cpp
//! @brief     Implements class SpecularPlot
//!
//! @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/PlotSpecular/SpecularPlot.h"
#include "Base/Axis/Frame.h"
#include "GUI/Model/Data/RealDataItem.h"
#include "GUI/Model/Data/SpecularDataItem.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
 
SpecularPlot::SpecularPlot(QWidget* parent)
    : ScientificPlot(parent, PLOT_TYPE::Plot1D)
    , m_custom_plot(new QCustomPlot)
    , m_update_timer(new UpdateTimer(replot_update_interval, this))
    , m_block_update(true)
{
    initPlot();
 
    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);
 
    setMouseTrackingEnabled(true);
}
 
PlotEventInfo SpecularPlot::eventInfo(double xpos, double ypos) const
{
    PlotEventInfo result(plotType());
    if (!specularItem())
        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 SpecularPlot::setLog(bool log)
{
    GUI::View::RangeUtils::setLogz(m_custom_plot->yAxis, log);
    GUI::View::RangeUtils::setLogz(m_custom_plot->yAxis2, log);
}
 
void SpecularPlot::resetView()
{
    specularItem()->resetView();
}
 
void SpecularPlot::onPropertyChanged(const QString& property_name)
{
    if (m_block_update)
        return;
 
    if (DataItem::isAxesUnitsPropertyName(property_name)) {
        setAxesRangeFromItem(specularItem());
        replot();
    }
}
 
void SpecularPlot::onXaxisRangeChanged(QCPRange newRange)
{
    m_block_update = true;
    specularItem()->setLowerX(newRange.lower);
    specularItem()->setUpperX(newRange.upper);
    m_block_update = false;
}
 
void SpecularPlot::onYaxisRangeChanged(QCPRange newRange)
{
    m_block_update = true;
    specularItem()->setLowerY(newRange.lower);
    specularItem()->setUpperY(newRange.upper);
    m_block_update = false;
}
 
void SpecularPlot::onTimeToReplot()
{
    m_custom_plot->replot();
}
 
void SpecularPlot::subscribeToItem()
{
    setPlotFromItem(specularItem());
 
    specularItem()->mapper()->setOnPropertyChange(
        [this](const QString& name) { onPropertyChanged(name); }, this);
 
    specularItem()->mapper()->setOnChildPropertyChange(
        [this](SessionItem* item, const QString name) {
            if (item->modelType() == BasicAxisItem::M_TYPE
                || item->modelType() == AmplitudeAxisItem::M_TYPE)
                modifyAxesProperties(item->itemName(), name);
        },
        this);
 
    specularItem()->mapper()->setOnValueChange([this]() { setPlotFromItem(this->specularItem()); },
                                               this);
 
    setConnected(true);
}
 
void SpecularPlot::unsubscribeFromItem()
{
    setConnected(false);
}
 
void SpecularPlot::initPlot()
{
    m_custom_plot->addGraph();
 
    QPen pen(QColor(0, 0, 255, 200));
    m_custom_plot->graph()->setLineStyle(QCPGraph::lsLine);
    m_custom_plot->graph()->setPen(pen);
 
    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()));
}
 
void SpecularPlot::initScatter()
{
    if (dynamic_cast<RealDataItem*>(specularItem()->parentItem())) {
        m_custom_plot->graph()->setScatterStyle(QCPScatterStyle::ssDisc);
    } else {
        m_custom_plot->graph()->setScatterStyle(QCPScatterStyle::ssNone);
    }
    m_custom_plot->replot();
}
 
void SpecularPlot::setConnected(bool isConnected)
{
    setAxesRangeConnected(isConnected);
    setUpdateTimerConnected(isConnected);
}
 
void SpecularPlot::setAxesRangeConnected(bool isConnected)
{
    if (isConnected) {
        connect(m_custom_plot->xAxis,
                static_cast<void (QCPAxis::*)(const QCPRange&)>(&QCPAxis::rangeChanged), this,
                &SpecularPlot::onXaxisRangeChanged, Qt::UniqueConnection);
 
        connect(m_custom_plot->yAxis,
                static_cast<void (QCPAxis::*)(const QCPRange&)>(&QCPAxis::rangeChanged), this,
                &SpecularPlot::onYaxisRangeChanged, Qt::UniqueConnection);
    } else {
        disconnect(m_custom_plot->xAxis,
                   static_cast<void (QCPAxis::*)(const QCPRange&)>(&QCPAxis::rangeChanged), this,
                   &SpecularPlot::onXaxisRangeChanged);
 
        disconnect(m_custom_plot->yAxis,
                   static_cast<void (QCPAxis::*)(const QCPRange&)>(&QCPAxis::rangeChanged), this,
                   &SpecularPlot::onYaxisRangeChanged);
    }
}
 
void SpecularPlot::setUpdateTimerConnected(bool isConnected)
{
    if (isConnected)
        connect(m_update_timer, &UpdateTimer::timeToUpdate, this, &SpecularPlot::onTimeToReplot,
                Qt::UniqueConnection);
    else
        disconnect(m_update_timer, &UpdateTimer::timeToUpdate, this, &SpecularPlot::onTimeToReplot);
}
 
void SpecularPlot::setPlotFromItem(SpecularDataItem* specularItem)
{
    ASSERT(specularItem);
 
    m_block_update = true;
 
    m_custom_plot->graph(0)->data()->clear();
    setAxesRangeFromItem(specularItem);
    setAxesLabelsFromItem(specularItem);
    setDataFromItem(specularItem);
 
    replot();
 
    m_block_update = false;
}
 
void SpecularPlot::setAxesRangeFromItem(SpecularDataItem* 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 SpecularPlot::setAxesLabelsFromItem(SpecularDataItem* item)
{
    setLabel(item->xAxisItem(), m_custom_plot->xAxis, item->getXaxisTitle());
    setLabel(item->yAxisItem(), m_custom_plot->yAxis, item->getYaxisTitle());
}
 
void SpecularPlot::setLabel(const BasicAxisItem* item, QCPAxis* axis, QString label)
{
    ASSERT(item && axis);
    if (item->isTitleVisible())
        axis->setLabel(label);
    else
        axis->setLabel(QString());
}
 
void SpecularPlot::setDataFromItem(SpecularDataItem* item)
{
    ASSERT(item);
    auto* data = item->getDatafield();
    if (!data)
        return;
 
    for (size_t i = 0, size = data->size(); i < size; ++i) {
        double x = data->frame().projectedCoord(i, 0);
        double y = data->operator[](i);
        m_custom_plot->graph()->addData(x, y);
    }
}
 
SpecularDataItem* SpecularPlot::specularItem()
{
    return const_cast<SpecularDataItem*>(static_cast<const SpecularPlot*>(this)->specularItem());
}
 
const SpecularDataItem* SpecularPlot::specularItem() const
{
    const auto* const result = dynamic_cast<const SpecularDataItem*>(currentItem());
    return result;
}
 
void SpecularPlot::modifyAxesProperties(const QString& axisName, const QString& propertyName)
{
    if (m_block_update)
        return;
 
    if (BasicAxisItem::isTitlePropertyName(propertyName)
        || BasicAxisItem::isTitleVisiblePropertyName(propertyName)) {
        setAxesLabelsFromItem(specularItem());
        replot();
    }
 
    if (SpecularDataItem::isXaxisPropertyName(axisName)) {
        if (BasicAxisItem::isBoundsPropertiesName(propertyName)) {
            setAxesRangeConnected(false);
            m_custom_plot->xAxis->setRange(specularItem()->getLowerX(),
                                           specularItem()->getUpperX());
            setAxesRangeConnected(true);
            replot();
        }
    } else if (SpecularDataItem::isYaxisPropertyName(axisName)) {
        if (BasicAxisItem::isBoundsPropertiesName(propertyName)) {
            setAxesRangeConnected(false);
            m_custom_plot->yAxis->setRange(specularItem()->getLowerY(),
                                           specularItem()->getUpperY());
            setAxesRangeConnected(true);
            replot();
        } else if (AmplitudeAxisItem::isLogScalePropertyName(propertyName)) {
            setLog(specularItem()->isLog());
            replot();
        }
    }
}
 
void SpecularPlot::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