1.付録A：netcdf.rb仕様書

目的：netCDFファイルのC言語インターフェースをrubyを用いて簡易に使用できるよう作成した。

構成

• NetCDF
• NetCDFDim
• NetCDFVar
• NetCDFAtt

NetCDF

クラスメソッド

NetCDF.open(filename, mode="r", share=false)

ファイルオープン（クラスメソッド）mode="w" でファイルが存在しなければ新規作成

引数

• filename (String): ファイル名
• mode (String) : オープンするモード "r"(読み取り), "w"(書き込み)
• share (true or false) : sharedにするか

戻り値

• NetCDFクラスのオブジェクト

拡張ライブラリ中のC言語の関数名

• NetCDF_open

NetCDF.new

openメソッドのエイリアスであるのでopenを参照のこと

NetCDF.create(filename, noclobber=false, share=false)

netCDFファイルを作る（クラスメソッド)

引数

• filename (String) : ファイル名
• noclobber (true or false) : 上書きするかしないか
• share (true or false) : sharedにするか

戻り値

• NetCDFクラスのオブジェクト

拡張ライブラリ中のC言語の関数名

• NetCDF_create

インスタンスメソッド

close

ファイルクローズ

引数

• なし

戻り値

• nil

拡張ライブラリ中のC言語の関数名

• NetCDF_close

ndims

次元の数

引数

• なし

戻り値

• Integer

拡張ライブラリ中のC言語の関数名

• NetCDF_ndims

nvars

変数の数

引数

• なし

戻り値

• Integer

拡張ライブラリ中のC言語の関数名

• NetCDF_nvars

natts

グローバル属性の数

引数

• なし

戻り値

• Integer

拡張ライブラリ中のC言語の関数名

• NetCDF_natts

unlimited

unlimited-dimensionを返す

引数

• なし

戻り値

• 存在するときNetCDFDimクラスのオブジェクト。ないときはnil

拡張ライブラリ中のC言語の関数名

• NetCDF_unlimited

path

NetCDFクラスのオブジェクトの指すファイルのパス

引数

• なし

戻り値

• String

拡張ライブラリ中のC言語の関数名

• NetCDF_path

redef

define modeにする。

引数

• なし

戻り値

• nil

拡張ライブラリ中のC言語の関数名

• NetCDF_redef

enddef

define modeを解除

引数

• なし

戻り値

• nil

拡張ライブラリ中のC言語の関数名

• NetCDF_enddef

sync

ディスクと同期

引数

• なし

戻り値

• nil

拡張ライブラリ中のC言語の関数名

• NetCDF_sync

def_dim(dimension_name, length)

dimensionを定義

引数

• dimension_name (String) : 定義するdimensionの名前
• length (Integer) : dimensionの長さ

戻り値

• NetCDFDimクラスのオブジェクト

拡張ライブラリ中のC言語の関数名

• NetCDF_def_dim

put_att(attribute_name, value, atttype=nil)

global attributeを設定

引数

• attribute_name (String) : global attributeの名前
• value (Numeric or String or Array(by Numeric or String only)) : 値
• atttype (nil or String) : タイプ(nil,"string","byte","sint","int","sfloat","float"のいずれか) (それぞれ,1,1,2,4,4,8バイト) nilはお任せ

戻り値

• NetCDFAttクラスのオブジェクト

拡張ライブラリ中のC言語の関数名

• NetCDF_put_att

def_var(variable_name, vartype, dimensions)

変数を定義

引数

• variable_name (String) : 定義するvariableの名前
• vartype (String) : タイプ ("byte","sint","sint","int""sfloat","float" のいずれか)
• dimensions (Array) : variableの次元

戻り値

• NetCDFVarクラスのオブジェクト

拡張ライブラリ中のC言語の関数名

• NetCDF_def_var

var(var_name)

既存の変数をオープン

引数

• var_name (String) : オープンする変数名

戻り値

• NetCDFVarクラスのオブジェクトまたはnil

拡張ライブラリ中のC言語の関数名

• NetCDF_var

dim(dimension_name)

既存の次元をオープン

引数

• dimension_name (String) : オープンする次元名

戻り値

• NetCDFDimクラスのオブジェクトまたはnil

拡張ライブラリ中のC言語の関数名

• NetCDF_dim

att(attribute_name)

既存のglobal-attributeをオープン

引数

• attribute_name (String) : オープンするglobal-attribute名

戻り値

• NetCDFAttクラスのオブジェクトまたはnil

拡張ライブラリ中のC言語の関数名

