Skip to content

API Reference / APIリファレンス

API reference for the main components and functions of the Wandas library. Wandasライブラリの主要コンポーネントと関数のAPIリファレンスです。

Top-Level API / トップレベルAPI

The primary top-level API is intentionally small: 主要なトップレベル API は意図的に小さくしています。

  • wd.read(...) - Read external source data into a ChannelFrame / 外部ソースデータを ChannelFrame として読み込む
  • wd.load(...) - Load Wandas native WDF files / Wandas native WDF ファイルを読み込む
  • wd.from_numpy(...) - Create a ChannelFrame from a NumPy array / NumPy 配列から ChannelFrame を作る
  • wd.from_folder(...) - Create a ChannelFrameDataset from a folder / フォルダから ChannelFrameDataset を作る
  • wd.ChannelFrame, wd.SpectralFrame, wd.CepstralFrame, wd.SpectrogramFrame, wd.CepstrogramFrame, wd.NOctFrame, wd.ChannelFrameDataset - Public frame classes / 公開フレームクラス

read_wav(), read_csv(), and from_ndarray() are compatibility helpers for existing code. New examples use read() and from_numpy(). read_wav()、read_csv()、from_ndarray() は既存コード向けの互換ヘルパーです。新しい例では read() と from_numpy() を使います。

Modules / モジュール

Browse the detailed API documentation for each module: 各モジュールの詳細なAPIドキュメントを参照してください：

Core Module / コアモジュール

The core module provides the basic functionality of Wandas, including base classes and metadata management. コアモジュールはWandasの基本機能（基底クラスやメタデータ管理など）を提供します。

  • BaseFrame - Base class for all frames / すべてのフレームの基底クラス
  • ChannelMetadata - Channel metadata management / チャンネルメタデータ管理

Frames Module / フレームモジュール

The frames module defines different types of data frames for time-domain, frequency-domain, and time-frequency-domain data. フレームモジュールは、時間領域、周波数領域、時間-周波数領域データのための様々なデータフレームを定義します。

  • ChannelFrame - Time-domain waveform data / 時間領域波形データ
  • SpectralFrame - Frequency-domain data / 周波数領域データ
  • CepstralFrame - Quefrency-domain data / ケフレンシー領域データ
  • SpectrogramFrame - Time-frequency domain data / 時間-周波数領域データ
  • CepstrogramFrame - Time-quefrency domain data / 時間-ケフレンシー領域データ
  • NOctFrame - N-octave band analysis / Nオクターブバンド解析
  • RoughnessFrame - Psychoacoustic roughness analysis results / 心理音響ラフネス解析結果

Processing Module / 処理モジュール

The processing module provides various processing functions for audio data, including filters, effects, and analysis. 処理モジュールは、フィルタ、エフェクト、分析など、オーディオデータに対する様々な処理機能を提供します。

  • Filters / フィルター - Digital filters for signal processing / 信号処理用デジタルフィルター
  • Effects / エフェクト - Audio effects processing / オーディオエフェクト処理
  • Spectral / スペクトル - Spectral analysis functions / スペクトル解析機能
  • Temporal / 時間領域 - Time-domain processing / 時間領域処理
  • Stats / 統計 - Statistical analysis / 統計分析

IO Module / 入出力モジュール

The IO module provides file reading and writing functions for various formats. 入出力モジュールは、様々なフォーマットのファイル読み書き機能を提供します。

Visualization Module / 可視化モジュール

The visualization module provides data visualization functions using Matplotlib. 可視化モジュールは、Matplotlibを使用したデータ視覚化機能を提供します。

  • Plotting functions / プロッティング関数
  • Plot strategies for different frame types / 異なるフレームタイプ用のプロット戦略

Utilities Module / ユーティリティモジュール

The utilities module provides auxiliary functions including dataset management and sample generation. ユーティリティモジュールは、データセット管理やサンプル生成などの補助機能を提供します。

  • Frame datasets / フレームデータセット - Batch processing of audio files / 音声ファイルのバッチ処理
  • Sample generation / サンプル生成 - Generate test signals / テスト信号生成
  • Type definitions / 型定義

Datasets Module / データセットモジュール

The datasets module provides sample data for testing and demonstrations. データセットモジュールは、テストやデモ用のサンプルデータを提供します。

  • Sample audio data / サンプル音声データ
  • Example datasets / サンプルデータセット

Pipeline Recipes API

The pipeline module records a public Frame workflow as a portable, validated RecipePlan and applies it to named runtime inputs. pipelineモジュールは公開Frame処理をportableなRecipePlanとして記録し、名前付きの runtime入力へ適用します。