ResInsight/ApplicationLibCode/ProjectDataModel/Summary/RimSummaryPlotAxisFormatter.cpp
2024-10-22 07:28:43 +02:00

370 lines
13 KiB
C++

/////////////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 2016 Statoil ASA
//
// ResInsight is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// ResInsight is distributed in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or
// FITNESS FOR A PARTICULAR PURPOSE.
//
// See the GNU General Public License at <http://www.gnu.org/licenses/gpl.html>
// for more details.
//
/////////////////////////////////////////////////////////////////////////////////
#include "RimSummaryPlotAxisFormatter.h"
#include "RiaDefines.h"
#include "RiaNumberFormat.h"
#include "Summary/RiaSummaryCurveDefinition.h"
#include "RifSummaryReaderInterface.h"
#include "RimAsciiDataCurve.h"
#include "RimPlotAxisProperties.h"
#include "RimSummaryCase.h"
#include "RimSummaryCurve.h"
#include "RimSummaryEnsemble.h"
#include "Tools/RimPlotAxisTools.h"
#include "RiuQtChartsPlotWidget.h"
#include "RiuSummaryQuantityNameInfoProvider.h"
#include "RiuSummaryQwtPlot.h"
#include <cmath>
#include <set>
#include <string>
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimSummaryPlotAxisFormatter::RimSummaryPlotAxisFormatter( RimPlotAxisProperties* axisProperties,
const std::vector<RimSummaryCurve*>& summaryCurves,
const std::vector<RiaSummaryCurveDefinition>& curveDefinitions,
const std::vector<RimAsciiDataCurve*>& asciiCurves,
const std::set<QString>& timeHistoryCurveQuantities )
: m_axisProperties( axisProperties )
, m_summaryCurves( summaryCurves )
, m_curveDefinitions( curveDefinitions )
, m_asciiDataCurves( asciiCurves )
, m_timeHistoryCurveQuantities( timeHistoryCurveQuantities )
{
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimSummaryPlotAxisFormatter::applyAxisPropertiesToPlot( RiuPlotWidget* plotWidget )
{
if ( !plotWidget ) return;
RiuPlotAxis axis = m_axisProperties->plotAxis();
{
QString axisTitle = m_axisProperties->customTitle();
if ( m_axisProperties->useAutoTitle() ) axisTitle = autoAxisTitle();
Qt::AlignmentFlag titleAlignment = Qt::AlignCenter;
if ( m_axisProperties->titlePosition() == RimPlotAxisPropertiesInterface::AXIS_TITLE_END )
{
titleAlignment = Qt::AlignRight;
}
QString objectName = createAxisObjectName();
m_axisProperties->setNameAndAxis( objectName, axisTitle, axis.axis(), axis.index() );
plotWidget->setAxisTitleText( axis, axisTitle );
bool titleBold = false;
plotWidget->setAxisFontsAndAlignment( axis, m_axisProperties->titleFontSize(), m_axisProperties->valuesFontSize(), titleBold, titleAlignment );
plotWidget->setAxisTitleEnabled( axis, true );
}
RimPlotAxisTools::applyAxisScaleDraw( plotWidget, axis, m_axisProperties );
#ifdef USE_QTCHARTS
auto qtChartsPlotWidget = dynamic_cast<RiuQtChartsPlotWidget*>( plotWidget );
if ( qtChartsPlotWidget )
{
auto mapToRiaNumberFormatType = []( RimPlotAxisProperties::NumberFormatType formatType )
{
if ( formatType == RimPlotAxisProperties::NumberFormatType::NUMBER_FORMAT_DECIMAL )
return RiaNumberFormat::NumberFormatType::FIXED;
if ( formatType == RimPlotAxisProperties::NumberFormatType::NUMBER_FORMAT_SCIENTIFIC )
return RiaNumberFormat::NumberFormatType::SCIENTIFIC;
return RiaNumberFormat::NumberFormatType::AUTO;
};
auto formatType = mapToRiaNumberFormatType( m_axisProperties->numberFormat() );
QString format = RiaNumberFormat::sprintfFormat( formatType, m_axisProperties->decimalCount() );
qtChartsPlotWidget->setAxisFormat( axis, format );
}
#endif
{
if ( m_axisProperties->isLogarithmicScaleEnabled() )
{
bool isLogScale = plotWidget->axisScaleType( axis ) == RiuQwtPlotWidget::AxisScaleType::LOGARITHMIC;
if ( !isLogScale )
{
plotWidget->setAxisScaleType( axis, RiuQwtPlotWidget::AxisScaleType::LOGARITHMIC );
plotWidget->setAxisMaxMinor( axis, 5 );
}
}
else
{
bool isLinearScale = plotWidget->axisScaleType( axis ) == RiuQwtPlotWidget::AxisScaleType::LINEAR;
if ( !isLinearScale )
{
plotWidget->setAxisScaleType( axis, RiuQwtPlotWidget::AxisScaleType::LINEAR );
plotWidget->setAxisMaxMinor( axis, 3 );
}
}
}
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RimSummaryPlotAxisFormatter::autoAxisTitle() const
{
std::map<std::string, std::set<std::string>> unitToQuantityNameMap;
auto addToUnitToQuantityMap = [&]( const std::string& unitText, const RifEclipseSummaryAddress& sumAddress )
{
size_t cutPos = sumAddress.vectorName().find( ':' );
if ( cutPos == std::string::npos ) cutPos = -1;
std::string titleText;
const std::string& quantityName = sumAddress.vectorName().substr( cutPos + 1 );
if ( sumAddress.isCalculated() )
{
titleText = shortCalculationName( quantityName );
}
else
{
if ( m_axisProperties->showDescription() )
{
auto candidateName = quantityName;
if ( sumAddress.isHistoryVector() ) candidateName = quantityName.substr( 0, quantityName.size() - 1 );
titleText = RiuSummaryQuantityNameInfoProvider::instance()->longNameFromVectorName( candidateName );
}
if ( m_axisProperties->showAcronym() )
{
if ( !titleText.empty() )
{
titleText += " (";
titleText += quantityName;
titleText += ")";
}
else
{
titleText += quantityName;
}
}
}
unitToQuantityNameMap[unitText].insert( titleText );
};
for ( RimSummaryCurve* rimCurve : m_summaryCurves )
{
RifEclipseSummaryAddress sumAddress;
std::string unitText;
if ( m_axisProperties->plotAxis().isHorizontal() )
{
sumAddress = rimCurve->summaryAddressX();
unitText = rimCurve->unitNameX();
}
else if ( rimCurve->axisY() == m_axisProperties->plotAxis() )
{
sumAddress = rimCurve->summaryAddressY();
unitText = rimCurve->unitNameY();
}
addToUnitToQuantityMap( unitText, sumAddress );
}
for ( const RiaSummaryCurveDefinition& curveDef : m_curveDefinitions )
{
RifEclipseSummaryAddress sumAddress;
if ( m_axisProperties->plotAxis().isHorizontal() )
{
sumAddress = curveDef.summaryAddressX();
}
else
{
sumAddress = curveDef.summaryAddressY();
}
std::string unitText;
if ( curveDef.ensemble() )
{
std::vector<RimSummaryCase*> sumCases = curveDef.ensemble()->allSummaryCases();
if ( !sumCases.empty() && sumCases[0] && sumCases[0]->summaryReader() )
{
unitText = sumCases[0]->summaryReader()->unitName( sumAddress );
}
}
else
{
RimSummaryCase* sumCase = curveDef.summaryCaseY();
if ( m_axisProperties->plotAxis().isHorizontal() )
{
sumCase = curveDef.summaryCaseX();
}
if ( sumCase && sumCase->summaryReader() )
{
unitText = sumCase->summaryReader()->unitName( sumAddress );
}
}
addToUnitToQuantityMap( unitText, sumAddress );
}
QString assembledYAxisText;
QString scaleFactorText = RimPlotAxisTools::scaleFactorText( m_axisProperties );
for ( const auto& unitIt : unitToQuantityNameMap )
{
// Insert line shift if multiple quantities are present, otherwise insert space
bool insertLineShift = unitIt.second.size() > 1;
for ( const auto& quantIt : unitIt.second )
{
assembledYAxisText += QString::fromStdString( quantIt );
insertLineShift ? ( assembledYAxisText += "<br>" ) : ( assembledYAxisText += " " );
}
if ( m_axisProperties->showUnitText() )
{
QString unitAndScaleText = QString::fromStdString( unitIt.first ) + scaleFactorText;
if ( !unitAndScaleText.isEmpty() )
{
assembledYAxisText += "[" + unitAndScaleText + "] ";
}
}
}
if ( !m_timeHistoryCurveQuantities.empty() )
{
if ( !assembledYAxisText.isEmpty() )
{
assembledYAxisText += " : ";
}
for ( const auto& timeQuantity : m_timeHistoryCurveQuantities )
{
assembledYAxisText += timeQuantity + " ";
}
}
return assembledYAxisText;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RimSummaryPlotAxisFormatter::createAxisObjectName() const
{
std::set<std::string> vectorNames;
auto addVectorNames = [&]( const RifEclipseSummaryAddress& sumAddress )
{
size_t cutPos = sumAddress.vectorName().find( ':' );
if ( cutPos == std::string::npos ) cutPos = -1;
std::string name;
const std::string& quantityName = sumAddress.vectorName().substr( cutPos + 1 );
if ( sumAddress.isCalculated() )
{
name = shortCalculationName( quantityName );
}
else
{
name = quantityName;
}
vectorNames.insert( name );
};
for ( RimSummaryCurve* rimCurve : m_summaryCurves )
{
if ( rimCurve->axisY() == m_axisProperties->plotAxis() )
{
addVectorNames( rimCurve->summaryAddressY() );
}
else if ( rimCurve->axisX() == m_axisProperties->plotAxis() )
{
addVectorNames( rimCurve->summaryAddressX() );
}
}
for ( const RiaSummaryCurveDefinition& curveDef : m_curveDefinitions )
{
if ( m_axisProperties->plotAxis().isVertical() )
{
addVectorNames( curveDef.summaryAddressY() );
}
else
{
addVectorNames( curveDef.summaryAddressX() );
}
}
QString assembledAxisObjectName;
for ( const auto& vectorName : vectorNames )
{
assembledAxisObjectName += QString::fromStdString( vectorName ) + " ";
}
if ( !m_timeHistoryCurveQuantities.empty() )
{
if ( !assembledAxisObjectName.isEmpty() )
{
assembledAxisObjectName += " : ";
}
for ( const auto& timeQuantity : m_timeHistoryCurveQuantities )
{
assembledAxisObjectName += timeQuantity + " ";
}
}
const int maxChars = 100;
QFont font;
QFontMetrics fm( font );
assembledAxisObjectName = fm.elidedText( assembledAxisObjectName, Qt::ElideRight, maxChars );
return assembledAxisObjectName;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::string RimSummaryPlotAxisFormatter::shortCalculationName( const std::string& calculationName )
{
QString calculationShortName = QString::fromStdString( calculationName );
int indexOfFirstSpace = calculationShortName.indexOf( ' ' );
if ( indexOfFirstSpace > -1 && indexOfFirstSpace < calculationShortName.size() )
{
calculationShortName = calculationShortName.left( indexOfFirstSpace );
}
return calculationShortName.toStdString();
}