ResInsight/ApplicationLibCode/ProjectDataModel/Summary/RimSummaryRegressionAnalysisCurve.h
2023-06-28 21:46:11 +02:00

134 lines
5.1 KiB
C++

/////////////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 2023 Equinor 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.
//
/////////////////////////////////////////////////////////////////////////////////
#pragma once
#include "cafAppEnum.h"
#include "cafPdmField.h"
#include "cafPdmObject.h"
#include "RimSummaryCurve.h"
#include <utility>
namespace regression
{
class ExponentialRegression;
class LinearRegression;
class LogarithmicRegression;
class PolynomialRegression;
class PowerFitRegression;
} // namespace regression
class RimTimeAxisAnnotation;
//==================================================================================================
///
///
//==================================================================================================
class RimSummaryRegressionAnalysisCurve : public RimSummaryCurve
{
CAF_PDM_HEADER_INIT;
public:
enum class RegressionType
{
LINEAR,
POLYNOMIAL,
POWER_FIT,
EXPONENTIAL,
LOGARITHMIC,
LOGISTIC
};
enum class ForecastUnit
{
DAYS,
MONTHS,
YEARS,
};
RimSummaryRegressionAnalysisCurve();
~RimSummaryRegressionAnalysisCurve() override;
// Y Axis functions
std::vector<double> valuesY() const override;
std::vector<time_t> timeStepsY() const override;
// X Axis functions
std::vector<double> valuesX() const override;
std::vector<time_t> timeStepsX() const override;
static std::vector<time_t>
getOutputTimeSteps( const std::vector<time_t>& timeSteps, int forecastBackward, int forecastForward, ForecastUnit forecastUnit );
void updateDefaultValues();
protected:
void updateTimeAnnotations() override;
private:
void onLoadDataAndUpdate( bool updateParentPlot ) override;
QString createCurveAutoName() override;
QString curveExportDescription( const RifEclipseSummaryAddress& address ) const override;
// Overridden PDM methods
void fieldChangedByUi( const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue ) override;
void defineUiOrdering( QString uiConfigName, caf::PdmUiOrdering& uiOrdering ) override;
void defineEditorAttribute( const caf::PdmFieldHandle* field, QString uiConfigName, caf::PdmUiEditorAttribute* attribute ) override;
std::tuple<std::vector<time_t>, std::vector<double>, QString> computeRegressionCurve( const std::vector<time_t>& timeSteps,
const std::vector<double>& values ) const;
static std::vector<double> convertToDouble( const std::vector<time_t>& timeSteps );
static std::vector<time_t> convertToTimeT( const std::vector<double>& timeSteps );
static std::pair<std::vector<double>, std::vector<double>> getPositiveValues( const std::vector<double>& timeSteps,
const std::vector<double>& values );
static std::pair<std::vector<time_t>, std::vector<double>>
getInRangeValues( const std::vector<time_t>& timeSteps, const std::vector<double>& values, time_t minTimeStep, time_t maxTimeStep );
static QString generateRegressionText( const regression::LinearRegression& reg );
static QString generateRegressionText( const regression::PolynomialRegression& reg );
static QString generateRegressionText( const regression::PowerFitRegression& reg );
static QString generateRegressionText( const regression::LogarithmicRegression& reg );
static QString generateRegressionText( const regression::ExponentialRegression& reg );
static QString getXAxisUnitText();
static void appendTimeSteps( std::vector<time_t>& destinationTimeSteps, const std::set<QDateTime>& sourceTimeSteps );
caf::PdmField<caf::AppEnum<RegressionType>> m_regressionType;
caf::PdmField<time_t> m_minTimeStep;
caf::PdmField<time_t> m_maxTimeStep;
caf::PdmField<bool> m_showTimeSelectionInPlot;
caf::PdmField<int> m_polynomialDegree;
caf::PdmField<QString> m_expressionText;
caf::PdmField<int> m_forecastForward;
caf::PdmField<int> m_forecastBackward;
caf::PdmField<caf::AppEnum<ForecastUnit>> m_forecastUnit;
caf::PdmPointer<RimTimeAxisAnnotation> m_timeRangeAnnotation;
std::vector<double> m_valuesX;
std::vector<time_t> m_timeStepsX;
std::vector<double> m_valuesY;
std::vector<time_t> m_timeStepsY;
};