Python script preAttribute

Table of Contents

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

See also

python.workflows.preAttribute

Aim of module

Computes a set attributes for a list of point cloud files.

General description

The main focus of the script is to compute new features within the point cloud and add them as attributes to the ODM. The script supports filewise and stripwise processing independed of the file structure.

Certain features have to be computed stripwise to be meaningful. In case the data are provided as strip files this task is trivial since it is identical to the filewise processing strategy. However, if the data are tiled (or multi strips have been merged) the stripwise computation is repeated multiple times for input each file only using the points of on strip a time (by applying filters). The strips have to be identifiable by the "stripAttribute" (see above)

See also

Script documentation

In the follow pseudo code describes the processing strategy preAttribute.py

Import each input file into an ODM (if not existing yet)
 
# filewise processing
Loop over all ODMs:
  Loop over filewise module list:
    run module with current ODM
 
# stripwise processing
Loop over all ODMs:
  Determine strip identifier values for the current ODM
  Loop over stripwise module list: 
    Loop over all strip identifier values:
      run module with current ODM and apply the current strip identifier filter

TO COME: cfg file

Parameter description

Common Package/Script Options

Settings concerning the general options for (package) scripts.

-infile input text file, directory or strip file

Type : Path
Remark : mandatory
Description: 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)

Type : Path
Remark : optional
Description: Specifies the directory where the final results are stored. If not specified, the results are created in the current working directory.

-tempdir temporary directory

Type : Path
Remark : optional, default: current directory
Description: 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 Path to configuration file

Type : Path
Remark : optional, default: $OPALS_ROOT/cfg/preAttribute.cfg
Description: 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

Type : Path
Remark : optional, default: current directory
Description: 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

Type : Boolean
Remark : optional, default: True
Description: 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.

possible input	evaluates to
1, true, yes, Boolean(True), True	Boolean(True)
0, false, no, Boolean(False), False	Boolean(False)

-distribute determine how many local processes should be used

Type : String
Remark : optional
Description: according to the number chosen as the value, independent processes are being started to parallelise (parts of) the program and therefore enhance the runtime.

Logging Options

Settings concerning the verbosity level of logging.

-fileLogLevel Log level in the logfile

Type : LogLevel
Remark : optional, default: info

-screenLogLevel Log level on screen

Type : LogLevel
Remark : optional, default: info

-logger Logger

Type : Logger
Remark : optional
Description: Logger is usually provided by the opals framework.The user may provide their own logger object, but it has to function in the same way as the opals Logger.

Examples

TO COME