ladybug_radiance.visualize.radrose module

Class for visualizing the impact of radiation from different direction as a rose.

class ladybug_radiance.visualize.radrose.RadiationRose(sky_matrix, intersection_matrix=None, direction_count=36, tilt_angle=0, legend_parameters=None, plot_irradiance=False, center_point=Point3D(0.00, 0.00, 0.00), radius=100, arrow_scale=1)[source]

Bases: object

Visualize the impact of radiation from different direction as a rose.

By default, the Radiation Rose depicts the amount of solar energy received by a vertical wall facing each of the directions of the compass rose. This is useful for understanding the radiation harm/benefit experienced by different building orientations or the orientations with the highest peak cooling load (for sky matrices of clear skies). The tilt_angle can be used to assess the solar energy falling on geometries that are not perfectly vertical, such as a tilted photovoltaic panel.

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 rose. The matrix should have a length equal to the direction_count and begin from north moving clockwise. Each sub-list should consist of booleans and have a length equal to the number of sky patches times 2 (indicating sky patches and ground patches). True indicates that a certain patch is seen and False indicates that the match is blocked. If None, the radiation rose will be computed assuming no obstructions. (Default: None).

  • direction_count – An integer greater than or equal to 3, which notes the number of arrows to be generated for the radiation rose. (Default: 36).

  • tilt_angle – A number between 0 and 90 that sets the vertical tilt angle (aka. the altitude) for all of the directions. By default, the Radiation Rose depicts the amount of solar energy received by a vertical wall (tilt_angle=0). The tilt_angle can be changed to a specific value to assess the solar energy falling on geometries that are not perfectly vertical, such as a tilted photovoltaic panel. (Default: 0).

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

  • plot_irradiance – Boolean to note whether the radiation rose 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 rose. (Default: (0, 0, 0)).

  • radius – A number to set the radius of the radiation rose. (Default: 100).

  • arrow_scale – A fractional number to note the scale of the radiation rose arrows in relation to the entire graphic. (Default: 1).

Properties:

  • direction_count

  • tilt_angle

  • legend_parameters

  • plot_irradiance

  • center_point

  • radius

  • arrow_scale

  • north

  • direction_vectors

  • total_values

  • direct_values

  • diffuse_values

  • metadata

  • is_benefit

ToString()[source]

Overwrite .NET ToString.

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

Draw an arrow mesh, orientation lines, 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 rose. This is useful when rendering all of the sky components together and one rose should not be on top of another. If None, the center point assigned to the object instance is used. (Default: None).

  • max_rad – An optional number to set the level of radiation or irradiance associated with the full radius of the rose. If None, this is determined by the maximum level of radiation in the input data but a number can be specified here to fix this at a specific value. This is particularly useful when comparing different roses to one another. (Default: None).

Returns:

A tuple with five values.

  • arrow_mesh – A colored Mesh3D for the rose arrows.

  • orientation_lines – A list of LineSegment3D for each direction.

  • compass – A ladybug Compass object for the rose.

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

  • rose_title – Text for the title of the rose.

static radial_vectors(direction_count, tilt_angle=0)[source]

Generate a list of radial vectors.

property arrow_scale

Get a number for the scale of arrows on the radiation rose.

property center_point

Get a Point3D for the center of the radiation rose.

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_count

Get the number of directions for the radiation rose.

property direction_vectors

Get a list of vectors for each of the directions the rose is facing.

All vectors are unit vectors.

property is_benefit

Boolean to note whether the sky matrix includes benefit information.

property legend_parameters

Get the legend parameters assigned to this radiation rose object.

property metadata

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

property north

Get a number north direction.

property plot_irradiance

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

property radius

Get a number for the radius of the radiation rose.

property tilt_angle

Get the angle of the radiation rose vertical tilt in degrees.

property total_values

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