honeybee_plus.radiance.material.trans module

Radiance Trans Material.

http://radsite.lbl.gov/radiance/refer/ray.html#Trans https://radiance-online.org//community/workshops/2010-freiburg/PDF/DavidMead.pdf

class honeybee_plus.radiance.material.trans.Trans(name, r_reflectance=0.0, g_reflectance=0.0, b_reflectance=0.0, specularity=0.0, roughness=0.0, transmitted_diff=0.0, transmitted_spec=0.0, modifier='void')

Bases: honeybee_plus.radiance.material.materialbase.RadianceMaterial

Radiance translucent material.

property average_reflectance

Calculate average reflectance of trans material.

b_reflectance = None

0).

Type

Reflectance for blue. The value should be between 0 and 1 (Default

classmethod by_single_reflect_value(name, rgb_reflectance=0.0, specularity=0.0, roughness=0.0, transmitted_diff=0.0, transmitted_spec=0.0, modifier='void')

Create trans material with single reflectance value.

name

Material name as a string. Do not use white space and special character

rgb_reflectance

Reflectance for red, green and blue. The value should be between 0 and 1 (Default: 0).

specularity

Fraction of specularity. Specularity fractions greater than 0.1 are not realistic (Default: 0).

roughness

Roughness is specified as the rms slope of surface facets. A value of 0 corresponds to a perfectly smooth surface, and a value of 1 would be a very rough surface. Roughness values greater than 0.2 are not very realistic. (Default: 0).

transmitted_diff

The transmitted diffuse component is the fraction of transmitted light that is transmitted diffusely in as scattering fashion.

transmitted_spec

The transmitted specular component is the fraction of transmitted light that is not diffusely scattered.

modifier

Material modifier (Default: “void”).

Usage:

wallMaterial = trans.by_single_reflect_value(“generic wall”, .55) print(wallMaterial)

classmethod from_json(rec_json)

Make radiance material from json {

“modifier”: {} or void, // Material modifier “type”: “trans”, // Material type “name”: “”, // Material Name “r_reflectance”: float, // Reflectance for red “g_reflectance”: float, // Reflectance for green “b_reflectance”: float, // Reflectance for blue “specularity”: float, // Material specularity “roughness”: float, // Material roughness “transmitted_diff”: float, “transmitted_spec”: float

}

classmethod from_reflected_spacularity(name, r_reflectance=0.0, g_reflectance=0.0, b_reflectance=0.0, reflected_spacularity=0.0, roughness=0.0, transmitted_diff=0.0, transmitted_spec=0.0, modifier='void')

Create trans material from reflected spacularityself.

See: https://radiance-online.org//community/workshops/2010-freiburg/PDF/DavidMead.pdf

name

Material name as a string. Do not use white space and special character.

r_reflectance

Reflectance for red. The value should be between 0 and 1 (Default: 0).

g_reflectance

Reflectance for green. The value should be between 0 and 1 (Default: 0).

b_reflectance

Reflectance for blue. The value should be between 0 and 1 (Default: 0).

reflected_spacularity

Fraction of reflected spacular. The reflected specularity of common uncoated glass is around .06, Matte = min 0, Satin = suggested max 0.07 (Default: 0).

roughness

Roughness is specified as the rms slope of surface facets. A value of 0 corresponds to a perfectly smooth surface, and a value of 1 would be a very rough surface. Roughness values greater than 0.2 are not very realistic. (Default: 0).

transmitted_diff

The transmitted diffuse component is the fraction of transmitted light that is transmitted diffusely in as scattering fashion.

transmitted_spec

The transmitted specular component is the fraction of transmitted light that is not diffusely scattered.

modifier

Material modifier (Default: “void”).

classmethod from_string(material_string, modifier=None)

Create a Radiance material from a string.

If the material has a modifier the modifier material should also be partof the string or should be provided using modifier argument.

g_reflectance = None

0).

Type

Reflectance for green. The value should be between 0 and 1 (Default

r_reflectance = None

0).

Type

Reflectance for red. The value should be between 0 and 1 (Default

roughness = None

Roughness is specified as the rms slope of surface facets. A value of 0 corresponds to a perfectly smooth surface, and a value of 1 would be a very rough surface. Roughness values greater than 0.2 are not very realistic. (Default: 0).

property specular_sampling_threshold

Specular sampling threshold (-st).

specularity = None

Fraction of specularity. Specularity fractions greater than 0.1 are not realistic (Default: 0).

to_json()

Translate radiance material to json {

“type”: “trans”, // Material type “name”: “”, // Material Name “r_reflectance”: float, // Reflectance for red “g_reflectance”: float, // Reflectance for green “b_reflectance”: float, // Reflectance for blue “specularity”: float, // Material specularity “roughness”: float, // Material roughness “transmitted_diff”: float, “transmitted_spec”: float

}

transmitted_diff = None

transmitted_spec = None