GetNLCDForBoundingbox Namespace Reference

Extract a tile of NLCD 2006 data for bounding box from a locally stored copy of the entire NLCD 2006 dataset dataset. More...

Variables
tuple	parser argparse.ArgumentParser(description='Get NLCD data (in GeoTIFF format) for a bounding box from a local copy of the entire NLCD 2006 dataset.')
string	help 'The configuration file'
tuple	args parser.parse_args()
tuple	cmdline GenericMetadata.getCommandLine()
	configFile None
tuple	config ConfigParser.RawConfigParser()
	projectDir args.projectDir
	outfile args.outfile
tuple	nlcdRaster config.get('NLCD', 'PATH_OF_NLCD2006')
tuple	studyArea GenericMetadata.readStudyAreaEntries(projectDir)
list	bbox studyArea['bbox_wgs84']
list	outputrasterresolutionX studyArea['dem_res_x']
list	outputrasterresolutionY studyArea['dem_res_y']
list	srs studyArea['dem_srs']
string	tmpTileFilename "%s-TEMP.tif"
tuple	tmpTileFilepath os.path.join(projectDir, tmpTileFilename)
string	tileFilename "%s.tif"
	s_srs None,t_srssrs,\
	trX outputrasterresolutionX,trYoutputrasterresolutionY,\
string	resampleMethod 'near'
tuple	asset AssetProvenance(GenericMetadata.MANIFEST_SECTION)

Detailed Description

Extract a tile of NLCD 2006 data for bounding box from a locally stored copy of the entire NLCD 2006 dataset dataset.

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: 'GDAL/OGR', 'PATH_OF_GDAL_TRANSLATE' 'NLCD', 'PATH_OF_NLCD2006'

1. The following metadata entry(ies) must be present in the study area section of the metadata associated with the project directory: bbox_wgs84 dem_res_x dem_res_y dem_srs

Post conditions

1. Will write the following entry(ies) to the manifest section of metadata associated with the project directory: landcover [the name of the landcover raster]

1. Will write the following entry(ies) to the study area section of metadata associated with the project directory: landcover_type=NLCD2006

Usage:

python ./GetNLCDForBoundingbox.py -p /path/to/project_dir

Note

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

Todo:

Buffer bounding box to ensure full coverage with valid NLCD data

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: 'GDAL/OGR', 'PATH_OF_GDAL_TRANSLATE' 'NLCD', 'PATH_OF_NLCD2006'

1. The following metadata entry(ies) must be present in the study area section of the metadata associated with the project directory: bbox_wgs84 dem_res_x dem_res_y dem_srs

Post conditions

1. Will write the following entry(ies) to the manifest section of metadata associated with the project directory: landcover [the name of the landcover raster]

1. Will write the following entry(ies) to the study area section of metadata associated with the project directory: landcover_type=NLCD2006

Usage:

python ./GetNLCDForBoundingbox.py -p /path/to/project_dir

Note

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

Todo:

Buffer bounding box to ensure full coverage with valid NLCD data

Variable Documentation

tuple GetNLCDForBoundingbox.args parser.parse_args()

tuple GetNLCDForBoundingbox.asset AssetProvenance(GenericMetadata.MANIFEST_SECTION)

tuple GetNLCDForBoundingbox.bbox studyArea['bbox_wgs84']

tuple GetNLCDForBoundingbox.cmdline GenericMetadata.getCommandLine()

tuple GetNLCDForBoundingbox.config ConfigParser.RawConfigParser()

list GetNLCDForBoundingbox.configFile None

string GetNLCDForBoundingbox.help 'The configuration file'

tuple GetNLCDForBoundingbox.nlcdRaster config.get('NLCD', 'PATH_OF_NLCD2006')

string GetNLCDForBoundingbox.outfile args.outfile

list GetNLCDForBoundingbox.outputrasterresolutionX studyArea['dem_res_x']

list GetNLCDForBoundingbox.outputrasterresolutionY studyArea['dem_res_y']

tuple GetNLCDForBoundingbox.parser argparse.ArgumentParser(description='Get NLCD data (in GeoTIFF format) for a bounding box from a local copy of the entire NLCD 2006 dataset.')

tuple GetNLCDForBoundingbox.projectDir args.projectDir

string GetNLCDForBoundingbox.resampleMethod 'near'

GetNLCDForBoundingbox.s_srs None,t_srssrs,\

list GetNLCDForBoundingbox.srs studyArea['dem_srs']

tuple GetNLCDForBoundingbox.studyArea GenericMetadata.readStudyAreaEntries(projectDir)

string GetNLCDForBoundingbox.tileFilename "%s.tif"

string GetNLCDForBoundingbox.tmpTileFilename "%s-TEMP.tif"

tuple GetNLCDForBoundingbox.tmpTileFilepath os.path.join(projectDir, tmpTileFilename)

GetNLCDForBoundingbox.trX outputrasterresolutionX,trYoutputrasterresolutionY,\