開発版ドキュメント · 0.2.3 30c2f8ba · 入門例の検証対象 0.2.3 · 版情報 · 既知の制限

GWpy 差分 API インデックス#

このページは、GWexpy が GWpy に対して追加するものを 差分中心で検索するためのものです。完全な API 一覧ではありません。API 全体については API リファレンスを参照してください。

まず移行の入口を知りたい場合は、GWpy ユーザーのための GWexpy に戻ってください。

カテゴリから始める#

カテゴリ	次のことをしたいときに参照：	代表的な項目	エントリポイント
マルチチャンネル	多数のチャンネルをまとめて処理する	`to_matrix()`, `TimeSeriesMatrix`, `FrequencySeriesMatrix`	行列チュートリアル
追加メソッド群	外部関数呼び出しをデータオブジェクト側へ寄せたい	`.find_peaks()`, `.fit()`, `.hht()`, `.arima()`	追加メソッド
フィールド API	時空のような構造や 4 次元データ構造を扱う	`ScalarField`, `FieldList`, `FieldDict`, `fft_space()`	フィールド API
共有／互換性	結果共有の挙動を理解する	透過的 Pickle	共有・互換性

詳細インデックス#

マルチチャンネル#

API の種類	代表的な API	安定性	GWpy に対して追加されるもの	詳細
変換メソッド	`TimeSeriesDict.to_matrix()` → `TimeSeriesMatrix`	安定	チャンネルのコレクションを、スペクトル解析や統計ワークフロー向けのバッチ解析コンテナに変換する	行列チュートリアル, TimeSeriesDict, TimeSeriesMatrix
変換メソッド	`FrequencySeriesDict.to_matrix()` → `FrequencySeriesMatrix`	安定	周波数系列オブジェクトのコレクションを、ペアワイズ解析やバッチ解析に適したコンテナに変換する	FrequencySeriesDict, FrequencySeriesMatrix
変換メソッド	`SpectrogramDict.to_matrix()` / `SpectrogramList.to_matrix()` → `SpectrogramMatrix`	安定	時間周波数のコレクションを、後段処理向けの行列スタイルのコンテナに移せるようにする	SpectrogramDict, SpectrogramList, SpectrogramMatrix

ファミリー固有の `to_matrix()` 契約（現行の安定挙動）#

to_matrix() は現時点では意図的にファミリー固有です。どの変換チェックとメタデータ保証が適用されるかの公開契約として、この表を利用してください。

ファミリー	コレクションのエントリポイント	軸ポリシー	リサンプリング／許容誤差	単位ポリシー	ラベル／往復変換の注記
`TimeSeries`	`TimeSeriesDict.to_matrix()` と `TimeSeriesList.to_matrix()`	`align_timeseries_collection()` によって共通の時間グリッドに整列します。整列が成功すれば、軸の厳密な一致は不要です。	既定は `align="intersection"`。整列用のキーワード引数（`method` や `tolerance` を含む）を整列ヘルパーに転送します。	この変換経路では、元の `TimeSeries.unit` はセル単位の行列メタデータに引き継がれません。メタデータを別途設定しない限り、復元された要素は無次元になります。	辞書のキーは要素名に書き込まれます。往復変換の辞書キーには、生成された行キー（`row0`、`row1`、…）が使われます。
`FrequencySeries`	`FrequencySeriesDict.to_matrix()`	サンプル長の一致のみを確認します。周波数座標値は先頭要素から取得されます。	リサンプリングも許容誤差パラメータもありません。	要素ごとの `unit` / `name` / `channel` は行列メタデータに保持され、往復変換で復元されます。	辞書キーは行キーとして保持されます。出力列は単一の `value` です。
`Spectrogram`	`SpectrogramDict.to_matrix()` と `SpectrogramList.to_matrix()`	先頭軸の単位に変換した後、形状が等しく、かつ時間／周波数軸が等しいことを要求します。	リサンプリングも許容誤差パラメータもありません。単位変換後の比較は厳密です。	要素ごとの `unit` / `name` / `channel` は保持されます。全体の行列単位は、すべての要素が同じ単位を共有する場合にのみ設定されます。	辞書キーは行キーとして保持されます。リストの行は生成されます（`batch0`、`batch1`、…）。
フィールド	SeriesMatrix の `to_matrix()` コレクション API はなし	SeriesMatrix の変換ではなく、`FieldList` / `FieldDict` の検証ルールを使用します。	フィールド検証は独自の軸許容誤差チェックを持ちます。	単位はフィールドオブジェクト側に残ります。`to_array()` は生の配列を返します。	SeriesMatrix の往復変換経路ではありません。

追加メソッド#

API の種類	代表的な API	安定性	GWpy に対して追加されるもの	詳細
インスタンスメソッド	`.find_peaks()`	安定	配列に落とすことなく、データオブジェクト上で直接ピーク検出を実行できるようにする	周波数系列チュートリアル, TimeSeries, FrequencySeries
インスタンスメソッド	`.fit()`	安定	データオブジェクトから直接フィッティングのワークフローを開始する	フィッティング, Fitting Reference
インスタンスメソッド	`.hht()`	実験的	ヒルベルト–黄（HHT）変換解析をオブジェクトメソッドとして提供する	HHT, TimeSeries
インスタンスメソッド	`.arima()`	実験的	時系列のモデリングと予測をオブジェクトメソッドとして提供する	ARIMA, TimeSeries

フィールド API#

API の種類	代表的な API	安定性	GWpy に対して追加されるもの	詳細
クラス	`ScalarField`	実験的	時間軸と空間軸を持つ、メタデータ対応の 4 次元フィールドコンテナを導入する	Field API 入門, ScalarField
インスタンスメソッド	`ScalarField.fft_space()`	実験的	Field オブジェクトモデルの中にとどまったまま空間領域変換を実行する	Field API 入門, ScalarField
コレクション	`FieldList` / `FieldDict`	実験的	複数の `ScalarField` オブジェクトをまとめて、バッチ処理と共有的な検証を行う	Field API 入門, FieldList, FieldDict

共有／互換性#

API の種類	代表的な API／挙動	安定性	GWpy に対して追加されるもの	詳細
挙動	透過的 Pickle	安定	GWexpy が生成したオブジェクトを、受け取り側に GWexpy が無くても GWpy の基底オブジェクトとして復元できるようにする	GWpy ユーザーのための GWexpy, インストールガイド

このページが重複させないもの#

直接 I/O 形式については、ファイル I/O 対応フォーマットガイドを参照してください。
外部ライブラリ変換の一覧については、Interop / 変換ガイドを参照してください。
API 全体については、API リファレンスを参照してください。