SpectrogramList
安定性: 安定
主な用途
SpectrogramList は複数の Spectrogram をチャンネル情報付きでまとめて扱うために使います。
代表的なシグネチャ
SpectrogramList(data: list[Spectrogram])
SpectrogramList.to_matrix()
最小例
from gwexpy.spectrogram import Spectrogram, SpectrogramList
import numpy as np
lst = SpectrogramList([Spectrogram(np.ones((8, 16)), dt=1.0, df=1.0)])
mat = lst.to_matrix()
関連理論
関連チュートリアル
API リファレンス
詳細な生成済み API はこのページの下部に続きます。
継承元: PhaseMethodsMixin, UserList
Spectrogram オブジェクトのリスト。 参考: TimeSeriesList に似ていますが、2D Spectrogram 用です。
物理コンテキスト
SpectrogramList は、複数の時間周波数マップを別々の意味を保ったまま一括処理したいときに使います。繰り返し観測、複数センサ、同一イベントの別前処理などが典型です。
各要素は別々の provenance を持ったままバッチ描画できます
コンテナ自体は色スケール、正規化、ビン幅の一致を保証しません
よくある誤読
スケールや単位を揃えずに明るさだけで要素間比較する
同じリストに入っているだけで
dt/dfが一致していると思い込む積み重ね表示を見て、メタデータ確認なしに整列済みだと判断する
どのページへ進むか
各マップの解釈: Spectrogram
整列済みコレクション解析: SpectrogramMatrix
Note
Spectrogram オブジェクトはメモリを大量に消費する可能性があります。
ディープコピーを避けるため、可能な限り inplace=True を使用してください。
メソッド
__init__
__init__(self, initlist=None)
self を初期化します。正確なシグネチャは help(type(self)) を参照してください。
(PhaseMethodsMixin から継承)
angle
angle(self, unwrap: bool = False, deg: bool = False, **kwargs: Any) -> Any
phase(unwrap=unwrap, deg=deg) のエイリアス。
bootstrap_asd
bootstrap_asd(self, *args, **kwargs)
リスト内の各スペクトログラムからロバスト ASD を推定します（FrequencySeriesList を返します）。
crop
crop(self, t0, t1, inplace=False)
各スペクトログラムをクロップします。
crop_frequencies
crop_frequencies(self, f0, f1, inplace=False)
周波数をクロップします。
degree
degree(self, unwrap: 'bool' = False) -> "'SpectrogramList'"
各スペクトログラムの位相（度単位）を計算します。
interpolate
interpolate(self, dt, df, inplace=False)
各スペクトログラムを補間します。
phase
phase(self, unwrap: bool = False, deg: bool = False, **kwargs: Any) -> Any
データの位相を計算します。
パラメータ
unwrap : bool, optional
True の場合、不連続性を除去するために位相をアンラップします。デフォルトは False。
deg : bool, optional
True の場合、位相を度で返します。デフォルトは False（ラジアン）。
戻り値
Series or Matrix or Collection
データの位相。
plot
plot(self, **kwargs)
すべてのスペクトログラムを縦に積み重ねてプロットします。
plot_summary
plot_summary(self, **kwargs)
リストをスペクトログラムとパーセンタイルサマリーを並べてプロットします。
write
write(self, target, *args, **kwargs)
SpectrogramList をファイルに書き込みます。
HDF5 出力では layout を指定できます（デフォルトは GWpy 互換の dataset-per-entry）。
sgl.write("out.h5", format="hdf5") # GWpy互換（既定）
sgl.write("out.h5", format="hdf5", layout="group") # 旧形式（group-per-entry）
warning
信頼できないデータを pickle / shelve で読み込まないでください。ロード時に任意コード実行が起こり得ます。
pickle 可搬性メモ: gwexpy の SpectrogramList は unpickle 時に builtins の list を返します
（中身は GWpy の Spectrogram、読み込み側に gwexpy は不要です）。
radian
radian(self, unwrap: 'bool' = False) -> "'SpectrogramList'"
各スペクトログラムの位相（ラジアン単位）を計算します。
rebin
rebin(self, dt, df, inplace=False)
各スペクトログラムをリビンします。
to_matrix
to_matrix(self)
SpectrogramMatrix (N, Time, Freq) に変換します。
to_cupy / to_dask / to_jax / to_tensorflow / to_torch
各アイテムを対応するフレームワークのテンソル/配列に変換します。リストを返します。
write
write(self, target, *args, **kwargs)
リストをファイルに書き込みます。