GPhys

本ライブラリはデータ形式に依存しないプログラミングを可能とし、またデータ変数と座標変数を一体化した「物理量」としてデータを扱うためのライブラリである。ここでデータ変数とは値を収める多次元配列と、データに関する付加的情報の組であり、座標変数は座標値の数値配列と座標に関する付加的情報の組である。

クラス構成は次の通りである。メソッド一覧は本ライブラリの構成を参照のこと。

クラス名説明

NumRu
- GPhys データ変数と座標変数を一体化して扱うためのクラス
- GData(未実装) データクラス
  - GDataMem メモリ上のデータを扱うクラス
  - GDataFile(未実装) ファイルデータを扱うクラス
    - GDataNetCDF NetCDFファイルのデータを扱うクラス
- Coord(未実装) 座標クラス
  - CoordReg 格子点座標を扱うためのクラス
  - CoordTrans(未実装)
  - CoordScat(未実装)
- Ggraphic 可視化モジュール

本ライブラリの使用法

本ライブラリは既にインストールされているものとする。(インストール方法はINSTALL、INSTALL.jp(日本語)を参照)

使用するには

require 'numru/gphys'

とすればよい。

また、

include NumRu

とすることにより、GPhysライブラリ内の各クラスにおいてNumRuを省略可能となる。これを行わない場合は NumRu::GPhys.new などとして各クラスを扱わねばならない。

まず、本ライブラリにより異なる形式のデータがほぼ同じプログラムで取り扱うことができるわけだが、これは各ファイル形式毎に異なるクラスを用意することにより実現している。本ライブラリにおいてこれらはGDataxxxというクラスである。そのクラスにファイル形式に依存しないインターフェースを持つメソッドを定義し、その中でファイル形式に応じた呼び出しを行う。すなわち、プログラム上は同じ名前のメソッドを呼んでいてもレシーバとなるオブジェクトのクラスが違えばそれぞれのクラスのメソッドが呼ばれるので結果、異なる形式のデータがほぼ同じプログラムで取り扱えるわけである。

また、データ変数と座標変数を一体として扱うには、データ変数と座標変数を内部変数として持つクラスを用意すればよい。本ライブラリにおいてはGPhysクラスがその役割を果たす。

GPhysが解釈する属性

本ライブラリでは、GPhysオブジェクトやGDataオブジェクトに対して属性を設定することができる。そしてある決まった名前の属性に関しては本ライブラリが自動的に解釈を行う。本ライブラリが解釈することのできる属性は次の通りである。

long_name: 名前 -> 図のタイトル等で用いられる。
units: 変数の単位 -> 演算に伴って更新される。
valid_range: 変数の範囲 -> 範囲外の数値は欠損値とみなす。
valid_min, valid_max: 変数の最小値、最大値 -> valid_range に変換する。
scale_factor: -> IOレベルで解釈する。配列抜きだしの際、元の値を scale_factor 倍する。
add_offset: -> IOレベルで解釈する。配列抜きだしの際、元の値に add_offsetを加える。
missing_value: 欠損値 -> 配列クラスで対処できるようにする。
positive: 軸の向き -> 図を書く際に解釈し、対応を行う。

すなわち、ユーザが属性を設定する場合、その名前は上で述べた属性名にすることが望ましい。これら以外の属性は自動的には解釈されない。従って、その処理はユーザが行わなければならない。

クラスメソッド

initialize(data_new, coord_new=nil)

GPhysオブジェクトを生成する。

引数

data_new:データオブジェクト(GData)
coord_new:座標オブジェクト(Coord)

備考

GPhysクラスの全ての初期化関数はこのメソッドを呼んでいる。

new2(narray, destination, attr=nil, coord_new=nil)

配列とデータクラスを指定してGPhysオブジェクトを生成する。

引数

narray: 多次元配列(NArray)
destination: 扱うデータクラス(Class)
attr: データの属性(Attribute)
coord_new: 座標クラスのオブジェクト(Coord)

備考

このメソッドは内部で指定したデータクラス(destination)の初期化を行っている。

open(uri, mode="r")

ファイルを開き、GPhysクラスの初期化を行う。

引数

uri: ファイル名、変数名を指定するURI(String)
mode: ファイルの読み書きモード(String)

備考

URIは"filename?var=varname"の形で書かれる。filenameはファイル名、varnameは変数名である。
modeはRubyのファイルモードと同じである。
- r: 読み込み専用
- r+: 読み書き両用
- w: 新規作成書き込み専用
- w+: 新規作成読み書き両用
- a: 追加書き込み、書き込み専用
- a+: 追加書き込み、読み書き両用

インスタンスメソッド

set_value(narray)

データの配列を設定する。

引数

narray: 新しい配列(NArray)

備考

設定される配列は元の配列と形が同じでなければならない。

get_value

データの配列を取り出す。

引数

なし

備考

返り値はNArrayオブジェクトである。

set_axis_value(dim, narray)

指定した次元の座標変数の配列を設定する。

引数

dim: 設定する次元(Fixnum)
narray: 設定する配列(NArray)

備考

dimは数値で指定する。dim=1の場合、1次元目の座標について設定する。
設定される配列は元の配列と形が同じでなければならない。

get_axis_value(dim)

