A collection of analyses that evaluate daylight related metrics.

Calculates the average, minimum and maximum illuminance for a shading mask during the time specified in a sky series.
Inputs
Name | Nickname | Description | Type |
---|---|---|---|
Shading Masks | S | The shading masks used to compute the daylight metrics. | ShadingMask |
Sky Series | S | The sky series that specify the illuminance at each time step. The time pattern in the sky series specifies the total amount of time in the analysis. | SkySeries |
Outputs
Name | Nickname | Description | Type |
---|---|---|---|
Average | Avg | The average illuminance during the sky series. | Double |
Min | Min | The minimum illuminance during the sky series. | Double |
Max | Max | The maximum illuminance during the sky series. | Double |

Calculates the daylight factor (DF) for a shading mask.
The daylight factor is the ratio of illumination at a point compared to an unobstructed point under an overcast sky.
This analysis is typically used with vertically oriented analysis points placed indoors.
Inputs
Name | Nickname | Description | Type |
---|---|---|---|
Shading Masks | S | The shading masks used to compute the daylight factors. | ShadingMask |
Outputs
Name | Nickname | Description | Type |
---|---|---|---|
DF | DF | The daylight factors for each shading mask. The value is a ratio ranging from 0 to 1, where 0 represents total obstruction of light and 1 represents no obstruction. | Double |

Calculates the daylight autonomy (DA) and continuous daylight autonomy (cDA) for a shading mask.
DA is the percentage of time during an analysis period at which the illuminance at a point is above a set threshold.
cDA is the same as DA with the modification that time steps that score below the threshold are awarded partial credit
for their relative illuminance in relation to the threshold.
Inputs
Name | Nickname | Description | Type |
---|---|---|---|
Shading Masks | M | Shading masks used to compute the daylight autonomy and continuous daylight autonomy. | ShadingMask |
Sky Series | S | A sky series that specify the illuminance at each time step. The time pattern in the sky series specifies the total amount of time in the analysis. | SkySeries |
Illuminance Threshold | T | The minimum amount of illuminance required for a time step to be regarded as autonomous. | Double |
Outputs
Name | Nickname | Description | Type |
---|---|---|---|
DA | DA | The daylight autonomy for each shading mask — i.e. the percentage of the time in the time pattern from the sky series at which the illumination for the shading mask is over the illuminance threshold. | Double |
cDA | cDA | The continuous daylight autonomy for each shading mask — i.e. the same as daylight autonomy plus a proportionate credit for the time steps that score below the threshold. | Double |

Calculates the useful daylight illuminance (UDI) for a shading mask.
The useful daylight illuminance is the percentage of time during an analysis period at which the illuminance at a point
is within an interval. This analysis is typically used with vertically oriented analysis points placed indoors.
Inputs
Name | Nickname | Description | Type |
---|---|---|---|
Shading Masks | M | The shading masks used to compute the continuous daylight autonomy. | ShadingMask |
Sky Series | S | The sky series that specify the illuminance at each time step. The time pattern in the sky series specifies the total amount of time in the analysis. | SkySeries |
Illuminance Interval | I | The interval specifying the minimum and maximum amount of illuminance required for a time step to be regarded as autonomous. | Interval |
Outputs
Name | Nickname | Description | Type |
---|---|---|---|
UDI | UDI | The useful daylight illuminance for each shading mask — i.e. the percentage of the time in the time pattern from the sky series at which the illumination for the shading mask is within the illuminance interval. | Double |
UDI Low | UDIL | The percentage of the time in the time pattern from the sky series at which the illumination for the shading mask is below the illuminance interval. | Double |
UDI High | UDIH | The percentage of the time in the time pattern from the sky series at which the illumination for the shading mask is above the illuminance interval. | Double |

Calculates the illuminance for a shading mask at a specific point in time.
Inputs
Name | Nickname | Description | Type |
---|---|---|---|
Shading Masks | M | The shading masks used to compute the illuminance. | ShadingMask |
Sky Instance | S | A sky instance that specifies the illuminance levels on the hemisphere at a specific point in time. | SkyInstance |
Outputs
Name | Nickname | Description | Type |
---|---|---|---|
Illuminance | I | The illuminance in lux received by a shading mask at a specific point in time. | Double |