@photivra/engine 1.5.0 → 2.0.0

package/dist/facade/scene-radiance.js

@@ -0,0 +1,205 @@
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * Turns a facade scene and an illuminant into a scene radiance provider for the existing native
+ * environment RAW contract (`NativeEnvironmentRawProvider.evaluateRadiance` and, for pupil sampling,
+ * `evaluateApertureRadiance`). The scene is an engine chart, a caller reflectance function or a caller
+ * radiance function.
+ *
+ * Geometry: one plane perpendicular to the optical axis at `distanceM` in front of the camera. A query's
+ * outgoing direction o (scene toward camera, see docs/SENSOR_ENVIRONMENT_QUERY.md) gives the look
+ * direction l = -o; the plane point is l·distanceM/l.z. With a pupil ray, the plane point is the ray from
+ * its lens origin to z = distanceM.
+ *
+ * Radiometry: a Lambertian reflector of reflectance ρ(λ) under irradiance E(λ) has radiance
+ * L(λ) = ρ(λ)·E(λ)/π (W·m⁻²·sr⁻¹·nm⁻¹). The illuminant spectral shape S(λ) is scaled so that the
+ * plane illuminance is E_v = K_m ∫ E(λ) V(λ) dλ with K_m = 683 lm/W (CIE photometric definition) and
+ * V(λ) = ȳ(λ) from the engine's analytic CIE 1931 fit. The light is uniform
+ * over the plane, with no shadows. Inter-reflection, gloss and fluorescence are not modelled.
+ * @see docs/QUICK_START.md
+ */
+import { InvalidConfigurationError } from "../core/configuration-error.js";
+import { requireInputObject } from "../core/record-validation.js";
+import { estimateCie1931ColorMatchingFunctions, prepareColorimetricSpectrum } from "../color/color-matching-functions.js";
+import { createCieIlluminantASpectrum, createCieDaylightSpectrum, createPlanckianSpectrum } from "../color/illuminants.js";
+import { resolveChartScene } from "./chart-scenes.js";
+/** CIE maximum luminous efficacy for photopic vision, lm/W. */
+export const PHOTOPIC_MAXIMUM_LUMINOUS_EFFICACY_LM_PER_W = 683;
+/** Wavelength range of every facade spectrum and of the facade sensor quadrature, nm. */
+export const FACADE_SPECTRAL_RANGE_NANOMETERS = Object.freeze({ minimum: 380, maximum: 780 });
+export function resolveCaptureIlluminant(value) {
+    if (value === "cie-a")
+        return resolveCaptureIlluminant({ kind: "cie-a" });
+    requireInputObject(value, "illuminant");
+    const record = value;
+    const allowed = { planckian: ["kind", "temperatureKelvin"], "cie-a": ["kind"],
+        daylight: ["kind", "correlatedColorTemperatureKelvin", "basis"], spectrum: ["kind", "spectrum", "label"] };
+    const keys = typeof record.kind === "string" ? allowed[record.kind] : undefined;
+    if (!keys)
+        throw new InvalidConfigurationError("Unknown illuminant kind.");
+    for (const key of Object.keys(record))
+        if (!keys.includes(key))
+            throw new InvalidConfigurationError("Unknown illuminant field: " + key + ".");
+    let spectrum, id, description;
+    try {
+        switch (value.kind) {
+            case "planckian": {
+                const t = value.temperatureKelvin;
+                if (typeof t !== "number" || !Number.isFinite(t) || t < 1000 || t > 25000)
+                    throw new InvalidConfigurationError("Planckian temperature must be 1000-25000 K.");
+                spectrum = createPlanckianSpectrum({ temperatureKelvin: t, wavelengthRangeNanometers: { ...FACADE_SPECTRAL_RANGE_NANOMETERS } });
+                id = "planckian-" + t + "K";
+                description = "Planck blackbody spectrum at " + t + " K (Planck's law).";
+                break;
+            }
+            case "cie-a":
+                spectrum = createCieIlluminantASpectrum();
+                id = "cie-a";
+                description = "CIE standard illuminant A from its defining formula: Planck's law with c2 = 1.435e-2 m·K and T = 2848 K, 100 at 560 nm.";
+                break;
+            case "daylight":
+                spectrum = createCieDaylightSpectrum({ correlatedColorTemperatureKelvin: value.correlatedColorTemperatureKelvin, coefficientRounding: "cie-three-decimals", basis: value.basis });
+                id = "cie-daylight-" + value.correlatedColorTemperatureKelvin + "K";
+                description = "CIE daylight from the caller's S0/S1/S2 basis (" + value.basis.datasetId + ").";
+                break;
+            case "spectrum":
+                spectrum = value.spectrum;
+                id = "caller-spectrum";
+                description = "Caller illuminant spectrum" + (typeof value.label === "string" ? " (" + value.label + ")" : "") + ".";
+                break;
+        }
+    }
+    catch (error) {
+        if (error instanceof InvalidConfigurationError)
+            throw error;
+        throw new InvalidConfigurationError("Invalid illuminant: " + (error instanceof Error ? error.message : "invalid"));
+    }
+    let shape;
+    try {
+        shape = prepareColorimetricSpectrum(spectrum, "illuminant");
+    }
+    catch (error) {
+        throw new InvalidConfigurationError("Invalid illuminant spectrum: " + (error instanceof Error ? error.message : "invalid"));
+    }
+    const range = shape.wavelengthRangeNanometers;
+    if (range.minimum > FACADE_SPECTRAL_RANGE_NANOMETERS.minimum || range.maximum < FACADE_SPECTRAL_RANGE_NANOMETERS.maximum)
+        throw new InvalidConfigurationError("The illuminant spectrum must cover 380-780 nm.");
+    for (let nm = FACADE_SPECTRAL_RANGE_NANOMETERS.minimum; nm <= FACADE_SPECTRAL_RANGE_NANOMETERS.maximum; nm += 1) {
+        const s = shape.evaluate(nm);
+        if (!(s >= 0))
+            throw new InvalidConfigurationError("The illuminant spectrum must be non-negative over 380-780 nm.");
+    }
+    return Object.freeze({ id, description, shape, spectrum });
+}
+/**
+ * Factor k such that k·S(λ) (W·m⁻²·nm⁻¹) gives `illuminanceLux` on the plane: E_v = 683 ∫ k S ȳ dλ,
+ * integrated with the 1 nm trapezoid rule over 380-780 nm (ȳ outside this range is below 4e-5 of its peak).
+ */
+export function calculateIlluminantIrradianceScale(shape, illuminanceLux) {
+    if (typeof shape !== "object" || shape === null || typeof shape.evaluate !== "function")
+        throw new InvalidConfigurationError("A prepared illuminant spectrum is required.");
+    if (typeof illuminanceLux !== "number" || !Number.isFinite(illuminanceLux) || illuminanceLux <= 0 || illuminanceLux > 1e7)
+        throw new InvalidConfigurationError("Illuminance must be a positive number of lux up to 1e7.");
+    let sum = 0;
+    for (let nm = FACADE_SPECTRAL_RANGE_NANOMETERS.minimum; nm <= FACADE_SPECTRAL_RANGE_NANOMETERS.maximum; nm++) {
+        const w = nm === FACADE_SPECTRAL_RANGE_NANOMETERS.minimum || nm === FACADE_SPECTRAL_RANGE_NANOMETERS.maximum ? 0.5 : 1;
+        sum += w * shape.evaluate(nm) * estimateCie1931ColorMatchingFunctions(nm).y;
+    }
+    if (!(sum > 0))
+        throw new InvalidConfigurationError("The illuminant has no luminous power.");
+    return illuminanceLux / (PHOTOPIC_MAXIMUM_LUMINOUS_EFFICACY_LM_PER_W * sum);
+}
+const UNCERTAINTY = Object.freeze({ kind: "not-quantified", limitation: "Analytic planar Lambertian scene; no measured scene, BRDF or illumination." });
+/**
+ * Wraps a chart or caller scene as a provider for the native environment RAW task. `irradianceScale` is
+ * from {@link calculateIlluminantIrradianceScale}; caller radiance scenes ignore the illuminant.
+ */
+export function buildPlanarSceneRadianceProvider(input) {
+    const { scene, illuminant, irradianceScale, geometry } = input;
+    const scale = geometry.metresPerFrameUnit, distance = geometry.distanceM, sceneId = input.sceneId, providerProfileId = input.providerProfileId;
+    const evidence = input.evidence, limitations = input.limitations;
+    const caller = "kind" in scene ? scene : undefined, chart = caller ? undefined : scene;
+    function radianceAt(u, v, nm) {
+        if (chart)
+            return chart.reflectanceAt(u, v, nm) * irradianceScale * illuminant.shape.evaluate(nm) / Math.PI;
+        const point = Object.freeze({ xM: u * scale, yM: v * scale, u, v, wavelengthNanometers: nm });
+        const value = caller.evaluate(point);
+        if (caller.kind === "reflectance-function") {
+            if (typeof value !== "number" || !Number.isFinite(value) || value < 0 || value > 1)
+                throw new InvalidConfigurationError("Scene reflectance function must return a value in [0, 1].");
+            return value * irradianceScale * illuminant.shape.evaluate(nm) / Math.PI;
+        }
+        if (typeof value !== "number" || !Number.isFinite(value) || value < 0)
+            throw new InvalidConfigurationError("Scene radiance function must return a finite non-negative radiance.");
+        return value;
+    }
+    function result(request, radiance) {
+        return { schemaVersion: "0.1.0", sampleId: request.sampleId, sceneId, providerProfileId, wavelengthNanometers: request.wavelengthNanometers,
+            wavelengthBasis: request.wavelengthBasis, quantity: "outgoing-spectral-radiance", unit: "W/m^2/sr/nm",
+            spectralRadianceWattsPerSquareMeterSteradianNanometer: radiance, scientificStatus: "approximation", uncertainty: UNCERTAINTY, evidence, limitations };
+    }
+    return {
+        sceneId, providerProfileId, radianceAt,
+        evaluateRadiance(request) {
+            const target = request.target;
+            if (target.kind !== "environment-direction")
+                throw new InvalidConfigurationError("Planar scene provider needs environment-direction queries.");
+            const o = target.outgoingDirectionUnitVector, lz = -o.z;
+            if (!(lz > 0))
+                throw new InvalidConfigurationError("Planar scene query does not point toward the scene plane.");
+            const t = distance / lz;
+            return result(request, radianceAt(-o.x * t / scale, -o.y * t / scale, request.wavelengthNanometers));
+        },
+        evaluateApertureRadiance(request, ray) {
+            const d = ray.directionUnitVector, origin = ray.originM;
+            if (!(d.z > 0))
+                throw new InvalidConfigurationError("Planar scene pupil ray does not point toward the scene plane.");
+            const t = (distance - origin.z) / d.z;
+            return result(request, radianceAt((origin.x + d.x * t) / scale, (origin.y + d.y * t) / scale, request.wavelengthNanometers));
+        }
+    };
+}
+/**
+ * Public scene-preset provider. Places an engine chart (or a caller reflectance or radiance function) on
+ * a plane `distanceM` in front of the camera and `framedWidthM` wide (frame units u = ±1 at its edges),
+ * lit by `illuminant` at `illuminanceLux`. The returned `evaluateRadiance` and `evaluateApertureRadiance`
+ * follow the native environment RAW provider contract. They answer requests for scene `sceneId` and
+ * provider `providerProfileId`.
+ */
+export function createPlanarSceneRadianceProvider(input) {
+    requireInputObject(input, "createPlanarSceneRadianceProvider input");
+    const keys = ["scene", "illuminant", "illuminanceLux", "distanceM", "framedWidthM", "aspect", "sceneId", "providerProfileId"];
+    for (const key of Object.keys(input))
+        if (!keys.includes(key))
+            throw new InvalidConfigurationError("createPlanarSceneRadianceProvider input has unknown field \"" + key + "\".");
+    for (const key of ["illuminanceLux", "distanceM", "framedWidthM", "aspect"]) {
+        const value = input[key];
+        if (typeof value !== "number" || !Number.isFinite(value) || value <= 0)
+            throw new InvalidConfigurationError(key + " must be a positive finite number.");
+    }
+    for (const key of ["sceneId", "providerProfileId"])
+        if (typeof input[key] !== "string" || !/^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$/.test(input[key]))
+            throw new InvalidConfigurationError(key + " must be a public opaque ID.");
+    requireInputObject(input.scene, "scene");
+    const caller = "kind" in input.scene ? requireCallerScene(input.scene) : undefined;
+    const chart = caller ? null : resolveChartScene({ scene: input.scene, aspect: input.aspect });
+    const illuminant = resolveCaptureIlluminant(input.illuminant);
+    const provider = buildPlanarSceneRadianceProvider({ scene: chart ?? caller, sceneId: input.sceneId, providerProfileId: input.providerProfileId, illuminant,
+        irradianceScale: calculateIlluminantIrradianceScale(illuminant.shape, input.illuminanceLux),
+        geometry: { distanceM: input.distanceM, metresPerFrameUnit: input.framedWidthM / 2 },
+        evidence: [{ sourceOrigin: "photivra", sourceReference: "photivra:planar-scene-provider", reuseStatus: "photivra-owned" }],
+        limitations: ["Planar Lambertian scene under uniform illumination; no shadows, inter-reflection, gloss or fluorescence."] });
+    return { ...provider, chart };
+}
+/** Validates a caller scene function record. */
+export function requireCallerScene(value) {
+    requireInputObject(value, "scene");
+    const record = value;
+    for (const key of Object.keys(record))
+        if (key !== "kind" && key !== "sceneId" && key !== "evaluate")
+            throw new InvalidConfigurationError("Unknown scene field: " + key + ".");
+    if ((record.kind !== "reflectance-function" && record.kind !== "radiance-function") || typeof record.evaluate !== "function" ||
+        typeof record.sceneId !== "string" || !/^[A-Za-z0-9][A-Za-z0-9._:-]{0,63}$/.test(record.sceneId))
+        throw new InvalidConfigurationError("A caller scene needs kind, a public sceneId and an evaluate function.");
+    return record;
+}
+//# sourceMappingURL=scene-radiance.js.map

