ladybug_comfort.chart.polygonutci module

Object for plotting an UTCI comfort polygon on a Psychrometric Chart.

class ladybug_comfort.chart.polygonutci.PolygonUTCI(psychrometric_chart, rad_temperature=None, wind_speed=None, comfort_parameter=None)[source]

Bases: object

Object to plot an UTCI comfort polygon on a Psychrometric Chart.

Parameters

  • psychrometric_chart – A ladybug-core PsychrometricChart object on which the UTCI comfort polygon will be plot.

  • rad_temperature – A list of numbers for the mean radiant temperature in Celsius. If None, a polygon for operative temperature will be plot, assuming that radiant temperature and air temperature are the same. (Default: None).

  • wind_speed – A list of numbers for the meteorological wind speed values in m/s (measured 10 m above the ground). If None, this will default to a low wind speed of 0.5 m/s, which is the lowest input speed that is recommended for the UTCI model.

  • comfort_parameter – Optional UTCIParameter object to specify parameters under which conditions are considered acceptable. If None, default will assume comfort thresholds consistent with those used by meteorologists to categorize outdoor conditions.

Properties:

  • psychrometric_chart

  • rad_temperature

  • wind_speed

  • comfort_parameter

  • polygon_count

  • left_comfort_lines

  • right_comfort_lines

  • left_comfort_line

  • right_comfort_line

  • comfort_polygons

  • merged_comfort_polygon

  • comfort_values

  • comfort_data

  • merged_comfort_values

  • merged_comfort_data

  • is_comfort_too_hot

  • is_comfort_too_cold

  • very_strong_cold_polygon

  • strong_cold_polygon

  • moderate_cold_polygon

  • moderate_heat_polygon

  • strong_heat_polygon

  • very_strong_heat_polygon

ToString()[source]

Overwrite .NET ToString.

comfort_polylines(polygon_index)[source]

Get the left and right Polyline2D that define a UTCI polygon comfort range.

Parameters

polygon_index – Integer for the comfort polygon for which min and max temperature will be computed.

Returns

The left and right Polyline2D that define the comfort range.

create_collection(value_list, polygon_name=None)[source]

Create a data collection of comfort data values from a list of values.

Parameters

  • value_list – A list of data that align with the number of points in the underlying psychrometric chart

  • polygon_name – An optional name to be used to create to the data collection metadata.

evaluate_inside(left, right, polygon_name=None)[source]

Get a data collection for polygon inclusion from left and right polylines.

This will be a single 0 or 1 if there is only one value plotted on the chart.

Parameters

  • left – A Polyline2D for the left of the polygon.

  • right – A Polyline2D for the right of the polygon.

  • polygon_name – An optional name to be used to create to the data collection metadata.

max_min_air_temperatures(polygon_index, rel_humid)[source]

Get the max and min air temperature for a comfort polygon at a relative humid.

Parameters

  • polygon_index – Integer for the comfort polygon for which min and max temperature will be computed.

  • rel_humid – A list of relative humidity values for which air temperature will be computed.

Returns

A list of tuples where each tuple contains two air temperature values in Celsius. The first air temperature is the minimum temperature that meets the PPD threshold. The second is the maximum that meets the PPD threshold

stress_polyline(stress_temperature)[source]

Get a Polyline2D that defines a specific UTCI value,.

Used to construct stress polygons.

Parameters

stress_temperature – Number in degrees Celsius for the UTCI value of the given stress threshold line to be computed.

Returns

A Polyline2D that define the comfort range.

DELTA_TEMP_TYPE = Temperature Delta
POLYGON_INCLUSION_TYPE = Polygon Inclusion
TEMP_TYPE = Temperature
property comfort_data

A tuple of data collections or 0/1 values for each of the comfort polygons.

property comfort_parameter

UTCI comfort parameters that are assigned to this object.

property comfort_polygons

A tuple of tuples where each sub-tuple defines one comfort polygon.

Sub-tuple comfort polygons consist of four or five Polyline2D or LineSegment2D that are ordered as follows (left, bottom, right, top).

property comfort_values

A tuple of tuples with each sub-tuple representing one of comfort polygons.

Each sub-tuple contains 0/1 values for whether the point is inside the comfort polygon or not.

property is_comfort_too_cold

Boolean to note whether comfort polygons are off the chart on the cold side.

property is_comfort_too_hot

Boolean to note whether comfort polygons are off the chart on the hot side.

property left_comfort_line

A single Polyline2D for the left of the merged comfort polygons.

property left_comfort_lines

Tuple of Polyline2D for the left of the comfort polygons.

property merged_comfort_data

A data collection or 0/1 for whether the data is in merged comfort polygon.

property merged_comfort_polygon

A tuple of Polyline2D or LineSegment2D that define the merged comfort polygon.

Comfort polygon consists of four or five Polyline2D or LineSegment2D that are ordered as follows (left, bottom, right, top).

property merged_comfort_values

A tuple of 0/1 for whether each point is in the merged comfort polygon or not.

property moderate_cold_polygon

A tuple of Polyline2D or LineSegment2D for the moderate cold polygon.

property moderate_heat_polygon

A tuple of Polyline2D or LineSegment2D for the moderate heat polygon.

property polygon_count

Integer for the number of comfort polygons contained on the object.

property psychrometric_chart

The ladybug PsychrometricChart object on which the polygons are plot.

property rad_temperature

Tuple of mean radiant temperature (MRT) values in degrees C.

None indicates that the radiant temperature is the same as the air temperature.

property right_comfort_line

A single Polyline2D for the right of the merged comfort polygons.

property right_comfort_lines

Tuple of Polyline2D for the right of the comfort polygons.

property strong_cold_polygon

A tuple of Polyline2D or LineSegment2D for the strong cold polygon.

property strong_heat_polygon

A tuple of Polyline2D or LineSegment2D for the strong heat polygon.

property very_strong_cold_polygon

A tuple of Polyline2D or LineSegment2D for the very strong cold polygon.

property very_strong_heat_polygon

A tuple of Polyline2D or LineSegment2D for the very strong heat polygon.

property wind_speed

Tuple of meteorological wind speed values in m/s.