コンテンツにスキップ

変換関数

プロパティ型説明
outputFloodStoreグループを書き出すストア
intervalnumber | undefined時刻をこの秒数より詰まらないように間引きます
toleranceFloodTolerance | undefined前後の時刻からの補間で再現できない時刻だけを残します。フレームの浸水セルのうち maxErrorShare の割合までは、水位が maxLevelError メートルずれてもかまいません。残すフレームは水位だけで決めるので、水位より速く変わるプロパティはそのフレームでしかサンプルされません
datumVerticalDatum | undefined入力の高さの鉛直基準(高さ を参照)
propertiesstring[] | PropertiesCallback | undefined水面の色分けに使う、セルごとに保存する数値プロパティ。入力自身の値をそのまま取り込む名前の配列か、入力の値のレコードから導出するコールバックです(レコードの中身は各変換関数の説明を参照)
precisionRecord<string, number> | undefinedプロパティごとの、パックする精度。指定のないプロパティは float32 で保存します
unitsRecord<string, string> | undefinedプロパティごとの単位("m/s" など)
labelsRecord<string, string> | undefinedプロパティごとの説明

有限の数値でないプロパティの値は欠損として保存し、件数を警告に出します。数値が一つもないプロパティは書き出しません。時間で値が変わらないプロパティは時間次元なしで保存し、各プロパティには値域を記録します(プロパティ を参照)。

CSV とラスターの変換関数は、各時刻を列かファイル名で決めます。

プロパティ型説明
timestring | undefined時刻の列。CSV のみ
timePatternRegExp | undefinedtime の代わりに、最初のグループで各ファイル名から時刻を取り出すパターン。指定すると、interval で除いた時刻のファイルは読みません
timeUnit"seconds" | "minutes" | "hours" | number | undefined数値の時刻の単位、またはその秒数(0.02 秒刻みのモデルステップなら 0.02)。既定は "seconds"
epochDate | undefined数値の時刻の起点。数値でない時刻は日時として読み、タイムゾーンがなければ UTC とします

時刻ごとの等間隔格子の水位を変換します。日本の標準地域メッシュのような浸水セルを並べた CSV ファイルか、時刻ごとに 1 つの netCDF のラスターです。どちらかは format("csv" か "netcdf")で指定し、指定しなければ最初の入力の拡張子から決めます。

resolution を指定すると、元セルをその大きさの格子に取り直します。各セルは、その中の元セルを平均します。元セルの方が大きいときは最も近い元セルを取ります。元セルの半分以上が浸水していればそのセルを浸水とし、水位は浸水した元セルの平均、ほかの値も浸水した元セルの平均です。resolution を指定しなければ、緯度経度の元セルをそのままセルにします。

プロパティ型説明
inputsInput[]CSV ファイル、または時刻ごとに 1 つの水位のラスター
format"csv" | "netcdf" | undefinedinputs の形式
projectionProjection | undefined座標の投影
resolutionnumber | undefined元セルを取り直すメートル単位のセルの大きさ。投影座標系の座標には必須です
terrainTerrain | undefined地盤高のないデータに、一度でも浸水したセルの中心で地盤高を取る地形。raster-dem ソースか TerrainSampler で、@navaramap/three の sampleTerrainMostDetailed と同じようにサンプリングします。ground プロパティとして保存します(高さを参照)

各行は、ある時刻の浸水セルです。行のないセルは乾いているとみなします。格子はセル自身の座標系で検出します。緯度経度の格子か、projection を指定した投影座標系の格子です。等間隔格子に載らない点は convertMesh で変換します。

プロパティ型説明
inputsInput[]浸水セルを時刻ごとに 1 行ずつ並べた CSV ファイル。指定したすべての列名を含む最初の行をヘッダーとし、その前の行は読み飛ばします。UTF-8 と Shift_JIS を判別します。フィールドは引用符で囲めますが、複数行にまたがることはできません
cornersCoordinateColumns[] | undefinedセルの対角の 2 隅か 4 隅すべての列を、それぞれ [経度, 緯度] で指定します。セルの大きさもここから求めます
centerCoordinateColumns | undefinedcorners の代わりの、セルの中心の列。セルの大きさは中心の間隔から求めます
levelstring | undefined水位の列
groundstring | undefinedlevel の代わりに、depth と足して水位になる地盤高の列
depthstring | undefined浸水深の列
minDepthnumber | undefineddepth を指定したとき、これより浅いセルを除きます

properties のコールバックには、位置と時刻を除く行の列が数値で渡ります。resolution を指定したときは、セル内の浸水した元セルでの平均です。数値のない列は undefined です。

各ラスターは netCDF ファイルです。x、lon、longitude、easting と y、lat、latitude、northing のいずれかの名前の 1 次元座標を持つ 2 次元変数か、x_range、y_range、dimension で配置する旧形式の z を読みます。classic netCDF はそのまま読みます。netCDF-4 は HDF5 なので、任意の peer dependency の h5wasm で読みます。fill value は欠損として読み、CF の scale_factor と add_offset を適用します。どのラスターも、最初の水位ラスターと同じ格子である必要があります。水位の欠損値は乾いているとみなします。時刻は timePattern で決めます。

