Skip to content

Commit

Permalink
fmk - more text about footprints
Browse files Browse the repository at this point in the history
  • Loading branch information
fmckenna committed Nov 8, 2024
1 parent 6f09dfa commit 3777bdc
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 7 deletions.
12 changes: 10 additions & 2 deletions docs/_sources/examples/footprint/footprint.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ To run the example provided contained in a file example.py for for a "Berkeley,
python3 brails_footprint.py "Berkeley, CA"
The example will print out the number of buildings obtained for each scraper. They are typically different. This is because they are developed from different data sources and using different techniques.
The example will print out the number of buildings obtained for each scraper.

.. code-block::
Expand All @@ -33,8 +33,16 @@ The example will print out the number of buildings obtained for each scraper. Th
USA 28404
---------------------------
The example when run will also prints out a two inventory subset of the data obtained. The data is different, and depending on the actual building information present in OSM can contain data fields or be empty.
The example when run will also prints out a two inventory subset of the data obtained for each footprint scraper. As shown below, the features obtained for each of the assets is different between scrapers.

.. literalinclude:: output.txt
:linenos:

.. note::

#. The number of buildings differs across datasets due to variations in data sources, processing techniques, geographic coverage, and update frequency. Since no dataset is perfect, users are encouraged to compare building inventories from different datasets for their area of interest by overlaying them with satellite imagery for accuracy.
#. OSM is a **community-driven** platform where volunteers manually contribute building footprints using ground surveys, GPS data, and licensed aerial imagery. This results in variable data quality depending on the region and contributor activity, with a particularly active community in non-urban areas. The results may contain **NA** values for buildings for which community has yet to provide data.
#. OSM offers global coverage, Microsoft’s data is expanding internationally, and USA Structures is limited to the United States.
#. OSM is updated in real time by contributors, Microsoft’s data is updated periodically, and USA Structures updates are infrequent.


13 changes: 11 additions & 2 deletions docs/examples/footprint/footprint.html
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python3</span> <span class="n">brails_footprint</span><span class="o">.</span><span class="n">py</span> <span class="s2">&quot;Berkeley, CA&quot;</span>
</pre></div>
</div>
<p>The example will print out the number of buildings obtained for each scraper. They are typically different. This is because they are developed from different data sources and using different techniques.</p>
<p>The example will print out the number of buildings obtained for each scraper.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">---------------------------</span>
<span class="n">Scraper</span> <span class="c1"># building</span>
<span class="o">---------------------------</span>
Expand All @@ -214,7 +214,7 @@
<span class="o">---------------------------</span>
</pre></div>
</div>
<p>The example when run will also prints out a two inventory subset of the data obtained. The data is different, and depending on the actual building information present in OSM can contain data fields or be empty.</p>
<p>The example when run will also prints out a two inventory subset of the data obtained for each footprint scraper. As shown below, the features obtained for each of the assets is different between scrapers.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="n">Small</span> <span class="n">Subset</span> <span class="n">of</span> <span class="n">USA</span> <span class="n">Inventory</span><span class="p">:</span>
<span class="linenos"> 2</span><span class="n">AssetInventory</span>
<span class="linenos"> 3</span><span class="n">Inventory</span> <span class="n">stored</span> <span class="ow">in</span><span class="p">:</span> <span class="nb">dict</span>
Expand Down Expand Up @@ -248,6 +248,15 @@
<span class="linenos">31</span> <span class="n">Features</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;type&#39;</span><span class="p">:</span> <span class="s1">&#39;Building&#39;</span><span class="p">,</span> <span class="s1">&#39;buildingheight&#39;</span><span class="p">:</span> <span class="mf">19.1</span><span class="p">,</span> <span class="s1">&#39;fpAreas&#39;</span><span class="p">:</span> <span class="mi">1675</span><span class="p">}</span>
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<ol class="arabic simple">
<li><p>The number of buildings differs across datasets due to variations in data sources, processing techniques, geographic coverage, and update frequency. Since no dataset is perfect, users are encouraged to compare building inventories from different datasets for their area of interest by overlaying them with satellite imagery for accuracy.</p></li>
<li><p>OSM is a <strong>community-driven</strong> platform where volunteers manually contribute building footprints using ground surveys, GPS data, and licensed aerial imagery. This results in variable data quality depending on the region and contributor activity, with a particularly active community in non-urban areas. The results may contain <strong>NA</strong> values for buildings for which community has yet to provide data.</p></li>
<li><p>OSM offers global coverage, Microsoft’s data is expanding internationally, and USA Structures is limited to the United States.</p></li>
<li><p>OSM is updated in real time by contributors, Microsoft’s data is updated periodically, and USA Structures updates are infrequent.</p></li>
</ol>
</div>
</section>


Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js

Large diffs are not rendered by default.

12 changes: 10 additions & 2 deletions examples/footprint/footprint.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ To run the example provided contained in a file example.py for for a "Berkeley,
python3 brails_footprint.py "Berkeley, CA"
The example will print out the number of buildings obtained for each scraper. They are typically different. This is because they are developed from different data sources and using different techniques.
The example will print out the number of buildings obtained for each scraper.

.. code-block::
Expand All @@ -33,8 +33,16 @@ The example will print out the number of buildings obtained for each scraper. Th
USA 28404
---------------------------
The example when run will also prints out a two inventory subset of the data obtained. The data is different, and depending on the actual building information present in OSM can contain data fields or be empty.
The example when run will also prints out a two inventory subset of the data obtained for each footprint scraper. As shown below, the features obtained for each of the assets is different between scrapers.

.. literalinclude:: output.txt
:linenos:

.. note::

#. The number of buildings differs across datasets due to variations in data sources, processing techniques, geographic coverage, and update frequency. Since no dataset is perfect, users are encouraged to compare building inventories from different datasets for their area of interest by overlaying them with satellite imagery for accuracy.
#. OSM is a **community-driven** platform where volunteers manually contribute building footprints using ground surveys, GPS data, and licensed aerial imagery. This results in variable data quality depending on the region and contributor activity, with a particularly active community in non-urban areas. The results may contain **NA** values for buildings for which community has yet to provide data.
#. OSM offers global coverage, Microsoft’s data is expanding internationally, and USA Structures is limited to the United States.
#. OSM is updated in real time by contributors, Microsoft’s data is updated periodically, and USA Structures updates are infrequent.


0 comments on commit 3777bdc

Please sign in to comment.