All files / cli/src/commands inspect.ts

100% Statements 24/24
96.15% Branches 50/52
100% Functions 10/10
100% Lines 20/20

Press n or j to go to the next uncovered block, b, p or k for the previous block.

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        108x       8x 6x           30x             54x         6x       1x   9x 9x 9x 1x 1x   8x 8x                                               12x                   36x 9x   9x     5x     9x          
import { defineCommand } from 'yargs-file-commands';
import { inputOptions, readInput } from '../options.js';
import { inspectPhotometry, type PhotometryInspection } from '../photometry.js';
 
const percentCell = (value: number | null) => (value === null ? '—' : value.toFixed(1)).padStart(11);
 
/** Compact human lines for the flux breakdown, ratios, CIE flux code and zonal lumens (Type C only). */
function extendedMetricLines(summary: PhotometryInspection): string[] {
  if (summary.downwardFluxLumens === null || summary.upwardFluxLumens === null) return [];
  return [
    `Downward / upward flux: ${summary.downwardFluxLumens.toFixed(3)} lm / ${summary.upwardFluxLumens.toFixed(3)} lm`,
    `DFF ${summary.downwardFluxFraction === null ? 'unavailable (no light)' : `${(summary.downwardFluxFraction * 100).toFixed(0)} %`}`,
    summary.lightOutputRatio === null
      ? 'LOR unavailable (no declared lamp flux)'
      : `LOR ${summary.lightOutputRatio.toFixed(2)} (DLOR ${summary.downwardLightOutputRatio!.toFixed(2)} / ULOR ${summary.upwardLightOutputRatio!.toFixed(2)})`,
    `CIE flux code: ${summary.cieFluxCode!.map((n) => n ?? '—').join(' ')}`,
    `Peak (tilt applied): ${summary.peakIntensityCandela!.toFixed(3)} cd at C${summary.peakDirection!.horizontalDegrees}° γ${summary.peakDirection!.verticalDegrees}°`,
    `Nadir intensity: ${summary.nadirCandela!.toFixed(3)} cd`,
    'Zonal lumens:',
    `  ${'Zone'.padEnd(9)}${'lm'.padStart(12)}${'% lamp'.padStart(11)}${'% luminaire'.padStart(13)}`,
    ...summary.zonalLumens!.map(
      (zone) =>
        `  ${`${zone.fromDegrees}–${zone.toDegrees}°`.padEnd(9)}${zone.lumens.toFixed(3).padStart(12)}${percentCell(zone.percentOfLamp)}${percentCell(zone.percentOfLuminaire).padStart(13)}`,
    ),
  ];
}
 
export const command = defineCommand({
  command: 'inspect <file>',
  describe: 'Show source metadata and photometric statistics',
  builder: (yargs) =>
    inputOptions(yargs).option('json', { type: 'boolean', describe: 'Emit a machine-readable summary' }),
  handler: async (argv) => {
    const { text, format, lampSetIndex } = await readInput(argv);
    const summary = inspectPhotometry(text, format, lampSetIndex);
    if (argv.json) {
      console.log(JSON.stringify(summary, null, 2));
      return;
    }
    const dimensions = summary.dimensions;
    const lines = [
      argv.file,
      `Format: ${summary.format}`,
      `Version: ${summary.version}`,
      `Photometric type: Type ${summary.photometricTypeName} (${summary.photometricType})`,
      `Photometry: ${summary.photometry}`,
      `Manufacturer: ${summary.manufacturer}`,
      `Luminaire: ${summary.luminaire}`,
      `Light source: ${summary.lightSource}`,
      `Lamp catalog: ${summary.lampCatalog}`,
      `Lamp count: ${summary.lampCount ?? 'select a lamp configuration'}`,
      `Lumens per lamp: ${summary.lumensPerLamp === null ? 'select a lamp configuration' : summary.lumensPerLamp === -1 ? 'not specified (absolute photometry)' : `${summary.lumensPerLamp} lm`}`,
      `Input power: ${summary.inputWatts === null ? 'select a lamp configuration' : `${summary.inputWatts} W`}`,
      `Peak intensity: ${summary.peakCandela === null ? 'select a lamp configuration' : `${summary.peakCandela} cd`}`,
      `Declared lamp flux: ${summary.declaredLampFluxLumens === null ? 'not specified (absolute photometry)' : `${summary.declaredLampFluxLumens} lm (lamp rating, not luminaire output)`}`,
      ...(summary.declaredLuminaireFluxLumens === null
        ? []
        : [`Declared luminaire flux: ${summary.declaredLuminaireFluxLumens} lm (source rating)`]),
      `Integrated luminaire flux: ${summary.integratedFluxLumens === null ? (summary.photometricType === 1 ? 'unavailable (select a lamp configuration)' : 'unavailable (Type C only)') : `${summary.integratedFluxLumens.toFixed(3)} lm (angular table estimate)`}`,
      `Integrated luminous efficacy: ${summary.luminousEfficacyLumensPerWatt === null ? 'unavailable (unsupported coordinates or zero input power)' : `${summary.luminousEfficacyLumensPerWatt.toFixed(3)} lm/W`}`,
      `Metrics lamp tilt: ${summary.metricsTiltDegrees}°`,
      ...(summary.metricsUnsupportedReason ? [`Metrics: ${summary.metricsUnsupportedReason}`] : []),
      ...summary.beamAngles.map(
        (cut) =>
          `C${cut.horizontalDegrees}–C${(cut.horizontalDegrees + 180) % 360} beam / field estimate: ${cut.beamAngleDegrees === null ? `unavailable (${cut.beamAngleStatus})` : `${cut.beamAngleDegrees.toFixed(3)}°`} / ${cut.fieldAngleDegrees === null ? `unavailable (${cut.fieldAngleStatus})` : `${cut.fieldAngleDegrees.toFixed(3)}°`} (peak direction ${cut.peakDirectionDegrees}°)`,
      ),
      ...extendedMetricLines(summary),
      `Angles: ${summary.verticalAngles} vertical × ${summary.horizontalAngles} horizontal`,
      `Dimensions (width × length × height): ${dimensions.width} × ${dimensions.length} × ${dimensions.height} ${summary.units}`,
      `Tilt correction: ${summary.hasTilt ? 'embedded' : 'none'}`,
      ...(summary.fileGenerationType === null
        ? []
        : [`File generation type: ${summary.fileGenerationType.toFixed(5)} (provenance, not an intensity multiplier)`]),
    ];
    const metadata = Object.entries(summary.metadata).map(([key, value]) => `${key}: ${value}`);
    const diagnostics = summary.diagnostics.map((item) => `${item.severity} [${item.code}]: ${item.message}`);
    const lampSets =
      summary.sourceFormat === 'ldt'
        ? summary.lampSets.map(
            (set, index) =>
              `Lamp configuration ${index + 1}${summary.selectedLampSetIndex === index ? ' (selected)' : ''}: ${set.description || 'not specified'}; ${set.totalLumens} lm; ${set.watts} W`,
          )
        : [];
    console.log(
      [...lines, ...lampSets, ...(metadata.length ? ['Metadata:', ...metadata] : []), ...diagnostics].join('\n'),
    );
  },
});