dynamic_time_warping_method.h

Go to the documentation of this file.

/* -------------------------------------------------------------------------*
*                               SPHinXsys                                   *
* --------------------------------------------------------------------------*
* SPHinXsys (pronunciation: s'finksis) is an acronym from Smoothed Particle *
* Hydrodynamics for industrial compleX systems. It provides C++ APIs for    *
* physical accurate simulation and aims to model coupled industrial dynamic *
* systems including fluid, solid, multi-body dynamics and beyond with SPH   *
* (smoothed particle hydrodynamics), a meshless computational method using  *
* particle discretization.                                                  *
*                                                                           *
* SPHinXsys is partially funded by German Research Foundation               *
* (Deutsche Forschungsgemeinschaft) DFG HU1527/6-1, HU1527/10-1             *
* and HU1527/12-1.                                                          *
*                                                                           *
* Portions copyright (c) 2017-2020 Technical University of Munich and       *
* the authors' affiliations.                                                *
*                                                                           *
* Licensed under the Apache License, Version 2.0 (the "License"); you may   *
* not use this file except in compliance with the License. You may obtain a *
* copy of the License at http://www.apache.org/licenses/LICENSE-2.0.        *
*                                                                           *
* --------------------------------------------------------------------------*/
#pragma once
#include "regression_test_base.hpp"

namespace SPH
{
    template<class ObserveMethodType>
    class RegressionTestDynamicTimeWarping : public RegressionTestTimeAveraged<ObserveMethodType>
    {
        /*identify the variable type from the parent class. */
        using VariableType = decltype(ObserveMethodType::type_indicator_);

    protected:
        std::string dtw_distance_filefullpath_;                    /* the path for DTW distance. */
        XmlEngine dtw_distance_xml_engine_in_;                     /* xml engine for dtw distance input. */
        XmlEngine dtw_distance_xml_engine_out_;                    /* xml engine for dtw distance output. */

        StdVec<Real> dtw_distance_, dtw_distance_new_;             /* the container of DTW distance between each pairs. */

        Real calculatePNorm(Real variable_a, Real variable_b);
        Real calculatePNorm(Vecd variable_a, Vecd variable_b);
        Real calculatePNorm(Matd variable_a, Matd variable_b);

        StdVec<Real> calculateDTWDistance(DoubleVec<VariableType> dataset_a_, DoubleVec<VariableType> dataset_b_);

    public:
        template<typename... ConstructorArgs>
        explicit RegressionTestDynamicTimeWarping(ConstructorArgs &&...args) :
            RegressionTestTimeAveraged<ObserveMethodType>(std::forward<ConstructorArgs>(args)...),
            dtw_distance_xml_engine_in_("dtw_distance_xml_engine_in", "dtw_distance"),
            dtw_distance_xml_engine_out_("dtw_distance_xml_engine_out", "dtw_distance")
        {
            dtw_distance_filefullpath_ = this->input_folder_path_ + "/" + this->body_name_ + "_"
                + this->quantity_name_ + "_dtwdistance.xml";
        };
        virtual ~RegressionTestDynamicTimeWarping() {};

        void settingupTheTest(); 
        void readDTWDistanceFromXml(); 
        void updateDTWDistance(); 
        void writeDTWDistanceToXml(); /* write the updated DTWDistance to .xml file.*/
        bool compareDTWDistance(Real threshold_value); /* compare the DTWDistance if converged. */
        void resultTest(); 
        void generateDataBase(Real threshold_value, string filter = "false")
        {
            this->writeXmlToXmlFile();
            this->readXmlFromXmlFile();
            this->transposeTheIndex();
            if (this->converged == "false")
            {
                settingupTheTest();
                if (filter == "true")
                    this->filterExtremeValues();
                readDTWDistanceFromXml();
                /* loop all existed result to get maximum dtw distance. */
                for (int n = 0; n != (this->number_of_run_ - 1); ++n)
                {
                    this->readResultFromXml(n);
                    updateDTWDistance();
                }
                this->writeResultToXml(this->number_of_run_ - 1);
                writeDTWDistanceToXml();
                compareDTWDistance(threshold_value);
            }
            else
                std::cout << "The results have been converged." << endl;
        };

        void newResultTest(string filter = "false")
        {
            this->writeXmlToXmlFile();
            this->readXmlFromXmlFile();
            this->transposeTheIndex();
            settingupTheTest();
            if (filter == "true")
                this->filterExtremeValues();
            readDTWDistanceFromXml();
            for (int n = 0; n != this->number_of_run_; ++n)
            {
                this->result_filefullpath_ = this->input_folder_path_ + "/" + this->body_name_
                    + "_" + this->quantity_name_ + "_Run_" + std::to_string(n) + "_result.xml";
                if (!fs::exists(this->result_filefullpath_))
                {
                    std::cout << "This result has not been preserved and will not be compared." << endl;
                    continue;
                }
                this->readResultFromXml(n);
                resultTest();
            }
            std::cout << "The result of " << this->quantity_name_
                << " is correct based on the dynamic time warping regression test!" << endl;
        };
    };
}