honeybee_radiance.modifierset module

Radiance modifier set.

class honeybee_radiance.modifierset.ApertureModifierSet(*args, **kwargs)[source]

Bases: honeybee_radiance.modifierset._BaseSet

Set containing all radiance modifiers needed to for a radiance model’s Apertures.

Parameters
  • window_modifier – A modifier object for apertures with an Outdoors boundary condition, False is_operable property, and Wall parent Face.

  • interior_modifier – A modifier object for apertures with a Surface boundary condition.

  • skylight_modifier – : A modifier object for apertures with an Outdoors boundary condition, False is_operable property, and a RoofCeiling or Floor face type for their parent face.

  • operable_modifier – A modifier object for apertures with an Outdoors boundary condition and a True is_operable property.

Properties:
  • window_modifier

  • interior_modifier

  • skylight_modifier

  • operable_modifier

  • modifiers

  • modified_modifiers

  • is_modified

ToString()

Overwrite .NET ToString.

duplicate()

Get a copy of this set.

classmethod from_dict(data)[source]

Create a ApertureModifierSet from a dictionary.

Note that the dictionary must be a non-abridged version for this classmethod to work.

Parameters

data – Dictionary describing the ApertureModifierSet.

lock()
to_dict(abridged=False, none_for_defaults=True)[source]

Get the ModifierSet as a dictionary.

Parameters
  • abridged – Boolean noting whether detailed modifier objects should be written into the ModifierSet (False) or just an abridged version (True). Default: False.

  • none_for_defaults – Boolean to note whether default modifiers in the set should be included in detail (False) or should be None (True). Default: True.

unlock()
property exterior_modifier

Get or set the modifier for exterior objects.

property interior_modifier

Get or set the modifier for interior objects.

property is_modified

Boolean noting whether any modifiers are modified from the default.

property modified_modifiers

List of all modifiers that are not defaulted within the set.

property modifiers

List of all modifiers contained within the set.

property operable_modifier

Get or set the modifier for operable apertures.

property skylight_modifier

Get or set the modifier for apertures in roofs.

property window_modifier

Get or set the modifier for exterior fixed apertures in walls.

class honeybee_radiance.modifierset.DoorModifierSet(*args, **kwargs)[source]

Bases: honeybee_radiance.modifierset._BaseSet

Set containing all radiance modifiers needed to for an radiance model’s Doors.

Parameters
  • exterior_modifier – A modifier object for doors in walls with an Outdoors boundary condition.

  • interior_modifier – A modifier object for doors with a Surface (or other) boundary condition.

  • exterior_glass_modifier – A modifier object for all glass doors with an Outdoors boundary condition.

  • interior_glass_modifier – A modifier object for all glass doors with a Surface boundary condition.

  • overhead_modifier – : A modifier object for doors with an Outdoors boundary condition and a RoofCeiling or Floor face type for their parent face.

Properties:
  • exterior_modifier

  • interior_modifier

  • exterior_glass_modifier

  • interior_glass_modifier

  • overhead_modifier

  • modifiers

  • modified_modifiers

  • is_modified

ToString()

Overwrite .NET ToString.

duplicate()

Get a copy of this set.

classmethod from_dict(data)[source]

Create a ApertureModifierSet from a dictionary.

Note that the dictionary must be a non-abridged version for this classmethod to work.

Parameters

data – Dictionary describing the ApertureModifierSet.

lock()
to_dict(abridged=False, none_for_defaults=True)

Get the ModifierSet as a dictionary.

Parameters
  • abridged – Boolean noting whether detailed modifiers objects should be written into the ModifierSet (False) or just an abridged version (True). Default: False.

  • none_for_defaults – Boolean to note whether default modifiers in the set should be included in detail (False) or should be None (True). Default: True.

unlock()
property exterior_glass_modifier

Get or set the modifier for exterior glass doors.

property exterior_modifier

Get or set the modifier for exterior objects.

property interior_glass_modifier

Get or set the modifier for interior glass doors.

property interior_modifier

