Changeset 868

Timestamp:

12/21/11 10:19:09 (17 months ago)

Author:

jjr8

Message:

* Incremented build number.
* Added batched Extract By Mask tool.

Location:

MGET/Branches/Jason/PythonPackage/src/GeoEco

Files:

• DataManagement/ArcGISRasters.py (modified) (4 diffs)
• OceanographicAnalysis/Eddies.py (modified) (2 diffs)
• __init__.py (modified) (1 diff)

MGET/Branches/Jason/PythonPackage/src/GeoEco/DataManagement/ArcGISRasters.py

@@ -27 +27 @@
 import sys
 
-from GeoEco.ArcGIS import GeoprocessorManager, ArcGISDependency
+from GeoEco.ArcGIS import GeoprocessorManager, ArcGISDependency, ArcGISExtensionDependency
 from GeoEco.DatabaseAccess import DatabaseConnection, InsertCursor
 from GeoEco.DatabaseAccess.ArcGIS import ArcGIS91DatabaseConnection
@@ -1567 +1567 @@
 
     @classmethod
+    def ExtractByMask(cls, inputRaster, mask, outputRaster, overwriteExisting=False):
+        cls.__doc__.Obj.ValidateMethodInvocation()
+        try:
+            gp = GeoprocessorManager.GetWrappedGeoprocessor()
+            gp.ExtractByMask_sa(inputRaster, mask, outputRaster)
+        except:
+            Logger.LogExceptionAsError()
+            raise
+
+    @classmethod
     def ProjectClipAndOrExecuteMapAlgebra(cls, inputRaster, outputRaster, projectedCoordinateSystem=None, geographicTransformation=None, resamplingTechnique=None, projectedCellSize=None, registrationPoint=None, clippingDataset=None, clippingRectangle=None, mapAlgebraExpression=None, buildPyramids=False, overwriteExisting=False):
         cls.__doc__.Obj.ValidateMethodInvocation()
