Skip to content

Repository files navigation

fusi

fusi は国土地理院の標高 GeoTIFF を Terrarium 形式のタイルに変換するツールチェーンです。mapterhorn が示した手法をベースに、Web Mercator(EPSG:3857)への自動再投影やズーム別の垂直解像度管理を備えています。内部的には Lossless WebP のタイルを MBTiles に書き出し、go-pmtilespmtiles convert コマンドで PMTiles に変換します。just aggregate は既定で系譜(lineage)MBTiles/PMTiles も同時生成します(suffix: -lineage)。

主な特徴

  • bounds.csv による GeoTIFF メタデータ管理と空間インデックス
  • 512px タイルを前提にした自動ズーム推定(GSD から max zoom を決定)
  • Terrarium エンコード(mapterhorn 互換)と nodata を 0 m に正規化する安全策
  • Lossless WebP タイルを MBTiles にストリーミング書き込みし、その後 PMTiles に変換
  • 集約パイプライン:複数 GeoTIFF をオンザフライでモザイクし 1 本の MBTiles/PMTiles に統合
  • 進捗表示:候補タイル数・書き出しタイル数・割合を標準出力に逐次表示
  • just コマンドで一連のタスクを自動化

必要なもの

  • Python 3.12 以上
  • pipenv
  • just(Homebrew: brew install just
  • go-pmtiles (pmtiles CLI、例: brew install golang && go install github.com/protomaps/go-pmtiles/cmd/pmtiles@latest

参考: ツールの導入例

brew install just parallel   # macOS
pip3 install --user pipenv
go install github.com/protomaps/go-pmtiles/cmd/pmtiles@latest

セットアップ

git clone https://github.com/hfu/fusi.git
cd fusi
just setup          # pipenv install を実行
just check          # 実行に必要なツールを確認

データの配置とプリセット

  1. 標高 GeoTIFF を source-store/<source_name>/ に格納します。ファイル名の規則は自由ですが、bounds.csv が参照できる位置にまとめておく必要があります。
  2. 大規模データセットでは、シンボリックリンクでサブセットを作るとテストが容易です。
mkdir -p source-store/japan_dem
cp /path/to/*.tif source-store/japan_dem/

# 例: 全ファイルのシンボリックリンクを bulk_all にまとめる
python - <<'PY'
from pathlib import Path
src = Path('source-store/japan_dem')
dst = Path('source-store/bulk_all')
dst.mkdir(exist_ok=True)
for tif in sorted(src.glob('*.tif')):
    link = dst / tif.name
    if not link.exists():
        link.symlink_to(tif.resolve())
PY

基本ワークフロー

1. bounds.csv を生成

just bounds bulk_all

標準出力に処理件数が表示され、source-store/bulk_all/bounds.csv が生成されます。

2. MBTiles/PMTiles を生成

推奨: Zoom分割による省メモリ実行(16GB RAM環境)

メモリ使用量を10GB以下に抑える分割実行方式:

just aggregate-split bulk_all
  • Zoom分割により、16GB RAMでも安定して実行可能
  • メモリ使用量: 従来の40GB → 10GB以下に削減
  • 処理時間: 従来比+10-20%程度
  • 詳細は ZOOM_SPLIT_GUIDE.md を参照

従来方式: 一括実行(24GB+ RAM推奨)

just aggregate bulk_all
  • output/fusi.pmtiles が生成されます(内部的に output/fusi.mbtilespmtiles convert)。
  • メモリ使用量が大きいため、32GB以上のRAMを推奨

代替: モジュールとして直接起動することもできます(just を介さずに実行する場合)。

python3 -m pipelines.aggregate_pmtiles -o output/fusi.pmtiles bulk_all

注意: 既存の MBTiles を上書きしたい場合は --overwrite を付けてください(デフォルトでは上書きを拒否します)。詳細ログは既定で有効です(--silent で抑制)。

補足: MBTiles の書き込みでは SQLite の WAL モードを使用します。長時間・大規模書き込み時に WAL ファイルが肥大化しないよう、内部で定期的に PRAGMA wal_checkpoint(TRUNCATE) を実行して .wal を短く保ち、処理完了時に PRAGMA journal_mode=DELETE に戻して .wal/.shm を削除する設計になっています。

系譜(lineage)メタデータについて

just aggregate は既定で --emit-lineage を有効にして、主 MBTiles/PMTiles と並行して系譜(provenance)MBTiles/PMTiles を生成します(ファイル名サフィックスは -lineage)。系譜 MBTiles にはメタデータ encoding: lineage が付与されます(pipelines/mbtiles_writer.pyupdate_metadata() により書き込み)。視覚化や検査の際に、通常の Terrarium タイルと系譜タイルを区別するために参照できます。

系譜タイルはピクセル毎に「どの優先度ソースが値を供給したか」を RGB で表します(nodata は -1 を表す専用色)。主タイル生成後の後処理として計算・書き込みするため、I/O が増えます。不要であれば --no-emit-lineage を指定してください。

長崎県スモークテスト結果

2025-11-26 に長崎県域(概算 bbox: 128.3,32.4,131.6,33.8)で --max-zoom 16 のスモークテストを実施しました。主要ポイントは以下の通りです。

  • タイル生成: 88,224 タイルを生成(候補 245,340 件のうち)
  • 中間 MBTiles: output/nagasaki.mbtiles を生成
  • PMTiles 変換: pmtiles convert による変換が正常完了(処理時間: 約 3 分 24 秒)
  • WAL/SHM: MBTiles 書き込みは WAL モードで行われたが、最終化処理により .wal は切り詰められ、.shm は短時間の共有メモリファイルとして残る場合がある

このスモークテストは、MBTiles-first フロー(SQLite にストリーム挿入してから go-pmtiles で PMTiles に変換する方式)が実運用規模に耐えうることの初期確認になりました。フル生産を行う際は以下に注意してください。

  • 実行前に df -h で出力先ディスクの空き容量を十分に確保すること(数十 GB の余裕を推奨)。
  • TMPDIR は出力先(外付け SSD 等)に設定してシステムボリュームの ENOSPC を回避すること。just レシピは既定でこれを設定します。
  • 長時間の書き込みでは WAL サイズを抑えるために pipelines/mbtiles_writer.py にて定期的な wal_checkpoint(TRUNCATE) を行っていますが、万一中断する場合は下記のチェックポイント/復旧コマンドを参考にしてください。

チェックポイント(例):

sqlite3 output/fusi.mbtiles "PRAGMA wal_checkpoint(TRUNCATE); PRAGMA journal_mode=DELETE;"

フル生産を開始する前にローカルで小さなサブセット(今回の長崎テストのような)を必ず実行し、ログを確認してから本番を回してください。

  • 別名で出力したい場合は just aggregate -o output/bulk_all.pmtiles bulk_all のように -o/--output で PMTiles パスを指定します。
  • bounds.csv から対象ファイルを抽出し、各タイルごとに再投影・モザイク・Terrarium エンコードを行います。
  • 標準出力にはズーム別の候補タイル数と進捗率に加え、フェーズログ(union bounds / coarse bucket 構築 / 候補数計測)が表示され、停滞の切り分けが容易です。
  • I/O 安定化のため、以下を既定で有効化しています(必要に応じて上書き可能です)。
    • TMPDIR を出力ディレクトリに設定(Python の一時ファイルを外付け側へ誘導)
    • GDAL_CACHEMAX=512(環境変数で変更可)
    • --warp-threads 1(再投影スレッドを1に抑制)
    • --io-sleep-ms 1(タイルごとに1msスリープでI/Oに負圧)
    • --progress-interval 200(進捗ログの既定間隔)
    • 既定で詳細ログを有効化しています(--silent を指定すると抑制されます)

本番全域の集約を開始する

準備ができている場合、以下の手順で本番全域の集約を開始できます。ここでは例として dem1a を対象・最大ズーム 16 に設定します。実行は出力先ディレクトリに十分な空き容量があり、外付け SSD を output/ として使える前提です。

  1. 出力ディレクトリとログを作成しておく(output/ が既にある場合は不要):
mkdir -p output
  1. 本番集約コマンド(推奨オプションを含む)。標準出力とエラーログを teeoutput/production-dem1a-aggregate.log に保存します。実行中は output/production-dem1a.mbtiles がストリーム書き出され、完了後に pmtiles convert により output/production-dem1a.pmtiles が生成されます。
TMPDIR="$PWD/output" GDAL_CACHEMAX=512 \
  just aggregate -o output/production-dem1a.pmtiles dem1a \
    --max-zoom 16 --progress-interval 100 --io-sleep-ms 1 \
    --warp-threads 1 2>&1 | tee output/production-dem1a-aggregate.log
  1. 実行後の検証(MBTiles 内に重複タイルがないかを確認):
sqlite3 output/production-dem1a.mbtiles \
  "SELECT COUNT(*) AS total_rows, COUNT(DISTINCT zoom_level || '-' || tile_column || '-' || tile_row) AS distinct_keys FROM tiles;"
# 戻り値が "N|N" なら重複はありません。

推奨: aggregate-split-lineage の実行例(TMPDIR 注意)

分割実行かつ系譜(lineage)も出力する場合の推奨コマンド例です。重要: --tmpdir. やシステムルートを指定すると、macOS のシステムボリュームの空きが少ない環境で ENOSPC エラーが発生することがあります。外付け SSD や大容量マウントを利用するか、output/ 配下に作成した専用ディレクトリを指定してください。

# 事前に TMPDIR を外部ボリュームか output/ 配下に作成しておく
export TMPDIR="/Volumes/BigDrive/pmtiles_tmp"
mkdir -p "$TMPDIR" && chmod 700 "$TMPDIR"

just aggregate-split-lineage dem1a dem5a dem5b dem5c dem10a dem10b \
  -o output/fusi.pmtiles --split-pattern balanced \
  --overwrite --tmpdir "$TMPDIR" --lineage-suffix=-lineage \
  --warp-threads 1 --io-sleep-ms 10 2>&1 | tee output/fusi-aggregate.log

短く言うと: --tmpdir . のようにカレントディレクトリを渡すのではなく、十分な空き容量がある場所を TMPDIR として指定してください。just レシピは TMPDIR が未設定のとき自動で output/tmp.* を作成しますが、大容量の一時領域が必要な場合は明示的に外部ディスクを指定するのが安全です。

  1. サンプルタイルをいくつか点検して、低優先度ソースが上位ソースの nodata を埋めていることを確認します(ツール: scripts/inspect_tile_fill.py)。例:
python3 scripts/inspect_tile_fill.py --mbtiles output/production-dem1a.mbtiles --z 8 --x 220 --y 152 --sources dem1a dem10b

注意: 長時間実行になるため、途中で中断した場合は sqlite3 にて PRAGMA wal_checkpoint(TRUNCATE); PRAGMA journal_mode=DELETE; を実行して WAL を切り詰めてください。

オプション(just aggregate 経由で pipelines/aggregate_pmtiles.py に渡ります)

  • -o/--output <pmtiles>: 最終的な PMTiles パスを指定(内部的に同名の .mbtiles が生成されます)
  • --bbox <west> <south> <east> <north>: WGS84 度で出力範囲を限定
  • --min-zoom, --max-zoom: 出力ズームレンジを明示指定
  • --progress-interval N: 進捗ログの間隔を調整

3. 出力の確認

just inspect output/fusi.pmtiles

ヘッダ情報・ズームレンジ・バウンディングボックスなどが確認できます。

4. 配布先へのアップロード(任意)

just upload

output/fusi.pmtiles を想定したアップロードタスクです。宛先やファイル名を変える場合は justfileupload レシピを調整してください。

オプション: 単一 GeoTIFF の変換

一枚の GeoTIFF を手早く確認したいときは just convert を使えます。

just convert source-store/bulk_all/sample.tif output/sample.pmtiles
  • --max-zoom を省略すると、ソースの Ground Sample Distance (GSD) からズームを自動推定します。
  • 実行ログに「Auto-selected max zoom …」が表示されます。

実務で得た Tips / トラブルシューティング

  • テストから本番へ: 小さなサブセットで just aggregate を試し、ズーム自動推定や nodata=0 m の挙動を確認してから全量処理すると安全です。
    • 推奨の小規模テスト地域: iwaki(今後のテスト例では iwaki を使用します)。
  • 進捗ログ: 大量データのときは出力が数時間続くことがあります。進捗ログには「書き出し済みタイル数」「チェック済み候補数」「全候補に対する割合」が表示されるため、残り時間の目安になります。フェーズログ(union/bucket/count)で停滞箇所を切り分けできます。
  • 一時ファイルの置き場: 既定で出力ディレクトリ配下にスプールするため、macOS のシステムボリューム容量逼迫を避けられます。独自ディレクトリへ変更する場合は TMPDIR を上書きしてください。
  • GDAL キャッシュ: 既定 GDAL_CACHEMAX=512。マシンに余裕があれば上げられますが、I/O 飽和時は増やし過ぎないでください。
  • Mapzen (Mapterhorn) との比較: Mapzen の Mapterhorn タイルはズーム 0–15 が公式レンジ(ドキュメント)です。本ツールはズーム 16 まで自動出力できるので、地形の細部を 1 段深く表現できます。
  • データサイズ: Lossless WebP により圧縮しますが、ズーム範囲によっては数十 GB になる場合があります。十分なディスク容量を確保してください。

よくあるエラーと対処

  • exit 137 / Killed(メモリ不足の可能性)
    • 対策: GDAL_CACHEMAX=128–256 に下げる、--warp-threads 1 を指定、--io-sleep-ms 5–10 に増やす、BBOX を絞る。
    • TMPDIR を必ず出力側(外付けSSD等)に設定。環境変数の誤記に注意。

Watchdog / TMPDIR recommendations

  • New flags: --watchdog-memory-mb and --watchdog-time-seconds are available for worker processes (when running pipelines.aggregate_by_zoom or via split_aggregate forwarding). These spawn a small background monitor that will send a SIGTERM to the worker if the runtime or RSS memory exceeds the configured limits (best-effort; psutil is used if available).

  • Example: run a memory-limited split aggregate with TMPDIR set to your external disk and a 10 GiB watchdog:

TMPDIR="$PWD/output" GDAL_CACHEMAX=256 \
  FUSI_MB_CHECKPOINT_INTERVAL=1000 \
  FUSI_MB_COMMIT_SLEEP_SEC=0.10 \
  FUSI_MB_BATCH_SLEEP_SEC=0.02 \
  pipenv run python -u -m pipelines.split_aggregate \
  --verbose --watchdog-memory-mb 10240 dem1a dem10b

Set TMPDIR to point to the external SSD (or use --tmpdir in the wrapper scripts) so temporary files are not written to the macOS system volume.

  • MapLibre の “dem dimension mismatch”

    • 原因: raster-dem の期待サイズと提供タイルサイズが異なる場合に発生。Terrarium は 512×512 前提。ソース設定の tileSizeencoding を確認。
    • 検証: MBTiles からサンプルタイルを取り出し、WebP をデコードして画像サイズが 512×512 であることを確認。
  • WAL ファイルの肥大化

    • 集約中は WAL モードを使用。完了時に journal_mode=DELETE に戻す。中断後は手動でチェックポイント:
    sqlite3 output/*.mbtiles "PRAGMA wal_checkpoint(TRUNCATE); PRAGMA journal_mode=DELETE;"

コマンド一覧(just --list と同等)

just setup                        # pipenv install
just check                        # 依存関係チェック
just bounds <source>              # bounds.csv 生成
just convert <input> <output> [--min-zoom Z] [--max-zoom Z]
just test-sample <source>         # 代表ファイルでの動作確認

# 通常のaggregate(24GB+ RAM推奨)
just aggregate <source...> [options]
  # -o/--output で PMTiles パスを指定(省略時は output/fusi.pmtiles)
  # 既定で詳細ログを有効化(`--silent` で抑制)し、TMPDIR=output/ と GDAL_CACHEMAX=512 を設定

# Zoom分割aggregate(16GB RAM環境推奨、省メモリ)
just aggregate-split <source...> [options]
  # --split-pattern でパターン選択(balanced, safe, fast, incremental)
  # --resume-from N で中断からの再開

# 特定のズーム範囲のみ処理
just aggregate-zoom <min_zoom> <max_zoom> <source...> [options]

# 複数MBTilesのマージ
just merge-mbtiles <output> <input1> <input2> ...

# Zoom分割パターンの確認
just show-split-patterns

just inspect <pmtiles>            # PMTiles メタデータ閲覧
just upload                       # output/fusi.pmtiles をリモートへ rsync
just clean / clean-all            # 出力や bounds.csv を削除

タイル仕様

  • タイルサイズ: 512 × 512 px
  • ズーム範囲: 既定値は 0–15。ソースの GSD ≈ 1.4 m の場合は自動で 16 が選択されます。
  • Terrarium エンコード
    • デコード式: elevation = (R × 256 + G + B / 256) - 32768
    • nodata は 0 m として出力(RGB ≈ 128/0/0)
    • ズーム別垂直解像度は mapterhorn と同じフォーミュラで 2 のべき乗に丸め
  • メタデータ: attribution に 国土地理院 (GSI Japan)、ライセンスとして R 6JHs 133 を埋め込み
  • PMTiles メタデータ: encoding=terrarium, tile_type=webp, attribution は 国土地理院 (GSI Japan)

Mapbox Terrain-RGB との比較

項目 fusi (Terrarium) Mapbox Terrain-RGB
オフセット +32768 +10000
解像度 1/256 m (ズーム 19 換算) 0.1 m
nodata 0 m -10000 m
用途 mapterhorn 互換ビジュアライズ Mapbox/MapLibre 公式タイルセット

プロジェクト構成

fusi/
├── source-store/             # ソース GeoTIFF(元ファイル or symlink)
│   └── <source>/
│       ├── *.tif
│       └── bounds.csv        # just bounds で生成
├── output/                   # 変換結果 MBTiles / PMTiles
├── pipelines/                # コア処理モジュール(ライブラリ的に再利用)
│   ├── source_bounds.py      # bounds.csv 作成
│   ├── convert_terrarium.py  # 単一 GeoTIFF → PMTiles(ライブラリ関数 + CLI)
│   ├── aggregate_pmtiles.py  # 複数 GeoTIFF → MBTiles 集約(生成器 / ライブラリ関数)
│   ├── mbtiles_writer.py     # Terrarium WebP タイルを MBTiles に書き出すヘルパ
│   └── inspect_pmtiles.py    # PMTiles のヘッダ確認
├── justfile                  # タスクランナー定義
├── Pipfile / Pipfile.lock    # Python 依存関係
├── IMPLEMENTATION_SUMMARY.md
└── README.md

役割の明確化:

  • pipelines/: ライブラリ的なコア処理(再投影、モザイク、エンコード、MBTiles 書き出し)を置きます。ユニットテストや他スクリプトからインポートして利用できる形で実装しています。
  • scripts/: 1回実行のユーティリティや検査スクリプト(例: scripts/inspect_tile_fill.py)を置きます。scripts/ 内のスクリプトは pipelines の関数を呼んで薄いラッパーにする方針です。

注意: scripts/ に置くスクリプトは原則として薄い CLI ラッパーにとどめ、コアの処理ロジックは必ず pipelines/ に実装してください。新しいコマンドを追加する際の推奨パターンは次のとおりです。

  • pipelines/ に機能(関数・main())を実装し、ユニットテストを添える。
  • scripts/ には引数パースと実行環境の調整(sys.path の補助等)、pipelines.<module>.main() の呼び出しだけを書く。

この分離により、ライブラリ機能をテストや他ツールから再利用しやすくなり、CI やバッチ処理からも安定して呼び出せます。

ロードマップ

  • GeoTIFF → Terrarium PMTiles 単体変換
  • bounds.csv 生成とメタデータ管理
  • nodata を 0 m に正規化する Terrarium 互換処理
  • ズーム自動推定 & 512px タイル対応
  • 集約パイプラインと進捗表示
  • Downsampling / オーバービュー生成
  • 配布用パッケージング(例: Cloud Storage 連携)

データのライセンスと出典

測量法に基づく国土地理院長承認(使用)R 6JHs 133

本プロジェクトは国土地理院(GSI)が提供する標高データを加工しています。利用にあたっては測量法の規定に従い、上記の承認番号を含むクレジット表記を行ってください。

ソフトウェアライセンス

CC0 1.0 Universal(Public Domain Dedication)です。LICENSE を参照してください。

コントリビュート

  1. リポジトリを Fork
  2. ブランチを作成
  3. 変更を実装し just test-sample / just aggregate などで確認
  4. Pull Request を作成

サポート

  • GitHub Issues: hfu/fusi/issues
  • その他連絡先: リポジトリメンテナーまで

About

Convert GeoTIFF to PMTiles for Japanese elevation data

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages