Le4MusicUtils

java.lang.Object
- jp.ac.kyoto_u.kuis.le4music.Le4MusicUtils

```
public final class Le4MusicUtils
extends java.lang.Object
```
音響信号処理に便利なstaticメソッドを提供するクラスです．

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static double`	`f0LowerBound` 基本周波数の下限 (Hz)
`static int`	`f0Resolution` 基本周波数のオクターブあたりの解像度
`static double`	`f0Standard` 基本周波数の基準値 (Hz)
`static double`	`f0UpperBound` 基本周波数の上限 (Hz)
`static double`	`frameDuration` 短時間分析におけるフレームの長さのデフォルト値（秒）
`static double`	`frameInterval` Recorder および Player がフレームを通知する間隔のデフォルト値（秒）
`static java.lang.String`	`outputImageExt` 出力画像のデフォルト拡張子
`static double`	`pdfPrintableHeight`
`static double`	`pdfPrintableWidth`
`static double`	`sampleRate` 録音時のサンプリング周波数のデフォルト値 (Hz)
`static int`	`sampleSizeInBits` 録音時の量子化ビット数のデフォルト値
`static double`	`shiftDuration` 短時間分析におけるフレームのシフト長のデフォルト値（秒）
`static double`	`spectrogramDuration` スペクトログラムの長さのデフォルト値（秒）
`static double`	`spectrumAmplitudeLowerBound` スペクトルプロット時の振幅範囲下限のデフォルト値 (dB)
`static double`	`spectrumAmplitudeUpperBound` スペクトルプロット時の振幅範囲上限のデフォルト値 (dB)
`static boolean`	`verbose` コマンドラインオプション "-v" や "--verbose" 処理用．
`static double`	`waveformAmplitudeBounds` 波形プロット時の振幅範囲のデフォルト値，0を中心としてこの値のプラスマイナス両方向．

メソッドのサマリー

すべてのメソッド staticメソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`static int`	`argmax(double[] a)` 配列中の最大値のインデックスを返す．
`static double`	`autoTickUnit(double x)` `NumberAxis`を生成する際に、範囲を表す`double`値に対して「ちょうどいい」tickUnit（データ単位の各大目盛の間の値）を返す。
`static double[]`	`blackmanharris(int size)` 与えられた長さおよび範囲（標準偏差の何倍か）をもつブラックマンハリス窓を返す．
`static org.apache.commons.math3.complex.Complex[]`	`fft(org.apache.commons.math3.complex.Complex[] src)` 入力複素配列をフーリエ変換する．
`static org.apache.commons.math3.complex.Complex[]`	`fft(double[] src)` 入力実配列をフーリエ変換する．
`static double[]`	`gaussian(int size)` 与えられた長さをもつガウス窓を返す．
`static double[]`	`gaussian(int size, double sigmas)` 与えられた長さおよび範囲（標準偏差の何倍か）をもつガウス窓を返す．
`static java.lang.String[]`	`getFilenameWithImageExt(java.util.Optional<java.lang.String> filenameOpt, java.lang.String defaultFilename)`
`static double[]`	`hamming(int size)` 与えられた長さのハミング窓 (hamming window) を返す．
`static double[]`	`hanning(int size)` 与えられた長さのハン窓 (hann window) を返す．
`static int`	`highestOneBit(int n)` 与えられた数nのビットが1である最大の桁を求める．
`static double`	`hz2nn(double hz)` ヘルツ単位の周波数をMIDIノートナンバーに変換する．
`static org.apache.commons.math3.complex.Complex[]`	`ifft(org.apache.commons.math3.complex.Complex[] src)` 入力複素配列を逆フーリエ変換する．
`static org.apache.commons.math3.complex.Complex[]`	`ifft(double[] src)` 入力実配列を逆フーリエ変換する．
`static double[]`	`irfft(org.apache.commons.math3.complex.Complex[] src)` 入力複素配列（長さ 2^n-1+1）をフーリエ変換し，実配列（長さ 2ⁿ）を返す．
`static double`	`log2(double x)` `double`値の2を底とする対数を返す。
`static <T> java.util.Map.Entry<java.lang.Double,T>`	`nearest(java.util.NavigableMap<java.lang.Double,T> nmap, double key)` 最近傍の値をキーに持つエントリを返す．
`static java.util.concurrent.ScheduledExecutorService`	`newSingleDaemonThreadScheduledExecutor()`
`static int`	`nextPow2(int n)` 与えられた数nに対して 2^p ≧ n を満たす最小のpを求める．
`static double`	`nn2hz(double nn)` MIDIノートナンバーをヘルツ単位の周波数に変換する．
`static void`	`printToPdf(javafx.scene.Node node)`
`static double[][]`	`readWaveform(javax.sound.sampled.AudioInputStream stream)` AudioInputStreamからデータを読み込んでデコードし，チャネルごとの波形が格納された配列を返す．
`static double[]`	`readWaveformMonaural(javax.sound.sampled.AudioInputStream stream)` AudioInputStreamからデータを読み込んでデコードし，全チャネルの平均波形が格納された配列を返す．
`static double[]`	`readWaveformMonaural(javax.sound.sampled.AudioInputStream stream, int channel)` AudioInputStreamからデータを読み込んでデコードし，指定されたチャネルの波形が格納された配列を返す．
`static double[]`	`rectangle(int size)` 与えられた長さの矩形窓 (rectangular window) を返す．
`static org.apache.commons.math3.complex.Complex[]`	`rfft(double[] src)` 入力実配列（長さ 2ⁿ）をフーリエ変換し，複素配列（長さ 2^n-1+1）を返す．
`static void`	`showAlertAndWait(java.lang.String contentText)`
`static void`	`showAlertAndWait(java.lang.String contentText, java.lang.Throwable e)`
`static java.util.stream.Stream<double[]>`	`sliding(double[] x, double[] window, int shiftSize)` 窓関数を用いた配列の切り出しを行う．
`static java.util.stream.Stream<double[]>`	`sliding(double[] x, int windowSize, int shiftSize)` 窓関数を用いた配列の切り出しを行う．

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - verbose
```
public static boolean verbose
```
    コマンドラインオプション "-v" や "--verbose" 処理用．使うときは static import 推奨
  - sampleRate
```
public static final double sampleRate
```
    録音時のサンプリング周波数のデフォルト値 (Hz)
    
    関連項目:
    
    定数フィールド値
  - sampleSizeInBits
```
public static final int sampleSizeInBits
```
    録音時の量子化ビット数のデフォルト値
    
    関連項目:
    
    定数フィールド値
  - waveformAmplitudeBounds
```
public static final double waveformAmplitudeBounds
```
    波形プロット時の振幅範囲のデフォルト値，0を中心としてこの値のプラスマイナス両方向．
    
    関連項目:
    
    定数フィールド値
  - spectrumAmplitudeLowerBound
```
public static final double spectrumAmplitudeLowerBound
```
    スペクトルプロット時の振幅範囲下限のデフォルト値 (dB)
    
    関連項目:
    
    定数フィールド値
  - spectrumAmplitudeUpperBound
```
public static final double spectrumAmplitudeUpperBound
```
    スペクトルプロット時の振幅範囲上限のデフォルト値 (dB)
    
    関連項目:
    
    定数フィールド値
  - frameDuration
```
public static final double frameDuration
```
    短時間分析におけるフレームの長さのデフォルト値（秒）
    
    関連項目:
    
    定数フィールド値
  - shiftDuration
```
public static final double shiftDuration
```
    短時間分析におけるフレームのシフト長のデフォルト値（秒）
    
    関連項目:
    
    定数フィールド値
  - frameInterval
```
public static final double frameInterval
```
    Recorder および Player がフレームを通知する間隔のデフォルト値（秒）
    
    関連項目:
    
    定数フィールド値
  - spectrogramDuration
```
public static final double spectrogramDuration
```
    スペクトログラムの長さのデフォルト値（秒）
    
    関連項目:
    
    定数フィールド値
  - f0Standard
```
public static final double f0Standard
```
    基本周波数の基準値 (Hz)
    
    関連項目:
    
    定数フィールド値
  - f0LowerBound
```
public static final double f0LowerBound
```
    基本周波数の下限 (Hz)
    
    関連項目:
    
    定数フィールド値
  - f0UpperBound
```
public static final double f0UpperBound
```
    基本周波数の上限 (Hz)
    
    関連項目:
    
    定数フィールド値
  - f0Resolution
```
public static final int f0Resolution
```
    基本周波数のオクターブあたりの解像度
    
    関連項目:
    
    定数フィールド値
  - outputImageExt
```
public static final java.lang.String outputImageExt
```
    出力画像のデフォルト拡張子
    
    関連項目:
    
    定数フィールド値
  - pdfPrintableWidth
```
public static final double pdfPrintableWidth
```
    関連項目:
    
    定数フィールド値
  - pdfPrintableHeight
```
public static final double pdfPrintableHeight
```
    関連項目:
    
    定数フィールド値
- メソッドの詳細
  - nextPow2
```
public static final int nextPow2(int n)
```
    与えられた数nに対して 2^p ≧ n を満たす最小のpを求める．例えば nextPow2(15) = 4, nextPow2(16) = 4, nextPow2(17) = 5 となる．
    
    パラメータ:
    
    n - 整数
    
    戻り値:
    
    2^p ≧ n を満たす最小のp
  - highestOneBit
```
public static final int highestOneBit(int n)
```
    与えられた数nのビットが1である最大の桁を求める．例えば highestOneBit(2) = 2, highestOneBit(3) = 2, highestOneBit(4) = 3 となる．
    
    パラメータ:
    
    n - 整数
    
    戻り値:
    
    nのうちビットが1である最大の桁
  - sliding
```
public static final java.util.stream.Stream<double[]> sliding(double[] x,
                                                              int windowSize,
                                                              int shiftSize)
