diff --git a/docs/user_manual/processing/parameters.rst b/docs/user_manual/processing/parameters.rst index c3f77998c22..fb2862500b7 100644 --- a/docs/user_manual/processing/parameters.rst +++ b/docs/user_manual/processing/parameters.rst @@ -26,6 +26,10 @@ Input types - :class:`QgsProcessingParameterAnnotationLayer ` - ``alg.ANNOTATION_LAYER`` - An annotation layer + * - Area + - :class:`QgsProcessingParameterArea ` + - + - A numeric parameter representing an area measure * - Authentication Configuration - :class:`QgsProcessingParameterAuthConfig ` - ``alg.AUTH_CFG`` @@ -238,6 +242,10 @@ Input types - - A vector tile layer destination parameter, for specifying the destination path for a vector tile layer created by the algorithm + * - Volume + - :class:`QgsProcessingParameterVolume ` + - + - A numeric parameter representing a volume measure Output types diff --git a/docs/user_manual/processing_algs/qgis/interpolation.rst b/docs/user_manual/processing_algs/qgis/interpolation.rst index 3b46c9b9bee..424f91eeea9 100644 --- a/docs/user_manual/processing_algs/qgis/interpolation.rst +++ b/docs/user_manual/processing_algs/qgis/interpolation.rst @@ -402,6 +402,9 @@ A weighting factor can be applied to the line segments. Parameters .......... +Basic parameters +^^^^^^^^^^^^^^^^ + .. list-table:: :header-rows: 1 :widths: 20 20 20 40 @@ -445,6 +448,34 @@ Parameters :start-after: **file_output_types** :end-before: **end_file_output_types** +Advanced parameters +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: + :header-rows: 1 + :widths: 20 20 20 40 + :class: longtable + + * - Label + - Name + - Type + - Description + * - **Creation options** + + Optional + - ``CREATE_OPTIONS`` + - [string] + + Default: '' + - For adding one or more creation options that control the + raster to be created (colors, block size, file + compression...). + For convenience, you can rely on predefined profiles (see + :ref:`GDAL driver options section `). + + Batch Process and Model Designer: separate multiple options with a pipe + character (``|``). + Outputs ....... diff --git a/docs/user_manual/processing_algs/qgis/mesh.rst b/docs/user_manual/processing_algs/qgis/mesh.rst index a2ad1b5beae..1f0c22bc7ef 100644 --- a/docs/user_manual/processing_algs/qgis/mesh.rst +++ b/docs/user_manual/processing_algs/qgis/mesh.rst @@ -730,6 +730,9 @@ properties ` (default is Multi level averaging method). Parameters .......... +Basic parameters +^^^^^^^^^^^^^^^^ + .. list-table:: :header-rows: 1 :widths: 20 20 20 40 @@ -789,6 +792,34 @@ Parameters :start-after: **file_output_types** :end-before: **end_file_output_types** +Advanced parameters +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: + :header-rows: 1 + :widths: 20 20 20 40 + :class: longtable + + * - Label + - Name + - Type + - Description + * - **Creation options** + + Optional + - ``CREATE_OPTIONS`` + - [string] + + Default: '' + - For adding one or more creation options that control the + raster to be created (colors, block size, file + compression...). + For convenience, you can rely on predefined profiles (see + :ref:`GDAL driver options section `). + + Batch Process and Model Designer: separate multiple options with a pipe + character (``|``). + Outputs ....... diff --git a/docs/user_manual/processing_algs/qgis/rasteranalysis.rst b/docs/user_manual/processing_algs/qgis/rasteranalysis.rst index 9f8ec592222..dba1667aaed 100644 --- a/docs/user_manual/processing_algs/qgis/rasteranalysis.rst +++ b/docs/user_manual/processing_algs/qgis/rasteranalysis.rst @@ -124,6 +124,21 @@ Advanced parameters Default: -9999.0 - Value to use for NoData in the output layer + * - **Creation options** + + Optional + - ``CREATE_OPTIONS`` + - [string] + + Default: '' + - For adding one or more creation options that control the + raster to be created (colors, block size, file + compression...). + For convenience, you can rely on predefined profiles (see + :ref:`GDAL driver options section `). + + Batch Process and Model Designer: separate multiple options with a pipe + character (``|``). Outputs ....... @@ -287,6 +302,21 @@ Advanced parameters Default: -9999.0 - Value to use for NoData in the output layer + * - **Creation options** + + Optional + - ``CREATE_OPTIONS`` + - [string] + + Default: '' + - For adding one or more creation options that control the + raster to be created (colors, block size, file + compression...). + For convenience, you can rely on predefined profiles (see + :ref:`GDAL driver options section `). + + Batch Process and Model Designer: separate multiple options with a pipe + character (``|``). Outputs ....... @@ -452,6 +482,21 @@ Advanced parameters Default: -9999.0 - Value to use for NoData in the output layer + * - **Creation options** + + Optional + - ``CREATE_OPTIONS`` + - [string] + + Default: '' + - For adding one or more creation options that control the + raster to be created (colors, block size, file + compression...). + For convenience, you can rely on predefined profiles (see + :ref:`GDAL driver options section `). + + Batch Process and Model Designer: separate multiple options with a pipe + character (``|``). Outputs ....... @@ -623,6 +668,21 @@ Advanced parameters Default: -9999.0 - Value to use for NoData in the output layer + * - **Creation options** + + Optional + - ``CREATE_OPTIONS`` + - [string] + + Default: '' + - For adding one or more creation options that control the + raster to be created (colors, block size, file + compression...). + For convenience, you can rely on predefined profiles (see + :ref:`GDAL driver options section `). + + Batch Process and Model Designer: separate multiple options with a pipe + character (``|``). Outputs ....... @@ -766,6 +826,21 @@ Advanced parameters Default: -9999.0 - Value to use for NoData in the output layer + * - **Creation options** + + Optional + - ``CREATE_OPTIONS`` + - [string] + + Default: '' + - For adding one or more creation options that control the + raster to be created (colors, block size, file + compression...). + For convenience, you can rely on predefined profiles (see + :ref:`GDAL driver options section `). + + Batch Process and Model Designer: separate multiple options with a pipe + character (``|``). Outputs ....... @@ -855,6 +930,9 @@ where *f1* is the spread and *f2* the midpoint. Parameters .......... +Basic parameters +^^^^^^^^^^^^^^^^ + .. list-table:: :header-rows: 1 :widths: 20 20 20 40 @@ -898,6 +976,34 @@ Parameters :start-after: **file_output_types** :end-before: **end_file_output_types** +Advanced parameters +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: + :header-rows: 1 + :widths: 20 20 20 40 + :class: longtable + + * - Label + - Name + - Type + - Description + * - **Creation options** + + Optional + - ``CREATE_OPTIONS`` + - [string] + + Default: '' + - For adding one or more creation options that control the + raster to be created (colors, block size, file + compression...). + For convenience, you can rely on predefined profiles (see + :ref:`GDAL driver options section `). + + Batch Process and Model Designer: separate multiple options with a pipe + character (``|``). + Outputs ....... @@ -966,6 +1072,9 @@ where *f1* is the spread and *f2* the midpoint. Parameters .......... +Basic parameters +^^^^^^^^^^^^^^^^ + .. list-table:: :header-rows: 1 :widths: 20 20 20 40 @@ -1008,6 +1117,34 @@ Parameters :start-after: **file_output_types** :end-before: **end_file_output_types** +Advanced parameters +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: + :header-rows: 1 + :widths: 20 20 20 40 + :class: longtable + + * - Label + - Name + - Type + - Description + * - **Creation options** + + Optional + - ``CREATE_OPTIONS`` + - [string] + + Default: '' + - For adding one or more creation options that control the + raster to be created (colors, block size, file + compression...). + For convenience, you can rely on predefined profiles (see + :ref:`GDAL driver options section `). + + Batch Process and Model Designer: separate multiple options with a pipe + character (``|``). + Outputs ....... @@ -1082,6 +1219,9 @@ membership. Parameters .......... +Basic parameters +^^^^^^^^^^^^^^^^ + .. list-table:: :header-rows: 1 :widths: 20 20 20 40 @@ -1124,6 +1264,34 @@ Parameters :start-after: **file_output_types** :end-before: **end_file_output_types** +Advanced parameters +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: + :header-rows: 1 + :widths: 20 20 20 40 + :class: longtable + + * - Label + - Name + - Type + - Description + * - **Creation options** + + Optional + - ``CREATE_OPTIONS`` + - [string] + + Default: '' + - For adding one or more creation options that control the + raster to be created (colors, block size, file + compression...). + For convenience, you can rely on predefined profiles (see + :ref:`GDAL driver options section `). + + Batch Process and Model Designer: separate multiple options with a pipe + character (``|``). + Outputs ....... @@ -1192,6 +1360,9 @@ The near membership function is defined as |near_formula|, where Parameters .......... +Basic parameters +^^^^^^^^^^^^^^^^ + .. list-table:: :header-rows: 1 :widths: 20 20 20 40 @@ -1234,6 +1405,34 @@ Parameters :start-after: **file_output_types** :end-before: **end_file_output_types** +Advanced parameters +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: + :header-rows: 1 + :widths: 20 20 20 40 + :class: longtable + + * - Label + - Name + - Type + - Description + * - **Creation options** + + Optional + - ``CREATE_OPTIONS`` + - [string] + + Default: '' + - For adding one or more creation options that control the + raster to be created (colors, block size, file + compression...). + For convenience, you can rely on predefined profiles (see + :ref:`GDAL driver options section `). + + Batch Process and Model Designer: separate multiple options with a pipe + character (``|``). + Outputs ....... @@ -1305,6 +1504,9 @@ membership. Parameters .......... +Basic parameters +^^^^^^^^^^^^^^^^ + .. list-table:: :header-rows: 1 :widths: 20 20 20 40 @@ -1353,6 +1555,34 @@ Parameters :start-after: **file_output_types** :end-before: **end_file_output_types** +Advanced parameters +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: + :header-rows: 1 + :widths: 20 20 20 40 + :class: longtable + + * - Label + - Name + - Type + - Description + * - **Creation options** + + Optional + - ``CREATE_OPTIONS`` + - [string] + + Default: '' + - For adding one or more creation options that control the + raster to be created (colors, block size, file + compression...). + For convenience, you can rely on predefined profiles (see + :ref:`GDAL driver options section `). + + Batch Process and Model Designer: separate multiple options with a pipe + character (``|``). + Outputs ....... @@ -1421,6 +1651,9 @@ The small membership function is defined as |small_formula|, where Parameters .......... +Basic parameters +^^^^^^^^^^^^^^^^ + .. list-table:: :header-rows: 1 :widths: 20 20 20 40 @@ -1463,6 +1696,34 @@ Parameters :start-after: **file_output_types** :end-before: **end_file_output_types** +Advanced parameters +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: + :header-rows: 1 + :widths: 20 20 20 40 + :class: longtable + + * - Label + - Name + - Type + - Description + * - **Creation options** + + Optional + - ``CREATE_OPTIONS`` + - [string] + + Default: '' + - For adding one or more creation options that control the + raster to be created (colors, block size, file + compression...). + For convenience, you can rely on predefined profiles (see + :ref:`GDAL driver options section `). + + Batch Process and Model Designer: separate multiple options with a pipe + character (``|``). + Outputs ....... @@ -1636,6 +1897,21 @@ Advanced parameters Default: -9999.0 - Value to use for NoData in the output layer + * - **Creation options** + + Optional + - ``CREATE_OPTIONS`` + - [string] + + Default: '' + - For adding one or more creation options that control the + raster to be created (colors, block size, file + compression...). + For convenience, you can rely on predefined profiles (see + :ref:`GDAL driver options section `). + + Batch Process and Model Designer: separate multiple options with a pipe + character (``|``). Outputs ....... @@ -1859,6 +2135,22 @@ Advanced parameters :start-after: **native_raster_data_types** :end-before: **end_native_raster_data_types** + * - **Creation options** + + Optional + - ``CREATE_OPTIONS`` + - [string] + + Default: '' + - For adding one or more creation options that control the + raster to be created (colors, block size, file + compression...). + For convenience, you can rely on predefined profiles (see + :ref:`GDAL driver options section `). + + Batch Process and Model Designer: separate multiple options with a pipe + character (``|``). + Outputs ....... @@ -2013,6 +2305,22 @@ Advanced parameters :start-after: **native_raster_data_types** :end-before: **end_native_raster_data_types** + * - **Creation options** + + Optional + - ``CREATE_OPTIONS`` + - [string] + + Default: '' + - For adding one or more creation options that control the + raster to be created (colors, block size, file + compression...). + For convenience, you can rely on predefined profiles (see + :ref:`GDAL driver options section `). + + Batch Process and Model Designer: separate multiple options with a pipe + character (``|``). + Outputs ....... @@ -3015,6 +3323,22 @@ Advanced parameters :start-after: **native_raster_data_types** :end-before: **end_native_raster_data_types** + * - **Creation options** + + Optional + - ``CREATE_OPTIONS`` + - [string] + + Default: '' + - For adding one or more creation options that control the + raster to be created (colors, block size, file + compression...). + For convenience, you can rely on predefined profiles (see + :ref:`GDAL driver options section `). + + Batch Process and Model Designer: separate multiple options with a pipe + character (``|``). + Outputs ....... @@ -3143,6 +3467,22 @@ Advanced parameters :start-after: **native_raster_data_types** :end-before: **end_native_raster_data_types** + * - **Creation options** + + Optional + - ``CREATE_OPTIONS`` + - [string] + + Default: '' + - For adding one or more creation options that control the + raster to be created (colors, block size, file + compression...). + For convenience, you can rely on predefined profiles (see + :ref:`GDAL driver options section `). + + Batch Process and Model Designer: separate multiple options with a pipe + character (``|``). + Outputs ....... @@ -3190,6 +3530,9 @@ is an option to override it. Parameters .......... +Basic parameters +^^^^^^^^^^^^^^^^ + .. list-table:: :header-rows: 1 :widths: 30 20 20 30 @@ -3241,6 +3584,34 @@ Parameters :start-after: **file_output_types** :end-before: **end_file_output_types** +Advanced parameters +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: + :header-rows: 1 + :widths: 20 20 20 40 + :class: longtable + + * - Label + - Name + - Type + - Description + * - **Creation options** + + Optional + - ``CREATE_OPTIONS`` + - [string] + + Default: '' + - For adding one or more creation options that control the + raster to be created (colors, block size, file + compression...). + For convenience, you can rely on predefined profiles (see + :ref:`GDAL driver options section `). + + Batch Process and Model Designer: separate multiple options with a pipe + character (``|``). + Outputs ....... @@ -3363,6 +3734,21 @@ Advanced parameters Default: 10 - When the ``DECIMAL_PLACES`` parameter is negative, raster values are rounded to multiples of the base n value + * - **Creation options** + + Optional + - ``CREATE_OPTIONS`` + - [string] + + Default: '' + - For adding one or more creation options that control the + raster to be created (colors, block size, file + compression...). + For convenience, you can rely on predefined profiles (see + :ref:`GDAL driver options section `). + + Batch Process and Model Designer: separate multiple options with a pipe + character (``|``). Outputs ....... diff --git a/docs/user_manual/processing_algs/qgis/rastercreation.rst b/docs/user_manual/processing_algs/qgis/rastercreation.rst index 77c22e48a53..5b69aa7e1dd 100644 --- a/docs/user_manual/processing_algs/qgis/rastercreation.rst +++ b/docs/user_manual/processing_algs/qgis/rastercreation.rst @@ -98,6 +98,21 @@ Advanced parameters * 4 --- Unsigned Integer32 * 5 --- Float32 * 6 --- Float64 + * - **Creation options** + + Optional + - ``CREATE_OPTIONS`` + - [string] + + Default: '' + - For adding one or more creation options that control the + raster to be created (colors, block size, file + compression...). + For convenience, you can rely on predefined profiles (see + :ref:`GDAL driver options section `). + + Batch Process and Model Designer: separate multiple options with a pipe + character (``|``). Outputs ....... @@ -223,6 +238,21 @@ Advanced parameters Default: 0.5 - + * - **Creation options** + + Optional + - ``CREATE_OPTIONS`` + - [string] + + Default: '' + - For adding one or more creation options that control the + raster to be created (colors, block size, file + compression...). + For convenience, you can rely on predefined profiles (see + :ref:`GDAL driver options section `). + + Batch Process and Model Designer: separate multiple options with a pipe + character (``|``). Outputs ....... @@ -337,6 +367,21 @@ Advanced parameters Default: 1.0 - + * - **Creation options** + + Optional + - ``CREATE_OPTIONS`` + - [string] + + Default: '' + - For adding one or more creation options that control the + raster to be created (colors, block size, file + compression...). + For convenience, you can rely on predefined profiles (see + :ref:`GDAL driver options section `). + + Batch Process and Model Designer: separate multiple options with a pipe + character (``|``). Outputs ....... @@ -457,6 +502,21 @@ Advanced parameters Default: 1.0 - + * - **Creation options** + + Optional + - ``CREATE_OPTIONS`` + - [string] + + Default: '' + - For adding one or more creation options that control the + raster to be created (colors, block size, file + compression...). + For convenience, you can rely on predefined profiles (see + :ref:`GDAL driver options section `). + + Batch Process and Model Designer: separate multiple options with a pipe + character (``|``). Outputs ....... @@ -576,6 +636,21 @@ Advanced parameters Default: 0.5 - + * - **Creation options** + + Optional + - ``CREATE_OPTIONS`` + - [string] + + Default: '' + - For adding one or more creation options that control the + raster to be created (colors, block size, file + compression...). + For convenience, you can rely on predefined profiles (see + :ref:`GDAL driver options section `). + + Batch Process and Model Designer: separate multiple options with a pipe + character (``|``). Outputs ....... @@ -701,6 +776,21 @@ Advanced parameters Default: 0.5 - + * - **Creation options** + + Optional + - ``CREATE_OPTIONS`` + - [string] + + Default: '' + - For adding one or more creation options that control the + raster to be created (colors, block size, file + compression...). + For convenience, you can rely on predefined profiles (see + :ref:`GDAL driver options section `). + + Batch Process and Model Designer: separate multiple options with a pipe + character (``|``). Outputs ....... @@ -821,6 +911,21 @@ Advanced parameters Default: 1.0 - + * - **Creation options** + + Optional + - ``CREATE_OPTIONS`` + - [string] + + Default: '' + - For adding one or more creation options that control the + raster to be created (colors, block size, file + compression...). + For convenience, you can rely on predefined profiles (see + :ref:`GDAL driver options section `). + + Batch Process and Model Designer: separate multiple options with a pipe + character (``|``). Outputs ....... @@ -940,6 +1045,21 @@ Advanced parameters Default: 1.0 - + * - **Creation options** + + Optional + - ``CREATE_OPTIONS`` + - [string] + + Default: '' + - For adding one or more creation options that control the + raster to be created (colors, block size, file + compression...). + For convenience, you can rely on predefined profiles (see + :ref:`GDAL driver options section `). + + Batch Process and Model Designer: separate multiple options with a pipe + character (``|``). Outputs ....... @@ -1067,6 +1187,21 @@ Advanced parameters Default: 0.0 - + * - **Creation options** + + Optional + - ``CREATE_OPTIONS`` + - [string] + + Default: '' + - For adding one or more creation options that control the + raster to be created (colors, block size, file + compression...). + For convenience, you can rely on predefined profiles (see + :ref:`GDAL driver options section `). + + Batch Process and Model Designer: separate multiple options with a pipe + character (``|``). Outputs ....... diff --git a/docs/user_manual/processing_algs/qgis/rasterterrainanalysis.rst b/docs/user_manual/processing_algs/qgis/rasterterrainanalysis.rst index a6b7cb689c9..4b75b7b4ee4 100644 --- a/docs/user_manual/processing_algs/qgis/rasterterrainanalysis.rst +++ b/docs/user_manual/processing_algs/qgis/rasterterrainanalysis.rst @@ -119,6 +119,9 @@ by either relaxing (``dz_max( d ) = d * s + ci``) or amplifying (``dz_max( d ) = Parameters .......... +Basic parameters +^^^^^^^^^^^^^^^^ + .. list-table:: :header-rows: 1 :widths: 20 20 20 40 @@ -196,6 +199,34 @@ Parameters :start-after: **file_output_types_skip** :end-before: **end_file_output_types_skip** +Advanced parameters +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: + :header-rows: 1 + :widths: 20 20 20 40 + :class: longtable + + * - Label + - Name + - Type + - Description + * - **Creation options** + + Optional + - ``CREATE_OPTIONS`` + - [string] + + Default: '' + - For adding one or more creation options that control the + raster to be created (colors, block size, file + compression...). + For convenience, you can rely on predefined profiles (see + :ref:`GDAL driver options section `). + + Batch Process and Model Designer: separate multiple options with a pipe + character (``|``). + Outputs ....... diff --git a/docs/user_manual/processing_algs/qgis/rastertools.rst b/docs/user_manual/processing_algs/qgis/rastertools.rst index 14d77149a6f..1b1aec065d6 100644 --- a/docs/user_manual/processing_algs/qgis/rastertools.rst +++ b/docs/user_manual/processing_algs/qgis/rastertools.rst @@ -378,6 +378,9 @@ fill value will be truncated when applied to an integer raster. Parameters .......... +Basic parameters +^^^^^^^^^^^^^^^^ + .. list-table:: :header-rows: 1 :widths: 20 20 20 40 @@ -413,6 +416,34 @@ Parameters :start-after: **file_output_types** :end-before: **end_file_output_types** +Advanced parameters +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: + :header-rows: 1 + :widths: 20 20 20 40 + :class: longtable + + * - Label + - Name + - Type + - Description + * - **Creation options** + + Optional + - ``CREATE_OPTIONS`` + - [string] + + Default: '' + - For adding one or more creation options that control the + raster to be created (colors, block size, file + compression...). + For convenience, you can rely on predefined profiles (see + :ref:`GDAL driver options section `). + + Batch Process and Model Designer: separate multiple options with a pipe + character (``|``). + Outputs ....... diff --git a/docs/user_manual/processing_algs/qgis/vectoranalysis.rst b/docs/user_manual/processing_algs/qgis/vectoranalysis.rst index f6dc6564be8..2bc8447cfcc 100644 --- a/docs/user_manual/processing_algs/qgis/vectoranalysis.rst +++ b/docs/user_manual/processing_algs/qgis/vectoranalysis.rst @@ -15,13 +15,11 @@ Basic statistics for fields --------------------------- Generates basic statistics for a field of the attribute table of a vector layer. - Numeric, date, time and string fields are supported. - The statistics returned will depend on the field type. -Statistics are generated as an HTML file and are available in the -:menuselection:`Processing --> Results viewer`. +Statistics can be generated as a table or an HTML file +and are available in the :menuselection:`Processing --> Results viewer`. **Default menu**: :menuselection:`Vector --> Analysis Tools` @@ -46,6 +44,19 @@ Parameters - Any supported table field to calculate the statistics * - **Statistics** + Optional + - ``OUTPUT`` + - [table] + + Default: ``[Create temporary layer]`` + - Specify the output table for the generated statistics. One of: + + .. include:: ../algs_include.rst + :start-after: **layer_output_types** + :end-before: **end_layer_output_types** + + * - **Statistics report** + Optional - ``OUTPUT_HTML_FILE`` - [html] @@ -70,6 +81,10 @@ Outputs - Type - Description * - **Statistics** + - ``OUTPUT`` + - [table] + - Table containing the calculated statistics + * - **Statistics report** - ``OUTPUT_HTML_FILE`` - [html] - HTML file with the calculated statistics