Python script qltLSM
Table of Contents
Aim of module
- See Also
- python.qltLSM
proxy class for packages.python.qltLSM
General description
- Parameters
-
temp remark : optional temporary directory directory for temporary files 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. projectDir remark : optional project directory project directory All of the parameters mentioned above, if not specified as absolute paths, are relative to the project directory. The default project directory is the current working directory, but this can be changed easily using the -p parameter. gearman remark : optional address and port of gearman job server currently this option is not yet supported. placed here for future reference cfg remark : optional configuration file configuration file 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. mask remark : optional create grid masks skipIfExists remark : optional skip processing if result already exists 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. outfile remark : optional output directory or settings file (.txt) output directory Specifies the directory where the final results are stored. If not specified, the results are created in the current working directory. infile remark : mandatory input text file, directory or strip file input files or file list 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.
- See Also
- Python script qltLSM
The following table contains a list of all involved modules and their default storage locations:
| OPALS Module | Default Directory | Comments |
| Module Import | .\import | ODM files |
| Module Bounds | .\bounds | boundary files, only if no pairs specified |
| Module Overlap | .\overlap | list of overlapping pairs, only if no pairs specified |
| Module Grid | .\grid | strip-wise DSMs, additional features: sigma and excenter |
| Module Algebra | .\grid | grid masks (for strip differences and LSM) |
| Module LSM | .\qltLSM | Transformation parameters (XML parameter file) |
Parameter description
-mask create grid masks
Type : Boolean
Remark :Optional, default: Boolean(True)
Description:
Possible values:
Remark :Optional, default: Boolean(True)
Description:
Possible values:
| 1 | True |
| 0 | False |
| true | True |
| false | False |
| yes | True |
| no | False |
Common Package/Script Options
Settings concerning the general options for (package) scripts.
-infile input text file, directory or strip file
Type : String
Remark :Mandatory
Description: input files or file list
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.
Remark :Mandatory
Description: input files or file list
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 : String
Remark :Optional
Description: output directory
Specifies the directory where the final results are stored.
If not specified, the results are created in the current working directory.
Remark :Optional
Description: output directory
Specifies the directory where the final results are stored.
If not specified, the results are created in the current working directory.
-temp temporary directory
Type : String
Remark :Optional, default: '.'
Description: directory for temporary files
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.
Remark :Optional, default: '.'
Description: directory for temporary files
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
Type : String
Remark :Optional
Description: configuration file
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.
Remark :Optional
Description: configuration file
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 : String
Remark :Optional
Description: project directory
All of the parameters mentioned above, if not specified as absolute paths, are
relative to the project directory. The default project directory is the current
working directory, but this can be changed easily using the -p parameter.
Remark :Optional
Description: project directory
All of the parameters mentioned above, if not specified as absolute paths, are
relative to the project directory. The default project directory is the current
working directory, but this can be changed easily using the -p parameter.
-skipIfExists skip processing if result already exists
Type : Boolean
Remark :Optional, default: Boolean(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 values:
Remark :Optional, default: Boolean(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 values:
| 1 | True |
| 0 | False |
| true | True |
| false | False |
| yes | True |
| no | False |
-gearman address and port of gearman job server
Type :
Remark :Optional
Description: currently this option is not yet supported. placed here for future reference
Remark :Optional
Description: currently this option is not yet supported. placed here for future reference
Examples
To be written.
