forDSM Class Reference

class for packages.python.forDSM More...

Inheritance diagram for forDSM:

Public Member Functions
def	__init__ (self, **kwargs)
def	__setattr__ (self, name, value)
def	__repr__ (self)
def	run (self)

Public Attributes
	threshold
	mosaic
	limit
	tileSize
	attribute
	enduranceMode
	gridSize
	searchRadius
	neighbours
	overlap
	nbThreads
	infile
	outfile
	temp
	cfg
	projectDir
	skipIfExists
	gearman
	screenLogLevel
	fileLogLevel

Static Public Attributes
list	attrs = ['threshold', 'mosaic', 'limit', 'tileSize', 'attribute', 'enduranceMode', 'gridSize', 'searchRadius', 'neighbours', 'overlap', 'nbThreads', 'infile', 'outfile', 'temp', 'cfg', 'projectDir', 'skipIfExists', 'gearman', 'screenLogLevel', 'fileLogLevel']
list	readonly_attrs = []

Detailed Description

class for packages.python.forDSM

see Python script forDSM for further details

Parameters

threshold	: Threshold for model calculation remark : mandatory Threshold for model calculation. If the simga0 map is greater than the threshold, the combined model will use the "max" value at that point.
mosaic	: Create DSM mosaic from all individual DSMs remark : optional
limit	: Limit of ouput remark : optional Limit output to a specific region ("lower,left,upper,right"). Alternatively, a path to a (polygon) shapefile to read shapes of interest from. (Values will only be calculated for points within the union of all polygons)
tileSize	: preTM tiling string remark : optional preTM tiling string - either one of: one or two floats (setting a tilesize), a shapefile (with a unique column name given in -a), rows/cols like "3r2c", "scan" to copy tiling from input files, None
attribute	: preTM naming string remark : optional preTM naming string - depening on the tiling string, this can be "shp.XX" where XX is the name of a unique field in the shapefile, "inp" to copy filenames from the tiling coming from the input files, any of "LL", "LR", "UR", "UL" in combination with a delimiter and a number of digits (e.g. "LR_6" for 6 digits and "_" as delimiter, "INDEX" or "NUMBERED" for adressing via count.
enduranceMode	: Enables/Disables the endurance mode. remark : optional If endurance mode is enabled the program will not stop if it encounters an errorin a tile. Instead it finishes all tiles as best as possible.
gridSize	: Set the grid size of the output raster file. remark : optional
searchRadius	: Set the search radius for MSL raster map. remark : optional
neighbours	: Set the number of nearest neighbours for grid point interpolation. remark : optional
overlap	: Set overlap for tiling (Default: searchRadius [-r]) remark : optional Set an overlap for tiling differing from default. Be sure to set this to match the filenames in case of already tiled input, and to ensure enough overlap, if multiple scripts are to be executed (e.g. forDelineate) (Estimation rule: searchRadius)
nbThreads	: The number of threads created by preCutting. Use 0 for maximum number of threads. remark : optional The number of threads created by preCutting. Setting it to 0 creates the maximumamount of threads supported by this machine. Setting it to 0 or a high number may impact the stability of the computer.
infile	: input text file, directory or strip file remark : mandatory As input either the name of an ASCII file (extension .txt) containing the names of the data files (one file per line) or an expression using wildcards to specify the respective data sets are accepted.
outfile	: output directory or settings file (.txt) remark : optional Specifies the directory where the final results are stored. If not specified, the results are created in the current working directory.
temp	: temporary directory remark : optional Specifies the directory where all intermediate results are stored. If not specified, a TEMP subdirectory is created in the current working directory. Additional subdirectories (one per involved module) are created.
cfg	: configuration file remark : optional The name of a configuration file containing all relevant calculation parameters is expected. If not specified, the default cfg files as provided by the OPALS distribution are used.
projectDir	: project directory remark : optional The default project directory is the current working directory, but can be easily changed by this parameter. All path parameters, if not specified as absolute paths, are interpreted relative to the project directory.
skipIfExists	: skip processing if result already exists remark : optional Skip processing if result already exists. In order to re-run current script it is useful to repeat the processing only if the respective output does not already exist. This allows for incremental processing of large projects.
gearman	: address and port of gearman job server remark : optional currently this option is not yet supported. placed here for future reference
screenLogLevel	: verbosity level of screen output remark : optional The minimum level of log message importance to print on the screen
fileLogLevel	: verbosity level of log file output remark : optional The minimum level of log message importance to export to the xml-log