Get or set the modifier for interior objects.

property is_modified

Boolean noting whether any modifiers are modified from the default.

property modified_modifiers

List of all modifiers that are not defaulted within the set.

property modifiers

List of all modifiers contained within the set.

property overhead_modifier

Get or set the modifier for skylights.

class honeybee_radiance.modifierset.FloorModifierSet(*args, **kwargs)[source]

Bases: honeybee_radiance.modifierset._BaseSet

Set containing all radiance modifiers needed to for an radiance model’s floors.

Properties:
  • exterior_modifier

  • interior_modifier

  • modifiers

  • modified_modifiers

  • is_modified

ToString()

Overwrite .NET ToString.

duplicate()

Get a copy of this set.

classmethod from_dict(data)

Create a SubSet from a dictionary.

Note that the dictionary must be a non-abridged version for this classmethod to work.

Parameters

data – Dictionary describing the Set of the object.

lock()
to_dict(abridged=False, none_for_defaults=True)

Get the ModifierSet as a dictionary.

Parameters
  • abridged – Boolean noting whether detailed modifiers objects should be written into the ModifierSet (False) or just an abridged version (True). Default: False.

  • none_for_defaults – Boolean to note whether default modifiers in the set should be included in detail (False) or should be None (True). Default: True.

unlock()
property exterior_modifier

Get or set the modifier for exterior objects.

property interior_modifier

Get or set the modifier for interior objects.

property is_modified

Boolean noting whether any modifiers are modified from the default.

property modified_modifiers

List of all modifiers that are not defaulted within the set.

property modifiers

List of all modifiers contained within the set.

class honeybee_radiance.modifierset.ModifierSet(*args, **kwargs)[source]

Bases: object

Set containting all radiance modifiers needed to create a radiance model.

ModifierSets can be used to establish templates that are applied broadly across a Model, like a color scheme used consistently throughout a building.

Parameters
  • identifier – Text string for a unique ModifierSet 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.

  • wall_set – An optional WallModifierSet object for this ModifierSet. If None, it will be the honeybee generic default WallModifierSet.

  • floor_set – An optional FloorModifierSet object for this ModifierSet. If None, it will be the honeybee generic default FloorModifierSet.

  • roof_ceiling_set – An optional RoofCeilingModifierSet object for this ModifierSet. If None, it will be the honeybee generic default RoofCeilingModifierSet.

  • aperture_set – An optional ApertureModifierSet object for this ModifierSet. If None, it will be the honeybee generic default ApertureModifierSet.

  • door_set – An optional DoorModifierSet object for this ModifierSet. If None, it will be the honeybee generic default DoorModifierSet.

  • shade_set – An optional ShadeModifierSet object for this ModifierSet. If None, it will be the honeybee generic default ShadeModifierSet.

  • air_boundary_modifier – An optional Modifier to be used for all Faces with an AirBoundary face type. If None, it will be the honeybee generic air wall modifier.

Properties:
  • identifier

  • display_name

  • wall_set

  • floor_set

  • roof_ceiling_set

  • aperture_set

  • door_set

  • shade_set

  • air_boundary_modifier

  • modifiers

  • modified_modifiers

  • modifiers_unique

  • modified_modifiers_unique

ToString()[source]

Overwrite .NET ToString.

duplicate()[source]

Get a copy of this ModifierSet.

classmethod from_dict(data)[source]

Create a ModifierSet from a dictionary.

Note that the dictionary must be a non-abridged version for this classmethod to work.

Parameters

data – Dictionary describing the ModifierSet in the following format.

{
'type': 'ModifierSet',
'identifier': str,  # ModifierSet identifier
"display_name": str,  # ModifierSet display name
'wall_set': {},  # WallModifierSet dictionary
'floor_set': {},  # FloorSet dictionary
'roof_ceiling_set': {},  # RoofCeilingModifierSet dictionary
'aperture_set': {},  # ApertureModifierSet dictionary
'door_set': {},  # DoorModifierSet dictionary
'shade_set': {},  # ShadeModifierSet dictionary
'air_boundary_modifier': {},  # AirBoundary dictionary
}
classmethod from_dict_abridged(data, modifier_dict)[source]

