---

title: Uhi


keywords: fastai
sidebar: home_sidebar

summary: "API details."
description: "API details."
nb_path: "01_uhi.ipynb"
---
<!--

#################################################
### THIS FILE WAS AUTOGENERATED! DO NOT EDIT! ###
#################################################
# file to edit: 01_uhi.ipynb
# command to build the docs after a change: nbdev_build_docs

-->

<div class="container" id="notebook-container">
        
    {% raw %}
    
<div class="cell border-box-sizing code_cell rendered">

</div>
    {% endraw %}

    {% raw %}
    
<div class="cell border-box-sizing code_cell rendered">

</div>
    {% endraw %}

    {% raw %}
    
<div class="cell border-box-sizing code_cell rendered">

<div class="output_wrapper">
<div class="output">

<div class="output_area">


<div class="output_markdown rendered_html output_subarea ">
<h2 id="Uhi" class="doc_header"><code>class</code> <code>Uhi</code><a href="https://github.com/raguileoam/ufro_uhi_plot/tree/master/ufro_uhi_plot/uhi.py#L16" class="source_link" style="float:right">[source]</a></h2><blockquote><p><code>Uhi</code>(<strong><code>path_file</code></strong>, <strong><code>station_label</code></strong>, <strong><code>datetime_label</code></strong>, <strong><code>temperature_label</code></strong>, <strong><code>latitude_label</code></strong>, <strong><code>longitude_label</code></strong>)</p>
</blockquote>
<p>Represents an image(s) of urban heat island(s)</p>
<p>Attributes:
  path_file: string
  station_label: string
  datetime_label: string
  temperature_label: string
  latitude_label: string
  longitude_label: string</p>

</div>

</div>

</div>
</div>

</div>
    {% endraw %}

    {% raw %}
    
<div class="cell border-box-sizing code_cell rendered">

<div class="output_wrapper">
<div class="output">

<div class="output_area">


<div class="output_markdown rendered_html output_subarea ">
<h2 id="OtherDf" class="doc_header"><code>class</code> <code>OtherDf</code><a href="https://github.com/raguileoam/ufro_uhi_plot/tree/master/ufro_uhi_plot/uhi.py#L128" class="source_link" style="float:right">[source]</a></h2><blockquote><p><code>OtherDf</code>(<strong><code>df</code></strong>, <strong><code>id</code></strong>, <strong><code>name</code></strong>)</p>
</blockquote>

</div>

</div>

</div>
</div>

</div>
    {% endraw %}

    {% raw %}
    
<div class="cell border-box-sizing code_cell rendered">

<div class="output_wrapper">
<div class="output">

<div class="output_area">


<div class="output_markdown rendered_html output_subarea ">
<h2 id="Util" class="doc_header"><code>class</code> <code>Util</code><a href="https://github.com/raguileoam/ufro_uhi_plot/tree/master/ufro_uhi_plot/uhi.py#L134" class="source_link" style="float:right">[source]</a></h2><blockquote><p><code>Util</code>()</p>
</blockquote>

</div>

</div>

</div>
</div>

</div>
    {% endraw %}

    {% raw %}
    
<div class="cell border-box-sizing code_cell rendered">

</div>
    {% endraw %}

    {% raw %}
    
<div class="cell border-box-sizing code_cell rendered">

<div class="output_wrapper">
<div class="output">

<div class="output_area">


<div class="output_markdown rendered_html output_subarea ">
<h4 id="Uhi.plotImagesPerDaysArray" class="doc_header"><code>Uhi.plotImagesPerDaysArray</code><a href="https://github.com/raguileoam/ufro_uhi_plot/tree/master/ufro_uhi_plot/uhi.py#L81" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>Uhi.plotImagesPerDaysArray</code>(<strong><code>outputFolder</code></strong>, <strong><code>daysArray</code></strong>, <strong><code>extent</code></strong>, <strong><code>hasBorders</code></strong>=<em><code>None</code></em>, <strong><code>hasLimits</code></strong>=<em><code>False</code></em>, <strong><code>transects</code></strong>=<em><code>[]</code></em>, <strong><code>Z_UNIT</code></strong>=<em><code>'°C'</code></em>, <strong><code>otherDf_id</code></strong>=<em><code>None</code></em>, <strong><code>otherDf_name</code></strong>=<em><code>None</code></em>, <strong><code>mapbox_username</code></strong>=<em><code>''</code></em>, <strong><code>mapbox_token</code></strong>=<em><code>''</code></em>, <strong><code>prefixFile</code></strong>=<em><code>''</code></em>, <strong><code>hasImage</code></strong>=<em><code>True</code></em>, <strong><code>hasScaleBar</code></strong>=<em><code>True</code></em>, <strong><code>hasCompassRose</code></strong>=<em><code>True</code></em>, <strong><code>hasLegend</code></strong>=<em><code>True</code></em>, <strong><code>hasColorbar</code></strong>=<em><code>True</code></em>, <strong><code>transparency</code></strong>=<em><code>0.7</code></em>, <strong><code>showPoints</code></strong>=<em><code>False</code></em>, <strong><code>contour</code></strong>=<em><code>'contourLine'</code></em>, <strong><code>drawMinMaxT</code></strong>=<em><code>False</code></em>)</p>
</blockquote>
<p>Input:
outputFolder: string of folder where the images of urban heat islands are saved.
daysArray: array of strings of days to plot the urban heat islands.
extent: array of 4 coordinates of the extent of the map.
hasBorders: geojson to border the urban heat island in a map. (default:None)
hasLimits: (default:False)
transects: (default:[])
Z_UNIT: unit of measure to be displayed in colobar. (default: '°C')
otherDf_id: id of the temperature station that will not be included in the UHI's triangulation but will be displayed. (default: None)
otherDf_name: name of the temperature station that will not be included in the UHI's triangulation but will be displayed. (default: None)
mapbox_username: mapbox's username to plot background map. (default: '')
mapbox_token: mapbox's token to plot background map. (default: '')
prefixFile: string of the output prefix filename. (default:'')
hasImage: boolean that decides if the image needs a Mapbox Map or not.
hasScaleBar: boolean that decides if the image needs a Scaler Bar or not.
hasCompassRose: boolean that decides if the image needs a Compass Rose or not.
hasLegend: boolean that decides if the image neede a Legend or not.
hasColorbar: boolean that decides if the image needs a color bar or not.
transparency: trasparency of the UHI's triangulation.
showPoints: boolean that decisdes if the image needs show station points.
contour:
drawMinMaxT:
Output: None</p>

</div>

</div>

</div>
</div>

</div>
    {% endraw %}

</div>