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. 3 :: Recipes

Daylight Factor

PreviousCumulative RadiationNextDirect Sun Hours

Last updated 3 years ago

-

Run a daylight factor study for a Honeybee model.

Daylight Factor (DF) is defined as the ratio of the indoor daylight illuminance to outdoor illuminance under an unobstructed overcast sky. It is expressed as a percentage between 0 and 100.

Because daylight factor is computed using an overcast sky, it does not change with [North, East, South, West] orientation. As such, it is more suited to assessing daylight in climates where cloudy conditions are common. The "HB Annual Daylight" recipe yields a much more accurate assessment of daylight and is suitable for all climates, though it requires a significantly longer calculation time than Daylight Factor.

Inputs

  • model [Required]

A Honeybee Model for which Daylight Factor will be simulated. Note that this model should have grids assigned to it in order to produce meaningfule results.

  • grid_filter

Text for a grid identifer or a pattern to filter the sensor grids of the model that are simulated. For instance, first_floor_* will simulate only the sensor grids that have an identifier that starts with first_floor_. By default, all grids in the model will be simulated.

  • radiance_par

Text for the radiance parameters to be used for ray tracing. (Default: -ab 2 -aa 0.1 -ad 2048 -ar 64).

  • run_settings

Settings from the "HB Recipe Settings" component that specify how the recipe should be run. This can also be a text string of recipe settings.

  • run [Required]

Set to True to run the recipe and get results. This input can also be the integer "2" to run the recipe silently.

Outputs

  • report

Reports, errors, warnings, etc.

  • results

The daylight factor values from the simulation in percent. Each value is for a different sensor of the grid. These can be plugged into the "LB Spatial Heatmap" component along with meshes of the sensor grids to visualize results.

[source code]