```
    窓関数を用いた配列の切り出しを行う．戻り値は Stream インタフェースを実装するため，切り出し処理そのものは遅延評価される．
    
    パラメータ:
    
    x - 切り出される配列
    
    windowSize - 窓関数の長さ
    
    shiftSize - 窓関数のシフト長
    
    戻り値:
    
    切り出された配列のストリーム
  - sliding
```
public static final java.util.stream.Stream<double[]> sliding(double[] x,
                                                              double[] window,
                                                              int shiftSize)
```
    窓関数を用いた配列の切り出しを行う．戻り値は Stream インタフェースを実装するため，切り出し処理そのものは遅延評価される．
    
    パラメータ:
    
    x - 切り出される配列
    
    window - 窓関数
    
    shiftSize - 窓関数のシフト長
    
    戻り値:
    
    切り出された配列のストリーム
  - fft
```
public static final org.apache.commons.math3.complex.Complex[] fft(org.apache.commons.math3.complex.Complex[] src)
```
    入力複素配列をフーリエ変換する．配列長は2のべき乗でなければならない．
    
    パラメータ:
    
    src - 入力複素配列
    
    戻り値:
    
    入力配列のフーリエ変換である複素配列．配列長は入力と等しい
    
    例外:
    
    java.lang.IllegalArgumentException - 配列長が2のべき乗でないとき
  - fft
```
public static final org.apache.commons.math3.complex.Complex[] fft(double[] src)
```
    入力実配列をフーリエ変換する．配列長は2のべき乗でなければならない．このメソッドは実部が入力配列，虚部が0の複素配列を引数とした fft(Complex[]) と等価である．
    
    パラメータ:
    
    src - 入力実配列
    
    戻り値:
    
    入力配列のフーリエ変換である複素配列．配列長は入力と等しい
    
    例外:
    
    java.lang.IllegalArgumentException - 配列長が2のべき乗でないとき
  - ifft
```
public static final org.apache.commons.math3.complex.Complex[] ifft(org.apache.commons.math3.complex.Complex[] src)
```
    入力複素配列を逆フーリエ変換する．配列長は2のべき乗でなければならない．
    
    パラメータ:
    
    src - 入力複素配列
    
    戻り値:
    
    入力配列の逆フーリエ変換である複素配列．配列長は入力と等しい
    
    例外:
    
    java.lang.IllegalArgumentException - 配列長が2のべき乗でないとき
  - ifft
```
public static final org.apache.commons.math3.complex.Complex[] ifft(double[] src)
```
    入力実配列を逆フーリエ変換する．配列長は2のべき乗でなければならない．このメソッドは実部が入力配列，虚部が0の複素配列を引数とした fft(Complex[]) の実行と等価である．
    
    パラメータ:
    
    src - 入力実配列
    
    戻り値:
    
    入力配列の逆フーリエ変換である複素配列．配列長は入力と等しい
    
    例外:
    
    java.lang.IllegalArgumentException - 配列長が2のべき乗でないとき
  - rfft
```
public static final org.apache.commons.math3.complex.Complex[] rfft(double[] src)
```
    入力実配列（長さ 2ⁿ）をフーリエ変換し，複素配列（長さ 2^n-1+1）を返す．実配列のフーリエ変換は対称（複素共役）配列，という性質に基づく．
    
    パラメータ:
    
    src - 入力実配列
    
    戻り値:
    
    入力配列のフーリエ変換である複素配列
    
    例外:
    
    java.lang.IllegalArgumentException - 配列長が2のべき乗でないとき
  - irfft
```
public static final double[] irfft(org.apache.commons.math3.complex.Complex[] src)
```
    入力複素配列（長さ 2^n-1+1）をフーリエ変換し，実配列（長さ 2ⁿ）を返す．実配列のフーリエ変換は対称（複素共役）配列，という性質に基づく．
    
    パラメータ:
    
    src - 入力複素配列
    
    戻り値:
    
    入力配列の逆フーリエ変換である実配列
    
    例外:
    
    java.lang.IllegalArgumentException - 配列長が2のべき乗でないとき
  - rectangle
```
public static final double[] rectangle(int size)
```
    与えられた長さの矩形窓 (rectangular window) を返す．
    
    パラメータ:
    
    size - 窓の長さ
    
    戻り値:
    
    矩形窓
  - hanning
```
public static final double[] hanning(int size)
```
    与えられた長さのハン窓 (hann window) を返す．
    
    パラメータ:
    
    size - 窓の長さ
    
    戻り値:
    
    ハン窓
  - hamming
```
public static final double[] hamming(int size)
```
    与えられた長さのハミング窓 (hamming window) を返す．
    
    パラメータ:
    
    size - 窓の長さ
    
    戻り値:
    
    ハミング窓
  - gaussian
```
public static final double[] gaussian(int size,
                                      double sigmas)
