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. 1 :: Modifiers

BSModifier

PreviousSearch ModifiersNextGlass Modifier

Last updated 2 years ago

-

Create a Bidirectional Scattering Distribution Function (BSDF) radiance modifier from an XML file.

Inputs

  • xml_file [Required]

Path to an XML file contining BSDF data. These files can be produced using the LBNL WINDOW software among other sources.

  • up_vec

A vector that sets the hemisphere that the BSDF modifier faces. For materials that are symmetrical about the face plane (like non-angled venetian blinds), this can be any vector that is not perfectly normal/perpendicular to the face. For asymmetrica materials like angled venetian blinds, this variable should be coordinated with the direction that the geometry is facing. The default is set to (0.01, 0.01, 1.00), which should hopefully not be normal to any typical face.

  • thickness

Optional number to set the thickness of the BSDF. Thickness is not supported for aBSDF type. (Default: 0).

  • bsdf_type

An integer to set the bsdf type. Choose from the choices below. (Default: 0).

* 0 BSDF

* 1 aBSDFChoose aBSDF (peak extraction) for systems with a strong specular transmission component. A proposed guideline for when to use aBSDF can be found in chapter 6 in "BSDF generation procedures for daylighting systems". Find the white paper at: 

* https://task61.iea-shc.org/publications

Outputs

  • modifier

A BSDF modifier that can be assigned to a Honeybee geometry or Modifier Sets.

[source code]