AxisRenderingUtils.cpp
207 lines
| 6.7 KiB
| text/x-c
|
CppLexer
Alexandre Leroux
|
r916 | #include "Visualization/AxisRenderingUtils.h" | ||
| #include <Data/ScalarSeries.h> | ||||
|
Alexandre Leroux
|
r921 | #include <Data/SpectrogramSeries.h> | ||
|
Alexandre Leroux
|
r916 | #include <Data/VectorSeries.h> | ||
|
Alexandre Leroux
|
r1335 | #include <Variable/Variable.h> | ||
|
Alexandre Leroux
|
r1050 | #include <Visualization/SqpColorScale.h> | ||
|
Alexandre Leroux
|
r916 | #include <Visualization/qcustomplot.h> | ||
|
Alexandre Leroux
|
r927 | Q_LOGGING_CATEGORY(LOG_AxisRenderingUtils, "AxisRenderingUtils") | ||
|
Alexandre Leroux
|
r916 | namespace { | ||
|
Alexandre Leroux
|
r917 | const auto DATETIME_FORMAT = QStringLiteral("yyyy/MM/dd hh:mm:ss:zzz"); | ||
| /// Format for datetimes on a axis | ||||
| const auto DATETIME_TICKER_FORMAT = QStringLiteral("yyyy/MM/dd \nhh:mm:ss"); | ||||
|
Alexandre Leroux
|
r1068 | const auto NUMBER_FORMAT = 'g'; | ||
| const auto NUMBER_PRECISION = 9; | ||||
|
Alexandre Leroux
|
r917 | /// Generates the appropriate ticker for an axis, depending on whether the axis displays time or | ||
| /// non-time data | ||||
|
Alexandre Leroux
|
r928 | QSharedPointer<QCPAxisTicker> axisTicker(bool isTimeAxis, QCPAxis::ScaleType scaleType) | ||
|
Alexandre Leroux
|
r917 | { | ||
| if (isTimeAxis) { | ||||
| auto dateTicker = QSharedPointer<QCPAxisTickerDateTime>::create(); | ||||
| dateTicker->setDateTimeFormat(DATETIME_TICKER_FORMAT); | ||||
| dateTicker->setDateTimeSpec(Qt::UTC); | ||||
| return dateTicker; | ||||
| } | ||||
|
Alexandre Leroux
|
r928 | else if (scaleType == QCPAxis::stLogarithmic) { | ||
| return QSharedPointer<QCPAxisTickerLog>::create(); | ||||
| } | ||||
|
Alexandre Leroux
|
r917 | else { | ||
| // default ticker | ||||
| return QSharedPointer<QCPAxisTicker>::create(); | ||||
| } | ||||
| } | ||||
| /** | ||||
| * Sets properties of the axis passed as parameter | ||||
| * @param axis the axis to set | ||||
| * @param unit the unit to set for the axis | ||||
| * @param scaleType the scale type to set for the axis | ||||
| */ | ||||
| void setAxisProperties(QCPAxis &axis, const Unit &unit, | ||||
| QCPAxis::ScaleType scaleType = QCPAxis::stLinear) | ||||
| { | ||||
| // label (unit name) | ||||
| axis.setLabel(unit.m_Name); | ||||
| // scale type | ||||
| axis.setScaleType(scaleType); | ||||
|
Alexandre Leroux
|
r928 | if (scaleType == QCPAxis::stLogarithmic) { | ||
| // Scientific notation | ||||
| axis.setNumberPrecision(0); | ||||
| axis.setNumberFormat("eb"); | ||||
| } | ||||
|
Alexandre Leroux
|
r917 | |||
| // ticker (depending on the type of unit) | ||||
|
Alexandre Leroux
|
r928 | axis.setTicker(axisTicker(unit.m_TimeUnit, scaleType)); | ||
|
Alexandre Leroux
|
r917 | } | ||
|
Alexandre Leroux
|
r916 | /** | ||
| * Delegate used to set axes properties | ||||
| */ | ||||
| template <typename T, typename Enabled = void> | ||||
| struct AxisSetter { | ||||
|
Alexandre Leroux
|
r1335 | static void setProperties(QCustomPlot &, SqpColorScale &) | ||
|
Alexandre Leroux
|
r916 | { | ||
| // Default implementation does nothing | ||||
|
Alexandre Leroux
|
r927 | qCCritical(LOG_AxisRenderingUtils()) << "Can't set axis properties: unmanaged type of data"; | ||
|
Alexandre Leroux
|
r916 | } | ||
|
Alexandre Leroux
|
r1335 | |||
| static void setUnits(T &, QCustomPlot &, SqpColorScale &) | ||||
| { | ||||
| // Default implementation does nothing | ||||
| qCCritical(LOG_AxisRenderingUtils()) << "Can't set axis units: unmanaged type of data"; | ||||
| } | ||||
|
Alexandre Leroux
|
r916 | }; | ||
| /** | ||||
| * Specialization of AxisSetter for scalars and vectors | ||||
| * @sa ScalarSeries | ||||
| * @sa VectorSeries | ||||
| */ | ||||
| template <typename T> | ||||
| struct AxisSetter<T, typename std::enable_if_t<std::is_base_of<ScalarSeries, T>::value | ||||
| or std::is_base_of<VectorSeries, T>::value> > { | ||||
|
Alexandre Leroux
|
r1335 | static void setProperties(QCustomPlot &, SqpColorScale &) | ||
| { | ||||
| // Nothing to do | ||||
| } | ||||
| static void setUnits(T &dataSeries, QCustomPlot &plot, SqpColorScale &) | ||||
|
Alexandre Leroux
|
r916 | { | ||
|
Alexandre Leroux
|
r917 | dataSeries.lockRead(); | ||
| auto xAxisUnit = dataSeries.xAxisUnit(); | ||||
| auto valuesUnit = dataSeries.valuesUnit(); | ||||
| dataSeries.unlock(); | ||||
| setAxisProperties(*plot.xAxis, xAxisUnit); | ||||
| setAxisProperties(*plot.yAxis, valuesUnit); | ||||
|
Alexandre Leroux
|
r916 | } | ||
| }; | ||||
|
Alexandre Leroux
|
r921 | /** | ||
| * Specialization of AxisSetter for spectrograms | ||||
| * @sa SpectrogramSeries | ||||
| */ | ||||
| template <typename T> | ||||
| struct AxisSetter<T, typename std::enable_if_t<std::is_base_of<SpectrogramSeries, T>::value> > { | ||||
|
Alexandre Leroux
|
r1335 | static void setProperties(QCustomPlot &plot, SqpColorScale &colorScale) | ||
|
Alexandre Leroux
|
r921 | { | ||
| // Displays color scale in plot | ||||
| plot.plotLayout()->insertRow(0); | ||||
|
Alexandre Leroux
|
r1050 | plot.plotLayout()->addElement(0, 0, colorScale.m_Scale); | ||
| colorScale.m_Scale->setType(QCPAxis::atTop); | ||||
| colorScale.m_Scale->setMinimumMargins(QMargins{0, 0, 0, 0}); | ||||
|
Alexandre Leroux
|
r921 | |||
| // Aligns color scale with axes | ||||
| auto marginGroups = plot.axisRect()->marginGroups(); | ||||
| for (auto it = marginGroups.begin(), end = marginGroups.end(); it != end; ++it) { | ||||
|
Alexandre Leroux
|
r1050 | colorScale.m_Scale->setMarginGroup(it.key(), it.value()); | ||
|
Alexandre Leroux
|
r921 | } | ||
| // Set color scale properties | ||||
|
Alexandre Leroux
|
r1143 | colorScale.m_AutomaticThreshold = true; | ||
|
Alexandre Leroux
|
r921 | } | ||
|
Alexandre Leroux
|
r1335 | |||
| static void setUnits(T &dataSeries, QCustomPlot &plot, SqpColorScale &colorScale) | ||||
| { | ||||
| dataSeries.lockRead(); | ||||
| auto xAxisUnit = dataSeries.xAxisUnit(); | ||||
| auto yAxisUnit = dataSeries.yAxisUnit(); | ||||
| auto valuesUnit = dataSeries.valuesUnit(); | ||||
| dataSeries.unlock(); | ||||
| setAxisProperties(*plot.xAxis, xAxisUnit); | ||||
| setAxisProperties(*plot.yAxis, yAxisUnit, QCPAxis::stLogarithmic); | ||||
| setAxisProperties(*colorScale.m_Scale->axis(), valuesUnit, QCPAxis::stLogarithmic); | ||||
| } | ||||
|
Alexandre Leroux
|
r921 | }; | ||
|
Alexandre Leroux
|
r916 | /** | ||
| * Default implementation of IAxisHelper, which takes data series to set axes properties | ||||
| * @tparam T the data series' type | ||||
| */ | ||||
| template <typename T> | ||||
| struct AxisHelper : public IAxisHelper { | ||||
|
Alexandre Leroux
|
r1335 | explicit AxisHelper(std::shared_ptr<T> dataSeries) : m_DataSeries{dataSeries} {} | ||
|
Alexandre Leroux
|
r916 | |||
|
Alexandre Leroux
|
r1050 | void setProperties(QCustomPlot &plot, SqpColorScale &colorScale) override | ||
|
Alexandre Leroux
|
r916 | { | ||
|
Alexandre Leroux
|
r1335 | AxisSetter<T>::setProperties(plot, colorScale); | ||
|
Alexandre Leroux
|
r916 | } | ||
|
Alexandre Leroux
|
r1335 | void setUnits(QCustomPlot &plot, SqpColorScale &colorScale) override | ||
| { | ||||
| if (m_DataSeries) { | ||||
| AxisSetter<T>::setUnits(*m_DataSeries, plot, colorScale); | ||||
| } | ||||
| else { | ||||
| qCCritical(LOG_AxisRenderingUtils()) << "Can't set units: inconsistency between the " | ||||
| "type of data series and the type supposed"; | ||||
| } | ||||
| } | ||||
| std::shared_ptr<T> m_DataSeries; | ||||
|
Alexandre Leroux
|
r916 | }; | ||
| } // namespace | ||||
|
Alexandre Leroux
|
r917 | QString formatValue(double value, const QCPAxis &axis) | ||
| { | ||||
| // If the axis is a time axis, formats the value as a date | ||||
| if (auto axisTicker = qSharedPointerDynamicCast<QCPAxisTickerDateTime>(axis.ticker())) { | ||||
| return DateUtils::dateTime(value, axisTicker->dateTimeSpec()).toString(DATETIME_FORMAT); | ||||
| } | ||||
| else { | ||||
|
Alexandre Leroux
|
r1068 | return QString::number(value, NUMBER_FORMAT, NUMBER_PRECISION); | ||
|
Alexandre Leroux
|
r917 | } | ||
| } | ||||
|
Alexandre Leroux
|
r1335 | std::unique_ptr<IAxisHelper> IAxisHelperFactory::create(const Variable &variable) noexcept | ||
|
Alexandre Leroux
|
r916 | { | ||
|
Alexandre Leroux
|
r1335 | switch (variable.type()) { | ||
| case DataSeriesType::SCALAR: | ||||
| return std::make_unique<AxisHelper<ScalarSeries> >( | ||||
| std::dynamic_pointer_cast<ScalarSeries>(variable.dataSeries())); | ||||
| case DataSeriesType::SPECTROGRAM: | ||||
| return std::make_unique<AxisHelper<SpectrogramSeries> >( | ||||
| std::dynamic_pointer_cast<SpectrogramSeries>(variable.dataSeries())); | ||||
| case DataSeriesType::VECTOR: | ||||
| return std::make_unique<AxisHelper<VectorSeries> >( | ||||
| std::dynamic_pointer_cast<VectorSeries>(variable.dataSeries())); | ||||
| default: | ||||
| // Creates default helper | ||||
| break; | ||||
|
Alexandre Leroux
|
r916 | } | ||
|
Alexandre Leroux
|
r1335 | |||
| return std::make_unique<AxisHelper<IDataSeries> >(nullptr); | ||||
|
Alexandre Leroux
|
r916 | } | ||