プロパティ型説明
seriesRecord<string, Input[]> | undefined流速のような、時刻ごとのほかのラスターを名前ごとに指定します。時刻は同じく timePattern で決めます。properties はこの名前で取り込み、コールバックにはセルごとの平均が渡ります
groundInput | undefined地盤高のラスター
groundScalenumber | undefined地盤高のラスターに掛ける値。津波モデルが地形を保存するときのような、基準面から下向きの深さなら -1 です。既定は 1
buildingsInput | undefined建物のあるところで 0 以外になるラスター。シミュレーションは建物を乾いたままにします。その元セルは浸水の割合からも平均からも除くので、建物の間のセルは空き地が浸水していれば浸水になります
datumOffsetnumber | undefined高さの起点の、datum での高さ(シミュレーション開始時の潮位など)。水位と地盤高に足します。既定は 0
variablestring | undefined2 次元変数が複数あるファイルから読む変数

CZML ファイルの時刻ごとのポリゴンを変換します。輪郭の中のセルは、頂点の高さを輪郭の三角形分割の上で線形補間して取ります。同じ時刻のポリゴンは重なってはいけません。

プロパティ型説明
inputInputCZML ファイル。頂点が水面の高さを持ち、properties はパケットの properties から取ります
resolutionnumber | undefined輪郭を取り直すメートル単位のセルの大きさ。格子に沿った輪郭は、指定しなければシミュレーションのセルとして取ります
time"start" | "end" | undefined有効期間のどちらの端を時刻とするか。既定は "start"
terrainTerrain | undefined地盤高のないデータに、一度でも浸水したセルの中心で地盤高を取る地形。raster-dem ソースか TerrainSampler で、@navaramap/three の sampleTerrainMostDetailed と同じようにサンプリングします。ground プロパティとして保存します(高さを参照)

時刻ごとの非構造メッシュ上の値を、resolution メートルの格子に取り直して変換します。節点の値は三角形の上で線形補間し、4 節点以上の面は三角形に分けます。三角形の一部の節点が乾いていて地盤高が分かるときは、乾いた節点で 0 として浸水深を補間するので、水はそこへ向かって薄くなります。

メッシュと値は、CSV ファイル(inputs)か、1 つの netCDF ファイル(input)から読みます。次のオプションはどちらにも使います。

プロパティ型説明
projectionProjection | undefined節点の位置の投影
resolutionnumberメッシュを取り直す格子のメートル単位のセルの大きさ
maxEdgenumber | undefined面がないとき、残す三角形の辺の最大長(メートル)。離れた浸水域どうしがつながらないようにします。nodes もないときは、浸水域の縁まで水が届くよう、乾いた点も水位のない行として含めます
levelstring | undefined水位の列(または変数)
groundstring | undefined地盤高の列(または変数)
depthstring | undefinedlevel の代わりに、ground と足して水位になる浸水深の列(または変数)
minDepthnumber | undefinedこれより浅い節点とセルを乾いているとみなすメートル単位の深さ。既定は 0.01
プロパティ型説明
inputsInput[]浸水した節点(または面)ごと、時刻ごとに 1 行の値の CSV ファイル。行のない節点は乾いているとみなします。読み方は convertRasters の CSV と同じです
nodesInput | undefined節点の CSV。id、position、地盤高のように時間で変わらない列を持ちます。列は値の行、節点の行の順に探します。ない場合は、各値の行がその節点の位置を持ちます
facesInput | undefined面の CSV。id と、各面を囲む順の節点の id を持ちます。ない場合は節点を三角形分割(Delaunay)します
faceNodesstring[] | undefinedfaces のうち節点の id を持つ列。空のフィールドで、それより節点の少ない面の終わりを示します。既定は id 以外のすべての列です
idstring | undefined節点・面・値の行の id の列。既定は "id"
valuesOn"nodes" | "faces" | undefined値が節点にあるか、面にあって面全体に取るか。既定は "nodes"
positionCoordinateColumns節点の位置の列(度)。projection を指定したときは東向き・北向きの座標です

properties のコールバックには、値の行を節点(または面)の行に重ねたものが、列名をキーにした文字列で渡ります。

プロパティ型説明
inputInputメッシュと時刻ごとの値を持つ netCDF ファイル。UGRID 規約に従ったものか、x、y、volumes の三角形のもの
meshstring | undefined2 次元メッシュが複数あるときに使う、UGRID のメッシュトポロジーの変数
epochDate | undefined時刻の units に日付がないときの、時刻の起点

level、ground、depth は変数名です。水位(または浸水深)は時刻ごとの [time, nodes] か [time, faces]、地盤高は同じ節点か面の上の、時間で変わらない変数です。節点(または面)は、minDepth 以上の深さがあるところ、地盤高がない場合は水位が欠損でないところを浸水とみなします。

  • UGRID:cf_role = "mesh_topology" かつ topology_dimension = 2 の変数がメッシュです。その node_coordinates と face_node_connectivity で節点と面を読み、接続表の start_index と _FillValue に従います。変数が節点と面のどちらにあるかは location で判断します。standard_name = "longitude" か units = "degrees_east" の座標は度とみなし、それ以外は projection が必要です。
  • volumes の三角形(.sww など):節点は x と y に属性 xllcorner と yllcorner を足した位置、三角形は volumes です。level と ground の既定は stage と elevation です。位置はモデルの投影座標なので、projection が必要です。
  • 時刻は変数 time(または standard_name = "time" の変数)です。単位が <unit> since <date> なら日時として読みます。そうでなければ、epoch からの秒に、ファイルの属性 starttime があれば足します。
  • properties には同じ節点(または面)の上の変数名を指定します。コールバックには、浸水した節点ごとに、そうした変数の値が名前をキーに渡されます。例:({ stage, elevation, xmomentum, ymomentum }) => ({ speed: Math.hypot(xmomentum, ymomentum) / (stage - elevation) })。
  • ファイルは丸ごとメモリに読み、そこから 1 時刻ずつ読みます。読める netCDF の版は convertRasters を参照してください。