"""
概要:
    ピークフィッティングと最適化過程の可視化を行うスクリプトです。

詳細説明:
    ガウス関数と一次式ベースラインを組み合わせたモデルを用いて、
    与えられたデータに対する非線形最小二乗法によるフィッティングを行います。
    最適化の過程を matplotlib を用いてリアルタイムに可視化します。

主な機能:
    ガウス関数とベースラインの計算。
    残差平方和を目的関数とした最適化。
    最適化過程のアニメーション表示。

関連リンク:
    peakfit10_usage
"""
import numpy as np
import matplotlib.pyplot as plt
from scipy.optimize import minimize


#method = "Nelder-Mead"
method = "bfgs"


def gaussian(x, A, mu, sigma):
    """
    概要:
        ガウス関数の値を計算します。

    詳細説明:
        入力データ x に対して、振幅 A、中心 mu、標準偏差 sigma のガウス関数を評価します。

    引数:
        :param x: 入力データ配列または数値。
        :type x: numpy.ndarray or float
        :param A: ガウス関数の振幅。
        :type A: float
        :param mu: ガウス関数の中心位置。
        :type mu: float
        :param sigma: ガウス関数の標準偏差。
        :type sigma: float

    戻り値:
        :returns: ガウス関数の計算結果。
        :rtype: numpy.ndarray or float
    """
    return A * np.exp(-(x - mu)**2 / (2 * sigma**2))


def baseline(x, b0, b1):
    """
    概要:
        一次式によるベースラインの値を計算します。

    詳細説明:
        入力データ x に対して、切片 b0 と傾き b1 を持つ直線関数の値を計算します。

    引数:
        :param x: 入力データ配列または数値。
        :type x: numpy.ndarray or float
        :param b0: ベースラインの切片。
        :type b0: float
        :param b1: ベースラインの傾き。
        :type b1: float

    戻り値:
        :returns: ベースラインの計算結果。
        :rtype: numpy.ndarray or float
    """
    return b0 + b1 * x


def model(x, p):
    """
    概要:
        フィッティング対象のモデル関数の値を計算します。

    詳細説明:
        パラメータのリスト p から A, mu, sigma, b0, b1 を取り出し、
        ガウス関数とベースラインの和を計算して返します。

    引数:
        :param x: 入力データ配列。
        :type x: numpy.ndarray
        :param p: モデルのパラメータ A, mu, sigma, b0, b1 を含むリストまたは配列。
        :type p: list or tuple or numpy.ndarray

    戻り値:
        :returns: モデル関数の計算結果。
        :rtype: numpy.ndarray
    """
    A, mu, sigma, b0, b1 = p
    return gaussian(x, A, mu, sigma) + baseline(x, b0, b1)


def objective(p, x, y):
    """
    概要:
        最適化のための目的関数を計算します。

    詳細説明:
        観測データ y とモデル関数の予測値の差の平方和を計算し、残差平方和を返します。

    引数:
        :param p: モデルのパラメータリスト。
        :type p: list or tuple or numpy.ndarray
        :param x: 入力データ配列。
        :type x: numpy.ndarray
        :param y: 観測データ配列。
        :type y: numpy.ndarray

    戻り値:
        :returns: 残差平方和の値。
        :rtype: float
    """
    return np.sum((y - model(x, p))**2)


def fit_with_visualization(x, y, p0):
    """
    概要:
        最適化の過程を可視化しながらフィッティングを行います。

    詳細説明:
        scipy.optimize.minimize を用いてパラメータの最適化を行い、
        各ステップごとのパラメータと誤差を履歴として記録します。
        また、各ステップのフィッティング結果をグラフに描画して更新します。

    引数:
        :param x: 入力データ配列。
        :type x: numpy.ndarray
        :param y: 観測データ配列。
        :type y: numpy.ndarray
        :param p0: 初期パラメータのリスト。
        :type p0: list or numpy.ndarray

    戻り値:
        :returns: 最終的な最適化パラメータ、パラメータの履歴リスト、誤差の履歴リストのタプル。
        :rtype: tuple
    """
    history_params = []
    history_error = []

    plt.ion()
    fig, ax = plt.subplots(figsize=(8, 5))

    # callback: 1 step ごとに呼ばれる
    def callback(p):
        """
        概要:
            最適化の各ステップで呼び出されるコールバック関数です。

        詳細説明:
            現在のパラメータ p を受け取り、誤差を計算して履歴に保存します。
            また、コンソールへの出力とグラフの更新を行います。

        引数:
            :param p: 現在のステップにおけるパラメータリスト。
            :type p: numpy.ndarray
        """
        err = objective(p, x, y)
        history_params.append(p.copy())
        history_error.append(err)

        print(f"step {len(history_params)}")
        print(f"params = {p}")
        print(f"error  = {err:.5f}")
        print("-" * 40)

        # グラフ更新
        ax.clear()
        ax.plot(x, y, "o", ms=4, label="data")
        ax.plot(x, model(x, p0), "--", label="initial")
        ax.plot(x, model(x, p), "-", label="current fit")
        ax.legend()
        ax.set_title(f"Iteration {len(history_params)}  Error={err:.4f}")
        plt.pause(0.1)

    # 最適化（Nelder-Mead は安定で可視化しやすい）
    result = minimize(
        objective,
        p0,
        args=(x, y),
        method=method,
        callback=callback,
        options={"maxiter": 200, "disp": True}
    )

    plt.ioff()
    plt.show()

    return result.x, history_params, history_error

if __name__ == "__main__":
    x = np.linspace(0, 10, 200)
    y_true = model(x, [5, 5, 0.8, 1.0, 0.1])
    y = y_true + 0.3 * np.random.randn(len(x))

    p0 = [3, 4, 1.0, 0.0, 0.0]  # わざと悪い初期値

    popt, params_hist, err_hist = fit_with_visualization(x, y, p0)

    print("最終パラメータ:", popt)