指定した次元の座標変数の配列を取り出す。

引数

dim: 取り出す次元(Fixnum)

備考

dimは数値で指定する。dim=1の場合、1次元目の座標の配列を取り出す。
返り値はNArrayオブジェクトである。

set_coord(coord)

座標を設定する。

引数

coord: 座標オブジェクト(Coord)

備考

[*index]

オブジェクトの切り出しを行う。

引数

index: インデックス(Array)

備考

self[0..1, 0] のようにして用いる。
インデックスはNArrayのインデックス指定に基づいている。

[index] = val

オブジェクトへの書き込みを行う。

引数

index: インデックス(Array)
val: 設定する値(Numeric, NArray)

備考

self[0..1, 0]=99.9 のようにして用いる。
インデックスはNArrayのインデックス指定に基づいている。

set_att(name, val)

データの属性を設定する。

引数

name: 属性名(String)
val: 属性の値(Numeric, String)

備考

属性名については((<GPhysが解釈する属性>))を参照のこと。

get_att(name)

データの属性を取り出す。

引数

name: 属性名(String)

備考

set_axis_att(dim, name, value)

指定した次元の座標変数の属性を設定する。

引数

dim: 設定する次元(Fixnum)
name: 属性名(String)
value: 属性の値(Numeric, NArray)

備考

dimは数値で指定する。dim=1の場合、1次元目の座標について設定する。
属性名についてはGPhysが解釈する属性を参照のこと。

get_axis_att(dim, name)

指定した次元の座標変数の属性を取り出す。

引数

dim: 設定する次元(Fixnum)
name: 属性名(String)

備考

dimは数値で指定する。dim=1の場合、1次元目の座標について設定する。

clone

オブジェクトのコピーを行う。

引数

なし

備考

このメソッドはディープなコピーを行わない。即ち、内部変数であるデータオブジェクトと座標オブジェクトは共通で別オブジェクトを作る。

copy

オブジェクトのコピーを行う。

引数

なし

備考

このメソッドはディープなコピーを行う。即ち、内部変数であるデータオブジェクトと座標オブジェクトもそれぞれコピーし別オブジェクトを作る。

process(option=nil)

データの加工を行う。

引数

option : データ加工の際のオプション(Hash)

備考

オプションを与えるハッシュのキーとして次のものを用いることができる。
* dvn(n=1,2,....): n次元目に関するインデックスを指定する。値にはFixnumまたはRangeを指定する。
    例）dv1=>2..7
* to2d: 2次元化を行う。最初の2つの次元の全ての要素と残りの次元の最初の要素を切り出す。to2d=>true で有効となる。

to2d(option=nil)

データを2次元化する。

引数

option: データ加工の際のオプション(Hash)

備考

オプションを与えるハッシュのキーとして次のものを用いることができる。
- dvn(n=1,2,....): n次元目に関するインデックスを指定する。値にはFixnumまたはRangeを指定する。
```
例）dv1=>2..7
```
このメソッドは self.process(to2d=>true, option) を呼び出す。

data

GPhysオブジェクト内部のデータオブジェクトを取り出す。

引数

なし

備考

返り値はデータオブジェクトである。

+(other)

加算を行う。

引数

other: 計算対象(GPhys, Numeric)

備考

GPhysオブジェクト同士の二項演算はお互いが異なる次元数の場合にも対応できる。
その場合、一方を他方に拡張する必要があるが、拡張を行う次元の判断は各ファイル形式毎に用意されている関連判断のメソッドにより行う。
異なる種類のデータ同士の計算も可能である。計算結果はselfと同じファイル形式となる。

-(other)

減算を行う。

引数

other: 計算対象(GPhys, Numeric)

備考

GPhysオブジェクト同士の二項演算はお互いが異なる次元数の場合にも対応できる。
その場合、一方を他方に拡張する必要があるが、拡張を行う次元の判断は各ファイル形式毎に用意されている関連判断のメソッドにより行う。
異なる種類のデータ同士の計算も可能である。計算結果はselfと同じファイル形式となる。

*(other)

積算を行う。

引数

other: 計算対象(GPhys, Numeric)

備考

GPhysオブジェクト同士の二項演算はお互いが異なる次元数の場合にも対応できる。
その場合、一方を他方に拡張する必要があるが、拡張を行う次元の判断は各ファイル形式毎に用意されている関連判断のメソッドにより行う。
異なる種類のデータ同士の計算も可能である。計算結果はselfと同じファイル形式となる。

/(other)

除算を行う。

引数

other: 計算対象(GPhys, Numeric)

備考

GPhysオブジェクト同士の二項演算はお互いが異なる次元数の場合にも対応できる。
その場合、一方を他方に拡張する必要があるが、拡張を行う次元の判断は各ファイル形式毎に用意されている関連判断のメソッドにより行う。
異なる種類のデータ同士の計算も可能である。計算結果はselfと同じファイル形式となる。

sum(dim)

指定した次元に関する和をとる。

引数

dim: 計算を行う次元(Fixnum)

備考

本メソッドのように計算の結果、次元数が変化する場合座標情報も正しく更新されている。

avg(dim)

指定した次元に関する平均をとる。

引数

dim: 計算を行う次元(Fixnum)

備考

本メソッドのように計算の結果、次元数が変化する場合座標情報も正しく更新されている。

var(dim)

指定した次元に関する分散をとる。

引数

dim: 計算を行う次元(Fixnum)

備考

本メソッドのように計算の結果、次元数が変化する場合座標情報も正しく更新されている。

stddev(dim)

指定した次元に関する標準偏差をとる。

引数

dim: 計算を行う次元(Fixnum)

備考

本メソッドのように計算の結果、次元数が変化する場合座標情報も正しく更新されている。

dim, rank

次元数を返す。

引数

なし

備考

返り値はFixnumである。

shape

データの形を返す。

引数

なし

備考

返り値はArrayである。

total

配列の全要素数を返す。

引数

なし

備考

返り値はFixnumである。

その他、GDataクラスで利用できるメソッドは全て利用できる。

NumRu::GData

本クラスについて

データクラスはデータ変数を扱うためのクラスである。内部情報として数値配列とデータに関する情報（名前、単位など）を持っている。GDataクラスはメモリ上のデータに関するクラスGDataMemとファイルデータを扱うためのクラスGDataFileのスーパークラスである。本クラスには全てのデータ形式に共通なメソッドを定義する。（現在未実装）

スーパークラス

Object

クラスメソッド

initialize(narray, attr=nil)

初期化を行う。

引数

narray: データ配列(NArray)
attr: データの属性(Hash)

備考

GDataMemクラスの全ての初期化関数はこのメソッドを呼んでいる。

new2(name,ntype,shape,attr=nil)

データ型と配列の形から初期化を行う。

引数

name: 変数名(String)
ntype: データ型(String)
shape: 配列の形(Array)
attr: 変数の属性(Hash)

備考

データ型は次のものが指定できる。
- "byte"(unsigned char): 1バイト整数型
- "sint": 1バイト整数型
- "int": 2バイト整数型
- "long": 4バイト整数型
- "float": 4バイト浮動小数点型
- "double": 8バイト浮動小数点型
属性名についてはGPhysが解釈する属性を参照のこと。

new3(name, narray, attr=nil)

配列から初期化を行う。

引数

name: 変数名(String)
narray: 配列(NArray)
attr: 変数の属性(Hash)

備考

属性名についてはGPhysが解釈する属性を参照のこと。

maxsize

データを分割するサイズの最大値を返す。

引数

なし

備考

本メソッドはデータの自動分割に関係する。詳しくは((<大規模データの取り扱い>))を参照のこと。

maxsize=(size)

データを分割するサイズの最大値を設定する。

引数

size: データを分割するサイズの最大値(Fixnum)

備考

本メソッドはデータの自動分割に関係する。詳しくは((<大規模データの取り扱い>))を参照のこと。

create_another(shape=nil, ntype=nil, attr=nil)

同じ属性を持つGDataMemオブジェクトを作る。

引数

shape: 配列の形(Array)
ntype: データの型(String)
attr: データの属性(Hash)

備考

本メソッドは別のデータオブジェクトを作る。コピー先のクラスはコピー元と同じである。

clone

オブジェクトの複製を行う。

引数

なし

備考

本メソッドはディープなコピーは行わない。本メソッドは配列はコピー元と共通に持ち、属性のみのコピーを行う。

copy(destination=nil, dimname=nil, filename=nil)

オブジェクトの複製を行う。

引数

destination: コピー先のクラス(Class)
dimname: 次元名(Array)
filename: ファイル名(String)

備考

本メソッドはディープなコピーを行う。即ち、配列のコピーも行う。また、コピー先のクラスを指定することが出来る。
dimnameは各次元の次元名が配列として収められたものである。

[*index]

データの切り出しを行う。

引数

index: インデックス(Array)

備考

self[0..1, 0] のようにして用いる。
インデックスはNArrayのインデックス指定に基づいている。
このメソッドは切り出した結果を新しいオブジェクトとするが、参照のみのデータ切り出しmapメソッドもある。詳しくは参照のみのサブセット切り出しを参照のこと。

[*index]=val

オブジェクトへの書き込みを行う。

引数

index: インデックス(Array)
val: 設定する値(Numeric, NArray)

備考

self[0..1, 0]=99.9 のようにして用いる。
インデックスはNArrayのインデックス指定に基づいている。

get

現在の数値配列を取り出す。

引数

なし

備考

返り値はNArrayオブジェクトである。

set(ary)

数値配列を変更する。

引数

ary: 新しい配列(NArray)

備考

get_att(attname)

属性の値を参照する。

引数

attname: 参照する属性名(String)

備考

set_att(attname, val)

属性を設定する。

引数

attname: 属性名(String)
val: 設定する値(Numeric, String)

備考

属性名については((<GPhysが解釈する属性>))を参照のこと。

name

データの名前を参照する。

引数

なし

備考

get_attr("name")と同じである。

name=(name)

データの名前を設定する。

引数

name: 新しい名前(String)

備考

set_attr("name", name)と同じである。

valid_range

データの有効範囲を参照する。

引数

なし

備考

set_attr("valid_range")と同じである。

valid_range=(range)

データの有効範囲を設定する。

引数

range: 新しいデータの範囲(Range)

備考

set_attr("valid_range", range)と同じである。

units

