> For the complete documentation index, see [llms.txt](https://docs.ladybug.tools/hb-radiance-primer/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ladybug.tools/hb-radiance-primer/components/1_modifiers/bsmodifier.md).

# BSModifier

![](/files/-MihqdJJaNUQ-BQcXsyo)

![](/files/-MihqbMrH6UXMGVLAxf-) - [\[source code\]](https://github.com/ladybug-tools/honeybee-grasshopper-radiance/blob/master/honeybee_grasshopper_radiance/src//HB%20BSDF%20Modifier.py)

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.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.ladybug.tools/hb-radiance-primer/components/1_modifiers/bsmodifier.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