```
    与えられた長さおよび範囲（標準偏差の何倍か）をもつガウス窓を返す．
    
    パラメータ:
    
    size - 窓の長さ
    
    sigmas - ガウス関数の範囲
    
    戻り値:
    
    ガウス窓
  - gaussian
```
public static final double[] gaussian(int size)
```
    与えられた長さをもつガウス窓を返す．このメソッドは gaussian(size, 3.0) と等価である．
    
    パラメータ:
    
    size - 窓の長さ
    
    戻り値:
    
    ガウス窓
  - blackmanharris
```
public static final double[] blackmanharris(int size)
```
    与えられた長さおよび範囲（標準偏差の何倍か）をもつブラックマンハリス窓を返す．
    
    パラメータ:
    
    size - 窓の長さ
    
    戻り値:
    
    ブラックマンハリス窓
  - nn2hz
```
public static final double nn2hz(double nn)
```
    MIDIノートナンバーをヘルツ単位の周波数に変換する．
    
    パラメータ:
    
    nn - MIDIノートナンバー
    
    戻り値:
    
    ヘルツ単位の周波数
  - hz2nn
```
public static final double hz2nn(double hz)
```
    ヘルツ単位の周波数をMIDIノートナンバーに変換する．
    
    パラメータ:
    
    hz - 周波数
    
    戻り値:
    
    MIDIノートナンバー
  - log2
```
public static final double log2(double x)
```
    double値の2を底とする対数を返す。
    
    パラメータ:
    
    x - 値
    
    戻り値:
    
    xの2を底とする対数
  - argmax
```
public static final int argmax(double[] a)
```
    配列中の最大値のインデックスを返す．
    
    パラメータ:
    
    a - 配列
    
    戻り値:
    
    配列中の最大値のインデックス
  - nearest
```
public static final <T> java.util.Map.Entry<java.lang.Double,T> nearest(java.util.NavigableMap<java.lang.Double,T> nmap,
                                                                        double key)