@@ -2801 +2811 @@
 may be different than what ArcGIS used when it created the
 raster."""))
+
+# Public method: ArcGISRaster.ExtractByMask
+
+AddMethodMetadata(ArcGISRaster.ExtractByMask,
+    shortDescription=_(u'Extracts the cells of a raster that correspond to the areas defined by a mask.'),
+    longDescription=_(
+u"""This tool just calls the ArcGIS Spatial Analyst's Extract By Mask
+tool. It only exists so that we can easily create a batched version of
+that tool."""),
+    isExposedToPythonCallers=True,
+    isExposedByCOM=True,
+    isExposedAsArcGISTool=False,
+    arcGISToolCategory=_(u'Spatial Analysis\\Project, Clip and/or Execute Map Algebra'),
+    dependencies=[ArcGISDependency(9, 1), ArcGISExtensionDependency(u'spatial')])
+
+CopyArgumentMetadata(ArcGISRaster.Copy, u'cls', ArcGISRaster.ExtractByMask, u'cls')
+
+AddArgumentMetadata(ArcGISRaster.ExtractByMask, u'inputRaster',
+    typeMetadata=ArcGISRasterLayerTypeMetadata(mustExist=True),
+    description=_(u'The input raster from which cells will be extracted.'),
+    arcGISDisplayName=_(u'Input raster'))
+
+AddArgumentMetadata(ArcGISRaster.ExtractByMask, u'mask',
+    typeMetadata=ArcGISGeoDatasetTypeMetadata(mustExist=True),
+    description=_(
+u"""Input mask data defining areas to extract.
+
+This is a raster or feature dataset.
+
+When the input mask data is a raster, NoData cells on the mask will be
+assigned NoData values on the output raster."""),
+    arcGISDisplayName=_(u'Input raster or feature mask data'))
+
+AddArgumentMetadata(ArcGISRaster.ExtractByMask, u'outputRaster',
+    typeMetadata=ArcGISRasterTypeMetadata(mustBeDifferentThanArguments=[u'inputRaster', u'mask'], deleteIfParameterIsTrue=u'overwriteExisting', createParentDirectories=True),
+    description=_(
+u"""The output raster containing the cell values extracted from the
+input raster.
+
+If this path refers to the file system, missing directories in the
+path will be created if they do not exist."""),
+    direction=u'Output',
+    arcGISDisplayName=_(u'Output raster'))
 
 # Public method: ArcGISRaster.ProjectClipAndOrExecuteMapAlgebra
@@ -3279 +3332 @@
     overwriteExistingDescription=_(u'If True and skipExisting is False, existing destination rasters will be overwritten.'))
 
+BatchProcessing.GenerateForMethod(ArcGISRaster.ExtractByMask,
+    inputParamNames=[u'inputRaster'],
+    inputParamFieldArcGISDisplayNames=[_(u'Input raster field')],
+    inputParamDescriptions=[_(u'%s input rasters.')],
+    outputParamNames=[u'outputRaster'],
+    outputParamFieldArcGISDisplayNames=[_(u'Output raster field')],
+    outputParamExpressionArcGISDisplayNames=[_(u'Output raster Python expression')],
+    outputParamDescriptions=[_(
+u"""%s output rasters to receive the cell values extracted from the
+input rasters.
+
+If these paths refers to the file system, missing directories in the
+paths will be created if they do not exist.""")],
+    outputParamExpressionDescriptions=[
+u"""Python expression used to calculate the absolute path of an output
+raster. The expression may be any Python statement appropriate
+for passing to the eval function and must return a Unicode string. The
+expression may reference the following variables:
+
+* workspaceToSearch - the value provided for the workspace to search
+  parameter
+
+* outputWorkspace - the value provided for the output workspace
+  parameter
+
+* inputRaster - the absolute path to the input raster
+
+The default expression::
+
+    os.path.join(outputWorkspace, inputRaster[len(workspaceToSearch)+1:])
+
+stores the output rasters in the output workspace at the same relative
+location as the input rasteres appear in the workspace to search. The
+output raster path is calculated by stripping the workspace to search
+from the input raster path and replacing it with the output workspace.
+
+For more information on Python syntax, please see the `Python
+documentation <http://www.python.org/doc/>`_."""],
+    outputParamDefaultExpressions=[u'os.path.join(outputWorkspace, inputRaster[len(workspaceToSearch)+1:])'],
+    constantParamNames=[u'mask'],
+    processListMethodName=u'ExtractByMaskList',
+    processListMethodShortDescription=_(u'For each ArcGIS raster in a list, extracts the cells that correspond to the areas defined by a mask.'),
+    processTableMethodName=u'ExtractByMaskTable',
+    processTableMethodShortDescription=_(u'For each ArcGIS raster in a table, extracts the cells that correspond to the areas defined by a mask.'),
+    processArcGISTableMethodName=u'ExtractByMaskArcGISTable',
+    processArcGISTableMethodArcGISDisplayName=_(u'Extract By Mask for ArcGIS Rasters Listed in Table'),
+    findAndProcessMethodName=u'FindAndExtractByMask',
+    findAndProcessMethodArcGISDisplayName=u'Find ArcGIS Rasters and Extract By Mask',
+    findAndProcessMethodShortDescription=_(u'Finds and rasters in an ArcGIS workspace and extracts the cells that correspond to the areas defined by a mask.'),
+    findMethod=ArcGISRaster.FindAndCreateTable,
+    findOutputFieldParams=[u'rasterField'],
+    findAdditionalParams=[u'wildcard', u'searchTree', u'rasterType'],
+    outputLocationTypeMetadata=ArcGISWorkspaceTypeMetadata(createParentDirectories=True),
+    outputLocationParamDescription=_(u'Workspace to receive the output rasters.'),
+    outputLocationParamArcGISDisplayName=_(u'Output workspace'),
+    calculateFieldMethod=Field.CalculateField,
+    calculateFieldExpressionParam=u'pythonExpression',
+    calculateFieldAdditionalParams=[u'modulesToImport'],
+    calculateFieldAdditionalParamsDefaults=[[u'os.path']],
+    calculateFieldHiddenParams=[u'statementsToExecFirst', u'statementsToExecPerRow'],
+    calculateFieldHiddenParamValues=[[u'import inspect\nf = inspect.currentframe()\ntry:\n    workspaceToSearch = f.f_back.f_back.f_back.f_back.f_back.f_locals[\'inputWorkspace\']\n    outputWorkspace = f.f_back.f_back.f_back.f_back.f_back.f_locals[\'outputWorkspace\']\nfinally:\n    del f\n'], [u'inputRaster = row.inputRaster']],
+    calculatedOutputsArcGISCategory=_(u'Output raster name options'),
+    skipExistingDescription=_(u'If True, processing will be skipped for output rasters that already exist.'),
+    overwriteExistingDescription=_(u'If True and skipExisting is False, existing output rasters will be overwritten.'))
+
 BatchProcessing.GenerateForMethod(ArcGISRaster.ProjectClipAndOrExecuteMapAlgebra,
     inputParamNames=[u'inputRaster'],

MGET/Branches/Jason/PythonPackage/src/GeoEco/OceanographicAnalysis/Eddies.py

@@ -633 +633 @@
     longDescription=_(
 u"""Minimum area-to-perimeter ratio for eddy cores, normalized such
-that a perfect sphere has the value 1. Eddy cores with ratios less
+that a perfect circle has the value 1. Eddy cores with ratios less
 than this value will be ignored.
 
@@ -641 +641 @@
     4 * pi * area / perimeter^2
 
-Under this formulation, a perfect sphere will have the value 1.0, a
+Under this formulation, a perfect circle will have the value 1.0, a
 square, about 0.7854, and an equilateral triangle, about 0.6046.
 

MGET/Branches/Jason/PythonPackage/src/GeoEco/__init__.py

@@ -1 @@
-__version__ = u'0.8a30'
+__version__ = u'0.8a31'