meridian.data.time_coordinates.TimeCoordinates

Meridian の入力データの時間座標のラッパー。

meridian.data.time_coordinates.TimeCoordinates(
    datetime_index: pd.DatetimeIndex
)

Meridian モデルでは、時間座標は型指定のない文字列として保存されます。ラベルとして処理され、直線的に増加する時間座標を表すという仮定がある以外に、モデルに対して固有の意味を持つことはありません。

このラッパー オブジェクトは、こうした時間座標から、「日付」の数値として扱われる値を抽出するために、追加の検証やメソッドを実行します。

datetime_index 指定された時間座標。インデックス登録可能な DatetimeIndex として解析されます。
all_dates 指定された時間座標（Python の datetime.date オブジェクトのリスト）。
all_dates_str 指定された時間座標（Meridian 形式の日付文字列のリスト）。これは、時間座標を単純なラベルとして処理するモデル内部で使用できます。
interval_days all_dates 内の 2 つの隣接する日付の間隔を返します。

メソッド

expand_selected_time_dims

ソースを表示

expand_selected_time_dims(
    start_date: (Date | None) = None, end_date: (Date | None) = None
) -> (list[datetime.date] | None)

選択した時間に基づいて、時間のディメンションの値を検証して返します。

start_date と end_date の両方が None の場合は、None を返します。指定する場合は、start_date と end_date の両方の日付を含む値が、入力データの時間座標内に存在する必要があります。

引数
start_date 選択した期間の開始日。None の場合は、入力データ内の最も早い時間のディメンション値を意味します。
end_date 選択した期間の終了日。None の場合は、入力データ内の最も遅い時間のディメンション値を意味します。

戻り値
選択した期間における入力データ内の時間ディメンションの値（datetime.date オブジェクト）のリスト。両方の引数が None の場合、または start_date と end_date が入力データ内の期間全体に一致している場合は、何もせずに None を渡します。

発生するエラー
start_date または end_date が入力データ内の時間ディメンションの座標にない場合は、ValueError が発生します。

from_dates

ソースを表示

@classmethod
from_dates(
    dates: _TimeCoordinateValues
) -> 'TimeCoordinates'

ポリモーフィックな一連の日付から TimeCoordinates を作成します。

引数
dates ポリモーフィックな一連の日付。Pandas DatetimeIndex または「YYYY-mm-dd」という文字列ラベルを含む Xarray DataArray のいずれかです。

戻り値
正規化された TimeCoordinates データクラス。

get_selected_dates

ソースを表示

get_selected_dates(
    selected_interval: (meridian.data.time_coordinates.DateInterval | None) = None
) -> list[datetime.date]

選択した間隔内のすべてのポイントを含む日付のシーケンスを作成します。

引数
selected_interval 開始時間と終了時間のタプル、または DateInterval proto。None の場合、all_dates が返されます。

戻り値
指定された開始日と終了日の間にある all_dates のサブセットを表す日付のシーケンス（Python の組み込みの datetime.date オブジェクト）。

発生するエラー
ValueError selected_interval が all_dates のサブセットでない場合。

__eq__

__eq__(
    other
)

self==value を返します。