Python script analyzeDEM

Table of Contents

• Aim of module
• General description
• Parameter description
• Examples

See Also

python.analyzeDEM

Aim of module

proxy class for packages.python.analyzeDEM

General description

Parameters

kernel	remark : optional Specification of one kernel shape from the opals-supported types [square (default) | circle | diamond]. Circle and diamond can only be used for a kernel size of 2 or higher.
dtm	remark : optional File or path containing Digital Terrain Model(s) [mandatory].
zone	remark : optional Polygon Shape file or point list (x1 y1 x2 y2 ... - see below) defining zone polygon(s) [optional].
rounding	remark : optional Options for rounding the results to exakt pixel positions ["corner"=default | "center"
skip	remark : optional Skip processing if result already exists. [1=skip(default) | 0=overwrite]
poly	remark : optional Manual Selection of polygons within the Shape file [optional]. Polygons are selected by their names of the attribute specified under -a. More inputs are separated by semicolon (;).
hist	remark : optional Decision if an additional histogram plot file (SVG) shall be stored. [1=yes | 0=no (default)]
vis	remark : optional Add Shadings and colored maps to the report [1=yes(default) | 0=no]
att	remark : optional Name of the Shape file attribute used as a zone name [default = "id"].
dsm	remark : optional File or wildcard path containing Digital Surface Model(s) [optional]. Attention! All filename parts replaced by a wildcard symbol have to correspond with the replaced parts of the DTM filenames.
delete	remark : optional All intermediate results not contained in the report can be automatically deleted to save memory. [1=delete | 0=keep (default)]
border	remark : optional By default, non-rectangular zones are also used as a rectangular bounding boxes for performance reasons. With this parameter, the processing is limited to the real polygons what is more time-consuming. [1=exact polygons | 0=rectangular bounding box (default)]
dir	remark : optional Existing directory to store the generated files. [default = CWD]
size	remark : optional Kernel size for the grid feature derivation [default=1]. More values can be passed separated by a comma (e.g. "-r 2,3,5").

See Also

Python script analyzeDEM

Parameter description

Elevation Model inputs

Settings concerning the input Terrain/Surface models.

-t/--terrainModel File or path containing Digital Terrain Model(s) [mandatory].

Type :
Remark :Optional
Description:

-s/--surfaceModel File or wildcard path containing Digital Surface Model(s) [optional]. Attention! All filename parts replaced by a wildcard symbol have to correspond with the replaced parts of the DTM filenames.

Type :
Remark :Optional
Description:

Example for input of terrain and surface models

-t C:\Data\TerrainModel\DTM_*.tif -s C:\Data\SurfaceModel\DSM_*.tif ('*' has to represent exactly the same string for corresponding files! DTM_4380_5270.tif and DSM_4380_5270.tif would be recognized as a pair.)

Zone specification

Settings concerning definition and cutting of the analyzed zone.

-z/--zone Polygon Shape file or point list (x1 y1 x2 y2 ... - see below) defining zone polygon(s) [optional].

Type :
Remark :Optional
Description:

-a/--attribute Name of the Shape file attribute used as a zone name [default = "id"].

Type :
Remark :Optional, default: id
Description:

-e/--exactBorder By default, non-rectangular zones are also used as a rectangular bounding boxes for performance reasons. With this parameter, the processing is limited to the real polygons what is more time-consuming. [1=exact polygons | 0=rectangular bounding box (default)]

Type : Integer
Remark :Optional, default: 0
Description:

-p/--pickPoly Manual Selection of polygons within the Shape file [optional]. Polygons are selected by their names of the attribute specified under -a. More inputs are separated by semicolon (;).

Type :
Remark :Optional
Description:

-c/--centerCorner Options for rounding the results to exakt pixel positions ["corner"=default | "center"

Type :
Remark :Optional, default: corner
Description:

Example of giving a polygon through point coordinates using the -z flag

-z "0 100 20 100 20 110 0 110" (Here, the result would be a 20x10 rectangle.) Attention: Only use the " quotation mark!

Processing options

Settings for the processing of DEM-derivation products using opalsGridFeature.

-r/--kernelSize Kernel size for the grid feature derivation [default=1]. More values can be passed separated by a comma (e.g. "-r 2,3,5").

Type :
Remark :Optional, default: 1
Description:

-k/--kernelShape Specification of one kernel shape from the opals-supported types [square (default) | circle | diamond]. Circle and diamond can only be used for a kernel size of 2 or higher.

Type :
Remark :Optional, default: square
Description:

Output options

Settings concerning the intermediate products and the final report.

-o/--outFolder Existing directory to store the generated files. [default = CWD]

Type :
Remark :Optional
Description:

-v/--visualize Add Shadings and colored maps to the report [1=yes(default) | 0=no]

Type : Integer
Remark :Optional, default: 1
Description:

-f/--histogramFile Decision if an additional histogram plot file (SVG) shall be stored. [1=yes | 0=no (default)]

Type : Integer
Remark :Optional, default: 0
Description:

-d/--deleteFiles All intermediate results not contained in the report can be automatically deleted to save memory. [1=delete | 0=keep (default)]

Type : Integer
Remark :Optional, default: 0
Description:

-x/--skipIfExists Skip processing if result already exists. [1=skip(default) | 0=overwrite]

Type : Integer
Remark :Optional, default: 1
Description:

Examples

To be written.