====== CanoPy user manual ======

[[CanoPy:]] is the Python module for [[:GFC canopy assessment|the Georgia Canopy Analysis 2009 project]] sponsored by [[http://www.gfc.state.ga.us/|the Georgia Forestry Commission (GFC)]]. For further information about this project, please refer to the [[CanoPy:]] page.

This document explains how to use the [[CanoPy:]] module. For technical details, please read the [[technical manual]]. Also refer to the [[tutorial]].

===== Authors =====

  * [[:Huidae Cho]], Ph.D.
  * [[:Owen Smith]]

===== Requirements =====

  * ArcGIS Desktop 10.x
  * ArcPy
  * Python 2 standard module: os
  * Feature Analyst(tm) by the Textron Systems
  * Automated Feature Extraction (AFE) models trained using Feature Analyst

We are currently planning on developing a fully open source solution without using ArcGIS and Feature Analyst.

===== How to use the CanoPy module =====

  - Clone the [[https://github.com/HuidaeCho/canopy|CanoPy GitHub repository]]<code>
git clone https://github.com/HuidaeCho/canopy.git
</code>
  - Copy ''canopy_config-example.py'' to ''canopy_config.py''
  - Edit ''canopy_config.py'' to recognize your layers and folder structures
  - Start ArcMap
  - Add Physiographic_Districts_GA.shp. Its layer name is ''phyregs_layer'' in ''canopy_config.py''
  - Add naip_ga_2009_1m_m4b.shp. Its layer name is ''naipqq_layer'' in ''canopy_config.py''
  - Open the Python window from within ArcMap
  - Import the canopy module<code python>
import sys
sys.path.append('C:/path/to/the/canopy/module')
import canopy
</code>
  - Assign physiographic region IDs to the naipqq layer<code python>
canopy.assign_phyregs_to_naipqq()
</code>
  - Add physiographic region IDs to process to ''phyreg_ids''<code python>
phyreg_ids = [8, 7]
</code>
  - Reproject original NAIP QQ tiles to the target projection<code python>
canopy.reproject_naip_tiles(phyreg_ids)
</code>
  - Run trained AFE models to classify canopy and non-canopy cells
  - Convert AFE output files to the final seamless canopy GeoTIFF file per physiographic region<code python>
canopy.convert_afe_to_canopy_tiff(phyreg_ids)
</code>

{{tag>software}}