ColorMap.cpp

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/View/PlotUtil/ColorMap.cpp
//! @brief     Implements class ColorMap
//!
//! @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/PlotUtil/ColorMap.h"
#include "GUI/Model/Data/IntensityDataItem.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;
const int colorbar_width_logz = 50;
const int colorbar_width = 80;
 
} // namespace
 
ColorMap::ColorMap(QWidget* parent)
    : ScientificPlot(parent, PLOT_TYPE::Plot2D)
    , m_customPlot(new QCustomPlot)
    , m_colorMap(nullptr)
    , m_colorScale(nullptr)
    , m_updateTimer(new UpdateTimer(replot_update_interval, this))
    , m_colorBarLayout(new QCPLayoutGrid)
    , m_block_update(true)
{
    initColorMap();
 
    auto* vlayout = new QVBoxLayout(this);
    vlayout->setMargin(0);
    vlayout->setSpacing(0);
    vlayout->addWidget(m_customPlot);
    m_customPlot->setAttribute(Qt::WA_NoMousePropagation, false);
    setLayout(vlayout);
 
    setMouseTrackingEnabled(true);
    //    setFixedColorMapMargins();
}
 
QRectF ColorMap::viewportRectangleInWidgetCoordinates()
{
    QCPRange xrange = m_customPlot->xAxis->range();
    QCPRange yrange = m_customPlot->yAxis->range();
    double left = xrange.lower;
    double right = xrange.upper;
    double top = yrange.upper;
    double bottom = yrange.lower;
 
    return QRectF(xAxisCoordToPixel(left), yAxisCoordToPixel(top),
                  xAxisCoordToPixel(right) - xAxisCoordToPixel(left),
                  yAxisCoordToPixel(bottom) - yAxisCoordToPixel(top));
}
 
PlotEventInfo ColorMap::eventInfo(double xpos, double ypos) const
{
    PlotEventInfo result(plotType());
    if (!intensityItem())
        return result;
 
    int nx(0), ny(0);
    m_colorMap->data()->coordToCell(xpos, ypos, &nx, &ny);
 
    result.setX(xpos);
    result.setY(ypos);
    result.setNx(nx);
    result.setNy(ny);
 
    result.setInAxesRange(axesRangeContains(xpos, ypos));
    result.setValue(m_colorMap->data()->cell(result.nx(), result.ny()));
    result.setLogValueAxis(intensityItem()->isLogz());
 
    return result;
}
 
//! sets logarithmic scale
void ColorMap::setLogz(bool logz)
{
    m_colorBarLayout->setMinimumSize(logz ? colorbar_width_logz : colorbar_width, 10);
    GUI::View::RangeUtils::setLogz(m_colorScale, logz);
}
 
//! reset all axes min,max to initial value
void ColorMap::resetView()
{
    intensityItem()->resetView();
}
 
void ColorMap::onIntensityModified()
{
    setAxesRangeFromItem(intensityItem());
    setDataFromItem(intensityItem());
    replot();
}
 
//! updates color map depending on  IntensityDataItem properties
void ColorMap::onPropertyChanged(const QString& property_name)
{
    if (m_block_update)
        return;
 
    if (IntensityDataItem::isGradientPropertyName(property_name)) {
        m_colorMap->setGradient(GUI::View::RangeUtils::itemGradient(intensityItem()));
        replot();
    } else if (IntensityDataItem::isInterpolatedPropertyName(property_name)) {
        m_colorMap->setInterpolate(intensityItem()->isInterpolated());
        replot();
    } else if (DataItem::isAxesUnitsPropertyName(property_name)) {
        setAxesRangeFromItem(intensityItem());
        replot();
    }
}
 
