imsequencefile_fiftコマンド マニュアル

(The documentation of imsequencefile_fift command)

Last Update: 2023/6/29


◆機能・用途(Purpose)

フーリエスペクトルをファイルから読み込んでフーリエ逆変換を行う。
Read a Fourier spectrum from a file and perform a Fourier inverse transformation.


◆ソースコード(Source code)

$YMAEDA_OPENTOOL_DIR/sequence/src/imsequencefile_fift.c


◆使用方法(Usage)

コマンドライン引数でパラメータを指定する。 パラメータの一覧を下表に示す。
Specify parameters by command-line arguments. The table below shows a list of parameters.


●「-」から始まらない引数 (Arguments not beginning with “-”)

引数
Argument
与える値
Quantity to be given
第1引数
1st argument
読み込むフーリエスペクトルのファイル名。 拡張子は ymaeda_opentools独自のフーリエスペクトルファイル形式 のいずれかでなければならない。
The name of the file for the input Fourier spectrum. The extension must be one of the special file formats of ymaeda_opentools for Fourier spectrum.
第2引数
2nd argument
出力する時系列データのファイル名。 拡張子は ymaeda_opentools独自の時系列データファイル形式(実部のみを出力する場合) またはスペクトルファイル形式(チェック用に虚部を含めて出力する場合) のいずれかでなければならない。
The name of the file for the output time series data. The extension must be one of the special file formats of ymaeda_opentools for time series data (to output only the real parts) or Fourier spectrum (to also output imaginary parts for check).


●1つの「-」から始まる引数 (Arguments beginning with a single “-”)

1つの「-」から始まる引数は自由な順番で指定できる。 「-」から始まらない引数の間に挿入しても良い。 相反する指定がなされた場合には後の指定が優先される。
Arguments beginning with a single “-” can be placed in an arbitrary order. They can even be inserted between arguments not beginning with “-”. In case of conflicting options being specified, the latter option has a higher priority.

引数
Argument
動作
Behaviour
-o 下記「--overwrite=yes」と同じ。
Same as “--overwrite=yes” below.
-e 下記「--erase_old_file=yes」と同じ。
Same as “--erase_old_file=yes” below.


●「--パラメータ名=パラメータ値」の形式の引数 (Arguments of a form “--Parameter name=Parameter Value”)

「--パラメータ名=パラメータ値」の形式の引数は自由な順番で指定できる。 「-」から始まらない引数の間に挿入しても良い。 相反する指定がなされた場合には後の指定が優先される。 デフォルト値を持つパラメータは省略できる。
Arguments of a form “--Parameter name=Parameter Value” can be placed in an arbitrary order. They can even be inserted between arguments not beginning with “-”. In case of conflicting options being specified, the latter option has a higher priority. Parameters that have default values can be omitted.

パラメータ名
Parameter name
意味
Meaning
可能なパラメータ値
Allowed parameter values
デフォルト値
Default value
overwrite 変換後のファイル(出力ファイル)と同名のファイルが既に存在する場合に 確認無しで上書きするか否か。
Whether to overwrite an existing file without warning or not if a file with the name same as the converted (output) file already exists.
  • yes
    確認無しで上書きする。
    Overwrite without warning.

  • no
    上書きしても良いかユーザに確認する。
    Consult the user whether to proceed (overwrite) or not.

no
erase_old_file 変換前のファイル(入力ファイル)を削除するか否か。
Whether to remove the input file used for the conversion or not.
  • yes
    削除する。
    Remove.

  • no
    削除しない。
    Do not remove.

no
size 出力する時系列データの時刻サンプル数。 時系列データをフーリエ変換する際に 長さを2の巾乗にするために末尾にダミーの0.0を挿入しているので、 フーリエスペクトルを単に逆変換して時系列データに戻すと ダミーの0.0の分だけ元の時系列データよりも長くなる。 そこで、元の時系列データの長さに戻すためにこのパラメータが用いられる。
The number of time samples of the time series data to output. This parameter accounts for the dammy zeroes that were appended at the end of the original time series data to make the length a power of 2 at the time of the Fourier transformation. Due to the dammy zeroes, simply inverting the Fourier spectrum results in a time series data that may be longer than the original one. To reconstruct the original length, this parameter is used.
入力ファイルにおける周波数サンプル数以下の正の整数。
A positive integer less than or equal to the number of frequency samples of the input file.
入力ファイルにおける周波数サンプル数。
The number of frequency samples of the input file.
t0 スペクトルをフーリエ逆変換して得られる時系列データの先頭時刻\(t_0\)。 時系列データをフーリエ変換する際に\(t_0\)の情報が失われるので、 逆変換によって完全に元の時系列データに戻すには \(t_0\)の値をスペクトルとは別に与える必要がある。
The beginning time of the transformed time series data. As the beginning time \(t_0\) of a time series data is lost by Fourier transformation, the value of \(t_0\) must be given in addition to the spectrum to completely reconstruct the original time series data by the inverse transformation.
実数。
A real number.

または以下の文字列も指定可能である。
Alternatively, the following strings can be used as the value of this parameter.

  • centered
    作成する時系列データの中央が時刻\(t=0\)になるように t0を自動的に決定する。 このオプションはクロススペクトルを相互相関関数に逆変換する際に 有用である。
    Automatically adjust t0 so that the output time series data be centered at time \(t=0\). This option is useful for the inverse transformation from a cross spectrum to a cross correlation function.

0.0
output_format 出力ファイルを実関数にするか複素関数にするかの選択。
A choice of the output file content; either a real or a complex function.
  • seq
    実関数として出力する。
    Output as a real function.

  • imseq
    複素関数として出力する。
    Output as a complex function.

seq


◆動作(Behaviour)

第1引数で指定したファイルからフーリエスペクトルを読み込み、 フーリエ逆変換を行い、 結果を第2引数で指定したファイルに出力する。
Read the Fourier spectrum from the file specified by the 1st argument, perform the Fourier inverse transformation, and output the result into the file specified by the 2nd argument.


◆使用例(Example)

sequencefile_fft waveform.seq1 spectrum.imseq1
imsequencefile_fift spectrum.imseq1 waveform_for_check.seq1 --size=360000