///////////////////////////////////////////////////////////////////////////////// // // 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 // for more details. // ///////////////////////////////////////////////////////////////////////////////// #pragma once #include "cafAppEnum.h" #include "cafPdmField.h" #include "cafPdmObject.h" #include "RimSummaryCurve.h" #include 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 valuesY() const override; std::vector timeStepsY() const override; // X Axis functions std::vector valuesX() const override; std::vector timeStepsX() const override; static std::vector getOutputTimeSteps( const std::vector& 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, QString> computeRegressionCurve( const std::vector& timeSteps, const std::vector& values ) const; static std::vector convertToDouble( const std::vector& timeSteps ); static std::vector convertToTimeT( const std::vector& timeSteps ); static std::pair, std::vector> getPositiveValues( const std::vector& timeSteps, const std::vector& values ); static std::pair, std::vector> getInRangeValues( const std::vector& timeSteps, const std::vector& 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& destinationTimeSteps, const std::set& sourceTimeSteps ); caf::PdmField> m_regressionType; caf::PdmField m_minTimeStep; caf::PdmField m_maxTimeStep; caf::PdmField m_showTimeSelectionInPlot; caf::PdmField m_polynomialDegree; caf::PdmField m_expressionText; caf::PdmField m_forecastForward; caf::PdmField m_forecastBackward; caf::PdmField> m_forecastUnit; caf::PdmPointer m_timeRangeAnnotation; std::vector m_valuesX; std::vector m_timeStepsX; std::vector m_valuesY; std::vector m_timeStepsY; };