• NetCDF_att

fill=(filemode)

fillmodeの設定

引数

• fillmode (true or false)

戻り値

• nil

拡張ライブラリ中のC言語の関数名

• NetCDF_fill

each_dim{ ... }

全次元(NetCDFDim)に関するイテレータ

引数

• { ... } : 繰り返すブロック

戻り値

• self

拡張ライブラリ中のC言語の関数名

• (Rubyのみで記述)

each_var{ ... }

全変数(NetCDFVar)に関するイテレータ

引数

• { ... } : 繰り返すブロック

戻り値

• self

拡張ライブラリ中のC言語の関数名

• (Rubyのみで記述)

each_att{ ... }

全属性(NetCDFAtt)に関するイテレータ

引数

• { ... } : 繰り返すブロック

戻り値

• self

拡張ライブラリ中のC言語の関数名

• (Rubyのみで記述)

dim_names

NetCDFクラスのオブジェクトの中にある、次元の名前をすべてあげて、配列に入れて返す。

引数

• なし

戻り値

• Array

拡張ライブラリ中のC言語の関数名

• （Rubyのみで記述）

var_names

NetCDFクラスのオブジェクトの中にある、変数の名前をすべてあげて、配列に入れて返す。

引数

• なし

戻り値

• Array

拡張ライブラリ中のC言語の関数名

• （Rubyのみで記述）

att_names

NetCDFクラスのオブジェクトの中にある、attributeの名前をすべてあげて、配列に入れて返す。 引数

• なし

戻り値

• Array

拡張ライブラリ中のC言語の関数名

• （Rubyのみで記述）

NetCDFDim

クラスメソッド

インスタンスメソッド

length

長さを返す

引数

• なし

戻り値

• Integer

拡張ライブラリ中のC言語の関数名

• NetCDF_dim_length

name=(dimension_newname)

名前をつけかえる

引数

• dimension_newname (String) : 新しい名前

戻り値

• なし

拡張ライブラリ中のC言語の関数名

• NetCDF_dim_name

name

名前を返す

引数

• なし

戻り値

• String

拡張ライブラリ中のC言語の関数名

• NetCDF_dim_inqname

unlimited?

無制限次元か？

引数

• なし

戻り値

• true or false

拡張ライブラリ中のC言語の関数名

• NetCDF_dim_whether_unlimited

NetCDFAtt

クラスメソッド

インスタンスメソッド

name

Attributeの名前を問う

引数

• なし

戻り値

• String

拡張ライブラリ中のC言語の関数名

• NetCDF_att_inq_name

name=(attribute_newname)

Attributeの名前を定義

引数

• attribute_newname (String) : 新しいattribute名

戻り値

• nil

拡張ライブラリ中のC言語の関数名

• NetCDF_att_rename

copy

Attributeをコピー

引数

• var (NetCDFVar)

戻り値

• NetCDFVar

拡張ライブラリ中のC言語の関数名

• NetCDF_att_copy

delete

Attributeを削除

引数

• なし

戻り値

• nil

拡張ライブラリ中のC言語の関数名

• NetCDF_att_delete

put(value, atttype=nil)

Attributeの中身を入れる。

引数

• value (Numeric or String or Array) : 入れる値(スカラー数字、文字列またはそれらのいずれかのArray)
• atttype (nil or String) : valueのタイプ(nilまたは"string","byte","sint","int","sfloat","float" (それぞれ,1,1,2,4,4,8バイト))

戻り値

• nil

拡張ライブラリ中のC言語の関数名

• NetCDf_att_put

get

Attributeの中身を取り出す

引数

• なし

戻り値

• 文字列またはNarrayオブジェクト

拡張ライブラリ中のC言語の関数名

• NetCDF_att_get

atttype

Attributeの種類を問う

引数

• なし

戻り値

• "string","byte","sint","int","sfloat","float"

拡張ライブラリ中のC言語の関数名

• NetCDF_att_atttype

NetCDFVar

クラスメソッド

インスタンスメソッド

dim(dim_num)

NetCDFVarクラスのオブジェクトから指定されたdimensionのNetCDFDimオブジェクトを取り出す。

引数

• dim_num (Fixnum) : 何番目の次元か。0から始まる

戻り値

• NetCDFDimオブジェクト

拡張ライブラリ中のC言語の関数名

• NetCDF_var_dim

dims

NetCDFVarクラスのオブジェクトが指す変数中のdimensionsに対応するNetCDFDimオブジェクトを全て取り出す.

引数

• なし

戻り値

