Click or drag to resize
Illuminance data type
Print this page

The data type Illuminance represents the amount of light falling onto (illuminating) and spreading over a given surface area. Illuminance correlates with how humans perceive the brightness of an illuminated area.

The TDE data types for quantifiable data (numeric values with units of measure) are all stored as double and are handled similarly for template scripting.

Tip Tip

Since every quantifiable data type is stored as double, be sure to account for that when you test equivalency (for example, 1 may actually be stored as 0.999999). Either round off the values being compared, or use ranges for the comparison.

Units
  • Lux or lx or lm/(m^2) — default
  • FootCandle or fc or lm/(ft^2)

Data from TDE defaults to the first unit listed for each data type. In the [Output] section, you can convert these values to the units you need:

Copy
[Output]
Illuminance(Lux) = Input.Illuminance  # converts to Lux
Field length

The effective range of this data type is: 0 to 2,000,000,000 Lux

JavaScript conversion

When you use the optional [Script] section to insert your own JavaScript functions, access this data type as follows:

Constructor
JavaScript
Copy
new Illuminance({Unit:Value})
Available fields for (get,set)

You can access the valid units of measure as fields:

  • .Lux

  • .FootCandle