Create a ModifierSet from an abridged dictionary.

Parameters
  • data – A ModifierSetAbridged dictionary with the format below.

  • modifier_dict – A dictionary with modifier identifiers as keys and honeybee modifier objects as values. These will be used to assign the 4 to the ModifierSet object.

{
'type': 'ModifierSetAbridged',
'identifier': str,  # ModifierSet identifier
"display_name": str,  # ModifierSet display name
'wall_set': {},  # WallModifierSetAbridged dictionary
'floor_set': {},  # FloorSetAbridged dictionary
'roof_ceiling_set': {},  # RoofCeilingModifierSetAbridged dictionary
'aperture_set': {},  # ApertureModifierSetAbridged dictionary
'door_set': {},  # DoorModifierSetAbridged dictionary
'shade_set': {},  # ShadeModifierSetAbridged dictionary
'air_boundary_modifier': {},  # AirBoundary dictionary
}
get_aperture_modifier(boundary_condition, is_operable, parent_face_type)[source]

Get a modifier object that will be assigned to a given type of aperture.

Parameters
  • boundary_condition – Text string for the boundary condition (eg. ‘Outdoors’, ‘Surface’)

  • is_operable – Boolean to note whether the aperture is operable.

  • parent_face_type – Text string for the type of face to which the aperture is a child (eg. ‘Wall’, ‘Floor’, ‘Roof’).

get_door_modifier(boundary_condition, is_glass, parent_face_type)[source]

Get a modifier object that will be assigned to a given type of door.

Parameters
  • boundary_condition – Text string for the boundary condition (eg. ‘Outdoors’, ‘Surface’).

  • is_glass – Boolean to note whether the door is glass (instead of opaque).

  • parent_face_type – Text string for the type of face to which the door is a child (eg. ‘Wall’, ‘Floor’, ‘Roof’).

get_face_modifier(face_type, boundary_condition)[source]

Get a modifier object that will be assigned to a given type of face.

Parameters
  • face_type – Text string for the type of face (eg. ‘Wall’, ‘Floor’, ‘Roof’, ‘AirBoundary’).

  • boundary_condition – Text string for the boundary condition (eg. ‘Outdoors’, ‘Surface’, ‘Ground’)

get_shade_modifier(is_indoor=False)[source]

Get a modifier object that will be assigned to a shade.

Parameters

is_indoor – A boolean to indicate if the shade is on the indoors or the outdoors of its parent. Default: False.

lock()[source]

The lock() method to will also lock the WallModifierSet, etc.

to_dict(abridged=False, none_for_defaults=True)[source]

Get ModifierSet as a dictionary.

Parameters
  • abridged – Boolean noting whether detailed modifier objects should be written into the ModifierSet (False) or just an abridged version (True). Default: False.

  • none_for_defaults – Boolean to note whether default modifiers in the set should be included in detail (False) or should be None (True). Default: True.

unlock()[source]

The unlock() method will also unlock the WallModifierSet, etc.

property air_boundary_modifier

Get or set a Modifier to be used for all Faces with an AirBoundary face type.

property aperture_set

Get or set the ApertureModifierSet assigned to this ModifierSet.

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 door_set

Get or set the DoorModifierSet assigned to this ModifierSet.

property floor_set

Get or set the FloorModifierSet assigned to this ModifierSet.

property identifier

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

property modified_modifiers

List of all modifiers that are not defaulted within the set.

property modified_modifiers_unique

List of all unique modifiers that are not defaulted within the set.

property modifiers

List of all modifiers contained within the set.

property modifiers_unique

List of all unique modifiers contained within the set.

property roof_ceiling_set

Get or set the RoofCeilingModifierSet assigned to this ModifierSet.

property shade_set

Get or set the ShadeModifierSet assigned to this ModifierSet.

property wall_set

Get or set the WallModifierSet assigned to this ModifierSet.

