GSTPy.NetworkInterface.save_feature — GSTPy documentation

# GSTPy.NetworkInterface.save_feature

`NetworkInterface.``save_feature`((NetworkInterface)self, (FeatureDesc)feature, (str)output_path[, (RequestFormat)request_format=GSTPy.RequestFormat.SFSP[, (SRS)srs=None[, (QueryBox)query_box=None[, (WriterOptions)writer_options=<GSTPy.WriterOptions object at 0x0000024D9C6CFEF0>[, (bool)write_object_archive=False[, (TilingParameters)tiling_parameters=None[, (int)sgrid_segmentation_colormap_id=-1[, (ShiftParameters)shift_parameters=None[, (MeshSimplificationParameters)mesh_simplification_parameters=None[, (int)commit_key=-1]]]]]]]]]]) → SaveFeatureResult :

  Download a feature directly to the filesystem.

  Parameters

    - feature (FeatureDesc) – The requested feature.

    - output_path (str) – The output path on the filesystem where the feature download output will be saved. Note: This has to be a directory, the filename of the result will be determined internally and is accessible in the result of this function.

    - request_format (RequestFormat) – The requested file format of the feature.

    - srs (SRS) – The requested SRS of the feature.

    - query_box (QueryBox) – The query box for partial request. If this parameter is supplied, the returned feature data will only be in the area defined with `QueryBox.box`.

    - writer_options (WriterOptions) – Writer options based on format.

    - write_object_archive (bool) – Write the object archive for the downloaded feature.

    - tiling_parameters (TilingParameters) – Use tiling.

    - sgrid_segmentation_colormap_id (int) – Use SGRID segmentation.

    - shift_parameters (ShiftParameters) – Shift the geometry.

    - mesh_simplification_parameters (MeshSimplificationParameters) – Use mesh simplification.

    - commit_key (int) – The requested commit key of the feature. Optional, defaults to latest.

  Returns

    The metadata of the save feature request.

  Return type

    SaveFeatureResult