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

Check Scene

PreviousSky ViewNextRadiance Parameter

Last updated 3 years ago

-

Run a quick view-based Radiance simulation to visualize the properties of Honeybee objects within Radiance.

Note that this simulation is always run on a single processor and will only show static Radiance properties (no dynamic Aperture or Shade properties). Accordingly, this component is only intended for quick checks of properties. For full customization of view-based simulations, the "HB Point-in-time View-based" recipe should be used.

Inputs

  • hb_objs [Required]

    An array of honeybee Rooms, Faces, Apertures, Doors or Shades to be visualized in Radiance. This can also be an entire Model to be visualized.

  • view

    An optional Honeybee-Radiance view to specify the view to render. If unspecified, the currently active Rhino viewport will be rendered.

  • sky

    An optional Radiance sky from any of the sky components under the "Light Sources" tab. If unspecified, a uniform sky with 10000 lux will be used.

  • adj_expos

    Boolean to note whether the exposure of the image should be adjusted to mimic the human visual response in the output. The goal of this process is to output an image that correlates more strongly with a person’s subjective impression of a scene rather than the absolute birghtness of the scene. (Default: True).

  • metric

    Either an integer or the full name of a point-in-time metric to be computed by the recipe. (Default: luminance). Choose from the following:

    • 0 = illuminance

    • 1 = irradiance

    • 2 = luminance

    • 3 = radiance

  • resolution

    An integer for the maximum dimension of each image in pixels (either width or height depending on the input view angle and type). (Default: 800).

  • radiance_par

    Text for the radiance parameters to be used for ray tracing. (Default: -ab 2 -aa 0.25 -ad 512 -ar 16).

  • run [Required]

    Set to "True" to run Radiance and get an image of the scene.

Outputs

  • report

    Reports, errors, warnings, etc.

  • hdr

    A High Dynamic Range (HDR) image of the scene. This can be plugged into the Ladybug "Image Viewer" component to preview the image. It can also be plugged into the "HB False Color" component to convert the image into a false color version. Lastly, it can be connected to the "HB HDR to GIF" component to get a GIF image that is more portable and easily previewed by different software. Pixel values are in the standard SI units of the requested input metric.

    • illuminance = lux (aka. lm/m2)

    • irradiance = W/m2

    • luminance = cd/m2 (aka. lm/m2-sr)

    • radiance = W/m2-sr

[source code]