SetLuminousFlux

Rescale the intensity distribution to a specified total luminous flux.

Undo support: Registered as undoable; see limitations below.

Syntax

SetLuminousFlux <emitterId> [<emitterId> ...] -> <flux>

Parameters

Supply positive finite flux, normally in lumens for photometric data.

Example

SetLuminousFlux 12 -> 1000

Example IDs are placeholders; replace them with IDs from your current session.

Response

OK; invalid or unavailable targets can be logged and skipped. Query flux afterward.

Notes

Changes intensity values, not just lamp metadata. Use data with a valid nonzero integrated distribution.

Implementation: EikonalWorksTools/EWIntensityView/src/actions/edit/SetLuminousFluxAction.h.

See API connection, grammar and client examples for quoting, error handling and model IDs.