```
    最近傍の値をキーに持つエントリを返す．
    
    型パラメータ:
    
    T - エントリの値の型
    
    パラメータ:
    
    nmap - Double値をキーにもつマップ
    
    key - 探索キー
    
    戻り値:
    
    探索キーに最も近い値をキーにもつエントリ
  - readWaveform
```
public static final double[][] readWaveform(javax.sound.sampled.AudioInputStream stream)
                                     throws java.io.IOException
```
    AudioInputStreamからデータを読み込んでデコードし，チャネルごとの波形が格納された配列を返す．
    
    パラメータ:
    
    stream - ストリーム
    
    戻り値:
    
    チャネルごとの波形が格納された配列
    
    例外:
    
    java.io.IOException - 入出力例外が発生した場合
  - readWaveformMonaural
```
public static final double[] readWaveformMonaural(javax.sound.sampled.AudioInputStream stream)
                                           throws java.io.IOException
```
    AudioInputStreamからデータを読み込んでデコードし，全チャネルの平均波形が格納された配列を返す．
    
    パラメータ:
    
    stream - ストリーム
    
    戻り値:
    
    全チャネルの平均波形が格納された配列
    
    例外:
    
    java.io.IOException - 入出力例外が発生した場合
  - readWaveformMonaural
```
public static final double[] readWaveformMonaural(javax.sound.sampled.AudioInputStream stream,
                                                  int channel)
                                           throws java.io.IOException
