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

リファレンス#

GWexpy API の技術的な仕様をまとめたリファレンスです。これらのページは autosummaryautodoc によりパッケージの docstring から直接生成され、このドキュメントのビルドに使用したパッケージを説明しています。ビルド情報を、利用中の環境の gwexpy.__version__ と照合してください。

注釈

API リファレンスの本文は、英語で書かれたソースの docstring から自動生成されています。これは本サイトの日本語版でも変わりません(翻訳されているのは周囲のナビゲーションやページ枠組みのみです)。docstring 自体の翻訳は、現時点ではスコープ外としています。

公開 API とサポート範囲#

利用手順が文書化された公開の入口を使用してください。生成されたメンバー一覧に名前があるだけでは、サポート対象の仕様であることを意味しません。実験的な機能や内部実装用の機能は、各ガイドに示された位置付けに従います。1.0 より前の API がすべて安定しているわけではありません。対応クラス、依存パッケージ、メタデータの保持範囲は、既知の制限I/O 対応一覧変換対応一覧を参照してください。

ドメイン別 API#

コンテナ

TimeSeriesFrequencySeriesSpectrogram とその行列・辞書形式、場、テーブル、ヒストグラム。

Time Series
解析と信号処理

スペクトル推定、フィルタリング、カップリング/統計、フィッティング、ノイズモデル、前処理、セグメント。

Spectral
相互運用性

外部の科学計算ライブラリやデータモデルと接続する to_*() / from_*()

Interoperability (gwexpy.interop)
入出力

GW データエコシステム全体にわたるマルチフォーマットの読み書き。

I/O
プロットとツール

プロット補助、時刻/GPS ユーティリティ、互換シム。

Plotting
GWpy との差分

GWexpy が GWpy に追加する、あるいは変更する点。

GWpy 差分 API インデックス