package/dist/facade/scene-radiance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scene-radiance.js","sourceRoot":"","sources":["../../src/facade/scene-radiance.ts"],"names":[],"mappings":"AAAA,sCAAsC;AAEtC;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAC3E,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,qCAAqC,EAAE,2BAA2B,EACtC,MAAM,sCAAsC,CAAC;AAClF,OAAO,EAAE,4BAA4B,EAAE,yBAAyB,EAAE,uBAAuB,EAAyB,MAAM,yBAAyB,CAAC;AAIlJ,OAAO,EAAE,iBAAiB,EAA4C,MAAM,mBAAmB,CAAC;AAEhG,+DAA+D;AAC/D,MAAM,CAAC,MAAM,2CAA2C,GAAG,GAAG,CAAC;AAC/D,yFAAyF;AACzF,MAAM,CAAC,MAAM,gCAAgC,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;AAuB9F,MAAM,UAAU,wBAAwB,CAAC,KAAwB;IAC/D,IAAI,KAAK,KAAK,OAAO;QAAE,OAAO,wBAAwB,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;IAC1E,kBAAkB,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;IACxC,MAAM,MAAM,GAAG,KAA2C,CAAC;IAC3D,MAAM,OAAO,GAAsC,EAAE,SAAS,EAAE,CAAC,MAAM,EAAE,mBAAmB,CAAC,EAAE,OAAO,EAAE,CAAC,MAAM,CAAC;QAC9G,QAAQ,EAAE,CAAC,MAAM,EAAE,kCAAkC,EAAE,OAAO,CAAC,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,CAAC;IAC7G,MAAM,IAAI,GAAG,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAChF,IAAI,CAAC,IAAI;QAAE,MAAM,IAAI,yBAAyB,CAAC,0BAA0B,CAAC,CAAC;IAC3E,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;QAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;YAAE,MAAM,IAAI,yBAAyB,CAAC,4BAA4B,GAAG,GAAG,GAAG,GAAG,CAAC,CAAC;IAC9I,IAAI,QAA8B,EAAE,EAAU,EAAE,WAAmB,CAAC;IACpE,IAAI,CAAC;QACH,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,WAAW,CAAC,CAAC,CAAC;gBACjB,MAAM,CAAC,GAAG,KAAK,CAAC,iBAAiB,CAAC;gBAClC,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,KAAK;oBAAE,MAAM,IAAI,yBAAyB,CAAC,6CAA6C,CAAC,CAAC;gBAC9J,QAAQ,GAAG,uBAAuB,CAAC,EAAE,iBAAiB,EAAE,CAAC,EAAE,yBAAyB,EAAE,EAAE,GAAG,gCAAgC,EAAE,EAAE,CAAC,CAAC;gBACjI,EAAE,GAAG,YAAY,GAAG,CAAC,GAAG,GAAG,CAAC;gBAAC,WAAW,GAAG,+BAA+B,GAAG,CAAC,GAAG,oBAAoB,CAAC;gBACtG,MAAM;YACR,CAAC;YACD,KAAK,OAAO;gBACV,QAAQ,GAAG,4BAA4B,EAAE,CAAC;gBAAC,EAAE,GAAG,OAAO,CAAC;gBAAC,WAAW,GAAG,yHAAyH,CAAC;gBACjM,MAAM;YACR,KAAK,UAAU;gBACb,QAAQ,GAAG,yBAAyB,CAAC,EAAE,gCAAgC,EAAE,KAAK,CAAC,gCAAgC,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;gBAClL,EAAE,GAAG,eAAe,GAAG,KAAK,CAAC,gCAAgC,GAAG,GAAG,CAAC;gBAAC,WAAW,GAAG,iDAAiD,GAAG,KAAK,CAAC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC;gBACpK,MAAM;YACR,KAAK,UAAU;gBACb,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;gBAAC,EAAE,GAAG,iBAAiB,CAAC;gBAClD,WAAW,GAAG,4BAA4B,GAAG,CAAC,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,GAAG,KAAK,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC;gBACrH,MAAM;QACV,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,yBAAyB;YAAE,MAAM,KAAK,CAAC;QAC5D,MAAM,IAAI,yBAAyB,CAAC,sBAAsB,GAAG,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IACrH,CAAC;IACD,IAAI,KAAmC,CAAC;IACxC,IAAI,CAAC;QAAC,KAAK,GAAG,2BAA2B,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAAC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QAClF,MAAM,IAAI,yBAAyB,CAAC,+BAA+B,GAAG,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IAC9H,CAAC;IACD,MAAM,KAAK,GAAG,KAAK,CAAC,yBAAyB,CAAC;IAC9C,IAAI,KAAK,CAAC,OAAO,GAAG,gCAAgC,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,GAAG,gCAAgC,CAAC,OAAO;QACtH,MAAM,IAAI,yBAAyB,CAAC,gDAAgD,CAAC,CAAC;IACxF,KAAK,IAAI,EAAE,GAAG,gCAAgC,CAAC,OAAO,EAAE,EAAE,IAAI,gCAAgC,CAAC,OAAO,EAAE,EAAE,IAAI,CAAC,EAAE,CAAC;QAChH,MAAM,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAC7B,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YAAE,MAAM,IAAI,yBAAyB,CAAC,+DAA+D,CAAC,CAAC;IACtH,CAAC;IACD,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;AAC7D,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,kCAAkC,CAAC,KAAmC,EAAE,cAAsB;IAC5G,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,CAAC,QAAQ,KAAK,UAAU;QAAE,MAAM,IAAI,yBAAyB,CAAC,6CAA6C,CAAC,CAAC;IAC5K,IAAI,OAAO,cAAc,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAC,IAAI,cAAc,IAAI,CAAC,IAAI,cAAc,GAAG,GAAG;QACvH,MAAM,IAAI,yBAAyB,CAAC,yDAAyD,CAAC,CAAC;IACjG,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,KAAK,IAAI,EAAE,GAAG,gCAAgC,CAAC,OAAO,EAAE,EAAE,IAAI,gCAAgC,CAAC,OAAO,EAAE,EAAE,EAAE,EAAE,CAAC;QAC7G,MAAM,CAAC,GAAG,EAAE,KAAK,gCAAgC,CAAC,OAAO,IAAI,EAAE,KAAK,gCAAgC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACvH,GAAG,IAAI,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,qCAAqC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC9E,CAAC;IACD,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;QAAE,MAAM,IAAI,yBAAyB,CAAC,uCAAuC,CAAC,CAAC;IAC7F,OAAO,cAAc,GAAG,CAAC,2CAA2C,GAAG,GAAG,CAAC,CAAC;AAC9E,CAAC;AAgCD,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,gBAAyB,EAAE,UAAU,EAAE,4EAA4E,EAAE,CAAC,CAAC;AAEjK;;;GAGG;AACH,MAAM,UAAU,gCAAgC,CAAC,KAShD;IACC,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAC;IAC/D,MAAM,KAAK,GAAG,QAAQ,CAAC,kBAAkB,EAAE,QAAQ,GAAG,QAAQ,CAAC,SAAS,EAAE,OAAO,GAAG,KAAK,CAAC,OAAO,EAAE,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,CAAC;IAC/I,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,EAAE,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;IACjE,MAAM,MAAM,GAAG,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,EAAE,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAA2B,CAAC;IAC7G,SAAS,UAAU,CAAC,CAAS,EAAE,CAAS,EAAE,EAAU;QAClD,IAAI,KAAK;YAAE,OAAO,KAAK,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,eAAe,GAAG,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC;QAC5G,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,KAAK,EAAE,EAAE,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,oBAAoB,EAAE,EAAE,EAAE,CAAC,CAAC;QAC9F,MAAM,KAAK,GAAG,MAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACtC,IAAI,MAAO,CAAC,IAAI,KAAK,sBAAsB,EAAE,CAAC;YAC5C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,CAAC;gBAAE,MAAM,IAAI,yBAAyB,CAAC,2DAA2D,CAAC,CAAC;YACrL,OAAO,KAAK,GAAG,eAAe,GAAG,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC;QAC3E,CAAC;QACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC;YAAE,MAAM,IAAI,yBAAyB,CAAC,qEAAqE,CAAC,CAAC;QAClL,OAAO,KAAK,CAAC;IACf,CAAC;IACD,SAAS,MAAM,CAAC,OAAiD,EAAE,QAAgB;QACjF,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,OAAO,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,OAAO,CAAC,oBAAoB;YACzI,eAAe,EAAE,OAAO,CAAC,eAAmE,EAAE,QAAQ,EAAE,4BAA4B,EAAE,IAAI,EAAE,aAAa;YACzJ,qDAAqD,EAAE,QAAQ,EAAE,gBAAgB,EAAE,eAAe,EAAE,WAAW,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;IAC1J,CAAC;IACD,OAAO;QACL,OAAO,EAAE,iBAAiB,EAAE,UAAU;QACtC,gBAAgB,CAAC,OAAO;YACtB,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;YAC9B,IAAI,MAAM,CAAC,IAAI,KAAK,uBAAuB;gBAAE,MAAM,IAAI,yBAAyB,CAAC,4DAA4D,CAAC,CAAC;YAC/I,MAAM,CAAC,GAAG,MAAM,CAAC,2BAA2B,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YACxD,IAAI,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;gBAAE,MAAM,IAAI,yBAAyB,CAAC,2DAA2D,CAAC,CAAC;YAChH,MAAM,CAAC,GAAG,QAAQ,GAAG,EAAE,CAAC;YACxB,OAAO,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAC;QACvG,CAAC;QACD,wBAAwB,CAAC,OAAO,EAAE,GAAG;YACnC,MAAM,CAAC,GAAG,GAAG,CAAC,mBAAmB,EAAE,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC;YACxD,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;gBAAE,MAAM,IAAI,yBAAyB,CAAC,+DAA+D,CAAC,CAAC;YACrH,MAAM,CAAC,GAAG,CAAC,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YACtC,OAAO,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,EAAE,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAC;QAC/H,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,iCAAiC,CAAC,KAUjD;IACC,kBAAkB,CAAC,KAAK,EAAE,yCAAyC,CAAC,CAAC;IACrE,MAAM,IAAI,GAAG,CAAC,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,WAAW,EAAE,cAAc,EAAE,QAAQ,EAAE,SAAS,EAAE,mBAAmB,CAAC,CAAC;IAC9H,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;QAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;YAAE,MAAM,IAAI,yBAAyB,CAAC,8DAA8D,GAAG,GAAG,GAAG,KAAK,CAAC,CAAC;IACjL,KAAK,MAAM,GAAG,IAAI,CAAC,gBAAgB,EAAE,WAAW,EAAE,cAAc,EAAE,QAAQ,CAAU,EAAE,CAAC;QACrF,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;QACzB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC;YAAE,MAAM,IAAI,yBAAyB,CAAC,GAAG,GAAG,oCAAoC,CAAC,CAAC;IAC1J,CAAC;IACD,KAAK,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAU;QAAE,IAAI,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,QAAQ,IAAI,CAAC,qCAAqC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAAE,MAAM,IAAI,yBAAyB,CAAC,GAAG,GAAG,8BAA8B,CAAC,CAAC;IACtO,kBAAkB,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACzC,MAAM,MAAM,GAAG,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACnF,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,iBAAiB,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAmB,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;IAC5G,MAAM,UAAU,GAAG,wBAAwB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAC9D,MAAM,QAAQ,GAAG,gCAAgC,CAAC,EAAE,KAAK,EAAE,KAAK,IAAI,MAAO,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,iBAAiB,EAAE,KAAK,CAAC,iBAAiB,EAAE,UAAU;QACzJ,eAAe,EAAE,kCAAkC,CAAC,UAAU,CAAC,KAAK,EAAE,KAAK,CAAC,cAAc,CAAC;QAC3F,QAAQ,EAAE,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,kBAAkB,EAAE,KAAK,CAAC,YAAY,GAAG,CAAC,EAAE;QACpF,QAAQ,EAAE,CAAC,EAAE,YAAY,EAAE,UAAU,EAAE,eAAe,EAAE,gCAAgC,EAAE,WAAW,EAAE,gBAAgB,EAAE,CAAC;QAC1H,WAAW,EAAE,CAAC,0GAA0G,CAAC,EAAE,CAAC,CAAC;IAC/H,OAAO,EAAE,GAAG,QAAQ,EAAE,KAAK,EAAE,CAAC;AAChC,CAAC;AAED,gDAAgD;AAChD,MAAM,UAAU,kBAAkB,CAAC,KAAc;IAC/C,kBAAkB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACnC,MAAM,MAAM,GAAG,KAAgC,CAAC;IAChD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;QAAE,IAAI,GAAG,KAAK,MAAM,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,UAAU;YAAE,MAAM,IAAI,yBAAyB,CAAC,uBAAuB,GAAG,GAAG,GAAG,GAAG,CAAC,CAAC;IAC/K,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,sBAAsB,IAAI,MAAM,CAAC,IAAI,KAAK,mBAAmB,CAAC,IAAI,OAAO,MAAM,CAAC,QAAQ,KAAK,UAAU;QAC1H,OAAO,MAAM,CAAC,OAAO,KAAK,QAAQ,IAAI,CAAC,oCAAoC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;QAAE,MAAM,IAAI,yBAAyB,CAAC,uEAAuE,CAAC,CAAC;IACjN,OAAO,MAAiE,CAAC;AAC3E,CAAC","sourcesContent":["// SPDX-License-Identifier: Apache-2.0\n\n/**\n * Turns a facade scene and an illuminant into a scene radiance provider for the existing native\n * environment RAW contract (`NativeEnvironmentRawProvider.evaluateRadiance` and, for pupil sampling,\n * `evaluateApertureRadiance`). The scene is an engine chart, a caller reflectance function or a caller\n * radiance function.\n *\n * Geometry: one plane perpendicular to the optical axis at `distanceM` in front of the camera. A query's\n * outgoing direction o (scene toward camera, see docs/SENSOR_ENVIRONMENT_QUERY.md) gives the look\n * direction l = -o; the plane point is l·distanceM/l.z. With a pupil ray, the plane point is the ray from\n * its lens origin to z = distanceM.\n *\n * Radiometry: a Lambertian reflector of reflectance ρ(λ) under irradiance E(λ) has radiance\n * L(λ) = ρ(λ)·E(λ)/π (W·m⁻²·sr⁻¹·nm⁻¹). The illuminant spectral shape S(λ) is scaled so that the\n * plane illuminance is E_v = K_m ∫ E(λ) V(λ) dλ with K_m = 683 lm/W (CIE photometric definition) and\n * V(λ) = ȳ(λ) from the engine's analytic CIE 1931 fit. The light is uniform\n * over the plane, with no shadows. Inter-reflection, gloss and fluorescence are not modelled.\n * @see docs/QUICK_START.md\n */\n\nimport { InvalidConfigurationError } from \"../core/configuration-error.js\";\nimport { requireInputObject } from \"../core/record-validation.js\";\nimport { estimateCie1931ColorMatchingFunctions, prepareColorimetricSpectrum, type ColorimetricSpectrum,\n  type PreparedColorimetricSpectrum } from \"../color/color-matching-functions.js\";\nimport { createCieIlluminantASpectrum, createCieDaylightSpectrum, createPlanckianSpectrum, type CieDaylightBasis } from \"../color/illuminants.js\";\nimport type { SceneRadianceEvaluationRequest, SceneRadianceEvaluationResult } from \"../schema/scene-radiance.js\";\nimport type { EvidenceProvenance } from \"../core/evidence-provenance.js\";\nimport type { SensorApertureRay } from \"../optics/sensor-aperture-rays.js\";\nimport { resolveChartScene, type ChartScene, type ResolvedChartScene } from \"./chart-scenes.js\";\n\n/** CIE maximum luminous efficacy for photopic vision, lm/W. */\nexport const PHOTOPIC_MAXIMUM_LUMINOUS_EFFICACY_LM_PER_W = 683;\n/** Wavelength range of every facade spectrum and of the facade sensor quadrature, nm. */\nexport const FACADE_SPECTRAL_RANGE_NANOMETERS = Object.freeze({ minimum: 380, maximum: 780 });\n\n/**\n * Illuminant choices. CIE D65 is not bundled: its S0/S1/S2 basis tables must come from the caller\n * (`daylight`). `planckian` is Planck's law; `cie-a` is CIE illuminant A from its defining formula.\n */\nexport type CaptureIlluminant =\n  | \"cie-a\"\n  | { kind: \"planckian\"; temperatureKelvin: number }\n  | { kind: \"cie-a\" }\n  | { kind: \"daylight\"; correlatedColorTemperatureKelvin: number; basis: CieDaylightBasis }\n  | { kind: \"spectrum\"; spectrum: ColorimetricSpectrum; label?: string };\n\nexport interface ResolvedCaptureIlluminant {\n  /** Short public description, for example \"planckian-6500K\". */\n  id: string;\n  description: string;\n  /** Relative spectral shape (arbitrary scale) over at least 380-780 nm. */\n  shape: PreparedColorimetricSpectrum;\n  /** Original spectrum, for colorimetric white-balance calculations. */\n  spectrum: ColorimetricSpectrum;\n}\n\nexport function resolveCaptureIlluminant(value: CaptureIlluminant): ResolvedCaptureIlluminant {\n  if (value === \"cie-a\") return resolveCaptureIlluminant({ kind: \"cie-a\" });\n  requireInputObject(value, \"illuminant\");\n  const record = value as unknown as Record<string, unknown>;\n  const allowed: Record<string, readonly string[]> = { planckian: [\"kind\", \"temperatureKelvin\"], \"cie-a\": [\"kind\"],\n    daylight: [\"kind\", \"correlatedColorTemperatureKelvin\", \"basis\"], spectrum: [\"kind\", \"spectrum\", \"label\"] };\n  const keys = typeof record.kind === \"string\" ? allowed[record.kind] : undefined;\n  if (!keys) throw new InvalidConfigurationError(\"Unknown illuminant kind.\");\n  for (const key of Object.keys(record)) if (!keys.includes(key)) throw new InvalidConfigurationError(\"Unknown illuminant field: \" + key + \".\");\n  let spectrum: ColorimetricSpectrum, id: string, description: string;\n  try {\n    switch (value.kind) {\n      case \"planckian\": {\n        const t = value.temperatureKelvin;\n        if (typeof t !== \"number\" || !Number.isFinite(t) || t < 1000 || t > 25000) throw new InvalidConfigurationError(\"Planckian temperature must be 1000-25000 K.\");\n        spectrum = createPlanckianSpectrum({ temperatureKelvin: t, wavelengthRangeNanometers: { ...FACADE_SPECTRAL_RANGE_NANOMETERS } });\n        id = \"planckian-\" + t + \"K\"; description = \"Planck blackbody spectrum at \" + t + \" K (Planck's law).\";\n        break;\n      }\n      case \"cie-a\":\n        spectrum = createCieIlluminantASpectrum(); id = \"cie-a\"; description = \"CIE standard illuminant A from its defining formula: Planck's law with c2 = 1.435e-2 m·K and T = 2848 K, 100 at 560 nm.\";\n        break;\n      case \"daylight\":\n        spectrum = createCieDaylightSpectrum({ correlatedColorTemperatureKelvin: value.correlatedColorTemperatureKelvin, coefficientRounding: \"cie-three-decimals\", basis: value.basis });\n        id = \"cie-daylight-\" + value.correlatedColorTemperatureKelvin + \"K\"; description = \"CIE daylight from the caller's S0/S1/S2 basis (\" + value.basis.datasetId + \").\";\n        break;\n      case \"spectrum\":\n        spectrum = value.spectrum; id = \"caller-spectrum\";\n        description = \"Caller illuminant spectrum\" + (typeof value.label === \"string\" ? \" (\" + value.label + \")\" : \"\") + \".\";\n        break;\n    }\n  } catch (error) {\n    if (error instanceof InvalidConfigurationError) throw error;\n    throw new InvalidConfigurationError(\"Invalid illuminant: \" + (error instanceof Error ? error.message : \"invalid\"));\n  }\n  let shape: PreparedColorimetricSpectrum;\n  try { shape = prepareColorimetricSpectrum(spectrum, \"illuminant\"); } catch (error) {\n    throw new InvalidConfigurationError(\"Invalid illuminant spectrum: \" + (error instanceof Error ? error.message : \"invalid\"));\n  }\n  const range = shape.wavelengthRangeNanometers;\n  if (range.minimum > FACADE_SPECTRAL_RANGE_NANOMETERS.minimum || range.maximum < FACADE_SPECTRAL_RANGE_NANOMETERS.maximum)\n    throw new InvalidConfigurationError(\"The illuminant spectrum must cover 380-780 nm.\");\n  for (let nm = FACADE_SPECTRAL_RANGE_NANOMETERS.minimum; nm <= FACADE_SPECTRAL_RANGE_NANOMETERS.maximum; nm += 1) {\n    const s = shape.evaluate(nm);\n    if (!(s >= 0)) throw new InvalidConfigurationError(\"The illuminant spectrum must be non-negative over 380-780 nm.\");\n  }\n  return Object.freeze({ id, description, shape, spectrum });\n}\n\n/**\n * Factor k such that k·S(λ) (W·m⁻²·nm⁻¹) gives `illuminanceLux` on the plane: E_v = 683 ∫ k S ȳ dλ,\n * integrated with the 1 nm trapezoid rule over 380-780 nm (ȳ outside this range is below 4e-5 of its peak).\n */\nexport function calculateIlluminantIrradianceScale(shape: PreparedColorimetricSpectrum, illuminanceLux: number): number {\n  if (typeof shape !== \"object\" || shape === null || typeof shape.evaluate !== \"function\") throw new InvalidConfigurationError(\"A prepared illuminant spectrum is required.\");\n  if (typeof illuminanceLux !== \"number\" || !Number.isFinite(illuminanceLux) || illuminanceLux <= 0 || illuminanceLux > 1e7)\n    throw new InvalidConfigurationError(\"Illuminance must be a positive number of lux up to 1e7.\");\n  let sum = 0;\n  for (let nm = FACADE_SPECTRAL_RANGE_NANOMETERS.minimum; nm <= FACADE_SPECTRAL_RANGE_NANOMETERS.maximum; nm++) {\n    const w = nm === FACADE_SPECTRAL_RANGE_NANOMETERS.minimum || nm === FACADE_SPECTRAL_RANGE_NANOMETERS.maximum ? 0.5 : 1;\n    sum += w * shape.evaluate(nm) * estimateCie1931ColorMatchingFunctions(nm).y;\n  }\n  if (!(sum > 0)) throw new InvalidConfigurationError(\"The illuminant has no luminous power.\");\n  return illuminanceLux / (PHOTOPIC_MAXIMUM_LUMINOUS_EFFICACY_LM_PER_W * sum);\n}\n\n/** A point of the scene plane passed to caller scene functions. */\nexport interface ScenePlanePoint {\n  /** Metres on the plane, from the optical axis: +x right, +y up (as seen from the camera). */\n  xM: number;\n  yM: number;\n  /** The same point in frame units (u = ±1 at the left/right frame edges, v up on the same scale). */\n  u: number;\n  v: number;\n  wavelengthNanometers: number;\n}\n/** Caller Lambertian reflectance (in [0, 1]) lit by the facade illuminant. */\nexport interface CallerReflectanceScene { kind: \"reflectance-function\"; sceneId: string; evaluate(point: Readonly<ScenePlanePoint>): number }\n/** Caller absolute spectral radiance in W·m⁻²·sr⁻¹·nm⁻¹; the facade illuminant is not used. */\nexport interface CallerRadianceScene { kind: \"radiance-function\"; sceneId: string; evaluate(point: Readonly<ScenePlanePoint>): number }\n\nexport interface PlanarSceneGeometry {\n  distanceM: number;\n  /** Metres per frame unit on the plane (half the framed width). */\n  metresPerFrameUnit: number;\n}\n\nexport interface PlanarSceneRadianceProvider {\n  sceneId: string;\n  providerProfileId: string;\n  evaluateRadiance(request: Readonly<SceneRadianceEvaluationRequest>): SceneRadianceEvaluationResult;\n  evaluateApertureRadiance(request: Readonly<SceneRadianceEvaluationRequest>, ray: Readonly<SensorApertureRay>): SceneRadianceEvaluationResult;\n  /** Spectral radiance at a plane point (frame units), the same value the callbacks return. */\n  radianceAt(u: number, v: number, wavelengthNanometers: number): number;\n}\n\nconst UNCERTAINTY = Object.freeze({ kind: \"not-quantified\" as const, limitation: \"Analytic planar Lambertian scene; no measured scene, BRDF or illumination.\" });\n\n/**\n * Wraps a chart or caller scene as a provider for the native environment RAW task. `irradianceScale` is\n * from {@link calculateIlluminantIrradianceScale}; caller radiance scenes ignore the illuminant.\n */\nexport function buildPlanarSceneRadianceProvider(input: {\n  scene: ResolvedChartScene | CallerReflectanceScene | CallerRadianceScene;\n  sceneId: string;\n  providerProfileId: string;\n  illuminant: ResolvedCaptureIlluminant;\n  irradianceScale: number;\n  geometry: PlanarSceneGeometry;\n  evidence: readonly EvidenceProvenance[];\n  limitations: readonly string[];\n}): PlanarSceneRadianceProvider {\n  const { scene, illuminant, irradianceScale, geometry } = input;\n  const scale = geometry.metresPerFrameUnit, distance = geometry.distanceM, sceneId = input.sceneId, providerProfileId = input.providerProfileId;\n  const evidence = input.evidence, limitations = input.limitations;\n  const caller = \"kind\" in scene ? scene : undefined, chart = caller ? undefined : scene as ResolvedChartScene;\n  function radianceAt(u: number, v: number, nm: number): number {\n    if (chart) return chart.reflectanceAt(u, v, nm) * irradianceScale * illuminant.shape.evaluate(nm) / Math.PI;\n    const point = Object.freeze({ xM: u * scale, yM: v * scale, u, v, wavelengthNanometers: nm });\n    const value = caller!.evaluate(point);\n    if (caller!.kind === \"reflectance-function\") {\n      if (typeof value !== \"number\" || !Number.isFinite(value) || value < 0 || value > 1) throw new InvalidConfigurationError(\"Scene reflectance function must return a value in [0, 1].\");\n      return value * irradianceScale * illuminant.shape.evaluate(nm) / Math.PI;\n    }\n    if (typeof value !== \"number\" || !Number.isFinite(value) || value < 0) throw new InvalidConfigurationError(\"Scene radiance function must return a finite non-negative radiance.\");\n    return value;\n  }\n  function result(request: Readonly<SceneRadianceEvaluationRequest>, radiance: number): SceneRadianceEvaluationResult {\n    return { schemaVersion: \"0.1.0\", sampleId: request.sampleId, sceneId, providerProfileId, wavelengthNanometers: request.wavelengthNanometers,\n      wavelengthBasis: request.wavelengthBasis as SceneRadianceEvaluationResult[\"wavelengthBasis\"], quantity: \"outgoing-spectral-radiance\", unit: \"W/m^2/sr/nm\",\n      spectralRadianceWattsPerSquareMeterSteradianNanometer: radiance, scientificStatus: \"approximation\", uncertainty: UNCERTAINTY, evidence, limitations };\n  }\n  return {\n    sceneId, providerProfileId, radianceAt,\n    evaluateRadiance(request): SceneRadianceEvaluationResult {\n      const target = request.target;\n      if (target.kind !== \"environment-direction\") throw new InvalidConfigurationError(\"Planar scene provider needs environment-direction queries.\");\n      const o = target.outgoingDirectionUnitVector, lz = -o.z;\n      if (!(lz > 0)) throw new InvalidConfigurationError(\"Planar scene query does not point toward the scene plane.\");\n      const t = distance / lz;\n      return result(request, radianceAt(-o.x * t / scale, -o.y * t / scale, request.wavelengthNanometers));\n    },\n    evaluateApertureRadiance(request, ray): SceneRadianceEvaluationResult {\n      const d = ray.directionUnitVector, origin = ray.originM;\n      if (!(d.z > 0)) throw new InvalidConfigurationError(\"Planar scene pupil ray does not point toward the scene plane.\");\n      const t = (distance - origin.z) / d.z;\n      return result(request, radianceAt((origin.x + d.x * t) / scale, (origin.y + d.y * t) / scale, request.wavelengthNanometers));\n    }\n  };\n}\n\n/**\n * Public scene-preset provider. Places an engine chart (or a caller reflectance or radiance function) on\n * a plane `distanceM` in front of the camera and `framedWidthM` wide (frame units u = ±1 at its edges),\n * lit by `illuminant` at `illuminanceLux`. The returned `evaluateRadiance` and `evaluateApertureRadiance`\n * follow the native environment RAW provider contract. They answer requests for scene `sceneId` and\n * provider `providerProfileId`.\n */\nexport function createPlanarSceneRadianceProvider(input: {\n  scene: ChartScene | CallerReflectanceScene | CallerRadianceScene;\n  illuminant: CaptureIlluminant;\n  illuminanceLux: number;\n  distanceM: number;\n  framedWidthM: number;\n  /** Frame height / width. */\n  aspect: number;\n  sceneId: string;\n  providerProfileId: string;\n}): PlanarSceneRadianceProvider & { chart: ResolvedChartScene | null } {\n  requireInputObject(input, \"createPlanarSceneRadianceProvider input\");\n  const keys = [\"scene\", \"illuminant\", \"illuminanceLux\", \"distanceM\", \"framedWidthM\", \"aspect\", \"sceneId\", \"providerProfileId\"];\n  for (const key of Object.keys(input)) if (!keys.includes(key)) throw new InvalidConfigurationError(\"createPlanarSceneRadianceProvider input has unknown field \\\"\" + key + \"\\\".\");\n  for (const key of [\"illuminanceLux\", \"distanceM\", \"framedWidthM\", \"aspect\"] as const) {\n    const value = input[key];\n    if (typeof value !== \"number\" || !Number.isFinite(value) || value <= 0) throw new InvalidConfigurationError(key + \" must be a positive finite number.\");\n  }\n  for (const key of [\"sceneId\", \"providerProfileId\"] as const) if (typeof input[key] !== \"string\" || !/^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$/.test(input[key])) throw new InvalidConfigurationError(key + \" must be a public opaque ID.\");\n  requireInputObject(input.scene, \"scene\");\n  const caller = \"kind\" in input.scene ? requireCallerScene(input.scene) : undefined;\n  const chart = caller ? null : resolveChartScene({ scene: input.scene as ChartScene, aspect: input.aspect });\n  const illuminant = resolveCaptureIlluminant(input.illuminant);\n  const provider = buildPlanarSceneRadianceProvider({ scene: chart ?? caller!, sceneId: input.sceneId, providerProfileId: input.providerProfileId, illuminant,\n    irradianceScale: calculateIlluminantIrradianceScale(illuminant.shape, input.illuminanceLux),\n    geometry: { distanceM: input.distanceM, metresPerFrameUnit: input.framedWidthM / 2 },\n    evidence: [{ sourceOrigin: \"photivra\", sourceReference: \"photivra:planar-scene-provider\", reuseStatus: \"photivra-owned\" }],\n    limitations: [\"Planar Lambertian scene under uniform illumination; no shadows, inter-reflection, gloss or fluorescence.\"] });\n  return { ...provider, chart };\n}\n\n/** Validates a caller scene function record. */\nexport function requireCallerScene(value: unknown): CallerReflectanceScene | CallerRadianceScene {\n  requireInputObject(value, \"scene\");\n  const record = value as Record<string, unknown>;\n  for (const key of Object.keys(record)) if (key !== \"kind\" && key !== \"sceneId\" && key !== \"evaluate\") throw new InvalidConfigurationError(\"Unknown scene field: \" + key + \".\");\n  if ((record.kind !== \"reflectance-function\" && record.kind !== \"radiance-function\") || typeof record.evaluate !== \"function\" ||\n    typeof record.sceneId !== \"string\" || !/^[A-Za-z0-9][A-Za-z0-9._:-]{0,63}$/.test(record.sceneId)) throw new InvalidConfigurationError(\"A caller scene needs kind, a public sceneId and an evaluate function.\");\n  return record as unknown as CallerReflectanceScene | CallerRadianceScene;\n}\n"]}

