"""
概要:
    非線形最小二乗法を用いたカーブフィットのアニメーションを表示するスクリプトです。

詳細説明:
    scipy.optimize.minimizeを使用してガウス関数のフィッティングを行い、
    その過程をmatplotlibでリアルタイムにアニメーション描画します。
    コマンドライン引数で初期のパラメータ a、x0、w を指定できます。

関連リンク:
    nlsq_curvefit2_animation_usage
"""
import sys
import numpy as np
import matplotlib.pyplot as plt
from matplotlib.font_manager import FontProperties
from scipy.optimize import minimize

# 日本語フォントの設定
fp = FontProperties(family='MS Gothic')

# パラメータの初期値
p0 = [2.0, 2.0, 0.5]

argv = sys.argv
narg = len(argv)
if narg == 1:
    print(f"\nUsage: {argv[0]} [a] [x0] [w]\n")
    sys.exit(1)
if narg >= 2:
    p0[0] = float(argv[1])
if narg >= 3:
    p0[1] = float(argv[2])
if narg >= 4:
    p0[2] = float(argv[3])

print()
print(f"Initial parameters: a={p0[0]}, x0={p0[1]}, w={p0[2]}")

# フィットする関数の定義
def func(x, a, x0, w):
    """
    概要:
        フィットに用いるガウス関数です。

    引数:
        :param x: x座標のデータ配列。
        :type x: numpy.ndarray
        :param a: 振幅パラメータ。
        :type a: float
        :param x0: 中心座標パラメータ。
        :type x0: float
        :param w: 幅パラメータ。
        :type w: float

    戻り値:
        :returns: ガウス関数の計算結果の配列。
        :rtype: numpy.ndarray
    """
    return a * np.exp(-(x - x0)**2 / w**2)

# データの生成
xdata = np.linspace(-10, 10, 100)
y_data = func(xdata, 1.0, 0.0, 2.0) + 0.1 * np.random.normal(size=xdata.size)

# 残差関数の定義
def residuals(params, x, y):
    """
    概要:
        フィッティングの残差を計算します。

    引数:
        :param params: 最適化対象のパラメータリスト。
        :type params: list または numpy.ndarray
        :param x: x座標のデータ配列。
        :type x: numpy.ndarray
        :param y: y座標のデータ配列。
        :type y: numpy.ndarray

    戻り値:
        :returns: データとモデルの差分残差配列。
        :rtype: numpy.ndarray
    """
    return y - func(x, *params)

# 最小化する関数の定義
def minimize_func(params):
    """
    概要:
        最小化の目的関数である残差平方和を計算します。

    引数:
        :param params: 最適化対象のパラメータリスト。
        :type params: list または numpy.ndarray

    戻り値:
        :returns: 残差の二乗和。
        :rtype: float
    """
    return np.sum(residuals(params, xdata, y_data)**2)

# プロットの設定
fig, ax = plt.subplots()
ax.plot(xdata, y_data, 'bo', label='データ')

line_initial, = ax.plot(xdata, func(xdata, *p0), 'g--', label='初期推定値')
line_fit, = ax.plot(xdata, func(xdata, *p0), 'r-', label='フィット')
ax.legend(prop=fp)
plt.ion()

# callback
iter = 0
def callback(params):
    """
    概要:
        最適化の各反復で呼び出されプロットを更新します。

    詳細説明:
        matplotlibを用いて現在のパラメータでの関数曲線をリアルタイムに描画し、
        コンソールに現在のイテレーション回数とパラメータを表示します。

    引数:
        :param params: 現在のイテレーションにおけるパラメータリスト。
        :type params: numpy.ndarray

    戻り値:
        :returns: なし。
        :rtype: None
    """
    global iter
    iter += 1
    print(f"Iteration #{iter}: params = {params}")
    line_fit.set_data(xdata, func(xdata, *params))
    plt.pause(0.1)
    
# fフィッティングの実行
result = minimize(minimize_func, 
                  p0, 
                  callback=callback, 
                  options={'disp': True})

# 最終結果のプロット
ax.plot(xdata, func(xdata, *result.x), 'b-', label='最終フィット')
ax.legend(prop=fp)
plt.ioff()
plt.show()

print("最適パラメータ: ", result.x)