preDataCheck Class Reference

class for packages.python.preDataCheck More...

Inheritance diagram for preDataCheck:

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

Public Attributes
	xylim
	zlim
	validpixels
	mosaic
	qgisProject
	enduranceMode
	screenLogLevel
	fileLogLevel
	infile
	outfile
	temp
	cfg
	projectDir
	skipIfExists
	distribute

Static Public Attributes
list	attrs = ['xylim', 'zlim', 'validpixels', 'mosaic', 'qgisProject', 'enduranceMode', 'screenLogLevel', 'fileLogLevel', 'infile', 'outfile', 'temp', 'cfg', 'projectDir', 'skipIfExists', 'distribute']
list	readonly_attrs = []

Detailed Description

class for packages.python.preDataCheck

see Python script preDataCheck for further details

Parameters

xylim	: input 2D limits for x and y) remark : optional If the user knows the coordinates of the bounding box (x and y limits) roughly containing the area of interest (i.e. a country or a state), it can be provided in the format [ymin,xmin,ymax,xmax], where Y is the abscissa and X the ordinate.
zlim	: input a range for the estimated z coordinates remark : optional A range for realistic z-coordinates can be added by the user to filter out faulty .las/.laz files containing out-of-range z values. The range is provided in the format [zmin, zmax].
validpixels	: input valid pixel threshold remark : optional After a bounding box is created, the share of valid pixels are checked. If they are below the threshold set, the input file is rejected. Values should be between 0 and 1.
mosaic	: create mosaics remark : optional
qgisProject	: path to qgis project file, if one should be written. A QGIS installation is required. remark : optional
enduranceMode	: Controls, whether or not script keeps running remark : optional If True, script keeps runnning after encountering an error.
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
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.
distribute	: determine how many local processes should be used remark : optional according to the number chosen as the value, independent processes are being started to parallelise (parts of) the program and therefore enhance the runtime.