• NetCDFDimオブジェクトのArray

拡張ライブラリ中のC言語の関数名

• NetCDF_var_dims

each_att{ ... }

全属性(NetCDFAtt)に関するイテレータ

引数

• { ... } : 繰り返すブロック

戻り値

• self

拡張ライブラリ中のC言語の関数名

• (Ruby only)

dim_names

dimensionの名前を全てあげて配列に入れて返す。

引数

• なし

戻り値

• Array

拡張ライブラリ中のC言語の関数名

• (Ruby only)

att_names

attributeの名前を全てあげて配列に入れて返す。

引数

• なし

戻り値

• Array

拡張ライブラリ中のC言語の関数名

• (Ruby only)

name

名前を問う

引数

• なし

戻り値

• String

拡張ライブラリ中のC言語の関数名

• NetCDF_var_inq_name

name=(variable_newname)

名前を付け替える

引数

• variable_newname (String) : 新しい名前

戻り値

• nil

拡張ライブラリ中のC言語の関数名

• NetCDF_var_rename

ndims

次元の数を問う

引数

• なし

戻り値

• Integer

拡張ライブラリ中のC言語の関数名

• NetCDF_var_ndims

vartype

変数の種類を問う

引数

• なし

戻り値

• String

拡張ライブラリ中のC言語の関数名

• NetCDF_var_vartype

natts

attributeの数を問う

引数

• なし

戻り値

• Integer

拡張ライブラリ中のC言語の関数名

• NetCDF_var_natts

file

NetCDFVarオブジェクトがもともと属するNetCDFオブジェクトを取り出す。 引数

• なし

戻り値

• NetCDFクラスのオブジェクト

拡張ライブラリ中のC言語の関数名

• NetCDF_var_file

att(attribute_name)

NetCDFVarオブジェクトからNetCDFAttオブジェクトを取り出す。

引数

• attribute_name (String) : 取り出すattribute名

戻り値

• Attributeクラスのオブジェクト、なければnil

拡張ライブラリ中のC言語の関数名

• NetCDF_var_att

put_att(attribute_name, value, atttype=nil)

attributeを設定

引数

• attribute_name (String) : attribute名
• value (Numeric or String or Array) : 設定する値
• atttype : attributeの型 (nilまたは"string","byte","sint","int","sfloat","float" (それぞれ,1,1,2,4,4,8バイト)) nilはお任せ

戻り値

• NetCDFAttのオブジェクト

拡張ライブラリ中のC言語の関数名

• NetCDF_put_att_var

put(value, option=nil)

値を入れる

引数

• value : 入れる値 (Numeric,Array(Numericの1次元配列)、NArray)
• option (Hash) : 変数の一部分を指定するためのオプション引数。ハッシュのキーとしては、"start","end","stride"の組、または"index"が使用できる。"index"は1要素（スカラー）を指す。"end","stride"は省略可。省略するにしろしないにしろ、書きこむ要素の数はValueのそれと一致していなければならない。start,end,indexではArrayの場合と同様、負の値で後ろからの位置を指定できる。"stride"は正の値のみ受け付ける例：変数が2次元(10×10)の場合{"start"=>[2,5],"end"=>[6,-1],"stride"=>[2,4]},例2：{"index"=>[0,0]}:最初の要素（変数は2次元）

戻り値

• nil

拡張ライブラリ中のC言語の関数名

• NetCDF_put_var_type（ハッシュを使用しないとき)
• NetCDF_put_vars _type（ハッシュのキーを"start""end","stride"としたとき)
• NetCDF_put_var1_ type（ハッシュのキーを"index"としたとき）

get(option=nil)

値を取り出す

引数

• option (Hash) : 変数の一部分を指定するためのオプション引数。ハッシュのキーとしては、"start","end","stride"の組、または"index"が使用できる。"index"は1要素（スカラー）を指す。"end","stride"は省略可。start,end,indexではArrayの場合と同様、負の値で後ろからの位置を指定できる。"stride"は正の値のみ受け付ける例：変数が2次元(10×10)の場合{"start"=>[2,5],"end"=>[6,-1],"stride"=>[2,4]},例2：{"index"=>[0,0]}:最初の要素（変数は2次元）

戻り値

• NArrayクラスのオブジェクト

拡張ライブラリ中のC言語の関数名

• NetCDF_get_var_type（ハッシュを使用しないとき）
• NetCDF_get_vars _type (ハッシュのキーを"start""end","stride"としたとき)
• NetCDF_get_var1_ type（ハッシュのキーを"index"としたとき）