HB-Radiance Primer
Ladybug Tools for Grasshopper Documentation
  • HB-Radiance Primer
  • Components
    • 0 :: Basic Properties
      • Face Radiance Attributes
      • Room Radiance Attributes
      • Automatic Aperture Group
      • Dynamic Aperture Group
      • Dynamic State
      • Dynamic State Geometry
      • Radial Grid from Rooms
      • Sensor Grid
      • Sensor Grid from Apertures
      • Sensor Grid from Rooms
      • View
      • View from Viewport
      • Assign Grids and Views
      • Get Grids and Views
      • Dynamic Shade Group
      • Get Dynamic Groups
      • Radial Sensor Grid
      • Section Plane View
      • Sensor Grid from Faces
    • 1 :: Modifiers
      • Search Modifier Sets
      • Search Modifiers
      • BSModifier
      • Glass Modifier
      • Metal Modifier
      • Mirror Modifier
      • Opaque Modifier
      • Translucent Modifier
      • ModifierSet
      • Exterior Modifier Subset
      • Interior Modifier Subset
      • Shade Modifier Subset
      • Subface Modifier Subset
      • Deconstruct ModifierSet
      • Deconstruct ModifierSet Interior
      • Apply Face Modifier
      • Apply ModifierSet
      • Apply Shade Modifier
      • Apply Window Modifier
      • Deconstruct Modifier
      • Glass Modifier 3
      • Metal Modifier 3
      • Mirror Modifier 3
      • Opaque Modifier 3
      • Translucent Modifier 3
    • 2 :: Light Sources
      • CIE Standard Sky
      • Certain Illuminance
      • Climatebased Sky
      • Custom Sky
      • Wea From Clear Sky
      • Wea From EPW
      • Wea From Tau Clear Sky
      • Wea from Zhang-Huang
      • Deconstruct Wea
      • Visualize Sky
    • 3 :: Recipes
      • Annual Daylight
      • Annual Irradiance
      • Imageless Annual Glare
      • Point-In-Time Grid-Based
      • Point-In-Time View-Based
      • Cumulative Radiation
      • Daylight Factor
      • Direct Sun Hours
      • Sky View
      • Check Scene
      • Radiance Parameter
      • Ambient Resolution
    • 4 :: Results
      • Annual Daylight Metrics
      • Annual Glare Metrics
      • Annual Sunlight Exposure
      • Aperture Group Schedule
      • Daylight Control Schedule
      • Spatial Daylight Autonomy
      • Annual Average Values
      • Annual Cumulative Values
      • Annual Peak Values
      • Annual Results to Data
      • Adjust HDR
      • False Color
      • Glare Postprocess
      • HDR to GIF
      • Extract HDR
      • Model to Rad Folder
Powered by GitBook
On this page
  • Inputs
  • Outputs
Export as PDF
  1. Components
  2. 4 :: Results

Annual Sunlight Exposure

PreviousAnnual Glare MetricsNextAperture Group Schedule

Last updated 1 year ago

-

Calculate Annual Sunlight Exposure from a results folder.

Note: This component will only output a LEED compliant ASE if you've run the simulation with all operable shading devices retracted. If you are using results with operable shading devices, then this output is NOT LEED compliant.

Inputs

  • results [Required]

An annual results folder containing direct illuminance results. This can be the output of the "HB Annual Daylight" component. This can also be just the path to the results folder.

  • occ_sch

An annual occupancy schedule as a Ladybug Data Collection or a HB-Energy schedule object. This can also be the identifier of a schedule in your HB-Energy schedule library. Any value in this schedule that is 0.1 or above will be considered occupied. If None, a schedule from 9AM to 5PM on weekdays will be used.

  • threshold

The threshold (lux) that determines if a sensor is overlit (default: 1000).

  • target_hrs

The number of occupied hours that cannot receive higher illuminance than the direct threshold (default: 250).

  • grid_filter

The name of a grid or a pattern to filter the grids. For instance, first_floor_* will simulate only the sensor grids that have an identifier that starts with first_floor_. By default all the grids will be processed.

Outputs

  • report

Reports, errors, warnings, etc.

  • ASE

Annual sunlight exposure as a percentage for each sensor grid.

  • hrs_above

The number of hours above the threshold for each sensor point. These can be plugged into the "LB Spatial Heatmap" component along with meshes of the sensor grids to visualize results.

[source code]