fukasis 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright © 2026 Tsuyoshi Kobayashi(legrs4073)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,3 +1,109 @@
-# Temporary Holding Version
+# fukasis (コマンドライン版)
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+FUKASIS-app で撮影したデータを PC で処理するコマンドラインツールです。
+アプリの **dark / calibration / csv / view** の 4 画面に相当するコマンドがあります。
+まとめて処理したいときや、スクリプトから呼びたいときに使います。画像を見ながら作業するなら [web 版](../web/README.md) が向いています。
+
+計算はアプリ (共通コア `core/`) と同じ結果になるようにしてあります。
+
+## ビルド
+
+[Rust](https://www.rust-lang.org/ja/tools/install) が必要です。外部クレートには依存していません。
+
+```bash
+cd cli
+cargo build --release
+```
+
+`cli/target/release/fukasis` (Windows では `fukasis.exe`) ができます。
+`cargo install --path cli` (リポジトリの直下で実行) とすると、`fukasis` コマンドとしてインストールされます。
+GitHub Actions の「PC tools」が動いているリポジトリでは、その実行結果からビルド済みの実行ファイル (Linux / macOS / Windows) も取得できます。
+
+## 使い方
+
+スマートフォンの `Internal_Storage/Documents/FUKASIS-app/` を PC にコピーして使います。
+
+### dark: ダーク減算
+
+```bash
+fukasis dark imgs/alphaOri_260314_1/stacked.tif imgs/dark_20260314/stacked.tif
+```
+
+ライトフレームと同じフォルダに `darked.tif` を書きます。`-o` で出力先を変えられます。
+
+### info: 画像の情報
+
+```bash
+fukasis info imgs/fluorescent_260314_1/stacked.tif
+```
+
+画像の大きさ、0次光の位置の推定、輝線の候補 (明るい順) を表示します。
+次の `calib` に渡す位置を調べるのに使えます。どちらも推定なので、おかしければ web 版で画像を見て確かめてください。
+
+### calib: 波長校正データを作る
+
+```bash
+fukasis calib --fol 3590 --line 1958=435.8 --line 1604=546.1 --line 1464=588.0 --line 1380=611.6 -o calibdata/fluorescent.csv
+```
+
+`--fol` は 0次光の位置、`--line` は「輝線の位置 = 波長 (nm)」です。位置はどちらも画像上の x 座標 (px) です。
+校正点は 4 本以上を推奨します。4 本ならその 4 点を通る 3 次式、5 本以上なら 3 次の最小二乗で当てはめます。
+当てはめとの差と、出力される波長の範囲が表示されます。`-o` を省くと校正データを標準出力に書きます。
+
+既存の校正データを確かめるだけなら:
+
+```bash
+fukasis calib --check calibdata/fluorescent.csv --fol 3590
+```
+
+### csv: スペクトルを出力
+
+```bash
+fukasis csv --image imgs/alphaOri_260314_1/darked.tif \
+            --calib calibdata/fluorescent.csv \
+            --sensitivity sensit_distr.csv \
+            --metadata imgs/alphaOri_260314_1/metadata.csv \
+            -o spectrum/alphaOri_260314_1.csv
+```
+
+- `--fol` を省くと 0次光の位置を自動で推定します (推定した値は表示されます)。ずれている場合は `--fol <x>` で指定してください。
+- `--metadata` は任意です。省くと 1 行目には画像のファイル名が入ります。
+- `-o` を省くと標準出力に書きます。
+- カラーフィルタ配列は、metadata に記録されていればそれを使います (無ければ GBRG)。`--cfa RGGB` のように指定もできます。
+- スペクトルを読む帯は、既定では画像の中央の幅 80 px です。機種によって違う場合は `--band-width <px>` と `--band-center <0〜1>` で変えられます。
+- 出力する範囲は校正データから波長 (400〜700 nm) で決まります。出力できる点が無いときは、理由を表示して終了します。
+
+### graph: グラフを SVG に出力
+
+```bash
+fukasis graph spectrum/alphaOri_260314_1.csv spectrum/betaOri_260314_1.csv -o compare.svg
+```
+
+8 本まで重ねて描けます。既定では明らかな異常値 (波長が折り返している部分・負の強度・孤立したスパイク) を除いて描きます。
+`--keep-outliers` を付けると除かずに描きます。`--title` で見出しを変えられます。
+
+## 対応している画像
+
+TIFF は、アプリが書き出す形式 (無圧縮・1 チャンネル・ストリップ形式。32 bit float のほか 8 / 16 / 32 bit 整数、64 bit float) に対応しています。
+圧縮された TIFF やタイル形式には対応していません。
+
+## テスト
+
+```bash
+cargo test
+```
+
+アプリの C++ をそのまま動かして作った正解データ (`testdata/`) と出力が一致することを確かめています。
+
+## リリース
+
+GitHub Releases・crates.io (`fukasis`)・npm (`fukasis`) で配布できる形にしてあります。手順は [docs/releasing.md](../docs/releasing.md) にあります。
+公開後は、次のどれでも入れられます。
+
+```bash
+cargo install fukasis
+```
+
+```bash
+npm install -g fukasis
+```

package/bin/fukasis.js

@@ -0,0 +1,160 @@
+#!/usr/bin/env node
+// SPDX-License-Identifier: MIT
+// npm で配る fukasis の起動役. optionalDependencies で一緒に入る機種別パッケージ
+// (@fksgeo/fukasis-bin-*) から実行ファイルを探して起動する.
+// esbuild や swc, Biome と同じやり方.
+'use strict';
+
+const { spawnSync } = require('child_process');
+const fs = require('fs');
+const os = require('os');
+const path = require('path');
+
+const s = (platform) => `@fksgeo/fukasis-bin-${platform}`;
+
+// pkg は既定 (Linux では glibc 版), muslPkg は musl 版 (Alpine など).
+// 32 bit ARM の v6Pkg / v6MuslPkg は ARMv6 版 (Raspberry Pi 1 / Zero).
+// os / cpu だけでは ARMv6 と ARMv7, glibc と musl を区別できず複数入ることがあるので, ここで選ぶ.
+const PLATFORMS = {
+  'darwin arm64': { pkg: s('darwin-arm64') },
+  'darwin x64': { pkg: s('darwin-x64') },
+  'win32 x64': { pkg: s('win32-x64') },
+  'win32 arm64': { pkg: s('win32-arm64') },
+  'win32 ia32': { pkg: s('win32-ia32') },
+  'linux x64': { pkg: s('linux-x64'), muslPkg: s('linux-x64-musl') },
+  'linux arm64': { pkg: s('linux-arm64'), muslPkg: s('linux-arm64-musl') },
+  'linux ia32': { pkg: s('linux-ia32'), muslPkg: s('linux-ia32-musl') },
+  'linux arm': {
+    pkg: s('linux-arm'),
+    muslPkg: s('linux-arm-musl'),
+    v6Pkg: s('linux-armv6'),
+    v6MuslPkg: s('linux-armv6-musl'),
+  },
+  'linux riscv64': { pkg: s('linux-riscv64'), muslPkg: s('linux-riscv64-musl') },
+  // 配っているのはリトルエンディアン (ppc64le) 版だけ
+  'linux ppc64': { pkg: s('linux-ppc64'), littleEndianOnly: true },
+  'linux s390x': { pkg: s('linux-s390x') },
+  'linux loong64': { pkg: s('linux-loong64') },
+  'android arm64': { pkg: s('android-arm64') },
+  'android arm': { pkg: s('android-arm') },
+  'android x64': { pkg: s('android-x64') },
+  'android ia32': { pkg: s('android-ia32') },
+  'freebsd x64': { pkg: s('freebsd-x64') },
+  'freebsd ia32': { pkg: s('freebsd-ia32') },
+  'netbsd x64': { pkg: s('netbsd-x64') },
+  'sunos x64': { pkg: s('sunos-x64') },
+};
+
+// Node の process.report には, glibc 版の Node なら glibc のバージョンが入っている (musl 版には無い).
+// process.report が無い古い Node では ldd の中身で判断する.
+function isMusl() {
+  if (process.platform !== 'linux') return false;
+  if (!process.report || typeof process.report.getReport !== 'function') {
+    try {
+      return fs.readFileSync('/usr/bin/ldd', 'utf8').includes('musl');
+    } catch (e) {
+      return false;
+    }
+  }
+  const { glibcVersionRuntime } = process.report.getReport().header;
+  return !glibcVersionRuntime;
+}
+
+// ARMv6 の機械では ARMv7 版は動かない. Node はビルドされた ARM のバージョンを覚えている
+function isArmV6() {
+  return process.arch === 'arm' && String(process.config.variables.arm_version) === '6';
+}
+
+function resolveFromPkg(pkg, exe) {
+  try {
+    return require.resolve(`${pkg}/bin/${exe}`);
+  } catch (e) {
+    // node_modules/fukasis/bin/ から見た node_modules/<pkg>/bin/
+    const local = path.join(__dirname, '..', '..', ...pkg.split('/'), 'bin', exe);
+    return fs.existsSync(local) ? local : null;
+  }
+}
+
+// 試すパッケージを, 合うものから順に並べる.
+// musl 版は静的リンクなので glibc の機械でも動く. glibc 版が入っていないときの控えにする
+function candidatesFor(entry, onMusl, armV6) {
+  const glibc = armV6 ? [entry.v6Pkg] : [entry.pkg, entry.v6Pkg];
+  const musl = armV6 ? [entry.v6MuslPkg] : [entry.muslPkg, entry.v6MuslPkg];
+  return (onMusl ? [...musl, ...glibc] : [...glibc, ...musl]).filter(Boolean);
+}
+
+// 起動する実行ファイルを { path, pkg, muslFallback } で返す. 見つからなければ { error }.
+// muslFallback は「musl の機械なのに glibc 版しか見つからなかった」とき true.
+// その glibc 版はたいてい起動できず, ただの ENOENT になるので, 呼び出し側で説明を足す.
+function findBinary({
+  platform = process.platform,
+  arch = process.arch,
+  endianness = os.endianness(),
+  musl = isMusl,
+  armV6 = isArmV6,
+  resolve = resolveFromPkg,
+} = {}) {
+  const key = `${platform} ${arch}`;
+  const entry = PLATFORMS[key];
+  if (!entry || (entry.littleEndianOnly && endianness !== 'LE')) {
+    return {
+      error:
+        `fukasis: this platform (${key}) has no prebuilt binary on npm.\n` +
+        'See https://github.com/igarinpiano/fukasis/releases for more builds, or build from source: cargo install fukasis',
+    };
+  }
+  const exe = platform === 'win32' ? 'fukasis.exe' : 'fukasis';
+  const onMusl = Boolean(entry.muslPkg) && musl();
+  const candidates = candidatesFor(entry, onMusl, arch === 'arm' && armV6());
+  const muslPkgs = [entry.muslPkg, entry.v6MuslPkg].filter(Boolean);
+  for (const pkg of candidates) {
+    const resolved = resolve(pkg, exe);
+    if (resolved) return { path: resolved, pkg, muslFallback: onMusl && !muslPkgs.includes(pkg) };
+  }
+  return {
+    error:
+      `fukasis: could not find the binary package (${candidates.join(' / ')}).\n` +
+      'Try reinstalling: npm install -g fukasis (without --omit=optional / --no-optional).',
+  };
+}
+
+function launchErrorMessage(found, error, arch = process.arch) {
+  let msg = `fukasis: failed to launch: ${error.message}`;
+  if (found.muslFallback && error.code === 'ENOENT') {
+    const muslPkg = PLATFORMS[`linux ${arch}`] && PLATFORMS[`linux ${arch}`].muslPkg;
+    msg +=
+      `\nfukasis: this looks like a musl system (Alpine, etc.), but only the glibc build (${found.pkg}) is installed,` +
+      ' and it cannot run without glibc.' +
+      `\nInstall the musl build: npm install -g ${muslPkg}`;
+  }
+  return msg;
+}
+
+function main() {
+  const found = findBinary();
+  if (found.error) {
+    console.error(found.error);
+    process.exit(1);
+  }
+  let result = spawnSync(found.path, process.argv.slice(2), { stdio: 'inherit' });
+  // 実行権限が落ちていたら付け直してもう一度
+  if (result.error && result.error.code === 'EACCES') {
+    try {
+      fs.chmodSync(found.path, 0o755);
+      result = spawnSync(found.path, process.argv.slice(2), { stdio: 'inherit' });
+    } catch (e) {
+      // 下でもとのエラーを表示する
+    }
+  }
+  if (result.error) {
+    console.error(launchErrorMessage(found, result.error));
+    process.exit(1);
+  }
+  process.exit(result.status === null ? 1 : result.status);
+}
+
+if (require.main === module) {
+  main();
+}
+
+module.exports = { PLATFORMS, findBinary, launchErrorMessage };

package/package.json

@@ -1,6 +1,61 @@
 {
   "name": "fukasis",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Process spectra captured with FUKASIS-app on a PC: dark subtraction, wavelength calibration, CSV export and SVG graphs",
+  "keywords": [
+    "spectroscopy",
+    "astronomy",
+    "spectrum",
+    "calibration",
+    "tiff",
+    "cli"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/igarinpiano/fukasis.git"
+  },
+  "homepage": "https://github.com/igarinpiano/fukasis/tree/master/cli",
+  "bugs": "https://github.com/igarinpiano/fukasis/issues",
+  "license": "MIT",
+  "bin": {
+    "fukasis": "bin/fukasis.js"
+  },
+  "files": [
+    "bin/",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=16"
+  },
+  "optionalDependencies": {
+    "@fksgeo/fukasis-bin-darwin-arm64": "0.1.0",
+    "@fksgeo/fukasis-bin-darwin-x64": "0.1.0",
+    "@fksgeo/fukasis-bin-win32-x64": "0.1.0",
+    "@fksgeo/fukasis-bin-win32-arm64": "0.1.0",
+    "@fksgeo/fukasis-bin-win32-ia32": "0.1.0",
+    "@fksgeo/fukasis-bin-linux-x64": "0.1.0",
+    "@fksgeo/fukasis-bin-linux-x64-musl": "0.1.0",
+    "@fksgeo/fukasis-bin-linux-arm64": "0.1.0",
+    "@fksgeo/fukasis-bin-linux-arm64-musl": "0.1.0",
+    "@fksgeo/fukasis-bin-linux-ia32": "0.1.0",
+    "@fksgeo/fukasis-bin-linux-ia32-musl": "0.1.0",
+    "@fksgeo/fukasis-bin-linux-arm": "0.1.0",
+    "@fksgeo/fukasis-bin-linux-arm-musl": "0.1.0",
+    "@fksgeo/fukasis-bin-linux-armv6": "0.1.0",
+    "@fksgeo/fukasis-bin-linux-armv6-musl": "0.1.0",
+    "@fksgeo/fukasis-bin-linux-riscv64": "0.1.0",
+    "@fksgeo/fukasis-bin-linux-riscv64-musl": "0.1.0",
+    "@fksgeo/fukasis-bin-linux-ppc64": "0.1.0",
+    "@fksgeo/fukasis-bin-linux-s390x": "0.1.0",
+    "@fksgeo/fukasis-bin-linux-loong64": "0.1.0",
+    "@fksgeo/fukasis-bin-android-arm64": "0.1.0",
+    "@fksgeo/fukasis-bin-android-arm": "0.1.0",
+    "@fksgeo/fukasis-bin-android-x64": "0.1.0",
+    "@fksgeo/fukasis-bin-android-ia32": "0.1.0",
+    "@fksgeo/fukasis-bin-freebsd-x64": "0.1.0",
+    "@fksgeo/fukasis-bin-freebsd-ia32": "0.1.0",
+    "@fksgeo/fukasis-bin-netbsd-x64": "0.1.0",
+    "@fksgeo/fukasis-bin-sunos-x64": "0.1.0"
+  }
+}