データの単位を参照する。

引数

なし

備考

get_attr("units")と同じである。

units=(units)

データの単位を設定する。

引数

units: 新しい単位(String)

備考

set_attr("units", units)と同じである。
将来的にはUnitsクラスを作成し、単位は全てUnitsクラスのオブジェクトにする。

map(mapper)

データの参照のみの切り出しを行う。

引数

mapper: 参照を与えるマッパーオブジェクト(Mapper)

備考

詳しくは((<参照のみのサブセット切り出し>))を参照のこと。

each_subset(forbit=nil){|data|

データオブジェクトの各サブセットに関する繰り返しを行う。

引数

forbit: 分割禁止次元(Fixnum)
data: データオブジェクトのサブセット(GDataMem)

備考

データの分割は内部で自動的に行われる。
データ分割については大規模データの取り扱いを参照のこと

each_slicer(forbit=nil){|mapper|

データオブジェクトの各サブセットを指すインデックスに関する繰り返しを行う。

引数

forbit: 分割禁止次元(Fixnum)
data: データオブジェクトのサブセットを指すインデックス(Mapper)

備考

データの分割は内部で自動的に行われる。
データ分割については大規模データの取り扱いを参照のこと

indgen, indgen!(initial=nil, increaze=nil)

配列の要素を指定した初期値、増加量で増やす。

引数

initial: 初期値(Numeric)
increaze

備考

indgen!は自分自身の変更を表す。

fill, fill!

配列を同一の値で埋める。

引数

なし

備考

fill!は自分自身の変更を表す。

random, random!

配列の値を0から指定した値までのランダム値に設定する。

引数

なし

備考

reshape, reshape!, shape=(newshape)

配列の形を変更する。

引数

newshape: 新しい配列の形(Array)

備考

redhape!は自分自身の変更を表す。

newdim, newdim!(dim)

長さ1の次元を挿入する。

引数

dim: 挿入する次元

備考

newdim!は自分自身の変更を表す。

floor

selfよりも小さい最大の整数を返す。

引数

なし

備考

ceil

selfよりも大きい最小の整数を返す。

引数

なし

備考

round

selfに最も近い整数を返す。

引数

なし

備考

to_f

値を浮動小数点数に変換する。

引数

なし

備考

to_i

値を整数に変換する。

引数

なし

備考

dim, rank

次元数を返す。

引数

なし

備考

返り値はFixnumである。

shape

現在の配列の形を返す。

引数

なし

備考

返り値はArrayである。

total

現在の配列の要素数を返す。

引数

なし

備考

返り値はFixnumである。

+(other)

加算を行う。

引数

other: 計算対象(GData, Numeric)

備考

GDataオブジェクト同士の二項演算はお互いが異なる次元数の場合にも対応できる。
その場合、一方を他方に拡張する必要があるが、拡張を行う次元の判断は各ファイル形式毎に用意されている関連判断のメソッドにより行う。
異なる種類のデータ同士の計算も可能である。計算結果はselfと同じファイル形式となる。

-(other)

減算を行う。

引数

other: 計算対象(GData, Numeric)

備考

GDataオブジェクト同士の二項演算はお互いが異なる次元数の場合にも対応できる。
その場合、一方を他方に拡張する必要があるが、拡張を行う次元の判断は各ファイル形式毎に用意されている関連判断のメソッドにより行う。
異なる種類のデータ同士の計算も可能である。計算結果はselfと同じファイル形式となる。

*(other)

積算を行う。

引数

other: 計算対象(GData, Numeric)

備考

GDataオブジェクト同士の二項演算はお互いが異なる次元数の場合にも対応できる。
その場合、一方を他方に拡張する必要があるが、拡張を行う次元の判断は各ファイル形式毎に用意されている関連判断のメソッドにより行う。
異なる種類のデータ同士の計算も可能である。計算結果はselfと同じファイル形式となる。

/(other)

除算を行う。

引数

other: 計算対象(GData, Numeric)

備考

GDataオブジェクト同士の二項演算はお互いが異なる次元数の場合にも対応できる。
その場合、一方を他方に拡張する必要があるが、拡張を行う次元の判断は各ファイル形式毎に用意されている関連判断のメソッドにより行う。
異なる種類のデータ同士の計算も可能である。計算結果はselfと同じファイル形式となる。

add(other, klass=nil)

結果を別オブジェクトとできる加算

引数

other: 計算対象(GData, Numeric)
klass: 結果のクラス(Class)

備考

GDataオブジェクト同士の二項演算はお互いが異なる次元数の場合にも対応できる。
その場合、一方を他方に拡張する必要があるが、拡張を行う次元の判断は各ファイル形式毎に用意されている関連判断のメソッドにより行う。
異なる種類のデータ同士の計算も可能である。計算結果はklassで指定したクラスのオブジェクトとなる。

sub(other, klass=nil)

結果を別オブジェクトとできる減算

引数

other: 計算対象(GData, Numeric)
klass: 結果のクラス(Class)

備考

GDataオブジェクト同士の二項演算はお互いが異なる次元数の場合にも対応できる。
その場合、一方を他方に拡張する必要があるが、拡張を行う次元の判断は各ファイル形式毎に用意されている関連判断のメソッドにより行う。
異なる種類のデータ同士の計算も可能である。計算結果はklassで指定したクラスのオブジェクトとなる。

mul(other, klass=nil)

結果を別オブジェクトとできる積算

引数

other: 計算対象(GData, Numeric)
klass: 結果のクラス(Class)

備考

GDataオブジェクト同士の二項演算はお互いが異なる次元数の場合にも対応できる。
その場合、一方を他方に拡張する必要があるが、拡張を行う次元の判断は各ファイル形式毎に用意されている関連判断のメソッドにより行う。
異なる種類のデータ同士の計算も可能である。計算結果はklassで指定したクラスのオブジェクトとなる。

div(other, klass=nil)

結果を別オブジェクトとできる除算

引数

other: 計算対象(GData, Numeric)
klass: 結果のクラス(Class)

備考

GDataオブジェクト同士の二項演算はお互いが異なる次元数の場合にも対応できる。
その場合、一方を他方に拡張する必要があるが、拡張を行う次元の判断は各ファイル形式毎に用意されている関連判断のメソッドにより行う。
異なる種類のデータ同士の計算も可能である。計算結果はklassで指定したクラスのオブジェクトとなる。

sum(dim)

指定した次元に関する和

引数

dim: 計算を行う次元(Fixnum)

備考

本メソッドのように計算の結果、次元数が変化する場合座標情報も正しく更新されている。

avg(dim)

指定した次元に関する平均

引数

dim: 計算を行う次元(Fixnum)

備考

本メソッドのように計算の結果、次元数が変化する場合座標情報も正しく更新されている。

var(dim)

指定した次元に関する分散

引数

dim: 計算を行う次元(Fixnum)

備考

本メソッドのように計算の結果、次元数が変化する場合座標情報も正しく更新されている。

stddev(dim)

指定した次元に関する標準偏差

引数

dim: 計算を行う次元(Fixnum)

備考

本メソッドのように計算の結果、次元数が変化する場合座標情報も正しく更新されている。

NumRu::GDataFile

本クラスについて

物理量ライブラリの実装が進み、利用できるデータ形式が増えるにしたがっ

てその管理は難しくなる。共通部分は上位クラスにまとめて定義することでデータクラスの実装や管理が簡単になり、開発効率が増す。ファイルを扱うデータクラスとしてGDataFileクラスを設け、各ファイル形式毎のクラスはGDataFile のサブクラスとする。

(補足)GDataFileクラスの実装について

GDataFileクラスの実装に移る前に現在実装されているGDataMemと

GDataNetCDFの構成について述べる。まず、GDataMemの内部変数は数値配列とデータの属性である。一方、NetCDFVarオブジェクトはデータの属性を内部に持っているため、GDataNetCDFの内部変数はNetCDFVarオブジェクトのみである。その他様々なデータ形式に関してもデータ変数内にデータの属性が定義できるかできないかで次の2種類に分類することができる

内部変数としてデータ変数のみをもつ。
内部変数としてデータ変数とデータの属性を持っている。

データクラスを上の2種類に統一するためにはデータクラスの下位レベルで予め統一された枠組みを用意しなければならない。そこでこの枠組みを各データ形式の入出力ライブラリ内で用意する。すなわち、入出力ライブラリの構成要素として、RubyNetCDFのNetCDFクラスに相当するファイルクラスとNetCDFVar クラスに相当する変数クラス、そしてNetCDFAttクラスに相当する属性クラスが必要である。NetCDFDimに相当するクラスはデータ操作には関係ない部分なので実装する必要はない。入出力ライブラリの統一により、各データクラスのメソッド内での入出力ライブラリメソッドの呼び出しが統一される。従って共通メソッドをGDataFileクラスに定義することができる。

スーパークラス

GData

NumRu::GDataNetCDF

本クラスについて

本クラスはNetCDFファイルのデータを扱うためのクラスである。

スーパークラス

GDataFile

クラスメソッド

initialize(netcdfvar)

初期化を行う。

引数

netcdfvar: NetCDFVarオブジェクト(NetCDFVar)

備考

GDataNetCDFクラスの全ての初期化関数はこのメソッドを呼んでいる。

new2(name, ntype, shape_ul0, dimname, filename=nil, attr=nil, mode="r+")

データ型と配列の形から初期化を行う。

引数

name: 変数名(String)
ntype: データ型(String)
shape_ul0: 配列の形(Array)
dimname: 次元名(Array)
filename: ファイル名(String)
attr: 変数の属性(Hash)
mode: ファイルの読み書きモード(String)

備考

データ型は次のものが指定できる。
- "byte"(unsigned char): 1バイト整数型
- "sint": 1バイト整数型
- "int": 2バイト整数型
- "long": 4バイト整数型
- "float": 4バイト浮動小数点型
- "double": 8バイト浮動小数点型
属性名についてはGPhysが解釈する属性を参照のこと。
modeはRubyのファイルモードと同じである。
- r: 読み込み専用
- r+: 読み書き両用
- w: 新規作成書き込み専用
- w+: 新規作成読み書き両用
- a: 追加書き込み、書き込み専用
- a+: 追加書き込み、読み書き両用

new3(name, narray, dimname, filename=nil, attr=nil, mode="r+")

配列から初期化を行う。

引数

name: 変数名(String)
narray: 配列(NArray)
dimname: 次元名(Array)
filename: ファイル名(String)
attr: 変数の属性(Hash)
mode: ファイルの読み書きモード

備考

属性名についてはGPhysが解釈する属性を参照のこと。
modeはRubyのファイルモードと同じである。
- r: 読み込み専用
- r+: 読み書き両用
- w: 新規作成書き込み専用
- w+: 新規作成読み書き両用
- a: 追加書き込み、書き込み専用
- a+: 追加書き込み、読み書き両用

open(name, filename, mode="r")

ファイルを開き、初期化を行う。

引数

name: 変数名(String)
filename: ファイル名(String)
mode: ファイルの読み書きモード(String)

備考

modeはRubyのファイルモードと同じである。
- r: 読み込み専用
- r+: 読み書き両用
- w: 新規作成書き込み専用
- w+: 新規作成読み書き両用
- a: 追加書き込み、書き込み専用
- a+: 追加書き込み、読み書き両用

create_another(shape=nil, ntype=nil, file=nil, attr=nil)

同じ属性を持つGDataMemオブジェクトを作る。

引数

shape: 配列の形(Array)
ntype: データの型(String)
file: ファイル名(String)
attr: データの属性(Hash)

備考

本メソッドは別のデータオブジェクトを作る。コピー先のクラスはコピー元と同じである。

copy(destination=nil, filename=nil)

オブジェクトの複製を行う。

引数

destination: コピー先のクラス(Class)
dimname: 次元名(Array)
filename: ファイル名(String)

備考

本メソッドはディープなコピーを行う。即ち、配列のコピーも行う。また、コピー先のクラスを指定することが出来る。

[*index]

データの切り出しを行う。

引数

index: インデックス(Array)

備考

self[0..1, 0] のようにして用いる。
インデックスはNArrayのインデックス指定に基づいている。
このメソッドは切り出した結果を新しいオブジェクトとするが、参照のみのデータ切り出しmapメソッドもある。詳しくは参照のみのサブセット切り出しを参照のこと。

[*index]=val

オブジェクトへの書き込みを行う。

引数

index: インデックス(Array)
val: 設定する値(Numeric, NArray)

備考

self[0..1, 0]=99.9 のようにして用いる。
インデックスはNArrayのインデックス指定に基づいている。

each_slicer(forbit=nil){|mapper|

データオブジェクトの各サブセットを指すインデックスに関する繰り返しを行う。

引数

forbit: 分割禁止次元(Fixnum)
data: データオブジェクトのサブセットを指すインデックス(Mapper)

備考

データの分割は内部で自動的に行われる。
データ分割については大規模データの取り扱いを参照のこと

each_subset(forbit=nil){|data|

データオブジェクトの各サブセットに関する繰り返しを行う。

引数

forbit: 分割禁止次元(Fixnum)
data: データオブジェクトのサブセット(GDataMem)

備考

データの分割は内部で自動的に行われる。
データ分割については大規模データの取り扱いを参照のこと

set(ary)

数値配列を変更する。

引数

ary: 新しい配列(NArray)

備考

get

現在の数値配列を取り出す。

引数

なし

備考

返り値はNArrayオブジェクトである。

get_att(attname)

属性の値を参照する。

引数

attname: 参照する属性名(String)

備考

set_att(attname, val)

属性を設定する。

引数

attname: 属性名(String)
val: 設定する値(Numeric, String)

備考

属性名については((<GPhysが解釈する属性>))を参照のこと。

name

データの名前を参照する。

引数

なし

備考

get_attr("name")と同じである。

name=(name)

データの名前を設定する。

引数

name: 新しい名前(String)

備考

set_attr("name", name)と同じである。

valid_range

データの有効範囲を参照する。

引数

なし

備考

set_attr("valid_range")と同じである。

valid_range=(range)

データの有効範囲を設定する。

引数

range: 新しいデータの範囲(Range)

備考

set_attr("valid_range", range)と同じである。

units

データの単位を参照する。

引数

なし

備考

get_attr("units")と同じである。

units=(units)

データの単位を設定する。

引数

units: 新しい単位(String)

備考

set_attr("units", units)と同じである。
将来的にはUnitsクラスを作成し、単位は全てUnitsクラスのオブジェクトにする。

indgen, indgen!(initial=nil, increaze=nil)

配列の要素を指定した初期値、増加量で増やす。

引数

initial: 初期値(Numeric)
increaze

備考

indgen!は自分自身の変更を表す。

fill, fill!

配列を同一の値で埋める。

引数

なし

備考

fill!は自分自身の変更を表す。

random, random!

配列の値を0から指定した値までのランダム値に設定する。

引数

なし

備考

reshape, reshape!, shape=(newshape)

配列の形を変更する。

引数

newshape: 新しい配列の形(Array)

備考

redhape!は自分自身の変更を表す。

newdim, newdim!(dim)

長さ1の次元を挿入する。

引数

dim: 挿入する次元

備考

newdim!は自分自身の変更を表す。

floor

selfよりも小さい最大の整数を返す。

引数

なし

備考

ceil

selfよりも大きい最小の整数を返す。

引数

なし

備考

round

selfに最も近い整数を返す。

引数

なし

備考

to_f

値を浮動小数点数に変換する。

引数

なし

備考

to_i

値を整数に変換する。

引数

なし

備考

dim, rank

次元数を返す。

引数

なし

備考

返り値はFixnumである。

shape

現在の配列の形を返す。

引数

なし

備考

返り値はArrayである。

total

現在の配列の要素数を返す。

引数

なし

備考

返り値はFixnumである。

+(other)

加算を行う。

引数

other: 計算対象(GData, Numeric)

備考

GDataオブジェクト同士の二項演算はお互いが異なる次元数の場合にも対応できる。
その場合、一方を他方に拡張する必要があるが、拡張を行う次元の判断は各ファイル形式毎に用意されている関連判断のメソッドにより行う。
異なる種類のデータ同士の計算も可能である。計算結果はselfと同じファイル形式となる。

-(other)

減算を行う。

引数

other: 計算対象(GData, Numeric)

備考

GDataオブジェクト同士の二項演算はお互いが異なる次元数の場合にも対応できる。
その場合、一方を他方に拡張する必要があるが、拡張を行う次元の判断は各ファイル形式毎に用意されている関連判断のメソッドにより行う。
異なる種類のデータ同士の計算も可能である。計算結果はselfと同じファイル形式となる。

*(other)

積算を行う。

引数

other: 計算対象(GData, Numeric)

備考

GDataオブジェクト同士の二項演算はお互いが異なる次元数の場合にも対応できる。
その場合、一方を他方に拡張する必要があるが、拡張を行う次元の判断は各ファイル形式毎に用意されている関連判断のメソッドにより行う。
異なる種類のデータ同士の計算も可能である。計算結果はselfと同じファイル形式となる。

/(other)

除算を行う。

引数

other: 計算対象(GData, Numeric)

備考

GDataオブジェクト同士の二項演算はお互いが異なる次元数の場合にも対応できる。
その場合、一方を他方に拡張する必要があるが、拡張を行う次元の判断は各ファイル形式毎に用意されている関連判断のメソッドにより行う。
異なる種類のデータ同士の計算も可能である。計算結果はselfと同じファイル形式となる。

add(other, klass=nil)

結果を別オブジェクトとできる加算

引数

other: 計算対象(GData, Numeric)
klass: 結果のクラス(Class)

備考

GDataオブジェクト同士の二項演算はお互いが異なる次元数の場合にも対応できる。
その場合、一方を他方に拡張する必要があるが、拡張を行う次元の判断は各ファイル形式毎に用意されている関連判断のメソッドにより行う。
異なる種類のデータ同士の計算も可能である。計算結果はklassで指定したクラスのオブジェクトとなる。

sub(other, klass=nil)

結果を別オブジェクトとできる減算

引数

other: 計算対象(GData, Numeric)
klass: 結果のクラス(Class)

備考

GDataオブジェクト同士の二項演算はお互いが異なる次元数の場合にも対応できる。
その場合、一方を他方に拡張する必要があるが、拡張を行う次元の判断は各ファイル形式毎に用意されている関連判断のメソッドにより行う。
異なる種類のデータ同士の計算も可能である。計算結果はklassで指定したクラスのオブジェクトとなる。

mul(other, klass=nil)

結果を別オブジェクトとできる積算

引数

other: 計算対象(GData, Numeric)
klass: 結果のクラス(Class)

備考

GDataオブジェクト同士の二項演算はお互いが異なる次元数の場合にも対応できる。
その場合、一方を他方に拡張する必要があるが、拡張を行う次元の判断は各ファイル形式毎に用意されている関連判断のメソッドにより行う。
異なる種類のデータ同士の計算も可能である。計算結果はklassで指定したクラスのオブジェクトとなる。

div(other, klass=nil)

結果を別オブジェクトとできる除算

引数

other: 計算対象(GData, Numeric)
klass: 結果のクラス(Class)

備考

GDataオブジェクト同士の二項演算はお互いが異なる次元数の場合にも対応できる。
その場合、一方を他方に拡張する必要があるが、拡張を行う次元の判断は各ファイル形式毎に用意されている関連判断のメソッドにより行う。
異なる種類のデータ同士の計算も可能である。計算結果はklassで指定したクラスのオブジェクトとなる。

sum(dim)

指定した次元に関する和

引数

dim: 計算を行う次元(Fixnum)

備考

本メソッドのように計算の結果、次元数が変化する場合座標情報も正しく更新されている。

avg(dim)

指定した次元に関する平均

引数

dim: 計算を行う次元(Fixnum)

備考

本メソッドのように計算の結果、次元数が変化する場合座標情報も正しく更新されている。

var(dim)

指定した次元に関する分散

引数

dim: 計算を行う次元(Fixnum)

備考

本メソッドのように計算の結果、次元数が変化する場合座標情報も正しく更新されている。

stddev(dim)

指定した次元に関する標準偏差

引数

dim: 計算を行う次元(Fixnum)

備考

本メソッドのように計算の結果、次元数が変化する場合座標情報も正しく更新されている。

NumRu::Gpraphic

本モジュールについて

本モジュールはGPhysオブジェクトを可視化するためのモジュールである。GPhysの持つデータ変数と座標変数が一体化しているという特徴を生かし、可視化を行うことが出来る。

また、本モジュールはAdvancedDCLを用いたものとなっており、本モジュールとAdvancedDCLを併用することによりより細かい可視化が可能となる。

更に、GPhysオブジェクトに設定した属性を自動的に解釈し、可視化を行う。解釈する属性についてはGPhysが解釈する属性を参照のこと。

contour(option=nil)

等高線図を描く。

引数

option: 可視化オプション(Hash)

備考

可視化オプションはAdvancedDCLにおけるパラメタ名、値を指定する。この設定はテンポラリなパラメタ設定となるので、描画後設定したパラメタは元の値に戻る。それが好ましくない場合はAdvancedDCLをユーザが直接用いパラメタ設定することになる。

Object

initialize(coord=nil)

初期化を行う。

引数

coord: 各軸のデータオブジェクト(Array)

備考

coordは各軸のデータ変数、補助変数がArrayとして収められているものである。すなわち、 coord = [[axis,support],[axis,support], ...] であり、axis, supportは共にGDataオブジェクトである。

rank

次元数を返す。

引数

なし

備考

返り値はFixnumである。

shape

各次元の長さをまとめて返す。

引数

なし

備考

返り値はArrayである。

get_axis(dim)

指定した次元のデータを返す。

引数

dim: 指定する次元(Fixnum)

備考

返り値はGDataである。

set_axis(dim, var)

指定した次元のデータを設定する。

引数

dim: 指定する次元(Fixnum)
var: 設定するデータ変数(GData)

備考

get_axis_att(dim, name)

指定した次元の属性を参照する。

引数

dim: 指定する次元(Fixnum)
name: 属性名(String)

備考

属性名については((<GPhysが解釈する属性>))を参照のこと。

set_axis_att(dim, name, val)

指定した次元の属性を設定する。

引数

dim: 指定する次元(Fixnum)
name: 属性名(String)
val: 設定する属性の値(String, Numeric)

備考

属性名については((<GPhysが解釈する属性>))を参照のこと。

get_supl(dim)

指定した次元の補助変数を取り出す。

引数

dim: 指定する次元(Fixnum)

備考

get_axis_value(dim)

指定した次元のデータ配列を取り出す。

引数

dim: 指定する次元(Fixnum)

備考

set_axis_value(dim)

指定した次元のデータ配列を設定する。

引数

dim: 指定する次元(Fixnum)

備考

copy

オブジェクトの複製を行う。

引数

なし

備考

slicer(option)

オプションからデータの切り出しを行う。

引数

option: データ切り出しのオプション(Hash)

備考

オプションを与えるハッシュのキーとして次のものを用いることができる。
* dvn(n=1,2,....): n次元目に関するインデックスを指定する。値にはFixnumまたはRangeを指定する。
    例）dv1=>2..7
* to2d: 2次元化を行う。最初の2つの次元の全ての要素と残りの次元の最初の要素を切り出す。to2d=>true で有効となる。

[*index]

データの切り出しを行う。

引数

index: インデックス(Array)

備考

self[0..1, 0] のようにして用いる。
インデックスはNArrayのインデックス指定に基づいている。

参照のみのサブセット切り出し

本ライブラリにおいて、データの切り出しには大きく２種類ある。最初の方法がメモリ上に新たに領域を確保し、切り出したデータをそこに収める方法である。そしてもう１つの方法が参照のみのサブセット切り出しである。これを行うためにMapperクラスを設け、データクラスの内部変数としてMapperオブジェクトを持たせ、データオブジェクトがデータ変数全体のどの位置を指しているかという情報を持たせている。この方法はその場で新たなメモリ領域を確保しないと言う点で前者と大きく異なる。前者の方法は[ ]メソッド、後者の方法はmapメソッドを用いて行う。

大規模データの取り扱い

本ライブラリでは大規模データを扱うための機能を組み込んだ。これはデータ分割をどのように行うのかを自動的に決定するものである。従来だとユーザがどのようにデータを分割するかを決定した上でプログラミングを行わなければならなかったが、本ライブラリを用いることでその負担が解消される。本ライブラリにおけるデータの分割は回転の遅い次元（NArrayでは最後の次元)から分割のための適当なサイズの上限に応じて優先的に分割を行う。即ち､まず最後の次元に関する分割が行われ、それでも上限を上回る場合はその次の次元についても分割が行われる。また、分割にあたってユーザが予め様々な項目を設定できる。

分割しない次元をユーザが指定できる。

ある次元に関する平均操作など、分割してはいけない次元が存在する場合、その次元を分割しないように指定することができる。

ユーザがデータを分割するサイズの上限を設定することが出来る。

GPhys

本ライブラリの使用法

本ライブラリによるデータの取り扱い

GPhysが解釈する属性

クラスメソッド

インスタンスメソッド

NumRu::GData

本クラスについて

スーパークラス

クラスメソッド

NumRu::GDataFile

本クラスについて

(補足)GDataFileクラスの実装について

スーパークラス

NumRu::GDataNetCDF

本クラスについて

スーパークラス

クラスメソッド

NumRu::Gpraphic

本モジュールについて

NumRu::CoordReg

本クラスについて

スーパークラス

参照のみのサブセット切り出し

大規模データの取り扱い