1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
|
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="ja" xml:lang="ja">
<head>
<meta http-equiv="Content-type" content="text/html; charset=utf-8" />
<title>Untitled</title>
</head>
<body>
<h1><a name="label-0" id="label-0">RubyNetCDF レファレンスマニュアル</a></h1><!-- RDLabel: "RubyNetCDF レファレンスマニュアル" -->
<p>RubyNetCDF version : 0.7.1</p>
<ul>
<li><a href="#label-9">メソッドインデックス</a></li>
</ul>
<p>---------------------------------------------</p>
<h2><a name="label-1" id="label-1">概要</a></h2><!-- RDLabel: "概要" -->
<p>RubyNetCDF は NetCDF ライブラリーの Ruby インターフェースである。Ruby
はフリーなオブジェクト指向スクリプト言語であり、
<a href="http://www.ruby-lang.org/">ここ</a>
から入手できる。RubyNetCDF は数値配列として、
Ruby で一般的に使われている多次元数値配列ライブラリー
<a href="http://www.ruby-lang.org/en/raa-list.rhtml?name=NArray">NArray</a>
を用るので、あらかじめインストールしておく必要がある。
NArray はデータを、C のポインターが指す連続したメモリー領域
に保持し、計算機資源を効率よく利用する。NArray は Python における
NumPy と似るが、幾つかのテストは NArray のほうが NumPy より効率が良い
ことを示唆している。
オプションとして、RubyNetCDF はデータ欠損の自動的な取り扱いメソッドを
提供する。これを使うには、
<a href="http://ruby.gfd-dennou.org/products/narray_miss/">NArrayMiss</a>
が必要である。詳しくは<a href="#label-6">使用法</a>を見よ。</p>
<p>現在 NetCDF-4 のサポートは部分的である(新しいデータモデルはサポートしてない)。</p>
<h3><a name="label-2" id="label-2">構成</a></h3><!-- RDLabel: "構成" -->
<p>RubyNetCDF は以下の４つのクラスから構成される。</p>
<ul>
<li><p><a href="#label-10">クラス NetCDF</a> -- ファイルのクラス</p>
<p>一つのNetCDFクラスのオブジェクトは一つの NetCDF ファイルに対応する</p></li>
<li><p><a href="#label-47">クラス NetCDFDim</a> -- 次元のクラス</p>
<p>C 版 NetCDF では、次元は、ファイルのIDと次元IDという２変数の組で表されるが、
Ruby 版では一つの NetCDFDim オブジェクトで代表される</p></li>
<li><p><a href="#label-55">クラス NetCDFVar</a> -- 変数のクラス</p>
<p>C 版 NetCDF では、変数は、ファイルのIDと変数IDという２変数の組で表されるが、
Ruby 版では一つの NetCDFVar オブジェクトで代表される</p></li>
<li><p><a href="#label-98">クラス NetCDFAtt</a> -- 属性のクラス</p>
<p>C 版 NetCDF では、属性は、ファイルのIDと変数IDと属性名の組で表されるが、
Ruby 版では一つの NetCDFAtt オブジェクトで代表される</p></li>
</ul>
<h3><a name="label-3" id="label-3">データ型</a></h3><!-- RDLabel: "データ型" -->
<p>本ライブラリーでは全ての NetCDF 変数の型 char, byte, short, int,
float, double がサポートされている。しかし、これらは Ruby の（より正確
に言うと NArray の）慣例に従って、それぞれ "char", "byte", "sint",
"int", "sfloat", "float" と呼ばれる。従って、NetCDFVar クラスの vartype
(=ntype) はこれらの文字列の一つを返す。また、NetCDFクラスの def_var メ
ソッドは、変数を定義する際、これらを受け付ける。特に注意する必要がある
のは、本ライブラリーでの "float" は C で言うところの double を意味する
ということである。これは Ruby の慣例のせいである -- 組み込みの Float
クラスは、C の float でなく double に対応するのである。</p>
<p>NetCDFVar クラスの get メソッドはファイル中と同じ型の NArray 変数に値
を読み込むが、"char" 型変数については "byte" 型 NArray に読み込まれる。
これは NArray が "char" 型を持たないからである。ただ、そもそも NArray
は byte 型で文字列を簡単に扱えるので、特に不都合はないと考えられる。</p>
<h3><a name="label-4" id="label-4">エラー処理</a></h3><!-- RDLabel: "エラー処理" -->
<p>エラーは基本的には例外を発生することにより対処する。但し、値を返すメソッ
ドでは軽微なエラーは nil を返すことで対処する（属性値を得るために指定
された名前の属性が存在しないときなど）。例外的な状況で nil を発生する
メソッドについてはマニュアルに明記してある。</p>
<h3><a name="label-5" id="label-5">セキュリティ</a></h3><!-- RDLabel: "セキュリティ" -->
<p>組み込みの File クラスと同じセキュリティー対応をしていてる。</p>
<h3><a name="label-6" id="label-6">使用法</a></h3><!-- RDLabel: "使用法" -->
<p>RubyNetCDFライブラリーを利用するためには、まず次の行を Ruby プログラムに書い
てライブラリーをロードする必要がある。</p>
<pre>require 'numru/netcdf'</pre>
<p>もしも (NetCDFVarクラスの) 自動的なデータ欠損処理メソッドを使いたい場
合は、以下を実行する必要がある。</p>
<pre>require 'numru/netcdf_miss'</pre>
<p>これは内部で一番最初に <code>require 'numru/netcdf'</code> を実行するので、
これだけ呼べば良い。データ欠損の扱いは
<a href="http://ruby.gfd-dennou.org/products/narray_miss/">NArrayMiss</a>
によるので、これをインストールしておかねばならない。
もしも <code>require 'numru/netcdf'</code> だけを呼ぶのなら、NArrayMiss
は不要である。</p>
<p>ここで、'numru' ("Numerical Ruby"から取られた) はユーザーのライブラリー
ロードパス中のサブディレクトリーで、RubyNetCDF ライブラリーが置かれる。
すると、以下のように利用できるようになる。</p>
<pre>file = NumRu::NetCDF.create('tmp.nc')
x = file.def_dim('x',10)
y = file.def_dim('y',10)
v = file.def_var('v','float',[x,y])
file.close</pre>
<p>ここで、NumRu はこのライブラリーを含むモジュールである。このようなモジュー
ルにくるんであるのは、名前空間での衝突を避けるためである。このような扱
いをしない場合、もしもユーザーが、本ライブラリー中のクラスと名前が衝突
するクラスやモジュールを含むライブラリーを使おうとすると、問題が起る。</p>
<p>このような問題が起こらないであろう場合は、"NumRu::" という冠は、NumRu
モジュールを「インクルード」することで外せる（現在のスコープにおいてと
いうこである）。従って次のように書ける。</p>
<pre>include NumRu
file = NetCDF.create('tmp.nc')
...</pre>
<p>さらなる使用例としてはダウンロード用パッケージに含まれる demo や test
プログラムを参照せよ。</p>
<p>---------------------------------------------</p>
<h2><a name="label-7" id="label-7">マニュアルの見方</a></h2><!-- RDLabel: "マニュアルの見方" -->
<dl>
<dt><h4><a name="label-8" id="label-8"><code>メソッド名(引数<var>1</var>, 引数<var>2</var>, ...) -- 省略可能な引数は 引数名=デフォルト値 の形で示す</code></a></h4></dt><!-- RDLabel: "メソッド名" -->
<dd>
<p>機能の解説</p>
<p>引数</p>
<ul>
<li>引数1の名 (そのクラスまたは取り得る値): 説明</li>
<li>引数2の名 (そのクラスまたは取り得る値): 説明</li>
<li>...</li>
</ul>
<p>戻り値</p>
<ul>
<li>戻り値の説明</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>NetCDF ver 3 の関数名。括弧がない場合、その関数と同等の機能を有
することを示す。直接的な対応がない場合、括弧内に依存する関数を挙げる。</li>
</ul></dd>
</dl>
<p>---------------------------------------------</p>
<h2><a name="label-9" id="label-9">メソッドインデックス</a></h2><!-- RDLabel: "メソッドインデックス" -->
<ul>
<li><p><a href="#label-10">クラス NetCDF</a></p>
<p>クラスメソッド</p>
<ul>
<li><a href="#label-13">NetCDF.nc4?</a> リンクされた NetCDF が version 4 かどうか返す</li>
<li><a href="#label-14">NetCDF.creation_format=</a> NetCDF.createで作られるファイルフォーマットを設定する (NetCDF-4 専用).</li>
<li><a href="#label-15">NetCDF.creation_format</a> NetCDF.createで作られるファイルフォーマットの設定を返す. (NetCDF-4 専用).</li>
<li><a href="#label-16">NetCDF.open</a> ファイルオープン（クラスメソッド）mode="w" でファイルが存在しなければ新規作成</li>
<li><a href="#label-17">NetCDF.new</a> NetCDF.openメソッドのエイリアスである</li>
<li><a href="#label-18">NetCDF.create</a> NetCDFファイルを作る（クラスメソッド)</li>
<li><a href="#label-19">NetCDF.create_tmp</a> テンポラリーNetCDFファイルを作る（クラスメソッド)</li>
</ul>
<p>インスタンスメソッド</p>
<ul>
<li><a href="#label-21">close</a> ファイルクローズ</li>
<li><a href="#label-22">ndims</a> ファイル中の次元の数を返す</li>
<li><a href="#label-23">nvars</a> ファイル中の変数の数を返す</li>
<li><a href="#label-24">natts</a> ファイル中のグローバル属性の数を返す</li>
<li><a href="#label-25">unlimited</a> ファイル中のunlimited dimensionを返す</li>
<li><a href="#label-26">path</a> ファイルのパス. open/create時のfilename引数の中身を返す.</li>
<li><a href="#label-27">redef</a> define modeにする。既にそうなら何もせずnilを返す。</li>
<li><a href="#label-28">enddef</a> data mode に入る。既にそうなら何もせずnilを返す。</li>
<li><a href="#label-29">define_mode?</a> 今定義モードかどうか問合わせる.</li>
<li><a href="#label-30">sync</a> メモリー中のバッファーをディスク上に反映してファイルを同期させる</li>
<li><a href="#label-31">def_dim</a> dimensionを定義</li>
<li><a href="#label-32">put_att</a> グローバル属性を設定</li>
<li><a href="#label-33">def_var</a> 変数を定義</li>
<li><a href="#label-34">def_var_with_dim</a> def_varと同じだが必要ならまず次元を定義する。</li>
<li><a href="#label-35">var</a> ファイルに既存の変数をオープン</li>
<li><a href="#label-36">vars</a> ファイルに既存の変数をまとめてオープン</li>
<li><a href="#label-37">dim</a> 既存の次元をオープン</li>
<li><a href="#label-38">dims</a> 既存の次元をまとめてオープン</li>
<li><a href="#label-39">att</a> 既存のグローバル属性をオープン</li>
<li><a href="#label-40">fill=</a> fillmodeの変更。(NetCDF のデフォルトは FILL である。)</li>
<li><a href="#label-41">each_dim</a> 次元に関するイテレータ. </li>
<li><a href="#label-42">each_var</a> 変数に関するイテレータ. </li>
<li><a href="#label-43">each_att</a> グローバル属性に関するイテレータ. </li>
<li><a href="#label-44">dim_names</a> ファイル中の全次元の名前を配列に入れて返す。</li>
<li><a href="#label-45">var_names</a> ファイル中の全変数の名前を配列に入れて返す。</li>
<li><a href="#label-46">att_names</a> ファイル中の全グローバル属性の名前を配列に入れて返す。</li>
</ul></li>
<li><p><a href="#label-47">クラス NetCDFDim</a></p>
<p>クラスメソッド</p>
<p>インスタンスメソッド</p>
<ul>
<li><a href="#label-50">length</a> 次元の長さを返す</li>
<li><a href="#label-51">length_ul0</a> length と同じだが、無制限次元に関しゼロを返す</li>
<li><a href="#label-52">name=</a> 名前をつけかえる</li>
<li><a href="#label-53">name</a> 名前を返す</li>
<li><a href="#label-54">unlimited?</a> 無制限次元かどうか？</li>
</ul></li>
<li><p><a href="#label-55">クラス NetCDFVar</a></p>
<p>クラスメソッド</p>
<ul>
<li><a href="#label-57">NetCDFVar.new</a> NetCDF.open と NetCDF#Var を組み合わせて一行で済ます(使わなくて良い).</li>
<li><a href="#label-58">NetCDFVar.unpack_type=</a> <a href="#label-89">unpack</a>で使うNArrayの型を固定する</li>
<li><a href="#label-59">NetCDFVar.unpack_type</a> <a href="#label-58">NetCDFVar.unpack_type=</a>で設定したNArrayの型を返す</li>
</ul>
<p>インスタンスメソッド</p>
<ul>
<li><a href="#label-61">deflate</a> 圧縮 (deflation) を設定. (netCDF-4 only)</li>
<li><a href="#label-62">deflate_params</a> 現在の圧縮設定問合せ. (netCDF-4 only)</li>
<li><a href="#label-63">endian=</a> エンディアンを設定 (netCDF-4 only)</li>
<li><a href="#label-64">endian</a> エンディアン設定を返す. (netCDF-4 only)</li>
<li><a href="#label-37">dim</a> その変数における dim_num 番目(0から数える)の次元を問合わせる。</li>
<li><a href="#label-38">dims</a> その変数の全次元を配列にいれて返す</li>
<li><a href="#label-67">shape_ul0</a> 変数の形を返す. 但し無制限次元の長さはゼロ.</li>
<li><a href="#label-68">shape_current</a> 変数の現在の形を返す.</li>
<li><a href="#label-43">each_att</a> 変数中の全属性(NetCDFAtt)に関するイテレータ</li>
<li><a href="#label-44">dim_names</a> 変数中の全次元の名前を配列に入れて返す。</li>
<li><a href="#label-46">att_names</a> 変数中の全属性の名前を配列に入れて返す。</li>
<li><a href="#label-53">name</a> 変数の名前を返す</li>
<li><a href="#label-52">name=</a> 名前を付け替える</li>
<li><a href="#label-22">ndims</a> 次元の数を問う</li>
<li><a href="#label-75">rank</a> ndimsのエリアス</li>
<li><a href="#label-76">ntype</a> vartype の別名</li>
<li><a href="#label-77">vartype</a> 変数値の型を問う</li>
<li><a href="#label-78">typecode</a> 変数値の型を問う(NArrayのtypecodeで返す)</li>
<li><a href="#label-24">natts</a> 属性の数を問う</li>
<li><a href="#label-80">file</a> その変数が属するファイルを問合わせる</li>
<li><a href="#label-39">att</a> 名前を指定した属性を返す</li>
<li><a href="#label-32">put_att</a> 属性を設定</li>
<li><a href="#label-83">put</a> <a href="#label-84">simple_put</a>の別名(alias)</li>
<li><a href="#label-84">simple_put</a> 値を入れる</li>
<li><a href="#label-85">pack</a> selfの属性 scale_factor and/or add_offset を用いて NArray 等を "pack" する.</li>
<li><a href="#label-86">scaled_put</a> <a href="#label-84">simple_put</a> と同様だが、<a href="#label-85">pack</a>により属性 scale_factor と add_offset を解釈する</li>
<li><a href="#label-87">get</a> <a href="#label-88">simple_get</a>の別名(alias)</li>
<li><a href="#label-88">simple_get</a> 値を取り出す</li>
<li><a href="#label-89">unpack</a> selfの属性 scale_factor and/or add_offset を用いて NArray 等を "unpack" する.</li>
<li><a href="#label-90">scaled_get</a> <a href="#label-88">simple_get</a> と同様だが、<a href="#label-89">unpack</a>により属性 scale_factor と add_offset を解釈する</li>
<li><a href="#label-91">[]</a> NetCDFVar#get と同様だが、サブセットを NArray#[] と同様に指定する. </li>
<li><a href="#label-92">[]=</a> NetCDFVar#put と同様だが、サブセットを NArray#[]= と同様に指定する.</li>
</ul>
<p>"numru/netcdf_miss" を require することで追加されるインスタンスメソッド</p>
<ul>
<li><a href="#label-94">get_with_miss</a> <a href="#label-87">get</a>と同様だが、データ欠損を処理する</li>
<li><a href="#label-95">get_with_miss_and_scaling</a> <a href="#label-94">get_with_miss</a>と同様だが、<a href="#label-89">unpack</a>によりスケーリングも行う.</li>
<li><a href="#label-96">put_with_miss</a> <a href="#label-83">put</a>と同様だが、データ欠損を処理する</li>
<li><a href="#label-97">put_with_miss_and_scaling</a> <a href="#label-96">put_with_miss</a>と同様だが、<a href="#label-85">pack</a>によりスケーリングも行う.</li>
</ul></li>
<li><p><a href="#label-98">クラス NetCDFAtt</a></p>
<p>クラスメソッド</p>
<p>インスタンスメソッド</p>
<ul>
<li><a href="#label-53">name</a> 属性の名前を返す</li>
<li><a href="#label-52">name=</a> 属性の名前を変更</li>
<li><a href="#label-103">copy</a> 属性を別の変数またはファイルにコピー。ファイルの場合はグローバル属性になる</li>
<li><a href="#label-104">delete</a> 属性を削除</li>
<li><a href="#label-83">put</a> 属性の値を設定</li>
<li><a href="#label-87">get</a> 属性の中身を取り出す</li>
<li><a href="#label-107">atttype</a> 属性値の型を問う</li>
<li><a href="#label-78">typecode</a> 属性値の型を問う(NArrayのtypecodeで返す)</li>
</ul></li>
</ul>
<p>---------------------------------------------</p>
<h1><a name="label-10" id="label-10">クラス NetCDF</a></h1><!-- RDLabel: "クラス NetCDF" -->
<h3><a name="label-11" id="label-11">定数</a></h3><!-- RDLabel: "定数" -->
<ul>
<li>NC_NOWRITE, NC_WRITE, NC_SHARE, NC_CLOBBER, NC_NOCLOBBER, NC_64BIT_OFFSET, NC_NETCDF4, NC_CLASSIC_MODEL, NCVERSION, SUPPORT_BIGMEM : これらは NumRu::NetCDF::NC_NOWRITE などアクセスする。</li>
</ul>
<h3><a name="label-12" id="label-12">クラスメソッド</a></h3><!-- RDLabel: "クラスメソッド" -->
<dl>
<dt><h4><a name="label-13" id="label-13"><code>NetCDF.nc4?</code></a></h4></dt><!-- RDLabel: "NetCDF.nc4?" -->
<dd>
このライブラリが NetCDF version 4 を使うようになっていれば
（リンクされてる NetCDF ライブラリがver 4なら）true を，
そうでなければ (NetCDF 3なら) false を返す。</dd>
<dt><h4><a name="label-14" id="label-14"><code>NetCDF.creation_format=(<var>cmode</var>)</code></a></h4></dt><!-- RDLabel: "NetCDF.creation_format=" -->
<dd>
<p>(このメソッドは NetCDF-4 が使われてるときのみ使用可能：そうでなければ
例外が発生する). NetCDF.create で作られるファイルのフォーマットを指定する.
初期設定は "classic".</p>
<p>引数</p>
<ul>
<li>cmode : 以下のいずれか。
<ul>
<li>0, nil, or NetCDF::NC_CLASSIC_MODEL : classic format
(以前からの NetCDF-3 のフォーマット). これが初期設定.</li>
<li>NetCDF::NC_64BIT_OFFSET : classic だが，変数のサイズを大きく出来る</li>
<li>NetCDF::NC_NETCDF4 : HDF5 ベースの NetCDF-4 新フォーマット</li>
<li>( NetCDF::NC_NETCDF4 | NetCDF::NC_CLASSIC_MODEL) [これは
NetCDF::NC_NETCDF4 と NetCDF::NC_CLASSIC_MODEL の bit "or"]:
NetCDF-4 新フォーマットだが，新しいデータモデルは使えないよう制限.</li>
</ul></li>
</ul></dd>
<dt><h4><a name="label-15" id="label-15"><code>NetCDF.creation_format</code></a></h4></dt><!-- RDLabel: "NetCDF.creation_format" -->
<dd>
(このメソッドは NetCDF-4 が使われてるときのみ使用可能：そうでなければ
例外が発生する).
NetCDF.create で作られるファイルのフォーマットの現在の設定を返す.</dd>
<dt><h4><a name="label-16" id="label-16"><code>NetCDF.open(<var>filename</var>, <var>mode</var>="<var>r</var>", <var>share</var>=<var>false</var>)</code></a></h4></dt><!-- RDLabel: "NetCDF.open" -->
<dd>
<p>ファイルオープン（クラスメソッド）mode="w" でファイルが存在しなければ新規作成</p>
<p>引数</p>
<ul>
<li>filename (String): ファイル名</li>
<li>mode (String) : 入出力モード: "r"(読み取りのみ); "w","w+" (書き
込み -- 現在の中身は上書き(消える!)); "r+","a","a+" (追加 --
現在の内容はそのままに、書き込み可)。 組み込みの File クラスと
違い、どのモードでも読み込みは可能。注意：元になる NetCDFライ
ブラリーの制限により、「追加」には余分な時間とディスクスペース
がかかる。</li>
<li>share (true or false) : sharedモードにするか (書き込み中のファ
イルに他のプロセスからの読み込みがあり得る場合に true とする。C版ユー
ザーズガイド第5章の nc_open の項を参照のこと)</li>
</ul>
<p>戻り値</p>
<ul>
<li>NetCDFクラスのオブジェクト</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_open, nc_create</li>
</ul></dd>
<dt><h4><a name="label-17" id="label-17"><code>NetCDF.new</code></a></h4></dt><!-- RDLabel: "NetCDF.new" -->
<dd>
NetCDF.openメソッドのエイリアスである</dd>
<dt><h4><a name="label-18" id="label-18"><code>NetCDF.create(<var>filename</var>, <var>noclobber</var>=<var>false</var>, <var>share</var>=<var>false</var>)</code></a></h4></dt><!-- RDLabel: "NetCDF.create" -->
<dd>
<p>NetCDFファイルを作る（クラスメソッド)</p>
<p>引数</p>
<ul>
<li>filename (String) : ファイル名</li>
<li>noclobber (true or false) : 上書きするかしないか</li>
<li>share (true or false) : shared mode を使うか (書き込み中のファ
イルに他のプロセスからの読み込みがあり得る場合に true とする。C版ユー
ザーズガイド第5章の nc_open の項を参照のこと)</li>
</ul>
<p>戻り値</p>
<ul>
<li>NetCDFクラスのオブジェクト</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_create</li>
</ul></dd>
<dt><h4><a name="label-19" id="label-19"><code>NetCDF.create_tmp(<var>tmpdir</var>=<var>ENV</var>['<var>TMPDIR</var>']||<var>ENV</var>['<var>TMP</var>']||<var>ENV</var>['<var>TEMP</var>']||'.', <var>share</var>=<var>false</var>)</code></a></h4></dt><!-- RDLabel: "NetCDF.create_tmp" -->
<dd>
<p>テンポラリーNetCDFファイルを作る（クラスメソッド)
名前は自動で決まる。クローズされると消される。</p>
<p>引数</p>
<ul>
<li>tmpdir (String) : テンポラリーファイルを置くディレクトリー名。
デフォルトは環境変数で指定されたディレクトリー（TMPDIR,TMP,or
TEMP）または '.'。セキュアーモードでは '.' のみがデフォルトとな
る。</li>
<li>share (true or false) : shared mode を使うか</li>
</ul>
<p>戻り値</p>
<ul>
<li>NetCDFクラスのオブジェクト</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_create</li>
</ul></dd>
</dl>
<h3><a name="label-20" id="label-20">インスタンスメソッド</a></h3><!-- RDLabel: "インスタンスメソッド" -->
<dl>
<dt><h4><a name="label-21" id="label-21"><code>close</code></a></h4></dt><!-- RDLabel: "close" -->
<dd>
<p>ファイルクローズ</p>
<p>引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>nil</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_close</li>
</ul></dd>
<dt><h4><a name="label-22" id="label-22"><code>ndims</code></a></h4></dt><!-- RDLabel: "ndims" -->
<dd>
<p>ファイル中の次元の数を返す</p>
<p>引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>Integer</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_inq_ndims</li>
</ul></dd>
<dt><h4><a name="label-23" id="label-23"><code>nvars</code></a></h4></dt><!-- RDLabel: "nvars" -->
<dd>
<p>ファイル中の変数の数を返す</p>
<p>引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>Integer</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_inq_nvars</li>
</ul></dd>
<dt><h4><a name="label-24" id="label-24"><code>natts</code></a></h4></dt><!-- RDLabel: "natts" -->
<dd>
<p>ファイル中のグローバル属性の数を返す</p>
<p>引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>Integer</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_inq_natts</li>
</ul></dd>
<dt><h4><a name="label-25" id="label-25"><code>unlimited</code></a></h4></dt><!-- RDLabel: "unlimited" -->
<dd>
<p>ファイル中のunlimited dimensionを返す</p>
<p>引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>存在するときNetCDFDimクラスのオブジェクト。ないときはnil</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_inq_unlimdim</li>
</ul></dd>
<dt><h4><a name="label-26" id="label-26"><code>path</code></a></h4></dt><!-- RDLabel: "path" -->
<dd>
<p>ファイルのパス. open/create時のfilename引数の中身を返す.</p>
<p>引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>String</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>なし</li>
</ul></dd>
<dt><h4><a name="label-27" id="label-27"><code>redef</code></a></h4></dt><!-- RDLabel: "redef" -->
<dd>
<p>define modeにする。既にそうなら何もせずnilを返す。</p>
<p>引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>true (定義モードへの変更が成功);
nil (既に定義モード中).
その他の理由で変更できない場合は例外発生.</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_redef</li>
</ul></dd>
<dt><h4><a name="label-28" id="label-28"><code>enddef</code></a></h4></dt><!-- RDLabel: "enddef" -->
<dd>
<p>data mode に入る。既にそうなら何もせずnilを返す。</p>
<p>引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>true (データモードへの変更が成功);
nil (既にデータモード中).
その他の理由で変更できない場合は例外発生.</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_endef</li>
</ul></dd>
<dt><h4><a name="label-29" id="label-29"><code>define_mode?</code></a></h4></dt><!-- RDLabel: "define_mode?" -->
<dd>
<p>今定義モードかどうか問合わせる.</p>
<p>引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>true (今定義モード);
false (今データモード);
nil (その他 -- 読み出し専用など).</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_redef と nc_enddef の組み合わせ</li>
</ul></dd>
<dt><h4><a name="label-30" id="label-30"><code>sync</code></a></h4></dt><!-- RDLabel: "sync" -->
<dd>
<p>メモリー中のバッファーをディスク上に反映してファイルを同期させる</p>
<p>引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>nil</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_sync</li>
</ul></dd>
<dt><h4><a name="label-31" id="label-31"><code>def_dim(<var>dimension_name</var>, <var>length</var>)</code></a></h4></dt><!-- RDLabel: "def_dim" -->
<dd>
<p>dimensionを定義</p>
<p>引数</p>
<ul>
<li>dimension_name (String) : 定義するdimensionの名前</li>
<li>length (Integer) : dimensionの長さ。無制限次元は 0。</li>
</ul>
<p>戻り値</p>
<ul>
<li>定義された次元 (NetCDFDimオブジェクト)</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_def_dim</li>
</ul></dd>
<dt><h4><a name="label-32" id="label-32"><code>put_att(<var>attribute_name</var>, <var>value</var>, <var>atttype</var>=<var>nil</var>)</code></a></h4></dt><!-- RDLabel: "put_att" -->
<dd>
<p>グローバル属性を設定</p>
<p>引数</p>
<ul>
<li>attribute_name (String) : グローバル属性の名前</li>
<li>value (Numeric, String, Array of Numeric, or NArray) : 設定する値</li>
<li>atttype (nil or String) : 属性の型.
"char"(="string"),"byte", "sint","int","sfloat", "float" (それ
ぞれ,1,1,2,4,4,8 バイト)) または nil (つまりお任せ)</li>
</ul>
<p>戻り値</p>
<ul>
<li>設定された属性 (NetCDFAttオブジェクト)</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_put_att_<type></li>
</ul></dd>
<dt><h4><a name="label-33" id="label-33"><code>def_var(<var>variable_name</var>, <var>vartype</var>, <var>dimensions</var>)</code></a></h4></dt><!-- RDLabel: "def_var" -->
<dd>
<p>変数を定義</p>
<p>引数</p>
<ul>
<li>variable_name (String) : 定義するvariableの名前</li>
<li>vartype (String or Fixnum) : 変数のタイプ ("char", "byte", "sint", "sint", "int",
"sfloat", "float" のいずれか、またはNArrayのtypecode(Fixnum))</li>
<li>dimensions (Array) : variableの次元。NetCDFDim の Array。最も
「速く回る」次元から「遅く回る」次元の順に。その長さが変数の
rank となる。</li>
</ul>
<p>戻り値</p>
<ul>
<li>定義した変数(NetCDFVarオブジェクト)</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_def_var</li>
</ul></dd>
<dt><h4><a name="label-34" id="label-34"><code>def_var_with_dim(<var>variable_name</var>, <var>vartype</var>, <var>shape_ul0</var>, <var>dimnames</var>)</code></a></h4></dt><!-- RDLabel: "def_var_with_dim" -->
<dd>
<p>def_varと同じだが必要ならまず次元を定義する。
既存次元の長さと合わない場合例外。</p>
<p>引数</p>
<ul>
<li>variable_name (String) : 定義するvariableの名前</li>
<li>vartype (String) : 変数のタイプ ("char", "byte", "sint", "sint", "int",
"sfloat", "float" のいずれか)</li>
<li>shape_ul0 (Array of Integer) : 変数の形、即ち、各次元の長さ。無
制限次元はゼロで表す。長さが変数の rank となる。</li>
<li>dimnames (Array of String) : 各次元の名前. 長さ(=>rank) は
shape_ul0 と等しくなければならない。</li>
</ul>
<p>戻り値</p>
<ul>
<li>定義した変数(NetCDFVarオブジェクト)</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>(nc_def_var)</li>
</ul></dd>
<dt><h4><a name="label-35" id="label-35"><code>var(<var>var_name</var>)</code></a></h4></dt><!-- RDLabel: "var" -->
<dd>
<p>ファイルに既存の変数をオープン</p>
<p>引数</p>
<ul>
<li>var_name (String) : オープンする変数名</li>
</ul>
<p>戻り値</p>
<ul>
<li>NetCDFVar クラスのオブジェクト。存在しなければ nil。</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_inq_varid</li>
</ul></dd>
<dt><h4><a name="label-36" id="label-36"><code>vars(<var>names</var> = <var>nil</var>)</code></a></h4></dt><!-- RDLabel: "vars" -->
<dd>
<p>ファイル中の変数をまとめてオープン</p>
<p>引数</p>
<ul>
<li>names (nil or Array of String) : オープンする変数名. nilなら全部（デフォルト）</li>
</ul>
<p>戻り値</p>
<ul>
<li>NetCDFVarオブジェクトのArray。namesに存在しない変数名が含まれれば例外発生。</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_inq_varid</li>
</ul></dd>
<dt><h4><a name="label-37" id="label-37"><code>dim(<var>dimension_name</var>)</code></a></h4></dt><!-- RDLabel: "dim" -->
<dd>
<p>既存の次元をオープン</p>
<p>引数</p>
<ul>
<li>dimension_name (String) : オープンする次元名</li>
</ul>
<p>戻り値</p>
<ul>
<li>NetCDFDimクラスのオブジェクト。存在しなければ nil。</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_inq_dimid</li>
</ul></dd>
<dt><h4><a name="label-38" id="label-38"><code>dims(<var>names</var> = <var>nil</var>)</code></a></h4></dt><!-- RDLabel: "dims" -->
<dd>
<p>ファイル中の次元をまとめてオープン</p>
<p>引数</p>
<ul>
<li>names (nil or Array of String) : オープンする次元名. nilなら全部（デフォルト）</li>
</ul>
<p>戻り値</p>
<ul>
<li>NetCDFDimオブジェクトのArray。namesに存在しない次元名が含まれれば例外発生。</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_inq_dimid</li>
</ul></dd>
<dt><h4><a name="label-39" id="label-39"><code>att(<var>attribute_name</var>)</code></a></h4></dt><!-- RDLabel: "att" -->
<dd>
<p>既存のグローバル属性をオープン</p>
<p>引数</p>
<ul>
<li>attribute_name (String) : オープンするグローバル属性名</li>
</ul>
<p>戻り値</p>
<ul>
<li>存在すれば NetCDFAttクラスのオブジェクト。存在しなければnil</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>(nc_inq_attidを検査に利用)</li>
</ul></dd>
<dt><h4><a name="label-40" id="label-40"><code>fill=(<var>filemode</var>)</code></a></h4></dt><!-- RDLabel: "fill=" -->
<dd>
<p>fillmodeの変更。(NetCDF のデフォルトは FILL である。)</p>
<p>引数</p>
<ul>
<li>fillmode (true for FILL or false for NOFILL)</li>
</ul>
<p>戻り値</p>
<ul>
<li>nil</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_set_fill</li>
</ul></dd>
<dt><h4><a name="label-41" id="label-41"><code>each_dim{ ... }</code></a></h4></dt><!-- RDLabel: "each_dim" -->
<dd>
<p>次元に関するイテレータ.
例: {|i| print i.name,"\n"} で全次元の名前を表示.</p>
<p>引数</p>
<ul>
<li>{ ... } : イテレーター用ブロック。do endブロックでもよい。</li>
</ul>
<p>戻り値</p>
<ul>
<li>self</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>(nc_inq_ndimsを利用)</li>
</ul></dd>
<dt><h4><a name="label-42" id="label-42"><code>each_var{ ... }</code></a></h4></dt><!-- RDLabel: "each_var" -->
<dd>
<p>変数に関するイテレータ.
例: {|i| print i.name,"\n"} で全変数の名前を表示.</p>
<p>引数</p>
<ul>
<li>{ ... } : イテレーター用ブロック。do endブロックでもよい。</li>
</ul>
<p>戻り値</p>
<ul>
<li>self</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>(nc_inq_nvarsを利用)</li>
</ul></dd>
<dt><h4><a name="label-43" id="label-43"><code>each_att{ ... }</code></a></h4></dt><!-- RDLabel: "each_att" -->
<dd>
<p>グローバル属性に関するイテレータ.
例: {|i| print i.name,"\n"} で全属性の名前を表示.</p>
<p>引数</p>
<ul>
<li>{ ... } : イテレーター用ブロック。do endブロックでもよい。</li>
</ul>
<p>戻り値</p>
<ul>
<li>self</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>(nc_inq_natts, nc_inq_attnameを利用)</li>
</ul></dd>
<dt><h4><a name="label-44" id="label-44"><code>dim_names</code></a></h4></dt><!-- RDLabel: "dim_names" -->
<dd>
<p>ファイル中の全次元の名前を配列に入れて返す。</p>
<p>引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>String の Array</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>(nc_inq_ndims, nc_inq_dimnameを利用)</li>
</ul></dd>
<dt><h4><a name="label-45" id="label-45"><code>var_names</code></a></h4></dt><!-- RDLabel: "var_names" -->
<dd>
<p>ファイル中の全変数の名前を配列に入れて返す。</p>
<p>引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>String の Array</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>(nc_inq_nvars, nc_inq_varnameを利用)</li>
</ul></dd>
<dt><h4><a name="label-46" id="label-46"><code>att_names</code></a></h4></dt><!-- RDLabel: "att_names" -->
<dd>
<p>ファイル中の全グローバル属性の名前を配列に入れて返す。
引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>String の Array</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>(nc_inq_natts, nc_inq_attnameを利用)</li>
</ul></dd>
</dl>
<p>---------------------------------------------</p>
<h1><a name="label-47" id="label-47">クラス NetCDFDim</a></h1><!-- RDLabel: "クラス NetCDFDim" -->
<h3><a name="label-48" id="label-48">クラスメソッド</a></h3><!-- RDLabel: "クラスメソッド" -->
<h3><a name="label-49" id="label-49">インスタンスメソッド</a></h3><!-- RDLabel: "インスタンスメソッド" -->
<dl>
<dt><h4><a name="label-50" id="label-50"><code>length</code></a></h4></dt><!-- RDLabel: "length" -->
<dd>
<p>次元の長さを返す</p>
<p>引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>Integer</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_inq_dimlen</li>
</ul></dd>
<dt><h4><a name="label-51" id="label-51"><code>length_ul0</code></a></h4></dt><!-- RDLabel: "length_ul0" -->
<dd>
<p>length と同じだが、無制限次元に関しゼロを返す</p>
<p>引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>Integer</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_inq_dimlen</li>
</ul></dd>
<dt><h4><a name="label-52" id="label-52"><code>name=(<var>dimension_newname</var>)</code></a></h4></dt><!-- RDLabel: "name=" -->
<dd>
<p>名前をつけかえる</p>
<p>引数</p>
<ul>
<li>dimension_newname (String) : 新しい名前</li>
</ul>
<p>戻り値</p>
<ul>
<li>nil</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_rename_dim</li>
</ul></dd>
<dt><h4><a name="label-53" id="label-53"><code>name</code></a></h4></dt><!-- RDLabel: "name" -->
<dd>
<p>名前を返す</p>
<p>引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>String</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_inq_dimname</li>
</ul></dd>
<dt><h4><a name="label-54" id="label-54"><code>unlimited?</code></a></h4></dt><!-- RDLabel: "unlimited?" -->
<dd>
<p>無制限次元かどうか？</p>
<p>引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>true or false</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>(nc_inq_unlimdim を利用)</li>
</ul></dd>
</dl>
<p>---------------------------------------------</p>
<h1><a name="label-55" id="label-55">クラス NetCDFVar</a></h1><!-- RDLabel: "クラス NetCDFVar" -->
<h3><a name="label-56" id="label-56">クラスメソッド</a></h3><!-- RDLabel: "クラスメソッド" -->
<dl>
<dt><h4><a name="label-57" id="label-57"><code>NetCDFVar.new(<var>file</var>,<var>varname</var>,<var>mode</var>="<var>r</var>",<var>share</var>=<var>false</var>)</code></a></h4></dt><!-- RDLabel: "NetCDFVar.new" -->
<dd>
<p>NetCDF変数をオープンする。これは、NetCDF#var (NetCDFクラスのイン
スタンスメソッドvar) を使っても出来るし、そちらのほうを推奨する。</p>
<p>引数</p>
<ul>
<li>file (NetCDF or String) : NetCDFオブジェクト(NetCDF)
または NetCDF ファイルのパス(String)</li>
<li>varname (String) : file中の変数名</li>
<li>mode (String) : 入出力モード。fileが String の時に使われる。
（NetCDF.openの項を見よ）</li>
<li>share (true or false) : sharedモードにするか。
fileが String の時に使われる。（NetCDF.openの項を見よ）</li>
</ul>
<p>戻り値</p>
<ul>
<li>NetCDFVarクラスのオブジェクト</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>(nc_open, nc_create, nc_inq_varid 等を利用する)</li>
</ul></dd>
<dt><h4><a name="label-58" id="label-58"><code>NetCDFVar.unpack_type=(<var>na_type</var>)</code></a></h4></dt><!-- RDLabel: "NetCDFVar.unpack_type=" -->
<dd>
<p><a href="#label-90">scaled_get</a>で使うNArrayの型を固定する.</p>
<p>引数</p>
<ul>
<li>na_type (Integer) : NArray::BYTE, NArray::SINT, NArray::INT,
NArray::SFLOAT, or NArray::FLOAT</li>
</ul>
<p>戻り値</p>
<ul>
<li>na_type (引数)</li>
</ul></dd>
<dt><h4><a name="label-59" id="label-59"><code>NetCDFVar.unpack_type</code></a></h4></dt><!-- RDLabel: "NetCDFVar.unpack_type" -->
<dd>
<p><a href="#label-58">NetCDFVar.unpack_type=</a>で設定したNArrayの型を返す.</p>
<p>戻り値</p>
<ul>
<li>nil, NArray::BYTE, NArray::SINT, NArray::INT,
NArray::SFLOAT, or NArray::FLOAT</li>
</ul></dd>
</dl>
<h3><a name="label-60" id="label-60">インスタンスメソッド</a></h3><!-- RDLabel: "インスタンスメソッド" -->
<dl>
<dt><h4><a name="label-61" id="label-61"><code>deflate(<var>deflate_level</var>, <var>shuffle</var>=<var>false</var>)</code></a></h4></dt><!-- RDLabel: "deflate" -->
<dd>
<p>(このメソッドは NetCDF-4 が使われてるときのみ使用可能：そうでなければ
例外が発生する).
(新しく作成された)変数が圧縮(deflate)されるようにする. このメソッドは，
変数を作成 (NetCDF#<a href="#label-33">def_var</a>) した後，NetCDF#<a href="#label-28">enddef</a>
を呼ぶ前に呼ばなければならない.</p>
<p>引数</p>
<ul>
<li>deflate_level (Integer) :: 0 to 9. (0: no compression; 9:
highest compression; recommended: 1 or 2).</li>
<li>shuffle (optional; true or false; default: false) if true,
turn on the shuffle filter.
<ul>
<li><a href="http://www.unidata.ucar.edu/software/netcdf/papers/AMS_2008.pdf"><URL:http://www.unidata.ucar.edu/software/netcdf/papers/AMS_2008.pdf></a>:
``The shuffle algorithm changes the byte order in the data stream;
when used with integers that are all close together, this
results in a better compression ratio. There is no benefit
from using the shuffle filter without also using
compression.''</li>
<li>Note: shuffle is effective for float variables too (tested by horinouchi).</li>
</ul></li>
</ul>
<p>戻り値</p>
<ul>
<li>self</li>
</ul></dd>
<dt><h4><a name="label-62" id="label-62"><code>deflate_params</code></a></h4></dt><!-- RDLabel: "deflate_params" -->
<dd>
<p>(このメソッドは NetCDF-4 が使われてるときのみ使用可能：そうでなければ
例外が発生する).
現在の圧縮(deflation)パラメターを返す。</p>
<p>戻り値</p>
<ul>
<li>[shuffle, deflate, deflate_level] (a 3-element Array).
shuffle と deflate は true または false. deflate_level は整数(0-9).</li>
</ul></dd>
<dt><h4><a name="label-63" id="label-63"><code>endian=(<var>endian</var>)</code></a></h4></dt><!-- RDLabel: "endian=" -->
<dd>
<p>(このメソッドは NetCDF-4 が使われてるときのみ使用可能：そうでなければ
例外が発生する).
エンディアンを設定する。使用タイミングは <a href="#label-61">deflate</a> と同じ。</p>
<p>Arguments</p>
<ul>
<li>endian : 次のいずれか:
NetCDF::NC_ENDIAN_NATIVE (=0) (default),
NetCDF::NC_ENDIAN_LITTLE (=1), or NetCDF::NC_ENDIAN_BIG (=2).</li>
</ul>
<p>Return value</p>
<ul>
<li>self</li>
</ul></dd>
<dt><h4><a name="label-64" id="label-64"><code>endian</code></a></h4></dt><!-- RDLabel: "endian" -->
<dd>
<p>(このメソッドは NetCDF-4 が使われてるときのみ使用可能：そうでなければ
例外が発生する).
現在のエンディアン設定を返す.</p>
<p>Return value</p>
<ul>
<li>次のいずれか:
NetCDF::NC_ENDIAN_NATIVE (=0) (default),
NetCDF::NC_ENDIAN_LITTLE (=1), or NetCDF::NC_ENDIAN_BIG (=2).</li>
</ul></dd>
<dt><h4><a name="label-65" id="label-65"><code>dim(<var>dim_num</var>)</code></a></h4></dt><!-- RDLabel: "dim" -->
<dd>
<p>その変数における dim_num 番目(0から数える)の次元を問合わせる。</p>
<p>引数</p>
<ul>
<li>dim_num (Fixnum) : 0,1,2,...。最も速く回る次元が0。</li>
</ul>
<p>戻り値</p>
<ul>
<li>NetCDFDimオブジェクト</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>(nc_inq_vardimid利用)</li>
</ul></dd>
<dt><h4><a name="label-66" id="label-66"><code>dims</code></a></h4></dt><!-- RDLabel: "dims" -->
<dd>
<p>その変数の全次元を配列にいれて返す</p>
<p>引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>NetCDFDimオブジェクトのArray</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_inq_vardimid</li>
</ul></dd>
<dt><h4><a name="label-67" id="label-67"><code>shape_ul0</code></a></h4></dt><!-- RDLabel: "shape_ul0" -->
<dd>
<p>変数の形を返す. 但し無制限次元の長さはゼロ.
他の変数の定義に便利.</p>
<p>引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>Array. [0次元目の長さ, 1次元目の長さ,.. ]</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>(nc_inq_vardimid, nc_inq_unlimdim 等を利用)</li>
</ul></dd>
<dt><h4><a name="label-68" id="label-68"><code>shape_current</code></a></h4></dt><!-- RDLabel: "shape_current" -->
<dd>
<p>変数の現在の形を返す.</p>
<p>引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>Array. [0次元目の長さ, 1次元目の長さ,.. ]</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>(nc_inq_vardimid 等を利用)</li>
</ul></dd>
<dt><h4><a name="label-69" id="label-69"><code>each_att{ ... }</code></a></h4></dt><!-- RDLabel: "each_att" -->
<dd>
<p>変数中の全属性(NetCDFAtt)に関するイテレータ</p>
<p>引数</p>
<ul>
<li>{ ... } : 繰り返すブロック</li>
</ul>
<p>戻り値</p>
<ul>
<li>self</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>(nc_inq_natts, nc_inq_attnameを利用)</li>
</ul></dd>
<dt><h4><a name="label-70" id="label-70"><code>dim_names</code></a></h4></dt><!-- RDLabel: "dim_names" -->
<dd>
<p>変数中の全次元の名前を配列に入れて返す。</p>
<p>引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>String の Array</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>(nc_inq_varndims, nc_inq_vardimid, nc_inq_dimname を利用)</li>
</ul></dd>
<dt><h4><a name="label-71" id="label-71"><code>att_names</code></a></h4></dt><!-- RDLabel: "att_names" -->
<dd>
<p>変数中の全属性の名前を配列に入れて返す。</p>
<p>引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>String の Array</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>(nc_inq_natts, nc_inq_attnameを利用)</li>
</ul></dd>
<dt><h4><a name="label-72" id="label-72"><code>name</code></a></h4></dt><!-- RDLabel: "name" -->
<dd>
<p>変数の名前を返す</p>
<p>引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>String</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_inq_varname</li>
</ul></dd>
<dt><h4><a name="label-73" id="label-73"><code>name=(<var>variable_newname</var>)</code></a></h4></dt><!-- RDLabel: "name=" -->
<dd>
<p>名前を付け替える</p>
<p>引数</p>
<ul>
<li>variable_newname (String) : 新しい名前</li>
</ul>
<p>戻り値</p>
<ul>
<li>nil</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_rename_var</li>
</ul></dd>
<dt><h4><a name="label-74" id="label-74"><code>ndims</code></a></h4></dt><!-- RDLabel: "ndims" -->
<dd>
<p>次元の数を問う</p>
<p>引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>Integer</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_inq_varndims</li>
</ul></dd>
<dt><h4><a name="label-75" id="label-75"><code>rank</code></a></h4></dt><!-- RDLabel: "rank" -->
<dd>
ndimsのエリアス</dd>
<dt><h4><a name="label-76" id="label-76"><code>ntype</code></a></h4></dt><!-- RDLabel: "ntype" -->
<dd>
vartypeの別名</dd>
<dt><h4><a name="label-77" id="label-77"><code>vartype</code></a></h4></dt><!-- RDLabel: "vartype" -->
<dd>
<p>変数値の型を問う</p>
<p>引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>String ("char","byte","sint","int","sfloat", or "float")</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_inq_vartype</li>
</ul></dd>
<dt><h4><a name="label-78" id="label-78"><code>typecode</code></a></h4></dt><!-- RDLabel: "typecode" -->
<dd>
<p>変数値の型を問う(NArrayのtypecodeで返す)</p>
<p>引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>Fixnumオブジェクト (NArray:BYTE, NArray:SINT, NArray:LINT, NArray:SFLOAT, NArray:SFLOAT, NArray:DFLOAT)</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_inq_vartype</li>
</ul></dd>
<dt><h4><a name="label-79" id="label-79"><code>natts</code></a></h4></dt><!-- RDLabel: "natts" -->
<dd>
<p>属性の数を問う</p>
<p>引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>Integer</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_inq_varnatts</li>
</ul></dd>
<dt><h4><a name="label-80" id="label-80"><code>file</code></a></h4></dt><!-- RDLabel: "file" -->
<dd>
<p>その変数が属するファイルを問合わせる</p>
<p>引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>NetCDFクラスのオブジェクト</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>なし</li>
</ul></dd>
<dt><h4><a name="label-81" id="label-81"><code>att(<var>attribute_name</var>)</code></a></h4></dt><!-- RDLabel: "att" -->
<dd>
<p>名前を指定した属性を返す</p>
<p>引数</p>
<ul>
<li>attribute_name (String) : 取り出す属性名</li>
</ul>
<p>戻り値</p>
<ul>
<li>NetCDFAttオブジェクト. 存在しなければnil</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>(nc_inq_attidを検査に利用)</li>
</ul></dd>
<dt><h4><a name="label-82" id="label-82"><code>put_att(<var>attribute_name</var>, <var>value</var>, <var>atttype</var>=<var>nil</var>)</code></a></h4></dt><!-- RDLabel: "put_att" -->
<dd>
<p>属性を設定</p>
<p>引数</p>
<ul>
<li>attribute_name (String) : attribute名</li>
<li>value (Numeric, String, Array of Numeric, or NArray) : 設定する値</li>
<li>atttype (nil or String) : 属性の型.
"char"(="string"),"byte", "sint","int","sfloat", "float" (それ
ぞれ,1,1,2,4,4,8 バイト)) または nil (つまりお任せ)</li>
</ul>
<p>戻り値</p>
<ul>
<li>NetCDFAttのオブジェクト</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_put_att_<type></li>
</ul></dd>
<dt><h4><a name="label-83" id="label-83"><code>put(<var>value</var>, <var>option</var>=<var>nil</var>)</code></a></h4></dt><!-- RDLabel: "put" -->
<dd>
<a href="#label-84">simple_put</a>の別名(alias)</dd>
<dt><h4><a name="label-84" id="label-84"><code>simple_put(<var>value</var>, <var>option</var>=<var>nil</var>)</code></a></h4></dt><!-- RDLabel: "simple_put" -->
<dd>
<p>値を入れる</p>
<p>引数</p>
<ul>
<li>value : 入れる値 (Numeric,Array(Numericの1次元配列)、NArray)
スカラー(Numeric)または長さ１の場合は、その値を一様に設定する。</li>
<li><p>option (Hash) : 変数の一部分を指定するためのオプション引数。省
略すれば、変数全体が対象となる。ハッシュのキーとしては、
"start","end","stride"の組、または"index"が使用できる。"index"
は1要素（スカラー）を指す。"end","stride"は省略可。省略するにし
ろしないにしろ、書きこむべき要素の数が valueのそれと一致するようにし
なければならない。start,end,indexではArrayの場合と同様、負の値で後ろ
からの位置を指定できる。"stride"は正の値のみ受け付けるので、配
列を引っくり返したければ後から別途やることになる。</p>
<p>例： 変数が2次元の場合:</p>
<p>{"start"=>[2,5],"end"=>[6,-1],"stride"=>[2,4]} -- 第1次元目は、
要素 2 から 6 まで 1 つおき (0から数えるので要素 2 は 3 番目であ
ることに注意)、第2次元目は、要素 6 から 最後(=-1)まで 3 つおき
にとったサブセット。</p>
<p>{"index"=>[0,0]}: 最初の要素にあた
るスカラー値</p>
<p>{"index"=>[0,-2]}: 1次元目は最初, 2次元目は最後から2番目にあた
るスカラー値</p></li>
</ul>
<p>戻り値</p>
<ul>
<li>nil</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_put_var_<type>, nc_put_vars_<type>, nc_put_var1_<type></li>
</ul></dd>
<dt><h4><a name="label-85" id="label-85"><code>pack(<var>na</var>)</code></a></h4></dt><!-- RDLabel: "pack" -->
<dd>
<p>selfの属性 scale_factor and/or add_offset を用いて NArray 等を "pack" する.</p>
<p>もしも scale_factor and/or add_offset が設定されていれば
(na-add_offset)/scale_factor を返す。そうでなければ na を返す。</p>
<p>引数</p>
<ul>
<li>na : pack する数値配列 (NArray, NArrayMiss, Array)</li>
</ul>
<p>戻り値</p>
<ul>
<li>a NArray or NArrayMiss</li>
</ul></dd>
<dt><h4><a name="label-86" id="label-86"><code>scaled_put(<var>value</var>, <var>option</var>=<var>nil</var>)</code></a></h4></dt><!-- RDLabel: "scaled_put" -->
<dd>
<p><a href="#label-84">simple_put</a> と同様だが、<a href="#label-85">pack</a>により属性 scale_factor と add_offset を解釈する</p>
<p>引数等については put の解説を参照のこと</p></dd>
<dt><h4><a name="label-87" id="label-87"><code>get(<var>option</var>=<var>nil</var>)</code></a></h4></dt><!-- RDLabel: "get" -->
<dd>
<a href="#label-88">simple_get</a>の別名(alias)</dd>
<dt><h4><a name="label-88" id="label-88"><code>simple_get(<var>option</var>=<var>nil</var>)</code></a></h4></dt><!-- RDLabel: "simple_get" -->
<dd>
<p>値を取り出す</p>
<p>引数</p>
<ul>
<li>option (Hash) : 変数の一部分を指定するためのオプション引数。仕
様は put に同じ。</li>
</ul>
<p>戻り値</p>
<ul>
<li>NArrayクラスのオブジェクト</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_get_var_<type>, nc_get_vars_<type>, nc_get_var1_<type></li>
</ul></dd>
<dt><h4><a name="label-89" id="label-89"><code>unpack(<var>na</var>)</code></a></h4></dt><!-- RDLabel: "unpack" -->
<dd>
<p>selfの属性 scale_factor and/or add_offset を用いて NArray 等を "unpack" する.</p>
<p>もしも scale_factor and/or add_offset が設定されていれば
na * scale_factor + add_offset を返す。そうでなければ na を返す。
coerce によって型が変化する -- 例えば、もし na が sint で
scale_factor と add_offset が sfloat であれば、返り値は sfloat
になる。返り値の型は <a href="#label-58">NetCDFVar.unpack_type=</a> を使って
陽に指定することもできる。</p>
<p>引数</p>
<ul>
<li>na : unpack する数値配列 (NArray, or NArrayMiss)</li>
</ul>
<p>戻り値</p>
<ul>
<li>a NArray or NArrayMiss</li>
</ul></dd>
<dt><h4><a name="label-90" id="label-90"><code>scaled_get(<var>option</var>=<var>nil</var>)</code></a></h4></dt><!-- RDLabel: "scaled_get" -->
<dd>
<p><a href="#label-88">simple_get</a> と同様だが、<a href="#label-89">unpack</a>により属性 scale_factor と add_offset を解釈する</p>
<p>引数等については put の解説を参照のこと</p></dd>
<dt><h4><a name="label-91" id="label-91"><code>[]</code></a></h4></dt><!-- RDLabel: "[]" -->
<dd>
<p>NetCDFVar#get と同様だが、サブセットを NArray#[] と同様に指定する. </p>
<p>NArrayでサポートされているサブセット指定方法に加えて、ステップ付
きの範囲を指定できる。これは {0..-1,2} などとする。つまり、要素
数が１のハッシュのキーに範囲(Range)、値にステップ(Integer)を指定
する。NArrayと違い、２次元以上の変数を１次元のインデックスで
指定することは出来ない。</p></dd>
<dt><h4><a name="label-92" id="label-92"><code>[] = </code></a></h4></dt><!-- RDLabel: "[]=" -->
<dd>
<p>NetCDFVar#put と同様だが、サブセットを NArray#[]= と同様に指定する. </p>
<p>NArrayでサポートされているサブセット指定方法に加えて、ステップ付
きの範囲を指定できる。これは {0..-1,2} などとする。つまり、要素
数が１のハッシュのキーに範囲(Range)、値にステップ(Integer)を指定
する。NArrayと違い、２次元以上の変数を１次元のインデックスで
指定することは出来ない。</p></dd>
</dl>
<h3><a name="label-93" id="label-93">"numru/netcdf_miss" を require することで追加されるインスタンスメソッド</a></h3><!-- RDLabel: ""numru/netcdf_miss" を require することで追加されるインスタンスメソッド" -->
<dl>
<dt><h4><a name="label-94" id="label-94"><code>get_with_miss(<var>option</var>=<var>nil</var>)</code></a></h4></dt><!-- RDLabel: "get_with_miss" -->
<dd>
<p><a href="#label-87">get</a>と同様だが、データ欠損を処理する</p>
<p>データ欠損は標準属性 valid_range, (valid_min and/or valid_max),
または missing_value により指定される。解釈の優先順位はこの順番で
ある。「ユーザーズガイド」の推奨と違い、ここでは missin_value も
解釈される。もし missing_value と valid_* が同時に存在する場合、
missng_value は有効データ範囲外にあってはならない。その場合、例外
が発生する。</p>
<p>上記のようにもしデータ欠損（の仕方）が指定されていれば、このメソッ
ドは NArrayMiss オブジェクトを返す。そうでなければ NArray を返す。</p>
<p>引数</p>
<ul>
<li><a href="#label-87">get</a>を見よ.</li>
</ul>
<p>戻り値</p>
<ul>
<li>NArrayMissオブジェクト (データ欠損が指定さている場合) または NArray
オブジェクト (データ欠損が指定さてない場合)</li>
</ul>
<p>NetcdfError 以外の例外発生</p>
<ul>
<li>missing_value がデータ有効範囲にない (上記参照のこと).</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li><a href="#label-87">get</a> を見よ. このメソッドは Ruby のみで書かれている. </li>
</ul>
<p>例</p>
<ul>
<li><p>次の例では <a href="#label-87">get</a> を <a href="#label-94">get_with_miss</a> を置き換えている.
こうすると <a href="#label-91">[]</a> もデータ欠損を解釈するようになる (内部で
<code>get</code> を呼んでるので).</p>
<pre>file = NetCDF.open('hogehoge.nc')
var = file.var('var')
def var.get(*args); get_with_miss(*args); end
p var.get # --> inteprets data missing if defined
p var[0..-1,0] # --> inteprets data missing if defined (assumed 2D)</pre></li>
</ul></dd>
<dt><h4><a name="label-95" id="label-95"><code>get_with_miss_and_scaling(<var>option</var>=<var>nil</var>)</code></a></h4></dt><!-- RDLabel: "get_with_miss_and_scaling" -->
<dd>
<p><a href="#label-94">get_with_miss</a>と同様だが、<a href="#label-89">unpack</a>によりスケーリングも行う.</p>
<p>欠損値処理は基本的には pack したデータを対象に行う(これは多くの
コンベンション採用されている)。ただし、valid_* / missing_value
の型が pack したデータの型と異なり、かつ unpackしたデータの型と
一致するとき（に限り） unpack したデータを対象とする。
これで基本的に全てのコンベンションに対応できる。</p>
<p>例</p>
<ul>
<li>上記参照。同じことができる。</li>
</ul></dd>
<dt><h4><a name="label-96" id="label-96"><code>put_with_miss(<var>value</var>, <var>option</var>=<var>nil</var>)</code></a></h4></dt><!-- RDLabel: "put_with_miss" -->
<dd>
<p><a href="#label-83">put</a>と同様だが、データ欠損を処理する</p>
<p>もしも <code>value</code> が NArray なら、このメソッドは <a href="#label-83">put</a> に同
じ. もし<code>value</code> が NArrayMiss でかつ self の属性によりデータ欠損が
定義されていれば (<a href="#label-94">get_with_miss</a>を参照のこと)、<code>value</code>
中のデータ欠損が解釈される。即ち、<code>value</code>中の欠損データは、
ある欠損値 (missing_value または _FillValue またはデータ有効範囲
外の適当な値) に置き換えられた上でファイルに書き込まれる。
<code>value</code> 中の非欠損データが <code>self</code> における有効範囲に入って
いるかどうかはチェックされない。</p>
<p>引数</p>
<ul>
<li>value : NArrayMiss または <a href="#label-83">put</a> で許されているクラスのオブジェクト.</li>
<li>option (Hash) : <a href="#label-83">put</a> を見よ.</li>
</ul>
<p>戻り値</p>
<ul>
<li>nil</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li><a href="#label-83">put</a> を見よ. このメソッドは Ruby のみで書かれている. </li>
</ul>
<p>例</p>
<ul>
<li><p>次の例では <a href="#label-83">put</a> を <a href="#label-96">put_with_miss</a> を置き換えている.
こうすると <a href="#label-92">[]=</a> もデータ欠損を解釈するようになる (内部で
<code>put</code> を呼んでるので).</p>
<pre>file = NetCDF.open('hogehoge.nc')
var = file.var('var')
def var.put(*args); put_with_miss(*args); end
var.put = narray_miss # --> inteprets data missing if defined
var[0..-1,0] = narray_miss # --> inteprets data missing if defined (assumed 2D)</pre></li>
</ul></dd>
<dt><h4><a name="label-97" id="label-97"><code>put_with_miss_and_scaling(<var>value</var>, <var>option</var>=<var>nil</var>)</code></a></h4></dt><!-- RDLabel: "put_with_miss_and_scaling" -->
<dd>
<p><a href="#label-96">put_with_miss</a>と同様だが、<a href="#label-85">pack</a>によりスケーリングも行う.</p>
<p>欠損値処理は基本的には pack したデータを対象に行う(これは多くの
コンベンション採用されている)。ただし、valid_* / missing_value
の型が pack したデータの型と異なり、かつ unpackしたデータの型と
一致するとき（に限り） unpack したデータを対象とする。
これで基本的に全てのコンベンションに対応できる。</p>
<p>例</p>
<ul>
<li>上記参照。同じことができる。</li>
</ul></dd>
</dl>
<p>---------------------------------------------</p>
<h1><a name="label-98" id="label-98">クラス NetCDFAtt</a></h1><!-- RDLabel: "クラス NetCDFAtt" -->
<h3><a name="label-99" id="label-99">クラスメソッド</a></h3><!-- RDLabel: "クラスメソッド" -->
<h3><a name="label-100" id="label-100">インスタンスメソッド</a></h3><!-- RDLabel: "インスタンスメソッド" -->
<dl>
<dt><h4><a name="label-101" id="label-101"><code>name</code></a></h4></dt><!-- RDLabel: "name" -->
<dd>
<p>属性の名前を返す</p>
<p>引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>String</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>なし</li>
</ul></dd>
<dt><h4><a name="label-102" id="label-102"><code>name=(<var>attribute_newname</var>)</code></a></h4></dt><!-- RDLabel: "name=" -->
<dd>
<p>属性の名前を変更</p>
<p>引数</p>
<ul>
<li>attribute_newname (String) : 新しい名前</li>
</ul>
<p>戻り値</p>
<ul>
<li>nil</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_rename_att</li>
</ul></dd>
<dt><h4><a name="label-103" id="label-103"><code>copy(<var>var_or_file</var>)</code></a></h4></dt><!-- RDLabel: "copy" -->
<dd>
<p>属性を別の変数またはファイルにコピー。ファイルの場合はグローバル属性になる</p>
<p>引数</p>
<ul>
<li>var_or_file (NetCDFVar or NetCDF)</li>
</ul>
<p>戻り値</p>
<ul>
<li>コピーして作られた属性 (NetCDFAtt)</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_copy_att</li>
</ul></dd>
<dt><h4><a name="label-104" id="label-104"><code>delete</code></a></h4></dt><!-- RDLabel: "delete" -->
<dd>
<p>属性を削除</p>
<p>引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>nil</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_del_att</li>
</ul></dd>
<dt><h4><a name="label-105" id="label-105"><code>put(<var>value</var>, <var>atttype</var>=<var>nil</var>)</code></a></h4></dt><!-- RDLabel: "put" -->
<dd>
<p>属性の値を設定</p>
<p>引数</p>
<ul>
<li>value (Numeric, String, Array of Numeric, or NArray) : 入れる値</li>
<li>atttype (nil or String) : 属性の型.
"char"(="string"),"byte", "sint","int","sfloat", "float" (それ
ぞれ,1,1,2,4,4,8 バイト)) または nil (つまりお任せ)</li>
</ul>
<p>戻り値</p>
<ul>
<li>nil</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_put_att_<type></li>
</ul></dd>
<dt><h4><a name="label-106" id="label-106"><code>get</code></a></h4></dt><!-- RDLabel: "get" -->
<dd>
<p>属性の中身を取り出す</p>
<p>引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>文字列またはNArrayオブジェクト (注意: スカラーの場合も長さ1の
NArrayになる)</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_get_att_<type></li>
</ul></dd>
<dt><h4><a name="label-107" id="label-107"><code>atttype</code></a></h4></dt><!-- RDLabel: "atttype" -->
<dd>
<p>属性値の型を問う</p>
<p>引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>"char","byte","sint","int","sfloat","float"</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_inq_atttype</li>
</ul></dd>
<dt><h4><a name="label-108" id="label-108"><code>typecode</code></a></h4></dt><!-- RDLabel: "typecode" -->
<dd>
<p>属性値の型を問う(NArrayのtypecodeで返す)</p>
<p>引数</p>
<ul>
<li>なし</li>
</ul>
<p>戻り値</p>
<ul>
<li>Fixnumオブジェクト (NArray:BYTE, NArray:SINT, NArray:LINT, NArray:SFLOAT, NArray:SFLOAT, NArray:DFLOAT)</li>
</ul>
<p>対応する(利用する) C 版 NetCDF の関数</p>
<ul>
<li>nc_inq_atttype</li>
</ul></dd>
</dl>
</body>
</html>
|