void ColorMap::onAxisPropertyChanged(const QString& axisName, const QString& propertyName)
{
    if (m_block_update)
        return;
 
    if (BasicAxisItem::isTitlePropertyName(propertyName)
        || BasicAxisItem::isTitleVisiblePropertyName(propertyName)) {
        setAxesLabelsFromItem(intensityItem());
        replot();
    }
 
    if (IntensityDataItem::isXaxisPropertyName(axisName)) {
        if (BasicAxisItem::isBoundsPropertiesName(propertyName)) {
            setAxesRangeConnected(false);
            m_customPlot->xAxis->setRange(GUI::View::RangeUtils::itemZoomX(intensityItem()));
            setAxesRangeConnected(true);
            replot();
        }
    } else if (IntensityDataItem::isYaxisPropertyName(axisName)) {
        if (BasicAxisItem::isBoundsPropertiesName(propertyName)) {
            setAxesRangeConnected(false);
            m_customPlot->yAxis->setRange(GUI::View::RangeUtils::itemZoomY(intensityItem()));
            setAxesRangeConnected(true);
            replot();
        }
    }
 
    else if (IntensityDataItem::isZaxisPropertyName(axisName)) {
        if (BasicAxisItem::isBoundsPropertiesName(propertyName)) {
            setDataRangeFromItem(intensityItem());
            replot();
        } else if (AmplitudeAxisItem::isLogScalePropertyName(propertyName)) {
            setLogz(intensityItem()->isLogz());
            replot();
        } else if (BasicAxisItem::isVisibilityPropertyName(propertyName)) {
            setColorScaleVisible(intensityItem()->zAxisItem()->visibilityValue());
            replot();
        }
    }
}
 
//! Propagate zmin, zmax back to IntensityDataItem
void ColorMap::onDataRangeChanged(QCPRange newRange)
{
    m_block_update = true;
    intensityItem()->setLowerAndUpperZ(newRange.lower, newRange.upper);
    m_block_update = false;
}
 
//! Propagate xmin, xmax back to IntensityDataItem
void ColorMap::onXaxisRangeChanged(QCPRange newRange)
{
    m_block_update = true;
    intensityItem()->setLowerX(newRange.lower);
    intensityItem()->setUpperX(newRange.upper);
    m_block_update = false;
}
 
//! Propagate ymin, ymax back to IntensityDataItem
void ColorMap::onYaxisRangeChanged(QCPRange newRange)
{
    m_block_update = true;
    intensityItem()->setLowerY(newRange.lower);
    intensityItem()->setUpperY(newRange.upper);
    m_block_update = false;
}
 
//! Schedule replot for later execution by onTimeReplot() slot.
 
void ColorMap::replot()
{
    m_updateTimer->scheduleUpdate();
}
 
//! Replots ColorMap.
 
void ColorMap::onTimeToReplot()
{
    m_customPlot->replot();
}
 
void ColorMap::subscribeToItem()
{
    setColorMapFromItem(intensityItem());
 
    intensityItem()->mapper()->setOnPropertyChange(
        [this](const QString& name) { onPropertyChanged(name); }, this);
 
    intensityItem()->mapper()->setOnChildPropertyChange(
        [this](SessionItem* item, const QString name) {
            if (item->modelType() == BasicAxisItem::M_TYPE
                || item->modelType() == AmplitudeAxisItem::M_TYPE)
                onAxisPropertyChanged(item->itemName(), name);
        },
        this);
 
    intensityItem()->mapper()->setOnValueChange([this]() { onIntensityModified(); }, this);
 
    setConnected(true);
}
 
void ColorMap::unsubscribeFromItem()
{
    setConnected(false);
}
 
//! creates and initializes the color map
void ColorMap::initColorMap()
{
    m_colorMap = new QCPColorMap(m_customPlot->xAxis, m_customPlot->yAxis);
    m_colorScale = new QCPColorScale(m_customPlot);
    m_colorMap->setColorScale(m_colorScale);
 
    m_colorBarLayout->addElement(0, 0, m_colorScale);
    m_colorBarLayout->setMinimumSize(colorbar_width_logz, 10);
    auto base_size = GUI::Util::Style::SizeOfLetterM(this).width() * 0.5;
    m_colorBarLayout->setMargins(QMargins(base_size, 0, base_size, 0));
 
    m_colorScale->axis()->axisRect()->setMargins(QMargins(0, 0, 0, 0));
    m_colorScale->axis()->axisRect()->setAutoMargins(QCP::msNone);
 
    m_colorScale->setBarWidth(GUI::Constants::plot_colorbar_size());
    m_colorScale->axis()->setTickLabelFont(
        QFont(QFont().family(), GUI::Constants::plot_tick_label_size()));
    m_customPlot->xAxis->setTickLabelFont(
        QFont(QFont().family(), GUI::Constants::plot_tick_label_size()));
    m_customPlot->yAxis->setTickLabelFont(
        QFont(QFont().family(), GUI::Constants::plot_tick_label_size()));
 
    connect(m_customPlot, &QCustomPlot::afterReplot, this, &ColorMap::marginsChangedNotify);
}
 
