honeybee_radiance.modifier.material.mirror module

Radiance Mirror Material.

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

class honeybee_radiance.modifier.material.mirror.Mirror(identifier, r_reflectance=1.0, g_reflectance=1.0, b_reflectance=1.0, modifier=None, alternate_material=None, dependencies=None)[source]

Bases: honeybee_radiance.modifier.material.materialbase.Material

Radiance mirror material.

Mirror is used for planar surfaces that produce virtual source reflections. This material should be used sparingly, as it may cause the light source calculation to blow up if it is applied to many small surfaces. This material is only supported for flat surfaces such as polygons and rings. The arguments are simply the RGB reflectance values, which should be between 0 and 1.

An optional string argument may be used (like the illum type) to specify a different material to be used for shading non-source rays. If this alternate material is given as “void”, then the mirror surface will be invisible. Using “void” is only appropriate if the surface hides other (more detailed) geometry with the same overall reflectance.

Parameters
  • identifier – Text string for a unique Material ID. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.

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

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

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

  • modifier – Material modifier (Default: None).

  • alternate_material – An optional material (like the illum type) used to specify a different material to be used for shading non-source rays. If None, this will keep the alternat_material as mirror. If this alternate material is given as “void”, then the mirror surface will be invisible. Using “void” is only appropriate if the surface hides other (more detailed) geometry with the same overall reflectance (Default: None).

  • dependencies – A list of primitives that this primitive depends on. This argument is only useful for defining advanced primitives where the primitive is defined based on other primitives (Default: []).

Properties:
  • identifier

  • display_name

  • r_reflectance

  • g_reflectance

  • b_reflectance

  • average_reflectance

  • values

  • modifier

  • alternate_material

  • dependencies

  • is_modifier

  • is_material

Usage:

mirror_material = Mirror("mirror_material", 0.95, .95, .95)
print(mirror_material)
ToString()

Overwrite .NET ToString.

add_dependent(dep)

Add dependent.

duplicate()

Get a copy of this object.

static filter_dict_input(input_dict)

Filter a dictionary of a Primitive to get modifier and dependency objects.

classmethod from_dict(data)[source]

Initialize Mirror from a dictionary.

Parameters

data – A dictionary in the format below.

{
"type": "Mirror",  # Material type
"identifier": "",  # Material identifier
"display_name": "",  # Material display name
"r_reflectance": float,  # Reflectance for red
"g_reflectance": float,  # Reflectance for green
"b_reflectance": float,  # Reflectance for blue
"modifier": {},  # Material modifier (Default: None)
"alternate_material": {},  # optional alternate material
"dependencies": []
}
classmethod from_primitive_dict(primitive_dict)[source]

Initialize mirror from a primitive dict.

Parameters

data – A dictionary in the format below.

{
"modifier": {},  # primitive modifier (Default: None)
"type": "mirror",  # primitive type
"identifier": "",  # primitive identifier
"display_name": "",  # primitive display name
"values": [],  # values
"dependencies": []
}
classmethod from_single_reflectance(identifier, rgb_reflectance=0.0, modifier=None, alternate_material=None, dependencies=None)[source]

Create mirror material with single reflectance value.

Parameters
  • identifier – Text string for a unique Material ID. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.

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

  • modifier – Material modifier (Default: None).

  • alternate_material – An optional material may be used like the illum type to specify a different material to be used for shading non-source rays. If None, this will keep the alternat_material as mirror. If this alternate material is given as “void”, then the mirror surface will be invisible. Using “void” is only appropriate if the surface hides other (more detailed) geometry with the same overall reflectance (Default: None).

  • dependencies – A list of primitives that this primitive depends on. This argument is only useful for defining advanced primitives where the primitive is defined based on other primitives. (Default: [])

Usage:

wall_material = Mirror.by_single_reflect_value("mirror", 1.0)
classmethod from_string(primitive_string)

Create a Radiance primitive from a string.

If the primitive modifier is not void or it has other dependencies, the modifier and/or dependencies must also be part of the input string.

lock()
to_dict()[source]

Translate this object to a dictionary.

to_radiance(minimal=False, include_modifier=True, include_dependencies=True)

Return full radiance definition.

Parameters
  • minimal – Boolean to note whether the radiance string should be written in a minimal format (with spaces instead of line breaks). Default: False.

  • include_modifier – Boolean to note whether the modifier of this primitive should be included in the string. Default: True.

  • include_dependencies – Boolean to note whether the dependencies of this primitive should be included in the string. Default: True.