```
    AudioInputStreamからデータを読み込んでデコードし，指定されたチャネルの波形が格納された配列を返す．
    
    パラメータ:
    
    stream - ストリーム
    
    channel - 波形を取り出すチャネル
    
    戻り値:
    
    指定されたチャネルの波形が格納された配列
    
    例外:
    
    java.io.IOException - 入出力例外が発生した場合
  - autoTickUnit
```
public static final double autoTickUnit(double x)
```
    NumberAxisを生成する際に、範囲を表すdouble値に対して「ちょうどいい」tickUnit（データ単位の各大目盛の間の値）を返す。典型的な使用法は以下の通り。
```
 
 double lowerBound = 0.0;
 double upperBound = waveform.length / sampleRate;
 final NumberAxis xAxis = new NumberAxis(
   "Time (seconds)",
   lowerBound,
   upperBound,
   autoTickunit(upperBound - lowerBound)
 );
 
 
```
    パラメータ:
    
    x - 範囲
    
    戻り値:
    
    「ちょうどいい」tickUnitを表すdouble値
    
    例外:
    
    java.lang.IllegalArgumentException - xが正実数でない場合
  - getFilenameWithImageExt
```
public static final java.lang.String[] getFilenameWithImageExt(java.util.Optional<java.lang.String> filenameOpt,
                                                               java.lang.String defaultFilename)
```
  - printToPdf
```
public static final void printToPdf(javafx.scene.Node node)
```
  - newSingleDaemonThreadScheduledExecutor
```
public static final java.util.concurrent.ScheduledExecutorService newSingleDaemonThreadScheduledExecutor()
```
  - showAlertAndWait
```
public static final void showAlertAndWait(java.lang.String contentText,
                                          java.lang.Throwable e)
```
  - showAlertAndWait
```
public static final void showAlertAndWait(java.lang.String contentText)
```

クラス Le4MusicUtils

フィールドのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

フィールドの詳細

verbose

sampleRate

sampleSizeInBits

waveformAmplitudeBounds

spectrumAmplitudeLowerBound

spectrumAmplitudeUpperBound

frameDuration

shiftDuration

frameInterval

spectrogramDuration

f0Standard

f0LowerBound

f0UpperBound

f0Resolution

outputImageExt

pdfPrintableWidth

pdfPrintableHeight

メソッドの詳細

nextPow2

highestOneBit

sliding

sliding

fft

fft

ifft

ifft

rfft

irfft

rectangle

hanning

hamming

gaussian

gaussian

blackmanharris

nn2hz

hz2nn

log2

argmax

nearest

readWaveform

readWaveformMonaural

readWaveformMonaural

autoTickUnit

getFilenameWithImageExt

printToPdf

newSingleDaemonThreadScheduledExecutor

showAlertAndWait

showAlertAndWait