void ColorMap::setConnected(bool isConnected)
{
    setAxesRangeConnected(isConnected);
    setDataRangeConnected(isConnected);
    setUpdateTimerConnected(isConnected);
}
 
//! Connects/disconnects signals related to ColorMap's X,Y axes rectangle change.
 
void ColorMap::setAxesRangeConnected(bool isConnected)
{
    if (isConnected) {
        connect(m_customPlot->xAxis,
                static_cast<void (QCPAxis::*)(const QCPRange&)>(&QCPAxis::rangeChanged), this,
                &ColorMap::onXaxisRangeChanged, Qt::UniqueConnection);
 
        connect(m_customPlot->yAxis,
                static_cast<void (QCPAxis::*)(const QCPRange&)>(&QCPAxis::rangeChanged), this,
                &ColorMap::onYaxisRangeChanged, Qt::UniqueConnection);
    } else {
        disconnect(m_customPlot->xAxis,
                   static_cast<void (QCPAxis::*)(const QCPRange&)>(&QCPAxis::rangeChanged), this,
                   &ColorMap::onXaxisRangeChanged);
 
        disconnect(m_customPlot->yAxis,
                   static_cast<void (QCPAxis::*)(const QCPRange&)>(&QCPAxis::rangeChanged), this,
                   &ColorMap::onYaxisRangeChanged);
    }
}
 
//! Connects/disconnects signals related to ColorMap's Z-axis (min,max) change.
 
void ColorMap::setDataRangeConnected(bool isConnected)
{
    if (isConnected)
        connect(m_colorMap, &QCPColorMap::dataRangeChanged, this, &ColorMap::onDataRangeChanged,
                Qt::UniqueConnection);
    else
        disconnect(m_colorMap, &QCPColorMap::dataRangeChanged, this, &ColorMap::onDataRangeChanged);
}
 
void ColorMap::setUpdateTimerConnected(bool isConnected)
{
    if (isConnected)
        connect(m_updateTimer, &UpdateTimer::timeToUpdate, this, &ColorMap::onTimeToReplot,
                Qt::UniqueConnection);
    else
        disconnect(m_updateTimer, &UpdateTimer::timeToUpdate, this, &ColorMap::onTimeToReplot);
}
 
//! to make fixed margins for whole colormap (change in axes labels wont affect axes rectangle)
void ColorMap::setFixedColorMapMargins()
{
    GUI::View::RangeUtils::setDefaultMargins(m_customPlot);
}
 
//! Sets initial state of ColorMap to match given intensity item.
 
void ColorMap::setColorMapFromItem(IntensityDataItem* intensityItem)
{
    ASSERT(intensityItem);
 
    m_block_update = true;
 
    setAxesRangeFromItem(intensityItem);
    setAxesZoomFromItem(intensityItem);
    setAxesLabelsFromItem(intensityItem);
    setDataFromItem(intensityItem);
    setColorScaleAppearanceFromItem(intensityItem);
    setDataRangeFromItem(intensityItem);
 
    replot();
 
    m_block_update = false;
}
 
//! Sets (xmin,xmax,nbins) and (ymin,ymax,nbins) of ColorMap from intensity item.
 
void ColorMap::setAxesRangeFromItem(IntensityDataItem* item)
{
    m_customPlot->setInteractions(QCP::iRangeDrag | QCP::iRangeZoom);
    m_customPlot->axisRect()->setupFullAxesBox(true);
    m_colorMap->data()->setSize(item->xSize(), item->ySize());
    m_colorMap->data()->setRange(GUI::View::RangeUtils::itemXrange(item),
                                 GUI::View::RangeUtils::itemYrange(item));
}
 
//! Sets zoom range of X,Y axes as in intensity item.
 
