ladybug_radiance.visualize.skydome module

Class for visualizing sky matrices on a dome.

class ladybug_radiance.visualize.skydome.SkyDome(sky_matrix, legend_parameters=None, plot_irradiance=False, center_point=Point3D(0.00, 0.00, 0.00), radius=100, projection=None)[source]

Bases: object

Visualize a sky matrix as a colored dome, subdivided into patches.

Parameters:

  • sky_matrix – A SkyMatrix object, which describes the radiation coming from the various patches of the sky.

  • legend_parameters – An optional LegendParameter object to change the display of the sky dome. If None, some default legend parameters will be used. (Default: None).

  • plot_irradiance – Boolean to note whether the sky dome should be plotted with units of total Radiation (kWh/m2) [False] or with units of average Irradiance (W/m2) [True]. (Default: False).

  • center_point – A point for the center of the dome. (Default: (0, 0, 0)).

  • radius – A number to set the radius of the sky dome. (Default: 100).

  • projection –

    Optional text for the name of a projection to use from the sky dome hemisphere to the 2D plane. If None, a 3D sky dome will be drawn instead of a 2D one. (Default: None) Choose from the following.

    • Orthographic

    • Stereographic

Properties:

  • legend_parameters

  • plot_irradiance

  • center_point

  • radius

  • projection

  • north

  • patch_vectors

  • total_values

  • direct_values

  • diffuse_values

  • metadata

  • is_benefit

ToString()[source]

Overwrite .NET ToString.

draw(rad_type='total', center=None)[source]

Draw a dome mesh, compass, graphic/legend, and title for the sky dome.

Parameters:

  • rad_type – Text for the type of radiation to use. Choose from total, direct, diffuse. (Default: total).

  • center – A Point3D to override the center of the sky dome. This is useful when rendering all of the sky components together and one dome should not be on top of another. If None, the center point assigned to the object instance is used. (Default: None).

Returns:

A tuple with five values.

  • dome_mesh – A colored Mesh3D for the dome.

  • dome_compass – A ladybug Compass object for the dome.

  • graphic – A GraphicContainer for the colored dome mesh, indicating the legend and title location for the dome.

  • dome_title – Text for the title of the dome.

  • values – A list of radiation values that align with the dome_mesh faces.

PROJECTIONS = ('Orthographic', 'Stereographic')
property center_point

Get a Point3D for the center of the dome.

property diffuse_values

Get a tuple of values for the diffuse radiation/irradiance of each patch.

property direct_values

Get a tuple of values for the direct radiation/irradiance of each patch.

property is_benefit

Boolean to note whether the sky matrix includes benefit information.

property legend_parameters

Get the legend parameters assigned to this sky dome object.

property metadata

Get a tuple of information about the metadata assigned to the sky dome.

property north

Get a number north direction.

property patch_vectors

Get a list of vectors for each of the patches of the sky dome.

All vectors are unit vectors and point from the center towards each of the patches. They can be used to construct visualizations of the rays used to perform radiation analysis.

property plot_irradiance

Get a boolean for whether the sky dome values are for irradiance in (W/m2).

property projection

Get text for the projection of the dome.

property radius

Get a number for the radius of the dome.

property total_values

Get a tuple of values for the total radiation/irradiance of each patch.