class honeybee_radiance.modifierset.RoofCeilingModifierSet(*args, **kwargs)[source]

Bases: honeybee_radiance.modifierset._BaseSet

Set containing all radiance modifiers needed to for an radiance model’s roofs.

Properties:
  • exterior_modifier

  • interior_modifier

  • modifiers

  • modified_modifiers

  • is_modified

ToString()

Overwrite .NET ToString.

duplicate()

Get a copy of this set.

classmethod from_dict(data)

Create a SubSet from a dictionary.

Note that the dictionary must be a non-abridged version for this classmethod to work.

Parameters

data – Dictionary describing the Set of the object.

lock()
to_dict(abridged=False, none_for_defaults=True)

Get the ModifierSet as a dictionary.

Parameters
  • abridged – Boolean noting whether detailed modifiers objects should be written into the ModifierSet (False) or just an abridged version (True). Default: False.

  • none_for_defaults – Boolean to note whether default modifiers in the set should be included in detail (False) or should be None (True). Default: True.

unlock()
property exterior_modifier

Get or set the modifier for exterior objects.

property interior_modifier

Get or set the modifier for interior objects.

property is_modified

Boolean noting whether any modifiers are modified from the default.

property modified_modifiers

List of all modifiers that are not defaulted within the set.

property modifiers

List of all modifiers contained within the set.

class honeybee_radiance.modifierset.ShadeModifierSet(*args, **kwargs)[source]

Bases: honeybee_radiance.modifierset._BaseSet

Set containing all radiance modifiers needed to for an radiance model’s Shade.

Properties:
  • exterior_modifier

  • interior_modifier

  • modifiers

  • modified_modifiers

  • is_modified

ToString()

Overwrite .NET ToString.

duplicate()

Get a copy of this set.

classmethod from_dict(data)

Create a SubSet from a dictionary.

Note that the dictionary must be a non-abridged version for this classmethod to work.

Parameters

data – Dictionary describing the Set of the object.

lock()
to_dict(abridged=False, none_for_defaults=True)

Get the ModifierSet as a dictionary.

Parameters
  • abridged – Boolean noting whether detailed modifiers objects should be written into the ModifierSet (False) or just an abridged version (True). Default: False.

  • none_for_defaults – Boolean to note whether default modifiers in the set should be included in detail (False) or should be None (True). Default: True.

unlock()
property exterior_modifier

Get or set the modifier for exterior objects.

property interior_modifier

Get or set the modifier for interior objects.

property is_modified

Boolean noting whether any modifiers are modified from the default.

property modified_modifiers

List of all modifiers that are not defaulted within the set.

property modifiers

List of all modifiers contained within the set.

class honeybee_radiance.modifierset.WallModifierSet(*args, **kwargs)[source]

Bases: honeybee_radiance.modifierset._BaseSet

Set containing all radiance modifiers needed to for an radiance model’s Walls.

Properties:
  • exterior_modifier

  • interior_modifier

  • modifiers

  • modified_modifiers

  • is_modified

ToString()

Overwrite .NET ToString.

duplicate()

Get a copy of this set.

classmethod from_dict(data)

Create a SubSet from a dictionary.

Note that the dictionary must be a non-abridged version for this classmethod to work.

Parameters

data – Dictionary describing the Set of the object.

lock()
to_dict(abridged=False, none_for_defaults=True)

Get the ModifierSet as a dictionary.

Parameters
  • abridged – Boolean noting whether detailed modifiers objects should be written into the ModifierSet (False) or just an abridged version (True). Default: False.

  • none_for_defaults – Boolean to note whether default modifiers in the set should be included in detail (False) or should be None (True). Default: True.

unlock()
property exterior_modifier

Get or set the modifier for exterior objects.

property interior_modifier

Get or set the modifier for interior objects.

property is_modified

Boolean noting whether any modifiers are modified from the default.

property modified_modifiers

List of all modifiers that are not defaulted within the set.

property modifiers

List of all modifiers contained within the set.