void ColorMap::setAxesZoomFromItem(IntensityDataItem* item)
{
    setAxesRangeConnected(false);
    m_customPlot->xAxis->setRange(item->getLowerX(), item->getUpperX());
    m_customPlot->yAxis->setRange(item->getLowerY(), item->getUpperY());
    setAxesRangeConnected(true);
}
 
//! Sets X,Y axes labels from item
 
void ColorMap::setAxesLabelsFromItem(IntensityDataItem* item)
{
    auto* xaxis = item->xAxisItem();
    if (xaxis->isTitleVisible())
        m_customPlot->xAxis->setLabel(item->getXaxisTitle());
    else
        m_customPlot->xAxis->setLabel(QString());
 
    m_colorScale->setMargins(QMargins(0, 0, 0, 0));
 
    auto* yaxis = item->yAxisItem();
    if (yaxis->isTitleVisible())
        m_customPlot->yAxis->setLabel(item->getYaxisTitle());
    else
        m_customPlot->yAxis->setLabel(QString());
}
 
//! Sets the intensity values to ColorMap.
 
void ColorMap::setDataFromItem(IntensityDataItem* item)
{
    auto* data = item->getDatafield();
    if (!data) {
        m_colorMap->data()->clear();
        return;
    }
 
    int nx(item->xSize()); // outside of the loop because of slow retrieval
    int ny(item->ySize());
    for (int ix = 0; ix < nx; ++ix)
        for (int iy = 0; iy < ny; ++iy)
            m_colorMap->data()->setCell(ix, iy, (*data)[iy + ny * ix]);
}
 
//! Sets the appearance of color scale (visibility, gradient type) from intensity item.
 
void ColorMap::setColorScaleAppearanceFromItem(IntensityDataItem* item)
{
    setColorScaleVisible(item->zAxisItem()->visibilityValue());
    m_colorMap->setGradient(GUI::View::RangeUtils::itemGradient(intensityItem()));
    m_colorMap->setInterpolate(intensityItem()->isInterpolated());
    // make sure the axis rect and color scale synchronize their bottom and top margins (so they
    // line up):
    auto* marginGroup = new QCPMarginGroup(m_customPlot);
    m_customPlot->axisRect()->setMarginGroup(QCP::msBottom | QCP::msTop, marginGroup);
    m_colorScale->setMarginGroup(QCP::msBottom | QCP::msTop, marginGroup);
}
 
void ColorMap::setDataRangeFromItem(IntensityDataItem* item)
{
    setDataRangeConnected(false);
    m_colorMap->setDataRange(GUI::View::RangeUtils::itemDataZoom(item));
    setLogz(item->isLogz());
    setDataRangeConnected(true);
}
 
void ColorMap::setColorScaleVisible(bool visibility_flag)
{
    m_colorBarLayout->setVisible(visibility_flag);
    if (visibility_flag) {
        // add it to the right of the main axis rect
        if (!m_customPlot->plotLayout()->hasElement(0, 1))
            m_customPlot->plotLayout()->addElement(0, 1, m_colorBarLayout);
    } else {
        m_customPlot->plotLayout()->take(m_colorBarLayout);
        m_customPlot->plotLayout()->simplify();
    }
}
 
//! Calculates left, right margins around color map to report to projection plot.
 
void ColorMap::marginsChangedNotify()
{
    QMargins axesMargins = m_customPlot->axisRect()->margins();
    //    QMargins colorBarMargins = m_colorScale->margins();
    //    QMargins colorScaleMargins = m_colorScale->axis()->axisRect()->margins();
 
    double left = axesMargins.left();
    //    double right = axesMargins.right() + colorBarMargins.right() + m_colorScale->barWidth()
    //            + colorScaleMargins.right() + m_colorBarLayout->rect().width();
 
    double right = axesMargins.right() + m_colorBarLayout->rect().width();
 
    emit marginsChanged(left, right);
}
 
IntensityDataItem* ColorMap::intensityItem()
{
    return const_cast<IntensityDataItem*>(static_cast<const ColorMap*>(this)->intensityItem());
}
 
const IntensityDataItem* ColorMap::intensityItem() const
{
    return dynamic_cast<const IntensityDataItem*>(currentItem());
}