ladybug_radiance.visualize.raddome module

Class for visualizing the impact of radiation from different directions over a dome.

class ladybug_radiance.visualize.raddome.RadiationDome(sky_matrix, intersection_matrix=None, azimuth_count=72, altitude_count=18, legend_parameters=None, plot_irradiance=False, center_point=Point3D(0.0, 0.0, 0.0), radius=100, projection=None)[source]

Bases: object

Visualize the radiation falling from different directions over a dome.

The Radiation Dome depicts the amount of solar energy received by all directions over a dome. This is useful for understanding the optimal orientation of solar panels and how the performance of the panel will be impacted if it’s orientation is off from the optimal position. It can also be used to identify the optimal wall orientation for passive solar heating when used with skies of radiation harm/benefit. When used with clear sky matrices, it can identify the orientations that result in the highest and lowest peak cooling load.

Parameters

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

  • intersection_matrix – An optional lists of lists, which can be used to account for context shade surrounding the radiation dome. The matrix should have a length equal to the (azimuth_count * altitude_count) + 1 and begin from north moving clockwise, continuing up the dome with each revolution. The last vector refers to a perfectly vertical orientation. Each sub-list should consist of booleans and have a length equal to the number of sky patches times 2 (indicating sky patches followed by ground patches). True indicates that a certain patch is seen and False indicates that the match is blocked. If None, the radiation dome will be computed assuming no obstructions. (Default: None).

  • azimuth_count – An integer greater than or equal to 3, which notes the number of horizontal orientations to be evaluated on the dome. (Default: 72).

  • altitude_count – An integer greater than or equal to 3, which notes the number of vertical orientations to be evaluated on the dome. (Default: 18).

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

  • plot_irradiance – Boolean to note whether the radiation 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 radiation 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:

  • azimuth_count

  • altitude_count

  • legend_parameters

  • plot_irradiance

  • center_point

  • radius

  • projection

  • north

  • direction_vectors

  • dome_mesh

  • total_values

  • direct_values

  • diffuse_values

  • metadata

  • is_benefit

ToString()[source]

Overwrite .NET ToString.

static dome_vectors(azimuth_count, altitude_count)[source]

Generate a list of vectors over the dome.

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

Draw an dome mesh, compass, graphic/legend, and title.

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 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 colored Mesh3D for the dome radiation. compass: A ladybug Compass object for the dome. graphic: A GraphicContainer for the colored arrow mesh, indicating the

legend and title location for the dome.

dome_title: Text for the title of the dome.

Return type

dome_mesh

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

Get the number of vertical directions for the radiation dome.

property azimuth_count

Get the number of horizontal orientations for the radiation dome.

property center_point

Get a Point3D for the center of the radiation dome.

property diffuse_values

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

property direct_values

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

property direction_vectors

Get a list of vectors for each of the directions the dome is evaluating.

All vectors are unit vectors.

property dome_mesh

Get a Mesh3D of the radiation dome with the center point and radius.

This dome will be properly oriented to the north of the input sky matrix but it will not have any colors assigned to it.

property is_benefit

Boolean to note whether the sky matrix includes benefit information.

property legend_parameters

Get the legend parameters assigned to this radiation dome object.

property max_direction

Get a the direction with the maximum total radiation/irradiance.

property max_info

Get a text string with information about the maximum radiation/irradiance.

This includes the altitude, azimuth, and radiation/irradiance value.

property max_point

Get a point on the dome with the maximum total radiation/irradiance.

property metadata

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

property north

Get a number north direction.

property plot_irradiance

Get a boolean for whether the 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 radiation dome.

property total_values

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