ladybug_comfort.parameter.utci module¶
Parameters for specifying acceptable thermal conditions using the UTCI model.
- class ladybug_comfort.parameter.utci.UTCIParameter(cold_thresh=None, heat_thresh=None, extreme_cold_thresh=None, very_strong_cold_thresh=None, strong_cold_thresh=None, moderate_cold_thresh=None, moderate_heat_thresh=None, strong_heat_thresh=None, very_strong_heat_thresh=None, extreme_heat_thresh=None)[source]¶
Bases:
ComfortParameter
Parameters of UTCI comfort.
- Parameters:
cold_thresh – UTCI temperature below which conditions represent cold stress [C]. Default: 9C.
heat_thresh – UTCI temperature above which conditions represent heat stress [C]. Default: 26C.
extreme_cold_thresh – UTCI temperature below which conditions represent extreme cold stress [C]. Default: -40C.
very_strong_cold_thresh – UTCI temperature below which conditions represent very strong cold stress [C]. Default: -27C.
strong_cold_thresh – UTCI temperature below which conditions represent strong cold stress [C]. Default: -13C.
moderate_cold_thresh – UTCI temperature below which conditions represent moderate cold stress [C]. Default: 0C.
moderate_heat_thresh – UTCI temperature above which conditions represent moderate heat stress [C]. Default: 28C.
strong_heat_thresh – UTCI temperature above which conditions represent strong heat stress [C]. Default: 32C.
very_strong_heat_thresh – UTCI temperature above which conditions represent very strong heat stress [C]. Default: 38C.
extreme_heat_thresh – UTCI temperature above which conditions represent extreme heat stress [C]. Default: 46C.
- Properties:
cold_thresh
heat_thresh
extreme_cold_thresh
very_strong_cold_thresh
strong_cold_thresh
moderate_cold_thresh
moderate_heat_thresh
strong_heat_thresh
very_strong_heat_thresh
extreme_heat_thresh
- ToString()¶
Overwrite .NET ToString.
- duplicate()¶
Get a copy of this object.
- classmethod from_dict(data)[source]¶
Create a UTCIParameter object from a dictionary.
- Parameters:
data – A UTCIParameter dictionary in following the format below.
{ 'type': 'UTCIParameter', 'cold_thresh': 9, 'heat_thresh': 26, 'extreme_cold_thresh': -40, 'very_strong_cold_thresh': -27, 'strong_cold_thresh': -13, 'moderate_cold_thresh': 0, 'moderate_heat_thresh': 28, 'strong_heat_thresh': 32, 'very_strong_heat_thresh': 38, 'extreme_heat_thresh': 46 }
- classmethod from_string(utci_parameter_string)[source]¶
Create an UTCIParameter object from an PMVParameter string.
- is_comfortable(utci)[source]¶
Determine if conditions are comfortable or not.
- Values are one of the following:
0 = uncomfortable 1 = comfortable
- original_utci_category(utci)[source]¶
Determine the category according to the original UTCI assessment scale.
Glossary of Terms for Thermal Physiology (2003). Journal of Thermal Biology 28, 75-106
Values are one of the following:
0 = extreme cold stress
1 = very strong cold stress
2 = strong cold stress
3 = moderate cold stress
4 = slight cold stress
5 = no thermal stress
6 = moderate heat stress
7 = strong heat stress
8 = strong heat stress
9 = extreme heat stress
- thermal_condition(utci)[source]¶
Determine whether conditions are cold, neutral or hot.
Values are one of the following:
-1 = cold
0 = netural
+1 = hot
- thermal_condition_eleven_point(utci)[source]¶
Determine the thermal condition on an eleven-point scale.
Values are one of the following:
-5 = extreme cold stress
-4 = very strong cold stress
-3 = strong cold stress
-2 = moderate cold stress
-1 = slight cold stress
0 = no thermal stress
+1 = slight heat stress
+2 = moderate heat stress
+3 = strong heat stress
+4 = very strong heat stress
+5 = extreme heat stress
- thermal_condition_five_point(utci)[source]¶
Determine the thermal condition on a five-point scale.
Values are one of the following:
-2 = strong/extreme cold stress
-1 = moderate cold stress
0 = no thermal stress
+1 = moderate heat stress
+2 = strong/extreme heat stress
- thermal_condition_nine_point(utci)[source]¶
Determine the thermal condition on a nine-point scale.
Values are one of the following:
-4 = very strong/extreme cold stress
-3 = strong cold stress
-2 = moderate cold stress
-1 = slight cold stress
0 = no thermal stress
+1 = slight heat stress
+2 = moderate heat stress
+3 = strong heat stress
+4 = very strong/extreme heat stress
- thermal_condition_seven_point(utci)[source]¶
Determine the thermal condition on a seven-point scale.
Values are one of the following:
-3 = very strong/extreme cold stress
-2 = strong cold stress
-1 = moderate cold stress
0 = no thermal stress
+1 = moderate heat stress
+2 = strong heat stress
+3 = very strong/extreme heat stress
- property cold_thresh¶
UTCI temperature below which conditions represent cold stress [C].
Default: 9C.
- property comfort_model¶
Return the name of the comfort model to which the parameters belong.
- property extreme_cold_thresh¶
UTCI temperature below which conditions represent extreme cold stress [C].
Default: -40C.
- property extreme_heat_thresh¶
UTCI temperature above which conditions represent extreme heat stress [C].
Default: 46C.
- property heat_thresh¶
UTCI temperature above which conditions represent heat stress [C].
Default: 26C.
- property moderate_cold_thresh¶
UTCI temperature below which conditions represent moderate cold stress [C].
Default: 0C.
- property moderate_heat_thresh¶
UTCI temperature above which conditions represent moderate heat stress [C].
Default: 28C.
- property strong_cold_thresh¶
UTCI temperature below which conditions represent strong cold stress [C].
Default: -13C.
- property strong_heat_thresh¶
UTCI temperature above which conditions represent strong heat stress [C].
Default: 32C.
- property very_strong_cold_thresh¶
UTCI temperature below which conditions represent very strong cold stress [C].
Default: -27C.
- property very_strong_heat_thresh¶
UTCI temperature above which conditions represent very strong heat stress [C].
Default: 38C.