AxisRenderingUtils.cpp
207 lines
| 6.7 KiB
| text/x-c
|
CppLexer
|
r915 | #include "Visualization/AxisRenderingUtils.h" | ||
#include <Data/ScalarSeries.h> | ||||
|
r920 | #include <Data/SpectrogramSeries.h> | ||
|
r915 | #include <Data/VectorSeries.h> | ||
|
r1281 | #include <Variable/Variable.h> | ||
|
r1009 | #include <Visualization/SqpColorScale.h> | ||
|
r915 | #include <Visualization/qcustomplot.h> | ||
|
r928 | Q_LOGGING_CATEGORY(LOG_AxisRenderingUtils, "AxisRenderingUtils") | ||
|
r915 | namespace { | ||
|
r916 | 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"); | ||||
|
r1027 | const auto NUMBER_FORMAT = 'g'; | ||
const auto NUMBER_PRECISION = 9; | ||||
|
r916 | /// Generates the appropriate ticker for an axis, depending on whether the axis displays time or | ||
/// non-time data | ||||
|
r929 | QSharedPointer<QCPAxisTicker> axisTicker(bool isTimeAxis, QCPAxis::ScaleType scaleType) | ||
|
r916 | { | ||
if (isTimeAxis) { | ||||
auto dateTicker = QSharedPointer<QCPAxisTickerDateTime>::create(); | ||||
dateTicker->setDateTimeFormat(DATETIME_TICKER_FORMAT); | ||||
dateTicker->setDateTimeSpec(Qt::UTC); | ||||
return dateTicker; | ||||
} | ||||
|
r929 | else if (scaleType == QCPAxis::stLogarithmic) { | ||
return QSharedPointer<QCPAxisTickerLog>::create(); | ||||
} | ||||
|
r916 | 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); | ||||
|
r929 | if (scaleType == QCPAxis::stLogarithmic) { | ||
// Scientific notation | ||||
axis.setNumberPrecision(0); | ||||
axis.setNumberFormat("eb"); | ||||
} | ||||
|
r916 | |||
// ticker (depending on the type of unit) | ||||
|
r929 | axis.setTicker(axisTicker(unit.m_TimeUnit, scaleType)); | ||
|
r916 | } | ||
|
r915 | /** | ||
* Delegate used to set axes properties | ||||
*/ | ||||
template <typename T, typename Enabled = void> | ||||
struct AxisSetter { | ||||
|
r1281 | static void setProperties(QCustomPlot &, SqpColorScale &) | ||
|
r915 | { | ||
// Default implementation does nothing | ||||
|
r928 | qCCritical(LOG_AxisRenderingUtils()) << "Can't set axis properties: unmanaged type of data"; | ||
|
r915 | } | ||
|
r1281 | |||
static void setUnits(T &, QCustomPlot &, SqpColorScale &) | ||||
{ | ||||
// Default implementation does nothing | ||||
qCCritical(LOG_AxisRenderingUtils()) << "Can't set axis units: unmanaged type of data"; | ||||
} | ||||
|
r915 | }; | ||
/** | ||||
* 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> > { | ||||
|
r1281 | static void setProperties(QCustomPlot &, SqpColorScale &) | ||
{ | ||||
// Nothing to do | ||||
} | ||||
static void setUnits(T &dataSeries, QCustomPlot &plot, SqpColorScale &) | ||||
|
r915 | { | ||
|
r916 | dataSeries.lockRead(); | ||
auto xAxisUnit = dataSeries.xAxisUnit(); | ||||
auto valuesUnit = dataSeries.valuesUnit(); | ||||
dataSeries.unlock(); | ||||
setAxisProperties(*plot.xAxis, xAxisUnit); | ||||
setAxisProperties(*plot.yAxis, valuesUnit); | ||||
|
r915 | } | ||
}; | ||||
|
r920 | /** | ||
* 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> > { | ||||
|
r1281 | static void setProperties(QCustomPlot &plot, SqpColorScale &colorScale) | ||
|
r920 | { | ||
// Displays color scale in plot | ||||
plot.plotLayout()->insertRow(0); | ||||
|
r1009 | plot.plotLayout()->addElement(0, 0, colorScale.m_Scale); | ||
colorScale.m_Scale->setType(QCPAxis::atTop); | ||||
colorScale.m_Scale->setMinimumMargins(QMargins{0, 0, 0, 0}); | ||||
|
r920 | |||
// Aligns color scale with axes | ||||
auto marginGroups = plot.axisRect()->marginGroups(); | ||||
for (auto it = marginGroups.begin(), end = marginGroups.end(); it != end; ++it) { | ||||
|
r1009 | colorScale.m_Scale->setMarginGroup(it.key(), it.value()); | ||
|
r920 | } | ||
// Set color scale properties | ||||
|
r1110 | colorScale.m_AutomaticThreshold = true; | ||
|
r920 | } | ||
|
r1281 | |||
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); | ||||
} | ||||
|
r920 | }; | ||
|
r915 | /** | ||
* 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 { | ||||
|
r1281 | explicit AxisHelper(std::shared_ptr<T> dataSeries) : m_DataSeries{dataSeries} {} | ||
|
r915 | |||
|
r1009 | void setProperties(QCustomPlot &plot, SqpColorScale &colorScale) override | ||
|
r915 | { | ||
|
r1281 | AxisSetter<T>::setProperties(plot, colorScale); | ||
|
r915 | } | ||
|
r1281 | 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; | ||||
|
r915 | }; | ||
} // namespace | ||||
|
r916 | 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 { | ||||
|
r1027 | return QString::number(value, NUMBER_FORMAT, NUMBER_PRECISION); | ||
|
r916 | } | ||
} | ||||
|
r1281 | std::unique_ptr<IAxisHelper> IAxisHelperFactory::create(const Variable &variable) noexcept | ||
|
r915 | { | ||
|
r1281 | 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; | ||||
|
r915 | } | ||
|
r1281 | |||
return std::make_unique<AxisHelper<IDataSeries> >(nullptr); | ||||
|
r915 | } | ||