package/dist/facade/simulate-capture.d.ts

@@ -0,0 +1,284 @@
+import type { EvidenceProvenance } from "../core/evidence-provenance.js";
+import { type GenericEquipmentTier, type GenericEquipmentTierPreset } from "../equipment/generic-tier-assets.js";
+import { type ResolvedWhiteBalanceState } from "../color/white-balance.js";
+import { type NativeRawOutput, type NativeRawPlan } from "../capture/native-raw.js";
+import { type NativeEnvironmentRawInput } from "../capture/native-environment-raw.js";
+import { type NativeRawDevelopmentInput, type RawHighlightDiagnostics } from "../capture/native-raw-development.js";
+import { type SdrToneCurve, type SdrToneCurveParameters, type SdrRenderingResult } from "../output/sdr-rendering.js";
+import type { RawHighlightMode } from "../color/sensor-color-development.js";
+import type { SimulateEnvironmentSensorRawFrameInput } from "../capture/environment-raw-producer.js";
+import { type LensProjectionModel } from "../camera/lens-projection.js";
+import type { RadialDistortionProfile } from "../optics/radial-distortion.js";
+import type { BrownConradyDistortionProfile } from "../optics/brown-conrady-distortion.js";
+import type { IlluminationVignettingProfile } from "../optics/illumination-vignetting.js";
+import type { CalculateEnvironmentSensorPhotoSignalInput } from "../sensor/environment-photo-signal.js";
+import { type ChartScene } from "./chart-scenes.js";
+import { type CaptureIlluminant, type CallerRadianceScene, type CallerReflectanceScene } from "./scene-radiance.js";
+/** Version of how the facade builds requests. It changes whenever the same input would build a different request. */
+export declare const SIMULATE_CAPTURE_FACADE_VERSION: "1.0.0";
+export type SimulateCaptureExposureMode = "manual" | "aperture-priority" | "shutter-priority" | "program";
+export type SimulateCaptureOutputFormat = "srgb-8" | "srgb-16" | "jpeg" | "png" | "dng";
+export type SimulateCaptureWhiteBalance = "scene-illuminant" | "auto" | "none" | {
+    kelvin: number;
+    tint?: number;
+} | {
+    channelGains: {
+        red: number;
+        green: number;
+        blue: number;
+    };
+};
+/**
+ * PNG colour encoding. `srgb` is the developed sRGB output. The others take the developed linear
+ * colour (camera → XYZ → linear sRGB/D65, unclipped) and convert it through CIE XYZ into the target
+ * primaries:
+ * - `display-p3`: Display P3 primaries (W3C CSS Color 4 `display-p3`; also SMPTE EG 432-1) with the
+ *   sRGB transfer function;
+ * - `rec2020`: ITU-R BT.2020 primaries and OETF.
+ * PQ and HLG (BT.2100) are not part of 2.0; see THIRD_PARTY.md.
+ */
+export type SimulateCaptureColorEncoding = "srgb" | "display-p3" | "rec2020";
+/** Built-in Bayer demosaic kernels (`createBuiltInBayerDemosaicProfiles`). */
+export type SimulateCaptureDemosaic = "bilinear";
+/**
+ * `margin` renders extra native sites around the output, as far as the kernel reaches. `mirror` renders
+ * exactly the output and reads mirrored (reflect-101) copies of the missing border sites. Mirroring is
+ * checked to keep the CFA (colour filter array) pattern consistent.
+ */
+export type SimulateCaptureBorderHandling = "margin" | "mirror";
+export type SimulateCaptureLensDistortion = {
+    kind: "radial";
+    profile: RadialDistortionProfile;
+} | {
+    kind: "brown-conrady";
+    profile: BrownConradyDistortionProfile;
+};
+export interface SimulateCaptureMotion {
+    /** Constant camera angular velocity, rad/s, in the engine's pitch/yaw/roll convention. Missing axes are 0. */
+    angularVelocityRadPerSec?: {
+        pitch?: number;
+        yaw?: number;
+        roll?: number;
+    };
+    /** Default "global". `rolling` derives the exposure schedule from the body's rolling readout declaration. */
+    shutter?: "global" | "rolling";
+    /** Rolling shutter only: time from the first to the last line over the simulated frame, in s. Default: the body's declared readout skew. */
+    rollingShutterSkewSeconds?: number;
+}
+export interface SimulateCaptureOptions {
+    /** Generic tier preset id or a full preset record (for example a modified copy of a catalog entry). Default "professional". */
+    camera?: GenericEquipmentTier | GenericEquipmentTierPreset;
+    lens?: {
+        /** Must lie in the lens capability (the generic primes are 50 mm). Default: the lens's shortest focal length. */
+        focalLengthMm?: number;
+        /** Aperture for manual and aperture-priority modes. Default 8. */
+        fNumber?: number;
+        /** Focus distance in metres. Default: the subject distance. */
+        focusDistanceM?: number;
+        /** Opt-in ideal circular-pupil ray sampling (defocus/depth of field). Default off (central ray only). */
+        pupilSampling?: {
+            radialSamples: number;
+            angularSamples: number;
+        };
+        /** Ideal lens projection (`LENS_PROJECTION_MODELS`). Default "rectilinear". Not combinable with pupilSampling. */
+        projection?: LensProjectionModel;
+        /** Caller-declared radial or Brown–Conrady distortion profile. Default none. Not combinable with pupilSampling. */
+        distortion?: SimulateCaptureLensDistortion;
+        /** Caller-declared radial relative-illumination (vignetting) profile, applied as environment field throughput. */
+        vignetting?: IlluminationVignettingProfile;
+        /**
+         * Caller sampled lens PSF, passed unchanged to the environment contract. Its focal length, f-number and
+         * focus must equal the resolved capture settings exactly. Not combinable with pupilSampling.
+         */
+        psf?: Extract<CalculateEnvironmentSensorPhotoSignalInput["psf"], {
+            kind: "sampled-local";
+        }>;
+    };
+    exposure?: {
+        /** Default "manual". */
+        mode?: SimulateCaptureExposureMode;
+        /** Default 100. */
+        iso?: number;
+        /** Shutter for manual and shutter-priority modes. Default 1/125 s. */
+        shutterSeconds?: number;
+        /** Exposure compensation applied to the meter target, in stops. Default 0. */
+        compensationStops?: number;
+    };
+    /** Required: an engine chart (for example `{ preset: "uniform" }`, an 18 % grey card) or a caller reflectance/radiance function. */
+    scene: ChartScene | CallerReflectanceScene | CallerRadianceScene;
+    /** Distance from the camera to the scene plane in metres. Default 5. */
+    subjectDistanceM?: number;
+    /** Default: Planckian 6500 K (a blackbody stand-in for daylight; CIE D65 is not bundled). */
+    illuminant?: CaptureIlluminant;
+    /** Illuminance on the scene plane, lux. Default about 21 481 lux (see `SIMULATE_CAPTURE_DEFAULT_ILLUMINANCE_LUX` and the assumptions). */
+    illuminanceLux?: number;
+    output?: {
+        /** Output pixels; the native sensor raster adds a one-site demosaic border on each side. Defaults 64 × 64. */
+        width?: number;
+        height?: number;
+        /** Default "srgb-8". */
+        format?: SimulateCaptureOutputFormat;
+        /** Default "identity". */
+        toneCurve?: SdrToneCurve;
+        /** Required by the luminance tone curves (see `SdrToneCurveParameters`). The facade does not make one up. */
+        toneCurveParameters?: SdrToneCurveParameters;
+        /** Default "clip". */
+        highlightMode?: RawHighlightMode;
+        /** Default "scene-illuminant". */
+        whiteBalance?: SimulateCaptureWhiteBalance;
+        /** JPEG constant quantization step 1-255 (not a manufacturer 'quality'). Default 2. */
+        jpegQuantizationStep?: number;
+        /** PNG only. Default "srgb". */
+        colorEncoding?: SimulateCaptureColorEncoding;
+        /** PNG only: 8 or 16 bits per sample. Default 8. */
+        bitDepth?: 8 | 16;
+        /**
+         * PNG SDR encodings only. Default "clip" (per-component clip to the target gamut). "perceptual" maps
+         * through `prepareRgbGamutMapping`: constant CIELAB L* and hue, chroma above 90 % of the boundary compressed.
+         */
+        gamutMapping?: "clip" | "perceptual";
+        /** Default: the 1.0 facade's bilinear RGGB kernels. */
+        demosaic?: SimulateCaptureDemosaic;
+        /** Default "margin". */
+        borderHandling?: SimulateCaptureBorderHandling;
+        /** DNG only: optional capture-event time (YYYY-MM-DDTHH:mm:ss.sssZ); without it no date tags are written. */
+        dng?: {
+            capturedAtUtc?: string;
+        };
+    };
+    /** Camera motion and shutter type. Default: still camera, global electronic shutter. */
+    motion?: SimulateCaptureMotion;
+    sensor?: {
+        /** Pixel pitch in micrometres. Default 6. */
+        pixelPitchMicrometers?: number;
+        /** Maximum spectral quadrature subinterval in nm. Default 20. */
+        spectralStepNanometers?: number;
+        /** Temporal midpoint samples across the exposure. Default 1. */
+        temporalSampleCount?: number;
+        /** Noise seed (uint32). Default 1. */
+        noiseSeed?: number;
+    };
+    /** Aborting cancels the running task; the promise rejects with a domain error and returns no partial image. */
+    signal?: AbortSignal;
+    /** Called after each committed RAW, development or JPEG tile. Cannot change output. */
+    onProgress?: (progress: SimulateCaptureProgress) => void;
+}
+export interface SimulateCaptureProgress {
+    stage: "raw" | "white-balance" | "development" | "jpeg";
+    completedTileCount: number;
+    totalTileCount: number;
+}
+/** One decision the facade made: a default, a derived value or a fixed modelling choice. */
+export interface SimulateCaptureAssumption {
+    /** Dotted option path or modelling topic, for example "exposure.shutterSeconds" or "model.lens-psf". */
+    id: string;
+    kind: "default" | "derived" | "model";
+    value: unknown;
+    explanation: string;
+}
+export interface SimulateCaptureResult {
+    facadeVersion: typeof SIMULATE_CAPTURE_FACADE_VERSION;
+    engineApiVersion: string;
+    image: {
+        width: number;
+        height: number;
+        format: SimulateCaptureOutputFormat;
+        /** Interleaved RGB, row by row from the top-left. sRGB-encoded (W3C CSS Color 4 sRGB; also IEC 61966-2-1) unless `colorEncoding` says otherwise. */
+        samples: Uint8Array | Uint16Array;
+        /** Baseline JPEG bytes when format is "jpeg". */
+        jpeg?: Uint8Array;
+        /** PNG file bytes when format is "png". */
+        png?: Uint8Array;
+        /** Encoding of `samples` and `png` when format is "png". */
+        colorEncoding?: SimulateCaptureColorEncoding;
+        /** Lossless uncompressed CFA DNG of the packed RAW when format is "dng" (`serializeNativeRawDng`); `samples` are then sRGB 8-bit. */
+        dng?: Uint8Array;
+    };
+    /** Packed native RAW (codes, black levels, saturation flags) as produced by the native environment RAW task. */
+    raw: NativeRawOutput;
+    plan: NativeRawPlan;
+    /** The complete underlying request. */
+    request: {
+        environmentRaw: NativeEnvironmentRawInput;
+        /** Rebuilds the exact physical site input the provider supplied for a native row-major index. */
+        siteInput(nativeIndex: number): SimulateEnvironmentSensorRawFrameInput["sites"][number];
+        development: Omit<NativeRawDevelopmentInput, "raw">;
+        whiteBalanceState: ResolvedWhiteBalanceState | null;
+    };
+    exposure: {
+        mode: SimulateCaptureExposureMode;
+        settings: {
+            fNumber: number;
+            shutterSeconds: number;
+            iso: number;
+        };
+        /** Exposure value at ISO 100 of the settings, log2(N²/t). */
+        ev100: number;
+        meteredSceneLuminanceCdPerSquareMeter: number;
+        /** Full output of the existing exposure-mode resolver. */
+        resolution: unknown;
+    };
+    scene: {
+        sceneId: string;
+        preset: string;
+        parameters: Readonly<Record<string, unknown>>;
+        illuminant: {
+            id: string;
+            description: string;
+            illuminanceLux: number;
+        };
+        distanceM: number;
+        /** Physical size of the framed scene plane, metres. */
+        framedWidthM: number;
+        framedHeightM: number;
+        /**
+         * SHA-256 of the canonical scene description, recorded as the capture source digest. Caller spectra (a
+         * `spectrum` or `daylight` illuminant, chart reflectance spectra) are part of the description: tabulated
+         * data exactly, function spectra sampled at 1 nm over 380-780 nm, plus the daylight basis datasetId.
+         * The body of a caller scene's evaluate function is not hashed.
+         */
+        sourceSha256: string;
+    };
+    diagnostics: {
+        providerEvaluationCount: number;
+        highlight: RawHighlightDiagnostics;
+        rendering: SdrRenderingResult["diagnostics"];
+        /** Present with output.gamutMapping "perceptual": pixels whose chroma or lightness the mapping changed. */
+        gamutMapping?: {
+            method: "cielab-hue-preserving-chroma-compression";
+            kneeFraction: number;
+            adjustedPixelCount: number;
+            lightnessClippedPixelCount: number;
+        };
+        timingsMs: {
+            raw: number;
+            whiteBalance: number;
+            development: number;
+            jpeg: number;
+            total: number;
+        };
+    };
+    provenance: {
+        scientificStatus: "approximation";
+        cameraPresetId: string;
+        cameraPresetVersion: string;
+        evidence: readonly EvidenceProvenance[];
+        /** Existing engine contracts the facade composed, in execution order. */
+        composedContracts: readonly string[];
+        limitations: readonly string[];
+    };
+    assumptions: readonly SimulateCaptureAssumption[];
+}
+/**
+ * Default illuminance, lux: an 18 % Lambertian grey card (L = 0.18·E/π) then gets exactly the CIPA DC-004 standard
+ * output sensitivity reference exposure H = 10/S at f/8, 1/125 s, ISO 100:
+ * E = π·10·N²/(0.65·t·S·0.18) = π·80 000/11.7 ≈ 21 480.98 lux.
+ */
+export declare const SIMULATE_CAPTURE_DEFAULT_ILLUMINANCE_LUX: number;
+/**
+ * Simulates one still capture of a planar scene and returns the developed image, the packed RAW, the full
+ * underlying request/plan, provenance and every assumption made. See docs/QUICK_START.md.
+ */
+export declare function simulateCapture(options: SimulateCaptureOptions): Promise<SimulateCaptureResult>;
+/** Chart preset ids accepted by `simulateCapture({ scene: { preset } })`. */
+export declare const SIMULATE_CAPTURE_CHART_PRESETS: readonly ("uniform" | "patches" | "slanted-edge" | "siemens-star" | "step-wedge" | "grey-ramp" | "checkerboard" | "point-grid")[];