tools-clip/model-definition.yml at main · OpenCLIM/tools-clip · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
kind: M
api_version: v1beta2
metadata:
  display_name: ToolSet:Clip
  name: toolset-clip
  summary: A utility tool for clipping spatial data
  publisher: Newcastle University
  source_code: https://github.com/OpenCLIM/tools-clip
  description: >
    Allows spatial datasets to be clipped. All input data should use the same coordinate system, and this will be adopted by the output dataset(s). Where the coordinate system for a dataset can't be found, the tool will end and the logfile should be checked for details. When performing a clip using a boundary dataset for the clip, the tool will end if the coordinate system of the input data and the clip data do not match - this will be reported in the logfile. Uses GDAL methods to perform the transformations.
spec:
  inputs:
    parameters:
      - name: output_file
        title: Output file name
        description: The name to be given to the output file - only used if one input file passed, otherwise overridden and the default behaviour used. By default, and if multiple input files set, '_clip' will be appended to the name of the input dataset for the output file name.
        type: string
        required: false
        default: 'None'
      - name: extent
        title: extent
        type: string
        description: Should be formatted as `<xmin>,<ymin>,<xmax>,<ymax>` and in the same coordinate system as the data to clip.
        default: 'None'
        required: false
      - name: round_extents
        title: round extents
        type: integer
        description: Round extents to clip a layer by to the nearst value (in meters), e.g. nearest 100, 1000
        default: 0
        required: false
      - name: clip_to_extent_bbox
        title: How to clip data to clip spatial file
        type: string
        description: If passing a vector file for the clip extent, clip to outline or clip to bounding box of vector data
        default: clip-to-bounding-box
        required: false
        options:
          - name: clip-to-bounding-box
            title: clip-to-bounding-box
          - name: clip-to-vector-outline
            title: clip-to-vector-outline
      - name: save_logfile
        title: save logfile
        type: string
        description: Save logfile
        default: 'False'
        required: false
        options:
          - name: 'False'
            title: False
          - name: 'True'
            title: True
    dataslots:
      - name: Input data files
        description: Any data files which are to be clipped. Should match common data formats (rasters - .asc, .tiff, .geotiff; vector - .gpkg, .shp . geojson)
        path: inputs/clip
        required: false
        default:
          - 129f9361-b2ed-460f-a44b-9eeaf00b769c
      - name: Clip extent file
        description: Either a spatial file to clip the input data with (GeoPackage or shapefile) or a text file defining the extent of the bounding box for the clip process.
        path: inputs/clip_extent
        default:
          - 8af3b905-27c9-46db-9684-06bf3eaf0f7c
        required: false

  outputs:
    datasets:
      - name: outputs/*.asc
        type: folder
        description: path to processed data outputs
      - name: outputs/*.log
        type: Text
        description: log file