.. _street_processors_example:

Image Processors
================

Image processors are modules for determining information from images, e.g. roof shape, occupancy. All image processors have a method **predict(ImageSet)** which will return the information predicted for the ImageSet provided. The following example can be used to test the different processors that utilize street level images of buildings, e.g. NFloorDetector.

.. literalinclude:: brails_street_processors.py
   :language: python
   :linenos:

To run for example the **brails_street_processors.py** script for Berkeley, CA the following would be issued frm a terminal window:

.. code-block::
      
   python3 brails_street_processors.py USA_FootprintScraper "Larkspur, CA" NSFloorDetector

and the application would produce two predictions:

.. literalinclude:: output.txt
   :linenos:   

.. raw:: html

      <table>
       <thead>
        <tr>
         <th>Processor</th>
         <th>Colab Link</th>
        </tr>
      </thead>
      <tbody>
      
          <tr>
            <td>NFloorDetector</td>
            <td><a href=https://colab.research.google.com/github/NHERI-SimCenter/BrailsPlusPlus/blob/master/examples/image_processor/nfloor_detector.ipynb target=_blank> <img src=https://colab.research.google.com/assets/colab-badge.svg/></a> </td>
          </tr>

          <tr>
            <td>NFloorsGPT</td>
            <td><a href=https://colab.research.google.com/github/NHERI-SimCenter/BrailsPlusPlus/blob/master/examples/image_processor/NFloorsGPT.ipynb target=_blank> <img src=https://colab.research.google.com/assets/colab-badge.svg/></a> </td>
          </tr>

	  <tr>
            <td>NFloorsVLM</td>
            <td><a href=https://colab.research.google.com/github/NHERI-SimCenter/BrailsPlusPlus/blob/master/examples/image_processor/NFloorsVLM.ipynb target=_blank> <img src=https://colab.research.google.com/assets/colab-badge.svg/></a> </td>
          </tr>	  

          <tr>
            <td>VLM_Segmenter</td>
            <td><a href=https://colab.research.google.com/github/NHERI-SimCenter/BrailsPlusPlus/blob/master/examples/image_processor/VLM_segmenter.ipynb target=_blank> <img src=https://colab.research.google.com/assets/colab-badge.svg/></a> </td>
          </tr>

          <tr>
            <td>ChimneyDetector</td>
            <td><a href=https://colab.research.google.com/github/NHERI-SimCenter/BrailsPlusPlus/blob/master/examples/image_processor/chimney_detector.ipynb target=_blank> <img src=https://colab.research.google.com/assets/colab-badge.svg/></a> </td>
          </tr>	  
	  
          <tr>
            <td>RoofShapeClassifier</td>
            <td><a href=https://colab.research.google.com/github/NHERI-SimCenter/BrailsPlusPlus/blob/master/examples/image_processor/roof_shape_classifier.ipynb target=_blank> <img src=https://colab.research.google.com/assets/colab-badge.svg/></a> </td>
          </tr>
	  
          <tr>	 
            <td>RoofShapeClassifier</td>
            <td><a href=https://colab.research.google.com/github/NHERI-SimCenter/BrailsPlusPlus/blob/master/examples/image_processor/roof_shape_classifier.ipynb target=_blank> <img src=https://colab.research.google.com/assets/colab-badge.svg/></a> </td>
          </tr>

          <tr>	 
            <td>OccupancyClassifier</td>
            <td><a href=https://colab.research.google.com/github/NHERI-SimCenter/BrailsPlusPlus/blob/master/examples/image_processor/occupancy_classifier.ipynb target=_blank> <img src=https://colab.research.google.com/assets/colab-badge.svg/></a> </td>
          </tr>

          <tr>	 
            <td>YearBuiltClassifier</td>
            <td><a href=https://colab.research.google.com/github/NHERI-SimCenter/BrailsPlusPlus/blob/master/examples/image_processor/year_built_classifier.ipynb target=_blank> <img src=https://colab.research.google.com/assets/colab-badge.svg/></a> </td>
          </tr>	  

	  
     </tbody>
   </table>
	   

.. note::