| 1 | #!/usr/bin/env python
|
|---|
| 2 | #
|
|---|
| 3 | ############################################################################
|
|---|
| 4 | #
|
|---|
| 5 | # MODULE: r.mask
|
|---|
| 6 | # AUTHOR(S): Michael Barton, Arizona State University
|
|---|
| 7 | # Markus Neteler
|
|---|
| 8 | # Converted to Python by Glynn Clements
|
|---|
| 9 | # Markus Metz
|
|---|
| 10 | # PURPOSE: Facilitates creation of raster MASK
|
|---|
| 11 | # COPYRIGHT: (C) 2005-2013 by the GRASS Development Team
|
|---|
| 12 | #
|
|---|
| 13 | # This program is free software under the GNU General Public
|
|---|
| 14 | # License (>=v2). Read the file COPYING that comes with GRASS
|
|---|
| 15 | # for details.
|
|---|
| 16 | #
|
|---|
| 17 | #############################################################################
|
|---|
| 18 |
|
|---|
| 19 | #%module
|
|---|
| 20 | #% description: Creates a MASK for limiting raster operation.
|
|---|
| 21 | #% keyword: raster
|
|---|
| 22 | #% keyword: mask
|
|---|
| 23 | #% overwrite: yes
|
|---|
| 24 | #%end
|
|---|
| 25 | #%option G_OPT_R_INPUT
|
|---|
| 26 | #% key: raster
|
|---|
| 27 | #% description: Name of raster map to use as mask
|
|---|
| 28 | #% required: NO
|
|---|
| 29 | #% guisection: Raster
|
|---|
| 30 | #%end
|
|---|
| 31 | #%option
|
|---|
| 32 | #% key: maskcats
|
|---|
| 33 | #% type: string
|
|---|
| 34 | #% label: Raster values to use for mask
|
|---|
| 35 | #% description: Format: 1 2 3 thru 7 *
|
|---|
| 36 | #% answer: *
|
|---|
| 37 | #% guisection: Raster
|
|---|
| 38 | #%end
|
|---|
| 39 | #%option G_OPT_V_INPUT
|
|---|
| 40 | #% key: vector
|
|---|
| 41 | #% label: Name of vector map to use as mask
|
|---|
| 42 | #% required: NO
|
|---|
| 43 | #% guisection: Vector
|
|---|
| 44 | #%end
|
|---|
| 45 | #%option G_OPT_V_FIELD
|
|---|
| 46 | #% label: Layer number or name (vector)
|
|---|
| 47 | #% required: NO
|
|---|
| 48 | #% guisection: Vector
|
|---|
| 49 | #%end
|
|---|
| 50 | #%option G_OPT_V_CATS
|
|---|
| 51 | #% label: Category values (vector)
|
|---|
| 52 | #% guisection: Vector
|
|---|
| 53 | #%end
|
|---|
| 54 | #%option G_OPT_DB_WHERE
|
|---|
| 55 | #% label: WHERE conditions of SQL statement without 'where' keyword (vector)
|
|---|
| 56 | #% guisection: Vector
|
|---|
| 57 | #%end
|
|---|
| 58 | #%flag
|
|---|
| 59 | #% key: i
|
|---|
| 60 | #% description: Create inverse mask
|
|---|
| 61 | #% guisection: Create
|
|---|
| 62 | #%end
|
|---|
| 63 | #%flag
|
|---|
| 64 | #% key: r
|
|---|
| 65 | #% description: Remove existing mask (overrides other options)
|
|---|
| 66 | #% guisection: Remove
|
|---|
| 67 | #%end
|
|---|
| 68 |
|
|---|
| 69 | import os
|
|---|
| 70 | import sys
|
|---|
| 71 | import atexit
|
|---|
| 72 |
|
|---|
| 73 | import grass.script as grass
|
|---|
| 74 | from grass.script.utils import encode
|
|---|
| 75 | from grass.exceptions import CalledModuleError
|
|---|
| 76 |
|
|---|
| 77 |
|
|---|
| 78 | def cleanup():
|
|---|
| 79 | if tmp:
|
|---|
| 80 | grass.run_command('g.remove', flags='f', type='raster',
|
|---|
| 81 | name=tmp, quiet=True)
|
|---|
| 82 | if tmp_hull:
|
|---|
| 83 | grass.run_command('g.remove', flags='f', type='vector',
|
|---|
| 84 | name=tmp_hull, quiet=True)
|
|---|
| 85 |
|
|---|
| 86 |
|
|---|
| 87 | def main():
|
|---|
| 88 | raster = options['raster']
|
|---|
| 89 | maskcats = options['maskcats']
|
|---|
| 90 | vector = options['vector']
|
|---|
| 91 | layer = options['layer']
|
|---|
| 92 | cats = options['cats']
|
|---|
| 93 | where = options['where']
|
|---|
| 94 | remove = flags['r']
|
|---|
| 95 | invert = flags['i']
|
|---|
| 96 |
|
|---|
| 97 | if not remove and not raster and not vector:
|
|---|
| 98 | grass.fatal(_("Either parameter <raster> or parameter <vector> is required"))
|
|---|
| 99 |
|
|---|
| 100 | mapset = grass.gisenv()['MAPSET']
|
|---|
| 101 | exists = bool(grass.find_file('MASK', element='cell', mapset=mapset)['file'])
|
|---|
| 102 |
|
|---|
| 103 | if remove:
|
|---|
| 104 | # -> remove
|
|---|
| 105 | if exists:
|
|---|
| 106 | if sys.platform == 'win32':
|
|---|
| 107 | grass.run_command('g.remove', flags='if', quiet=True,
|
|---|
| 108 | type='raster', name='MASK')
|
|---|
| 109 | else:
|
|---|
| 110 | grass.run_command('g.remove', flags='f', quiet=True,
|
|---|
| 111 | type='raster', name='MASK')
|
|---|
| 112 | grass.message(_("Raster MASK removed"))
|
|---|
| 113 | else:
|
|---|
| 114 | grass.fatal(_("No existing MASK to remove"))
|
|---|
| 115 | else:
|
|---|
| 116 | # -> create
|
|---|
| 117 | if exists:
|
|---|
| 118 | if not grass.overwrite():
|
|---|
| 119 | grass.fatal(_("MASK already found in current mapset. Delete first or overwrite."))
|
|---|
| 120 | else:
|
|---|
| 121 | grass.warning(_("MASK already exists and will be overwritten"))
|
|---|
| 122 | grass.run_command('g.remove', flags='f', quiet=True,
|
|---|
| 123 | type='raster', name='MASK')
|
|---|
| 124 |
|
|---|
| 125 | if raster:
|
|---|
| 126 | # check if input raster exists
|
|---|
| 127 | if not grass.find_file(raster)['file']:
|
|---|
| 128 | grass.fatal(_("Raster map <%s> not found") % raster)
|
|---|
| 129 |
|
|---|
| 130 | if maskcats != '*' and not remove:
|
|---|
| 131 | if grass.raster_info(raster)['datatype'] != "CELL":
|
|---|
| 132 | grass.fatal(_("The raster map <%s> must be integer (CELL type) "
|
|---|
| 133 | " in order to use the 'maskcats' parameter") % raster)
|
|---|
| 134 |
|
|---|
| 135 | p = grass.feed_command(
|
|---|
| 136 | 'r.reclass',
|
|---|
| 137 | input=raster,
|
|---|
| 138 | output='MASK',
|
|---|
| 139 | overwrite=True,
|
|---|
| 140 | rules='-')
|
|---|
| 141 | res = "%s = 1" % maskcats
|
|---|
| 142 | p.stdin.write(encode(res))
|
|---|
| 143 | p.stdin.close()
|
|---|
| 144 | p.wait()
|
|---|
| 145 | elif vector:
|
|---|
| 146 | vector_name = grass.find_file(vector, 'vector')['fullname']
|
|---|
| 147 | if not vector_name:
|
|---|
| 148 | grass.fatal(_("Vector map <%s> not found") % vector)
|
|---|
| 149 |
|
|---|
| 150 | # parser bug?
|
|---|
| 151 | if len(cats) == 0:
|
|---|
| 152 | cats = None
|
|---|
| 153 | if len(where) == 0:
|
|---|
| 154 | where = None
|
|---|
| 155 |
|
|---|
| 156 | if grass.vector_info_topo(vector_name)['areas'] < 1:
|
|---|
| 157 | grass.warning(_("No area found in vector map <%s>. "
|
|---|
| 158 | "Creating a convex hull for MASK.") % vector_name)
|
|---|
| 159 | global tmp_hull
|
|---|
| 160 | tmp_hull = "tmp_hull_%d" % os.getpid()
|
|---|
| 161 | to_rast_input = tmp_hull
|
|---|
| 162 | # force 'flat' convex hull for 3D vector maps
|
|---|
| 163 | try:
|
|---|
| 164 | grass.run_command('v.hull', flags='f', quiet=True,
|
|---|
| 165 | input=vector_name, output=tmp_hull,
|
|---|
| 166 | layer=layer, cats=cats, where=where)
|
|---|
| 167 | except CalledModuleError:
|
|---|
| 168 | grass.fatal(
|
|---|
| 169 | _("Unable to create a convex hull for vector map <%s>") %
|
|---|
| 170 | vector_name)
|
|---|
| 171 | else:
|
|---|
| 172 | to_rast_input = vector_name
|
|---|
| 173 |
|
|---|
| 174 | env = os.environ.copy()
|
|---|
| 175 | if grass.verbosity() > 1:
|
|---|
| 176 | env['GRASS_VERBOSE'] = '1'
|
|---|
| 177 | grass.run_command('v.to.rast', input=to_rast_input, layer=layer,
|
|---|
| 178 | output='MASK', use='val', val='1',
|
|---|
| 179 | type='area', cats=cats, where=where, env=env)
|
|---|
| 180 |
|
|---|
| 181 | if invert:
|
|---|
| 182 | global tmp
|
|---|
| 183 | tmp = "r_mask_%d" % os.getpid()
|
|---|
| 184 | grass.run_command('g.rename', raster=('MASK', tmp), quiet=True)
|
|---|
| 185 | grass.message(_("Creating inverted raster MASK..."))
|
|---|
| 186 | grass.mapcalc("MASK = if(isnull($tmp), 1, null())", tmp=tmp)
|
|---|
| 187 | grass.verbose(_("Inverted raster MASK created"))
|
|---|
| 188 | else:
|
|---|
| 189 | grass.verbose(_("Raster MASK created"))
|
|---|
| 190 |
|
|---|
| 191 | grass.message(_("All subsequent raster operations will be limited to "
|
|---|
| 192 | "the MASK area. Removing or renaming raster map named "
|
|---|
| 193 | "'MASK' will restore raster operations to normal."))
|
|---|
| 194 |
|
|---|
| 195 | if __name__ == "__main__":
|
|---|
| 196 | options, flags = grass.parser()
|
|---|
| 197 | tmp = tmp_hull = None
|
|---|
| 198 | atexit.register(cleanup)
|
|---|
| 199 | main()
|
|---|