unlock()
GEOMETRYTYPES = {'bubble', 'cone', 'cup', 'cylinder', 'instance', 'mesh', 'polygon', 'ring', 'source', 'sphere', 'tube'}
MATERIALTYPES = {'BRTDfunc', 'BSDF', 'aBSDF', 'antimatter', 'ashik2', 'dielectric', 'glass', 'glow', 'illum', 'interface', 'light', 'metal', 'metal2', 'metdata', 'metfunc', 'mirror', 'mist', 'mixedfunc', 'plasdata', 'plasfunc', 'plastic', 'plastic2', 'prism1', 'prism2', 'spotlight', 'trans', 'trans2', 'transdata', 'transfunc'}
MIXTURETYPES = {'mixdata', 'mixfunc', 'mixpict', 'mixtext'}
MODIFIERTYPES = {'BRTDfunc', 'BSDF', 'aBSDF', 'antimatter', 'ashik2', 'brightdata', 'brightfunc', 'brighttext', 'colordata', 'colorfunc', 'colorpict', 'colortext', 'dielectric', 'glass', 'glow', 'illum', 'interface', 'light', 'metal', 'metal2', 'metdata', 'metfunc', 'mirror', 'mist', 'mixdata', 'mixedfunc', 'mixfunc', 'mixpict', 'mixtext', 'plasdata', 'plasfunc', 'plastic', 'plastic2', 'prism1', 'prism2', 'spotlight', 'texdata', 'texfunc', 'trans', 'trans2', 'transdata', 'transfunc'}
NONEOPAQUETYPES = {'BRTDfunc', 'BSDF', 'aBSDF', 'dielectric', 'glass', 'mist', 'mixfunc', 'prism1', 'prism2', 'trans', 'trans2', 'transdata', 'transfunc'}
PATTERNTYPES = {'brightdata', 'brightfunc', 'brighttext', 'colordata', 'colorfunc', 'colorpict', 'colortext'}
TEXTURETYPES = {'texdata', 'texfunc'}
TYPES = {'BRTDfunc', 'BSDF', 'aBSDF', 'antimatter', 'ashik2', 'brightdata', 'brightfunc', 'brighttext', 'bubble', 'colordata', 'colorfunc', 'colorpict', 'colortext', 'cone', 'cup', 'cylinder', 'dielectric', 'glass', 'glow', 'illum', 'instance', 'interface', 'light', 'mesh', 'metal', 'metal2', 'metdata', 'metfunc', 'mirror', 'mist', 'mixdata', 'mixedfunc', 'mixfunc', 'mixpict', 'mixtext', 'plasdata', 'plasfunc', 'plastic', 'plastic2', 'polygon', 'prism1', 'prism2', 'ring', 'source', 'sphere', 'spotlight', 'texdata', 'texfunc', 'trans', 'trans2', 'transdata', 'transfunc', 'tube'}
property alternate_material

Get or set an optional material for shading non-source rays.

If None, this will keep the alternat_material as mirror. If this alternate material is given as “void”, then the mirror surface will be invisible. Using “void” is only appropriate if the surface hides other (more detailed) geometry with the same overall reflectance.

property b_reflectance

Get or set the reflectance for blue channel.

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

property dependencies

Get list of dependencies for this primitive.

Additional dependencies can be added with the add_dependent method.

property display_name

Get or set a string for the object name without any character restrictions.

If not set, this will be equal to the identifier.

property g_reflectance

Get or set the reflectance for green channel.

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

property identifier

Get or set a text string for the unique primitive identifier.

property is_geometry

Get a boolean noting whether this object is a Radiance geometry.

property is_material

Get a boolean noting whether this object is a material modifier.

property is_mixture

Get a boolean noting whether this object is a mixture modifier.

property is_modifier

Get a boolean indicating whether this object is a Radiance modifier.

Modifiers include materials, mixtures, textures and patterns.

property is_opaque

Get or set a boolean to indicate whether this primitive is opaque.

This property is used to separate opaque and non-opaque geometries as well as modifiers.

property is_pattern

Get a boolean noting whether this object is a pattern modifier.

property is_texture

Get a boolean noting whether this object is a texture modifier.

property is_void

Only true for a void.

property modifier

Get or set an object for the primitive modifier.

property r_reflectance

Get or set the reflectance for red channel.

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

property type

Get or set a string for the primitive type.

This should always be lower case in order to match the radiance convention.

property values

Get or set the values of the current primitive as a list of three lists.

Each sub-list represents a line of the primitive’s radiance representation and contain the properties that define the primitive.

Usage:

# This will erase all values except the first line, which has 9 custom items
primitive.values = [
    [0.5, 0.5, 0.5, "/usr/oak.pic", ".", "frac(U)", "frac(V)", "-s", 1.1667],
    [],
    []
]