GenerateLandcoverMaps Namespace Reference

Import landcover raster maps into a GRASS location and generate landcover, road and impervious coverage maps. More...

Variables
tuple	parser = argparse.ArgumentParser(description='Generate landcover maps in GRASS GIS')
string	help = 'The configuration file. Must define section "GRASS" and option "GISBASE"'
tuple	args = parser.parse_args()
tuple	cmdline = RHESSysMetadata.getCommandLine()
	configFile = None
tuple	context = Context(args.projectDir, configFile)
tuple	grassMetadata = RHESSysMetadata.readGRASSEntries(context)
tuple	metadata = RHESSysMetadata.readRHESSysEntries(context)
tuple	paramDbPath = os.path.join(context.projectDir, metadata['paramdb'])
tuple	roadRulePath = os.path.join(context.projectDir, metadata['landcover_road_rule'])
tuple	imperviousRulePath = os.path.join(context.projectDir, metadata['landcover_impervious_rule'])
tuple	landuseRulePath = os.path.join(context.projectDir, metadata['landcover_landuse_rule'])
tuple	stratumRulePath = os.path.join(context.projectDir, metadata['landcover_stratum_rule'])
	laiRulePath = None
tuple	paths = RHESSysPaths(args.projectDir, metadata['rhessys_dir'])
tuple	params = importlib.import_module('rhessys.params')
tuple	paramConst = importlib.import_module('rhessys.constants')
tuple	paramDB = params.paramDB(filename=paramDbPath)
tuple	modulePath = context.config.get('GRASS', 'MODULE_PATH')
tuple	grassDbase = os.path.join(context.projectDir, metadata['grass_dbase'])
tuple	grassConfig = GRASSConfig(context, grassDbase, metadata['grass_location'], metadata['grass_mapset'])
tuple	grassLib = GRASSLib(grassConfig=grassConfig)
list	landcoverRast = grassMetadata['landcover_rast']
list	demRast = grassMetadata['dem_rast']
tuple	result = grassLib.script.run_command('r.mask', flags='r')
string	stratumRast = 'stratum'
tuple	pipe = grassLib.script.pipe_command('r.stats', flags='licn', input=stratumRast)
dictionary	rasterVals = {}
tuple	paramsFound
string	landuseRast = 'landuse'

Detailed Description

Import landcover raster maps into a GRASS location and generate landcover, road and impervious coverage maps.

This software is provided free of charge under the New BSD License. Please see the following license information:

Copyright (c) 2013, University of North Carolina at Chapel Hill All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
• Neither the name of the University of North Carolina at Chapel Hill nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Author

Brian Miles brian.nosp@m._mil.nosp@m.es@un.nosp@m.c.ed.nosp@m.u

Pre conditions

1. Configuration file must define the following sections and values: 'GRASS', 'GISBASE'
2. The following metadata entry(ies) must be present in the GRASS section of the metadata associated with the project directory: dem_rast landcover_rast stratum_rast [if defonly==False] landuse_rast [if defonly==False]
3. The following metadata entry(ies) must be present in the RHESSys section of the metadata associated with the project directory: paramdb paramdb_dir grass_dbase grass_location grass_mapset rhessys_dir landcover_road_rule landcover_impervious_rule landcover_stratum_rule landcover_landuse_rule landcover_lai_rule [if LAI flag is specified]

Post conditions

1. Will write the following entry(ies) to the RHESSys section of metadata associated with the project directory: stratum_defs landuse_defs
2. Will write the following entry(ies) to the GRASS section of metadata associated with the project directory: roads_rast [if skiproads == False] [if defonly==True] impervious_rast [if defonly==True] landuse_rast [if defonly==True] stratum_rast [if defonly==True] lai_rast [if LAI flag is specified] [if defonly==True]

Usage:

GenerateLandcoverMaps.py -p /path/to/project_dir

Note

EcoHydroWorkflowLib configuration file must be specified by environmental variable 'ECOHYDROWORKFLOW_CFG', or -i option must be specified.

Variable Documentation

tuple GenerateLandcoverMaps.args = parser.parse_args()

tuple GenerateLandcoverMaps.cmdline = RHESSysMetadata.getCommandLine()

GenerateLandcoverMaps.configFile = None

tuple GenerateLandcoverMaps.context = Context(args.projectDir, configFile)

list GenerateLandcoverMaps.demRast = grassMetadata['dem_rast']

tuple GenerateLandcoverMaps.grassConfig = GRASSConfig(context, grassDbase, metadata['grass_location'], metadata['grass_mapset'])

tuple GenerateLandcoverMaps.grassDbase = os.path.join(context.projectDir, metadata['grass_dbase'])

tuple GenerateLandcoverMaps.grassLib = GRASSLib(grassConfig=grassConfig)

tuple GenerateLandcoverMaps.grassMetadata = RHESSysMetadata.readGRASSEntries(context)

string GenerateLandcoverMaps.help = 'The configuration file. Must define section "GRASS" and option "GISBASE"'

tuple GenerateLandcoverMaps.imperviousRulePath = os.path.join(context.projectDir, metadata['landcover_impervious_rule'])

tuple GenerateLandcoverMaps.laiRulePath = None

list GenerateLandcoverMaps.landcoverRast = grassMetadata['landcover_rast']

list GenerateLandcoverMaps.landuseRast = 'landuse'

tuple GenerateLandcoverMaps.landuseRulePath = os.path.join(context.projectDir, metadata['landcover_landuse_rule'])

tuple GenerateLandcoverMaps.metadata = RHESSysMetadata.readRHESSysEntries(context)

tuple GenerateLandcoverMaps.modulePath = context.config.get('GRASS', 'MODULE_PATH')

tuple GenerateLandcoverMaps.paramConst = importlib.import_module('rhessys.constants')

tuple GenerateLandcoverMaps.paramDB = params.paramDB(filename=paramDbPath)

tuple GenerateLandcoverMaps.paramDbPath = os.path.join(context.projectDir, metadata['paramdb'])

tuple GenerateLandcoverMaps.params = importlib.import_module('rhessys.params')

tuple GenerateLandcoverMaps.paramsFound

Initial value:

= paramDB.search(paramConst.SEARCH_TYPE_HIERARCHICAL, None, key, None, None, None, None, None, None, None, None,
                                 defaultIdOverride=rasterVals[key])

tuple GenerateLandcoverMaps.parser = argparse.ArgumentParser(description='Generate landcover maps in GRASS GIS')

tuple GenerateLandcoverMaps.paths = RHESSysPaths(args.projectDir, metadata['rhessys_dir'])

tuple GenerateLandcoverMaps.pipe = grassLib.script.pipe_command('r.stats', flags='licn', input=stratumRast)

dictionary GenerateLandcoverMaps.rasterVals = {}

tuple GenerateLandcoverMaps.result = grassLib.script.run_command('r.mask', flags='r')

tuple GenerateLandcoverMaps.roadRulePath = os.path.join(context.projectDir, metadata['landcover_road_rule'])

list GenerateLandcoverMaps.stratumRast = 'stratum'

tuple GenerateLandcoverMaps.stratumRulePath = os.path.join(context.projectDir, metadata['landcover_stratum_rule'])