dragonfly_radiance.properties.room2d module¶

Room2D Radiance Properties.

class dragonfly_radiance.properties.room2d.Room2DRadianceProperties(host, modifier_set=None, grid_parameters=None)[source]¶

Bases: object

Radiance Properties for Dragonfly Room2D.

Parameters

host – A dragonfly_core Room2D object that hosts these properties.
modifier_set – A honeybee ModifierSet object to specify all default modifiers for the Faces of the Room2D. If None, the Room2D will use the honeybee default modifier set, which is only representative of typical indoor conditions in the visible spectrum. (Default: None).
grid_parameters – An optional list of GridParameter objects to describe how sensor grids should be generated for the Room2D. (Default: None).

Properties:

add_grid_parameter(grid_parameter)[source]¶

Add a GridParameter to this Room2D.

Parameters: grid_parameter – An GridParameter objects to describe how sensor grids should be generated for the Room2D.

apply_properties_from_dict(abridged_data, modifier_sets)[source]¶

Apply properties from a Room2DRadiancePropertiesAbridged dictionary.

Parameters

abridged_data – A Room2DRadiancePropertiesAbridged dictionary (typically coming from a Model).
modifier_sets – A dictionary of ModifierSets with identifiers of the sets as keys, which will be used to re-assign modifier_sets.

duplicate(new_host=None)[source]¶

Get a copy of this object.

Parameters: new_host – A new Room2D object that hosts these properties. If None, the properties will be duplicated with the same host.

classmethod from_dict(data, host)[source]¶

Create Room2DRadianceProperties from a dictionary.

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

Parameters

data – A dictionary representation of Room2DRadianceProperties in the format below.
host – A Room2D object that hosts these properties.

{
"type": 'Room2DRadianceProperties',
"modifier_set": {},  # A ModifierSet dictionary
"grid_parameters": []  # A list of GridParameter dictionaries
}

from_honeybee(hb_properties)[source]¶

Transfer radiance attributes from a Honeybee Room to Dragonfly Room2D.

Parameters: hb_properties – The RoomRadianceProperties of the honeybee Room that is being translated to a Dragonfly Room2D.

remove_grid_parameters()[source]¶: Remove all grid_parameters from the Room2D.

to_dict(abridged=False)[source]¶

Return Room2D radiance properties as a dictionary.

Parameters: abridged – Boolean for whether the full dictionary of the Room2D should be written (False) or just the identifier of the the individual properties (True). Default: False.

to_honeybee(new_host)[source]¶

Get a honeybee version of this object.

Parameters: new_host – A honeybee-core Room object that will host these properties.

property grid_parameters¶: Get or set a list of GridParameters to generate sensor grids for the room.

property modifier_set¶

Get or set the Room2D ModifierSet object.

If not set, it will be set by the parent Story or will be the Honeybee default generic ModifierSet.