honeybee_plus.radiance.material.metal module

Radiance Metal Material.

http://radsite.lbl.gov/radiance/refer/ray.html#Metal

class honeybee_plus.radiance.material.metal.Metal(name, r_reflectance=0, g_reflectance=0, b_reflectance=0, specularity=0.9, roughness=0, modifier='void')

Bases: honeybee_plus.radiance.material.materialbase.RadianceMaterial

Radiance metal material.

property average_reflectance

Calculate average reflectance of metal 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, specularity=0, roughness=0, modifier='void')

Create metal 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).

modifier

Material modifier (Default: “void”).

Usage:

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

classmethod from_json(rec_json)

Make radiance material from json {

“modifier”: modifier, “type”: “metal”, // 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

}

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).

specularity = None

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

to_json()

Translate radiance material to json {

“type”: “metal”, // 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

}