preCutting Class Reference

class for packages.python.preCutting More...

+ Inheritance diagram for preCutting:

Public Member Functions

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

Public Attributes

 shapeFile
 
 attribute
 
 pick
 
 buffer
 
 vector
 
 raster
 
 truePolygons
 
 formula
 
 resamplingMethod
 
 roundingMethod
 
 export
 
 oformat
 
 skipIfExists
 
 writeEmptyTiles
 
 odmTileSize
 
 singleFilePerTile
 
 nbThreads
 
 generateOverviews
 
 screenLogLevel
 
 fileLogLevel
 

Static Public Attributes

list attrs = ['shapeFile', 'attribute', 'pick', 'buffer', 'vector', 'raster', 'truePolygons', 'formula', 'resamplingMethod', 'roundingMethod', 'export', 'oformat', 'skipIfExists', 'writeEmptyTiles', 'odmTileSize', 'singleFilePerTile', 'nbThreads', 'generateOverviews', 'screenLogLevel', 'fileLogLevel']
 
list readonly_attrs = []
 

Detailed Description

class for packages.python.preCutting

see Python script preCutting for further details

Parameters
shapeFile: Shape file containing the polygons used as cutting limits.
remark : mandatory
attribute: Name of the Shape file attribute that will be part of the export filename.
remark : optional
pick: Choice of the target polygon(s) if not all polygon(s) shall be cut.
remark : optional
buffer: Buffering distance around the polygon in meters.
remark : optional
vector: Path(s) to the vector file(s)
remark : optional
Path where the vector files to cut are located [mandatory if no rasterpath is specified]. At the moment only ODM files are supported. For example -vector U:\Tiles\*.tif -vector U:\OtherTiles\ -vector U:\Folder\poly*.tif
raster: Path(s) to the raster file(s)
remark : optional
Path where the raster files to cut are located [mandatory if no vectorpath is specified]. For example -raster U:\Tiles\*.tif -raster U:\OtherTiles\ -raster U:\Folder\poly*.tif
truePolygons: Use true polygon or rectangular bounding box
remark : optional
By default, only the polygon bounding box of rasters is cut out. With this option, it is possible to cut out the true polygon shape. Since the process is more time consuming, it should only be chosen for non-rectangular polygons.
formula: Formula for the combination of overlapping raster files in opalsAlgebra.
remark : optional
resamplingMethod: OpalsGrid resampling method [bilinear | bicubic | nearestNeighbour]
remark : optional
roundingMethod: Method to round the results to exakt pixel positions [corner | center]
remark : optional
export: [path]\[prefix of filename].[extension]
remark : optional
Define the [path]\[prefix of filename].[extension] - any of the three may be left out. For example: -export U:\results\polygons\cut\myPrefix.jpg
oformat: GDAL driver for raster, file format or XML file for Vector.
remark : optional
skipIfExists: Skip processing if result already exists.
remark : optional
writeEmptyTiles: if True also empty tile files are created
remark : optional
odmTileSize: Optional odm tiles size when exporting odm files. If not set, the automatic odm tile size estimation is used
remark : optional
singleFilePerTile: One input file per output tile
remark : optional
If set to True only one input file is used for creating the output tile (based on the shortest distance between center points of the input files)
nbThreads: set the number of processes for parallel processing
remark : optional
Sets the number of processes that work parallel to cut the tiles.The maximum number of processes that can work parallel is limited by the CPUSetting this Value to 0 will use the maximum.
generateOverviews: if True, overview matrices for a stricter overlap test are generated.
remark : optional
Controls, whether or not opalsInfo creates the overview matrices for inputshape Files. If they are already created by the user beforehand, the script will still check for strict overlaps.
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