From f87d83e80eb884b1d3bfc7b1877375a1cc1d653f Mon Sep 17 00:00:00 2001 From: Jan Caha Date: Wed, 14 Aug 2024 10:02:15 +0200 Subject: [PATCH 1/5] update tests --- .../doc/tool_optimize_point_location.help | 16 +++++----- .../processing/doc/tool_points_around.help | 20 ++++++------- .../doc/tool_points_by_azimuths.help | 22 +++++++------- .../doc/tool_points_in_direction.help | 20 ++++++------- ...ool_replace_raster_values_by_constant.help | 14 ++++----- .../tool_replace_raster_values_by_field.help | 15 +++++----- .../doc/tool_sizes_at_distances.help | 10 +++---- website/pages/tools/Azimuths/tool_azimuth.md | 1 - .../tool_sizes_at_distances.md | 20 ++++++------- .../tool_optimize_point_location.md | 22 +++++++------- .../Points Creation/tool_points_around.md | 27 +++++++++-------- .../tool_points_by_azimuths.md | 29 +++++++++---------- .../tool_points_in_direction.md | 29 +++++++++---------- .../tool_replace_raster_values_by_constant.md | 21 +++++++------- .../tool_replace_raster_values_by_field.md | 21 +++++++------- 15 files changed, 140 insertions(+), 147 deletions(-) diff --git a/los_tools/processing/doc/tool_optimize_point_location.help b/los_tools/processing/doc/tool_optimize_point_location.help index 707cbec..d669f5c 100755 --- a/los_tools/processing/doc/tool_optimize_point_location.help +++ b/los_tools/processing/doc/tool_optimize_point_location.help @@ -1,9 +1,9 @@ { - "ALG_DESC": "Optimizes point location for visibility analyses using optimization raster. The values of `InputRaster` serve as optimization criterion with higher values marking better options. The result is the copy of `InputLayer` with points location changed.", - "ALG_CREATOR": "Jan Caha", - "InputRaster": "Raster layer used as optimization criterion. Higher values are better.", - "InputLayer": "Point layer that specifies input points.", - "Distance": "Distance around point to search for better value. Linked to parameter `InputRaster`.", - "MaskRaster": "Raster specifying areas that can be used. Values `NoData` and `0` marks area that is unavailable.", - "OutputLayer": "Copy of `InputLayer` with position of points changed." -} + "ALG_DESC": "Optimizes point locations for visibility analyses using an optimization raster. The values of `InputRaster` serve as the optimization criterion, with higher values indicating better options. The result is a copy of `InputLayer` with point locations adjusted.", + "ALG_CREATOR": "Jan Caha", + "InputRaster": "Raster layer used as the optimization criterion. Higher values are better.", + "InputLayer": "Point layer that specifies the input points.", + "Distance": "Distance around each point to search for a better value. Linked to the `InputRaster` parameter.", + "MaskRaster": "Raster specifying areas that can be used. Values `NoData` and `0` mark areas that are unavailable.", + "OutputLayer": "Copy of `InputLayer` with adjusted point positions." +} \ No newline at end of file diff --git a/los_tools/processing/doc/tool_points_around.help b/los_tools/processing/doc/tool_points_around.help index 69ea0d8..6968a52 100755 --- a/los_tools/processing/doc/tool_points_around.help +++ b/los_tools/processing/doc/tool_points_around.help @@ -1,11 +1,11 @@ { - "ALG_DESC": "Create points at given distance from points from input layer that span from minimal to maximal angle with specified angle step.", - "ALG_CREATOR": "Jan Caha", - "InputLayer": "Point layer around which the new points will be created.", - "IdField": "Field value to assign to `id_original_point` for new layer.", - "AngleStart": "Angle (azimuth) at which the generation of points should start.", - "AngleEnd": "Angle (azimuth) at which the generation of points should end.", - "AngleStep": "Determines density of point placement between `Minimal angle` and `Maximal angle`. Angular distance of points. Number of points will be (`Maximal angle` - `Minimal angle`) / `AngleStep`.", - "Distance": "How far from the original point the new points should be created.", - "OutputLayer": "Output layer containing LoS with new attributes." -} + "ALG_DESC": "Creates points at a specified distance from points in the input layer, spanning from a minimal to a maximal angle with a specified angle step.", + "ALG_CREATOR": "Jan Caha", + "InputLayer": "Point layer around which the new points will be created.", + "IdField": "Field value to assign to `id_original_point` for the new layer.", + "AngleStart": "Angle (azimuth) at which the generation of points should start.", + "AngleEnd": "Angle (azimuth) at which the generation of points should end.", + "AngleStep": "Determines the density of point placement between `AngleStart` and `AngleEnd`. The angular distance between points. The number of points will be (`AngleEnd` - `AngleStart`) / `AngleStep`.", + "Distance": "Distance from the original point at which the new points should be created.", + "OutputLayer": "Output layer containing the new points." +} \ No newline at end of file diff --git a/los_tools/processing/doc/tool_points_by_azimuths.help b/los_tools/processing/doc/tool_points_by_azimuths.help index 548ead1..9a9c289 100755 --- a/los_tools/processing/doc/tool_points_by_azimuths.help +++ b/los_tools/processing/doc/tool_points_by_azimuths.help @@ -1,12 +1,12 @@ { - "ALG_DESC": "Create points set of points at given distance from points from input layer that span given angle offset from main direction layer.", - "ALG_CREATOR": "Jan Caha", - "InputLayer": "Point layer around which the new points will be created.", - "IdField": "Field value to assign to `id_original_point` for new layer.", - "AngleStart": "Angle (azimuth) at which the generation of points should start.", - "AngleEnd": "Angle (azimuth) at which the generation of points should end.", - "OverNorth": "Specify if the number goes trough North (azimuth 0), as there are two ways to connect azimuths 90 - 270, one through south (over azimuth 180) and second through north (azimuth 0 or 360).", - "AngleStep": "Determines density of point placement between `Minimal angle` and `Maximal angle`. Angular distance of points. Number of points will be (`Maximal angle` - `Minimal angle`) / `AngleStep`.", - "Distance": "How far from the original point the new points should be created.", - "OutputLayer": "Output layer containing LoS with new attributes." -} + "ALG_DESC": "Creates a set of points at a specified distance from points in the input layer, spanning a given angle offset from the main direction layer.", + "ALG_CREATOR": "Jan Caha", + "InputLayer": "Point layer around which the new points will be created.", + "IdField": "Field value to assign to `id_original_point` for the new layer.", + "AngleStart": "Angle (azimuth) at which the generation of points should start.", + "AngleEnd": "Angle (azimuth) at which the generation of points should end.", + "OverNorth": "Specify if the angle spans through North (azimuth 0). There are two ways to connect azimuths 90 - 270: one through south (over azimuth 180) and the other through north (azimuth 0 or 360).", + "AngleStep": "Determines the density of point placement between `AngleStart` and `AngleEnd`. The angular distance between points. The number of points will be (`AngleEnd` - `AngleStart`) / `AngleStep`.", + "Distance": "Distance from the original point at which the new points should be created.", + "OutputLayer": "Output layer containing the new points." +} \ No newline at end of file diff --git a/los_tools/processing/doc/tool_points_in_direction.help b/los_tools/processing/doc/tool_points_in_direction.help index b99fd8b..1003943 100755 --- a/los_tools/processing/doc/tool_points_in_direction.help +++ b/los_tools/processing/doc/tool_points_in_direction.help @@ -1,11 +1,11 @@ { - "ALG_DESC": "Create set of points at given distance from points from input layer that span given angle offset from main direction layer.", - "ALG_CREATOR": "Jan Caha", - "InputLayer": "Point layer around which the new points will be created.", - "DirectionLayer": "Point layer (containing only one point) that specifies main direction.", - "IdField": "Field value to assign to `id_original_point` for new layer.", - "AngleOffset": "Offset from main direction, the whole range is [main azimuth - angleOffset;main azimuth + angleOffset].", - "AngleStep": "Determines density of point placement between `Minimal angle` and `Maximal angle`. Angular distance of points. Number of points will be (`Maximal angle` - `Minimal angle`) / `AngleStep`.", - "Distance": "How far from the original point the new points should be created.", - "OutputLayer": "Output layer containing LoS with new attributes." -} + "ALG_DESC": "Creates a set of points at a given distance from points in the input layer, spanning a specified angle offset from the main direction layer.", + "ALG_CREATOR": "Jan Caha", + "InputLayer": "Point layer around which the new points will be created.", + "DirectionLayer": "Point layer (containing only one point) that specifies the main direction.", + "IdField": "Field value to assign to `id_original_point` for the new layer.", + "AngleOffset": "Offset from the main direction. The whole range is [main azimuth - angleOffset; main azimuth + angleOffset].", + "AngleStep": "Determines the density of point placement between `Minimal angle` and `Maximal angle`. The angular distance between points. The number of points will be (`Maximal angle` - `Minimal angle`) / `AngleStep`.", + "Distance": "Distance from the original point at which the new points should be created.", + "OutputLayer": "Output layer containing the new points." +} \ No newline at end of file diff --git a/los_tools/processing/doc/tool_replace_raster_values_by_constant.help b/los_tools/processing/doc/tool_replace_raster_values_by_constant.help index 6c5ce26..d0e843e 100755 --- a/los_tools/processing/doc/tool_replace_raster_values_by_constant.help +++ b/los_tools/processing/doc/tool_replace_raster_values_by_constant.help @@ -1,8 +1,8 @@ { - "ALG_DESC": "Tool to replace raster values in polygons by constant value (specified by `RasterValue`). ", - "ALG_CREATOR": "Jan Caha", - "RasterLayer": "Raster layer to use as base.", - "VectorLayer": "Vector layer that specifies areas of raster to replace the values.", - "RasterValue": "Value to use as replacement.", - "OutputRaster": "Output raster with new values." -} + "ALG_DESC": "Replaces raster values within specified polygons with a constant value.", + "ALG_CREATOR": "Jan Caha", + "RasterLayer": "Raster layer to use as the base.", + "VectorLayer": "Vector layer specifying the areas of the raster where values will be replaced.", + "RasterValue": "Constant value to use as the replacement.", + "OutputRaster": "Output raster with the new values." +} \ No newline at end of file diff --git a/los_tools/processing/doc/tool_replace_raster_values_by_field.help b/los_tools/processing/doc/tool_replace_raster_values_by_field.help index 6490623..5985137 100755 --- a/los_tools/processing/doc/tool_replace_raster_values_by_field.help +++ b/los_tools/processing/doc/tool_replace_raster_values_by_field.help @@ -1,9 +1,8 @@ { - "ALG_DESC": "Tool to replace raster values in polygons by field value (defined by `ValueField`). ", - "ALG_CREATOR": "Jan Caha", - "RasterLayer": "Raster layer to use as base.", - "VectorLayer": "Vector layer that specifies areas of raster to replace the values.", - "RasterValue": "Value to use as replacement.", - "ValueField": "Field from vector layer that defines values that should be used in output raster.", - "OutputRaster": "Output raster with new values." -} + "ALG_DESC": "Tool to replace raster values within polygons based on a specified field value (`ValueField`).", + "ALG_CREATOR": "Jan Caha", + "RasterLayer": "Base raster layer.", + "VectorLayer": "Vector layer defining areas where raster values will be replaced.", + "ValueField": "Field from the vector layer specifying the values to use in the output raster.", + "OutputRaster": "Output raster with updated values." +} \ No newline at end of file diff --git a/los_tools/processing/doc/tool_sizes_at_distances.help b/los_tools/processing/doc/tool_sizes_at_distances.help index a416e43..86f3ebd 100755 --- a/los_tools/processing/doc/tool_sizes_at_distances.help +++ b/los_tools/processing/doc/tool_sizes_at_distances.help @@ -1,9 +1,9 @@ { - "ALG_DESC": "The tool calculates sizes of objects at specific distances (specified in the table) that have given horizontal angular size.

I.e. what sizes of objects have given horizontal angular size at distances specified in the table.

To be usable in other plugin tools, there are two necessary parameter to be set: default sampling size, used before first distance from the table is used, and maximal distance. Both adds special row into the output table so that it can be later correctly processed.", - "ALG_CREATOR": "Jan Caha", + "ALG_DESC": "This tool calculates the sizes of objects at specific distances (as specified in the table) that have a given horizontal angular size.

For example, it determines the sizes of objects that have a given horizontal angular size at the distances specified in the table.

To be usable in other plugin tools, two necessary parameters must be set: the default sampling size, used before the first distance from the table is applied, and the maximal distance. Both add a special row into the output table so that it can be correctly processed later.", + "ALG_CREATOR": "Jan Caha", "Angle": "Horizontal angular size that the objects should have (in degrees).", "Distance": "Distances of the objects in meters (table).", - "DefaultSamplingDistance": "Sampling distance to used, in tools that work with this table, for values smaller then smallest distance..", - "MaximalDistance": "Add special row to the output used in other tools. The row has size of the object equal to maximum size in the input table and distance -1. This is used to indicate maximal possible legth of LoS.", - "OutputTable": "Output table containing information about angle size, size of objects and relevant distances." + "DefaultSamplingDistance": "Sampling distance to be used in tools that work with this table for values smaller than the smallest distance.", + "MaximalDistance": "Adds a special row to the output used in other tools. The row has the size of the object equal to the maximum size in the input table and a distance of -1. This is used to indicate the maximal possible length of the line of sight (LoS).", + "OutputTable": "Output table containing information about the angle size, size of objects, and relevant distances." } \ No newline at end of file diff --git a/website/pages/tools/Azimuths/tool_azimuth.md b/website/pages/tools/Azimuths/tool_azimuth.md index f10cad8..e9090e6 100755 --- a/website/pages/tools/Azimuths/tool_azimuth.md +++ b/website/pages/tools/Azimuths/tool_azimuth.md @@ -29,4 +29,3 @@ For $n$ points and $m$ lines/polygons the output layer will have $n \times m$ ro ## Tool screenshot ![Extract Azimuth between Points and Centroids](../../images/tool_azimuth.png) - \ No newline at end of file diff --git a/website/pages/tools/Calculate Parameters Settings/tool_sizes_at_distances.md b/website/pages/tools/Calculate Parameters Settings/tool_sizes_at_distances.md index 1bd3971..9a15caf 100755 --- a/website/pages/tools/Calculate Parameters Settings/tool_sizes_at_distances.md +++ b/website/pages/tools/Calculate Parameters Settings/tool_sizes_at_distances.md @@ -10,19 +10,19 @@ To be usable in other plugin tools, there are two necessary parameters to be set ## Parameters -| Label | Name | Type | Description | -| ----------------------------------------------------------------------------- | ------------------------- | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Angle size of object (in degrees) | `Angle` | [number]

Default:
`0.1` | Horizontal angular size that the objects should have (in degrees). | -| Distances to calculate object size (in meters) | `Distance` | [matrix] | Distances of the objects in meters (table). | -| Default sampling size (in meters) | `DefaultSamplingDistance` | [number]

Default:
`1.0` | Sampling distance to used, in tools that work with this table, for values smaller than smallest distance. | -| Add maximal distance value (with sampling equal to maximal sampling distance) | `MaximalDistance` | [boolean]

Default: `True` | Add special row to the output used in other tools. The row has size of the object equal to maximum size in the input table and distance -1. This is used to indicate maximal possible legth of LoS. | -| Output table | `OutputTable` | [table] | Output table containing information about angle size, size of objects and relevant distances (without geometry). | +| Label | Name | Type | Description | +| ----------------------------------------------------------------------------- | ------------------------- | --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Angle size of object (in degrees) | `Angle` | [number]

Default:
`0.1` | Horizontal angular size that the objects should have (in degrees). | +| Distances to calculate object size (in meters) | `Distance` | [matrix] | Distances of the objects in meters (table). | +| Default sampling size (in meters) | `DefaultSamplingDistance` | [number]

Default:
`1.0` | Sampling distance to be used in tools that work with this table for values smaller than the smallest distance. | +| Add maximal distance value (with sampling equal to maximal sampling distance) | `MaximalDistance` | [boolean]

Default: `True` | Adds a special row to the output used in other tools. The row has the size of the object equal to the maximum size in the input table and a distance of -1. This is used to indicate the maximal possible length of the line of sight (LoS). | +| Output table | `OutputTable` | [table] | Output table containing information about the angle size, size of objects, and relevant distances. | ## Outputs -| Label | Name | Type | Description | -| ------------ | ------------- | ------- | --------------------------------------------------------------------------------------------------------------- | -| Output table | `OutputTable` | [table] | Output table containing information about angle size, size of objects and relevant distances (without geometry) | +| Label | Name | Type | Description | +| ------------ | ------------- | ------- | -------------------------------------------------------------------------------------------------- | +| Output table | `OutputTable` | [table] | Output table containing information about the angle size, size of objects, and relevant distances. | ### Fields in the output layer diff --git a/website/pages/tools/Points Creation/tool_optimize_point_location.md b/website/pages/tools/Points Creation/tool_optimize_point_location.md index c622974..8e2e5c4 100755 --- a/website/pages/tools/Points Creation/tool_optimize_point_location.md +++ b/website/pages/tools/Points Creation/tool_optimize_point_location.md @@ -1,24 +1,24 @@ # Optimize Point Location -Optimizes point location for visibility analyses using optimization raster. The values of `InputRaster` serve as optimization criterion with higher values marking better options. The result is the copy of `InputLayer` with points location changed. +Optimizes point locations for visibility analyses using an optimization raster. The values of `InputRaster` serve as the optimization criterion, with higher values indicating better options. The result is a copy of `InputLayer` with point locations adjusted. The optimization process is guided by two addition parameters - `Distance` and `MaskRaster`. `Distance` specifies distance around origin point to search for better values on `InputRaster` to move the point to. `MaskRaster` allows to optionally input raster that can move forbid some areas to be used as new point location. `MaskRaster` values `NoData` and `0` can be used to mark unavailable areas, other values can be used to place optimized points. ## Parameters -| Label | Name | Type | Description | -| -------------------------------------- | ------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------- | -| Location optimization raster | `InputRaster` | [raster] | Raster layer used as optimization criterion. Higher values are better. | -| Input point layer (points to optimize) | `InputLayer` | [vector: point] | Point layer that specifies input points. | -| Search radius | `Distance` | [number]

Default:
`30` | Distance around point to search for better value. Linked to parameter `InputRaster`. | -| Mask raster | `MaskRaster` | [raster] | Raster specifying areas that can be used. Values `NoData` and `0` marks area that is unavailable. | -| Output layer (optimized points) | `OutputLayer` | [vector: point] | Copy of `InputLayer` with position of points changed. | +| Label | Name | Type | Description | +| -------------------------------------- | ------------- | --------------------------------------- | -------------------------------------------------------------------------------------------------- | +| Location optimization raster | `InputRaster` | [raster] | Raster layer used as the optimization criterion. Higher values are better. | +| Input point layer (points to optimize) | `InputLayer` | [vector: point] | Point layer that specifies the input points. | +| Search radius | `Distance` | [number]

Default:
`30` | Distance around each point to search for a better value. Linked to the `InputRaster` parameter. | +| Mask raster | `MaskRaster` | [raster] | Raster specifying areas that can be used. Values `NoData` and `0` mark areas that are unavailable. | +| Output layer (optimized points) | `OutputLayer` | [vector: point] | Copy of `InputLayer` with adjusted point positions. | ## Outputs -| Label | Name | Type | Description | -| ------------------------------- | ------------- | --------------- | ----------------------------------------------------- | -| Output layer (optimized points) | `OutputLayer` | [vector: point] | Copy of `InputLayer` with position of points changed. | +| Label | Name | Type | Description | +| ------------------------------- | ------------- | --------------- | --------------------------------------------------- | +| Output layer (optimized points) | `OutputLayer` | [vector: point] | Copy of `InputLayer` with adjusted point positions. | ### Fields in the output layer diff --git a/website/pages/tools/Points Creation/tool_points_around.md b/website/pages/tools/Points Creation/tool_points_around.md index 3a12a4c..ab61ee2 100755 --- a/website/pages/tools/Points Creation/tool_points_around.md +++ b/website/pages/tools/Points Creation/tool_points_around.md @@ -1,26 +1,26 @@ # Create Points Around -Create points at given distance from points from input layer that span from minimal to maximal angle with specified angle step. +Creates points at a specified distance from points in the input layer, spanning from a minimal to a maximal angle with a specified angle step. The default values create points from angle 0 (north) to angle 359 (almost north) by one 1 degree, which means 360 points (one point per degree). ## Parameters -| Label | Name | Type | Description | -| ---------------------------- | ------------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| Input point layer | `InputLayer` | [vector: point] | Point layer around which the new points will be created. | -| ID field to assign to output | `IdField` | [tablefield: numeric] | Field value to assign to `id_original_point` for new layer. | -| Minimal angle | `AngleStart` | [number]

Default:
`0` | Angle (azimuth) at which the generation of points should start. | -| Maximal angle | `AngleEnd` | [number]

Default:
`359` | Angle (azimuth) at which the generation of points should end. | -| Angle step | `AngleStep` | [number]

Default:
`1` | Determines density of point placement between `Minimal angle` and `Maximal angle`. Angular distance of points. Number of points will be (`Maximal angle` - `Minimal angle`) / `AngleStep`. | -| Distance | `Distance` | [number]

Default:
`10` | How far from the original point the new points should be created. | -| Output layer | `OutputLayer` | [vector: point] | Output layer containing points. | +| Label | Name | Type | Description | +| ---------------------------- | ------------- | ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Input point layer | `InputLayer` | [vector: point] | Point layer around which the new points will be created. | +| ID field to assign to output | `IdField` | [tablefield: numeric] | Field value to assign to `id_original_point` for the new layer. | +| Minimal angle | `AngleStart` | [number]

Default:
`0` | Angle (azimuth) at which the generation of points should start. | +| Maximal angle | `AngleEnd` | [number]

Default:
`359` | Angle (azimuth) at which the generation of points should end. | +| Angle step | `AngleStep` | [number]

Default:
`1` | DDetermines the density of point placement between `AngleStart` and `AngleEnd`. The angular distance between points. The number of points will be (`AngleEnd` - `AngleStart`) / `AngleStep`. | +| Distance | `Distance` | [number]

Default:
`10` | Distance from the original point at which the new points should be created. | +| Output layer | `OutputLayer` | [vector: point] | Output layer containing the new points. | ## Outputs -| Label | Name | Type | Description | -| ------------ | ------------- | --------------- | ------------------------------- | -| Output layer | `OutputLayer` | [vector: point] | Output layer containing points. | +| Label | Name | Type | Description | +| ------------ | ------------- | --------------- | --------------------------------------- | +| Output layer | `OutputLayer` | [vector: point] | Output layer containing the new points. | ### Fields in the output layer @@ -31,4 +31,3 @@ The default values create points from angle 0 (north) to angle 359 (almost north ## Tool screenshot ![Create points around](../../images/tool_points_around.png) - \ No newline at end of file diff --git a/website/pages/tools/Points Creation/tool_points_by_azimuths.md b/website/pages/tools/Points Creation/tool_points_by_azimuths.md index f19617d..aa742bb 100755 --- a/website/pages/tools/Points Creation/tool_points_by_azimuths.md +++ b/website/pages/tools/Points Creation/tool_points_by_azimuths.md @@ -1,27 +1,27 @@ # Create Points by Azimuths -Create points at given distance from points from input layer that span from minimal to maximal azimuth with specified angle step. +Creates a set of points at a specified distance from points in the input layer, spanning a given angle offset from the main direction layer. The default values create points from angle 0 (north) to angle 360 (almost north) by one 1 degree, which means 360 points (one point per degree). But smaller section can be generated. For example just wedge from 90 to 180 degrees. It is possible to also select the opposite wedge by checking _Goes trough north (0 or 360 degrees)_ option. That will generate values from 180 to 360 and then 0 to 90 to fulfill the requirement. ## Parameters -| Label | Name | Type | Description | -| ------------------------------------ | ------------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| Input point layer | `InputLayer` | [vector: point] | Point layer around which the new points will be created. | -| ID field to assign to output | `IdField` | [tablefield: numeric] | Field value to assign to `id_original_point` for new layer. | -| Minimal angle | `AngleStart` | [number]

Default:
`0` | Angle (azimuth) at which the generation of points should start. | -| Maximal angle | `AngleEnd` | [number]

Default:
`359` | Angle (azimuth) at which the generation of points should end. | -| Goes trough north (0 or 360 degrees) | `OverNorth` | [boolean]

Default: `True` | Specify if the number goes trough North (azimuth 0), as there are two ways to connect azimuths 90 - 270, one through south (over azimuth 180) and second through north (azimuth 0 or 360). | -| Angle step | `AngleStep` | [number]

Default:
`1` | Determines density of point placement between `Minimal angle` and `Maximal angle`. Angular distance of points. Number of points will be (`Maximal angle` - `Minimal angle`) / `AngleStep`.| -| Distance | `Distance` | [number]

Default:
`10` | How far from the original point the new points should be created. | -| Output layer | `OutputLayer` | [vector: point] | Output layer containing points. | +| Label | Name | Type | Description | +| ------------------------------------ | ------------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Input point layer | `InputLayer` | [vector: point] | Point layer around which the new points will be created. | +| ID field to assign to output | `IdField` | [tablefield: numeric] | Field value to assign to `id_original_point` for the new layer. | +| Minimal angle | `AngleStart` | [number]

Default:
`0` | Angle (azimuth) at which the generation of points should start. | +| Maximal angle | `AngleEnd` | [number]

Default:
`359` | Angle (azimuth) at which the generation of points should end. | +| Goes trough north (0 or 360 degrees) | `OverNorth` | [boolean]

Default: `True` | Specify if the angle spans through North (azimuth 0). There are two ways to connect azimuths 90 - 270: one through south (over azimuth 180) and the other through north (azimuth 0 or 360). | +| Angle step | `AngleStep` | [number]

Default:
`1` | Determines density of point placement between `Minimal angle` and `Maximal angle`. Angular distance of points. Number of points will be (`Maximal angle` - `Minimal angle`) / `AngleStep`. | +| Distance | `Distance` | [number]

Default:
`10` | Distance from the original point at which the new points should be created. | +| Output layer | `OutputLayer` | [vector: point] | Output layer containing the new points. | ## Outputs -| Label | Name | Type | Description | -| ------------ | ------------- | --------------- | ------------------------------- | -| Output layer | `OutputLayer` | [vector: point] | Output layer containing points. | +| Label | Name | Type | Description | +| ------------ | ------------- | --------------- | --------------------------------------- | +| Output layer | `OutputLayer` | [vector: point] | Output layer containing the new points. | ### Fields in the output layer @@ -32,4 +32,3 @@ The default values create points from angle 0 (north) to angle 360 (almost north ## Tool screenshot ![Create points around](../../images/tool_points_by_azimuths.png) - \ No newline at end of file diff --git a/website/pages/tools/Points Creation/tool_points_in_direction.md b/website/pages/tools/Points Creation/tool_points_in_direction.md index 90f56ee..96f027a 100644 --- a/website/pages/tools/Points Creation/tool_points_in_direction.md +++ b/website/pages/tools/Points Creation/tool_points_in_direction.md @@ -1,26 +1,26 @@ # Create Points in Direction -Create set of points at given distance from points from input layer that span given angle offset from main direction layer. +Creates a set of points at a given distance from points in the input layer, spanning a specified angle offset from the main direction layer. The default value produces range of values [-20;20] by one angle from azimuth of point in main direction layer. ## Parameters -| Label | Name | Type | Description | -| ------------------------------------ | ---------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| Input point layer | `InputLayer` | [vector: point] | Point layer around which the new points will be created. | -| Main direction point layer | `DirectionLayer` | [vector: point] | Point layer (containing only one point) that specifies main direction. | -| ID field to assign to output | `IdField` | [tablefield: numeric] | Field value to assign to `id_original_point` for new layer. | -| Angle offset from the main direction | `AngleOffset` | [number]

Default:
`20` | Offset from main direction, the whole range is [main azimuth - angleOffset;main azimuth + angleOffset]. | -| Angle step | `AngleStep` | [number]

Default:
`1` | Determines density of point placement between `Minimal angle` and `Maximal angle`. Angular distance of points. Number of points will be (`Maximal angle` - `Minimal angle`) / `AngleStep`. | -| Distance | `Distance` | [number]

Default:
`10` | How far from the original point the new points should be created. | -| Output layer | `OutputLayer` | [vector: point] | Output layer containing points. | +| Label | Name | Type | Description | +| ------------------------------------ | ---------------- | --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Input point layer | `InputLayer` | [vector: point] | Point layer around which the new points will be created. | +| Main direction point layer | `DirectionLayer` | [vector: point] | Point layer (containing only one point) that specifies the main direction. | +| ID field to assign to output | `IdField` | [tablefield: numeric] | Field value to assign to `id_original_point` for the new layer. | +| Angle offset from the main direction | `AngleOffset` | [number]

Default:
`20` | Offset from the main direction. The whole range is [main azimuth - angleOffset; main azimuth + angleOffset]. | +| Angle step | `AngleStep` | [number]

Default:
`1` | Determines the density of point placement between `Minimal angle` and `Maximal angle`. The angular distance between points. The number of points will be (`Maximal angle` - `Minimal angle`) / `AngleStep`. | +| Distance | `Distance` | [number]

Default:
`10` | Distance from the original point at which the new points should be created. | +| Output layer | `OutputLayer` | [vector: point] | Output layer containing the new points. | ## Outputs -| Label | Name | Type | Description | -| ------------ | ------------- | --------------- | ------------------------------- | -| Output layer | `OutputLayer` | [vector: point] | Output layer containing points. | +| Label | Name | Type | Description | +| ------------ | ------------- | --------------- | --------------------------------------- | +| Output layer | `OutputLayer` | [vector: point] | Output layer containing the new points. | ### Fields in the output layer @@ -29,8 +29,7 @@ The default value produces range of values [-20;20] by one angle from azimuth of * __id_point__ - integer - unique id value for the point * __difference_to_main_azimuth__ - double - difference of main point azimuth to this point's azimuth * __angle_step_between_points__ - double - azimuth step between individual points -* + ## Tool screenshot ![Create points in direction](../../images/tool_points_in_direction.png) - \ No newline at end of file diff --git a/website/pages/tools/Raster Editing/tool_replace_raster_values_by_constant.md b/website/pages/tools/Raster Editing/tool_replace_raster_values_by_constant.md index 2dee648..cca9118 100755 --- a/website/pages/tools/Raster Editing/tool_replace_raster_values_by_constant.md +++ b/website/pages/tools/Raster Editing/tool_replace_raster_values_by_constant.md @@ -1,23 +1,22 @@ # Replace Raster Values by Constant Value -Tool to replace raster values in polygons with constant value (specified by `RasterValue`). +Replaces raster values within specified polygons with a constant value. ## Parameters -| Label | Name | Type | Description | -| ------------------------ | -------------- | ----------------- | ------------------------------------------------------------------ | -| Raster Layer | `RasterLayer` | [raster] | Raster layer to use as base. | -| Vector Layer | `VectorLayer` | [vector: polygon] | Vector layer that specifies areas of raster to replace the values. | -| Raster value for polygon | `RasterValue` | [number] | Value to use as replacement. | -| Output Raster | `OutputRaster` | [raster] | Output raster with new values. | +| Label | Name | Type | Description | +| ------------------------ | -------------- | ----------------- | ------------------------------------------------------------------------------ | +| Raster Layer | `RasterLayer` | [raster] | Raster layer to use as the base. | +| Vector Layer | `VectorLayer` | [vector: polygon] | Vector layer specifying the areas of the raster where values will be replaced. | +| Raster value for polygon | `RasterValue` | [number] | Constant value to use as the replacement. | +| Output Raster | `OutputRaster` | [raster] | Output raster with the new values. | ## Outputs -| Label | Name | Type | Description | -| ------------- | -------------- | -------- | ------------------------------ | -| Output Raster | `OutputRaster` | [raster] | Output raster with new values. | +| Label | Name | Type | Description | +| ------------- | -------------- | -------- | ---------------------------------- | +| Output Raster | `OutputRaster` | [raster] | Output raster with the new values. | ## Tool screenshot ![Replace Raster Values by Constant Value](../../images/tool_replace_raster_values_by_constant.png) - \ No newline at end of file diff --git a/website/pages/tools/Raster Editing/tool_replace_raster_values_by_field.md b/website/pages/tools/Raster Editing/tool_replace_raster_values_by_field.md index bb6d187..0b5c71c 100755 --- a/website/pages/tools/Raster Editing/tool_replace_raster_values_by_field.md +++ b/website/pages/tools/Raster Editing/tool_replace_raster_values_by_field.md @@ -1,23 +1,22 @@ # Replace Raster Values by Field Values -Tool to replace raster values in polygons with field values (defined by `ValueField`). +Tool to replace raster values within polygons based on a specified field value (`ValueField`). ## Parameters -| Label | Name | Type | Description | -| ---------------------------- | -------------- | --------------------- | --------------------------------------------------------------------------------- | -| Raster Layer | `RasterLayer` | [raster] | Raster layer to use as base. | -| Vector Layer | `VectorLayer` | [vector: polygon] | Vector layer that specifies areas of raster to replace the values. | -| Field specifying replacement | `ValueField` | [tablefield: numeric] | Field from vector layer that defines values that should be used in output raster. | -| Output Raster | `OutputRaster` | [raster] | Output raster with new values. | +| Label | Name | Type | Description | +| ---------------------------- | -------------- | --------------------- | ------------------------------------------------------------------------------ | +| Raster Layer | `RasterLayer` | [raster] | Base raster layer. | +| Vector Layer | `VectorLayer` | [vector: polygon] | Vector layer defining areas where raster values will be replaced. | +| Field specifying replacement | `ValueField` | [tablefield: numeric] | Field from the vector layer specifying the values to use in the output raster. | +| Output Raster | `OutputRaster` | [raster] | Output raster with updated values. | ## Outputs -| Label | Name | Type | Description | -| ------------- | -------------- | -------- | ------------------------------ | -| Output Raster | `OutputRaster` | [raster] | Output raster with new values. | +| Label | Name | Type | Description | +| ------------- | -------------- | -------- | ---------------------------------- | +| Output Raster | `OutputRaster` | [raster] | Output raster with updated values. | ## Tool screenshot ![Replace Raster Values by Field Values](../../images/tool_replace_raster_values_by_field.png) - \ No newline at end of file From a53121d3be7f91d7e3b2050da03b47fea7a5e79e Mon Sep 17 00:00:00 2001 From: Jan Caha Date: Wed, 14 Aug 2024 10:02:26 +0200 Subject: [PATCH 2/5] update index --- website/pages/index.md | 35 ++++++++++++++++++----------------- 1 file changed, 18 insertions(+), 17 deletions(-) diff --git a/website/pages/index.md b/website/pages/index.md index 3fadc84..e889da6 100755 --- a/website/pages/index.md +++ b/website/pages/index.md @@ -1,40 +1,41 @@ # LoS Tools -QGIS plugin to create and analyse lines-of-sight. Provides also set of supporting tools. The plugin is focused on point to point visibility, in contrast to classic viewshed analysis which is point to area. Besides that it provides tools for identification of horizon points (on LoS), horizon lines (from a set of LoS) and also additional useful tools related to visibility analysis. +QGIS plugin to create and analyze lines-of-sight. It also provides a set of supporting tools. The plugin focuses on point-to-point visibility, in contrast to classic viewshed analysis, which is point-to-area. Additionally, it provides tools for identifying horizon points (on LoS), horizon lines (from a set of LoS), and other useful tools related to visibility analysis. -## Link to QGIS Plugin repository +## Link to QGIS Plugin Repository -Plugin is available here: [https://plugins.qgis.org/plugins/los_tools/](https://plugins.qgis.org/plugins/los_tools/) +The plugin is available here: [https://plugins.qgis.org/plugins/los_tools/](https://plugins.qgis.org/plugins/los_tools/) -## Important terms +## Important Terms -### Line-of-sight (LoS) +### Line-of-Sight (LoS) -Line from a specific observer point (observer) that to or through specific target point. This plugin defines three types of LoS: local, global, without target. +A line from a specific observer point (observer) to or through a specific target point. This plugin defines three types of LoS: local, global, and without target. -The local and global LoS are used to describe visibility of specific target (i.e. highest point of building, top of the hill etc.) from observing points. Local LoS is strictly between observer and target and does not allow to assess the visibility behind the target. Global LoS is from observer through target but continues behind it as much as underlying elevation raster allows. Global LoS allows assesment of visibility of target with respect to surface located behind it. +Local and global LoS are used to describe the visibility of a specific target (e.g., the highest point of a building, the top of a hill) from observing points. Local LoS is strictly between the observer and the target and does not allow for the assessment of visibility behind the target. Global LoS extends from the observer through the target and continues behind it as far as the underlying elevation raster allows. Global LoS allows for the assessment of the visibility of the target with respect to the surface located behind it. -LoS without target is a special case of LoS where the target point serves only as descriptor of direction and is not used to evaluate visibility at all. The target points for this can be generated by tools [Create points around](./tools/Points Creation/tool_points_around.md) and [Create points in direction](./tools/Points Creation/tool_points_in_direction.md). Sets of LoS generated using these tools can be used to identify horizon lines. +LoS without target is a special case of LoS where the target point serves only as a descriptor of direction and is not used to evaluate visibility at all. The target points for this can be generated by the tools [Create Points Around](./tools/Points Creation/tool_points_around.md) and [Create Points in Direction](./tools/Points Creation/tool_points_in_direction.md). Sets of LoS generated using these tools can be used to identify horizon lines. ### Horizons -Generally, horizon is a point on LoS that is visible and is immediately followed by an invisible point. There are several types of horizons mentioned in the plugin's tools. Mainly local and global horizons and horizon lines. +Generally, a horizon is a point on LoS that is visible and is immediately followed by an invisible point. There are several types of horizons mentioned in the plugin's tools, mainly local and global horizons and horizon lines. -Global horizon is a horizon that is highest on LoS and if the surface raster extent is sufficient it should be the point where LoS meets the sky. LoS have just one global horizon. +A global horizon is the highest point on the LoS and, if the surface raster extent is sufficient, it should be the point where the LoS meets the sky. Each LoS has just one global horizon. -Local horizon is any horizon on LoS that is not global. There may be any number of local horizons on LoS. Amogst these local horizons the highest local horizon can be useful for some analyses. The maximal local horizon is the highest horizon that is not global. +A local horizon is any horizon on the LoS that is not global. There may be multiple local horizons on an LoS. Among these local horizons, the highest local horizon can be useful for some analyses. The maximal local horizon is the highest horizon that is not global. -### DEM use in the plugin -Most tools in the plugin allow you to use more than one DEM raster. The rasters are ordered from smallest cell size to the biggest. The cell size of each raster must be unique to form complete ordering of rasters. Elevation is always obtained from raster with smallest cell size that has valid elevation value (no data is not considered as valid value). This allows utilization of DEM with large cells as addition to DEM with smaller cells. For example DEM with cell size 1 meter can be used within city for areas close to observers and SRTM data (30 meter cell size) in areas around the city, far from the observer. +### DEM Use in the Plugin -### LoS Sampling strategy +Most tools in the plugin allow you to use more than one DEM raster. The rasters are ordered from the smallest cell size to the largest. The cell size of each raster must be unique to form a complete ordering of rasters. Elevation is always obtained from the raster with the smallest cell size that has a valid elevation value (no data is not considered a valid value). This allows the utilization of DEMs with large cells in addition to DEMs with smaller cells. For example, a DEM with a cell size of 1 meter can be used within a city for areas close to observers, and SRTM data (30 meter cell size) can be used in areas around the city, far from the observer. -For tools [Create Global LoS](./tools/LoS%20Creation/tool_create_global_los.md), [Create Local LoS](./tools/LoS%20Creation/tool_create_local_los.md), [Create No Target LoS](./tools/LoS%20Creation/tool_create_notarget_los.md) the LoS is determined by **sampling distance**, which determines how often a point is placed on the LoS, and optionally by **maximal LoS length**. +### LoS Sampling Strategy -[# Create No Target LoS V2](./tools/LoS%20Creation/tool_create_notarget_los_v2.md) parametrizes LoS by so called **Sampling distance - distance table**. This approach is significantly more flexible, as it allows the sampling distance to change based on distance from the observer. The table is output of tools Calculate Object Distances[](tools/Calculate%20Parameters%20Settings/tool_distances_for_sizes.md) and [Calculate Object Sizes](tools/Calculate%20Parameters%20Settings/tool_sizes_at_distances.md). Each row specifies distance from which specific sampling size should be used. For example row with column values of __Distance (meters)__ 1000 and __Size of object (meters)__ 1.754 specifies that sampling distance of 1.754 meters should be used on LoS when the length exceeds 1000 meters. Maximal length of LoS is given by maximal value of __Distance (meters)__. +For tools [Create Global LoS](./tools/LoS%20Creation/tool_create_global_los.md), [Create Local LoS](./tools/LoS%20Creation/tool_create_local_los.md), and [Create No Target LoS](./tools/LoS%20Creation/tool_create_notarget_los.md), the LoS is determined by **sampling distance**, which specifies how often a point is placed on the LoS, and optionally by **maximal LoS length**. -There can be two special rows in the table with values of __Distance (meters)__ 0 and -1. Row with value 0 specifies sampling distance for distance smaller than smallest provided distance (default value is 1). Row with value -1 means that there is no maximal LoS length and that the limit is provided by raster data extent. +The tool [Create No Target LoS V2](./tools/LoS%20Creation/tool_create_notarget_los_v2.md) parametrizes LoS by a so-called **Sampling distance - distance table**. This approach is significantly more flexible, as it allows the sampling distance to change based on the distance from the observer. The table is the output of the tools [Calculate Object Distances](tools/Calculate%20Parameters%20Settings/tool_distances_for_sizes.md) and [Calculate Object Sizes](tools/Calculate%20Parameters%20Settings/tool_sizes_at_distances.md). Each row specifies the distance from which a specific sampling size should be used. For example, a row with column values of __Distance (meters)__ 1000 and __Size of object (meters)__ 1.754 specifies that a sampling distance of 1.754 meters should be used on the LoS when the length exceeds 1000 meters. The maximal length of the LoS is given by the maximal value of __Distance (meters)__. + +There can be two special rows in the table with values of __Distance (meters)__ 0 and -1. A row with a value of 0 specifies the sampling distance for distances smaller than the smallest provided distance (default value is 1). A row with a value of -1 means that there is no maximal LoS length and that the limit is provided by the raster data extent. ## Citation From dd4e81223f71f957d10271d0fe7ec1242f445a54 Mon Sep 17 00:00:00 2001 From: Jan Caha Date: Wed, 14 Aug 2024 10:26:11 +0200 Subject: [PATCH 3/5] update --- los_tools/processing/doc/tool_export_los.help | 14 ++++++------- .../doc/tool_extract_horizon_lines.help | 16 +++++++------- .../processing/doc/tool_extract_horizons.help | 16 +++++++------- .../tool_extract_los_visibility_parts.help | 16 +++++++------- .../tool_extract_los_visibility_polygons.help | 14 ++++++------- .../doc/tool_extract_points_los.help | 18 ++++++++-------- .../doc/tool_limit_angles_vector.help | 14 ++++++------- .../Azimuths/tool_limit_angles_vector.md | 21 +++++++++---------- .../tools/Export to Table/tool_export_los.md | 20 +++++++++--------- .../tools/Horizons/tool_extract_horizons.md | 20 ++++++++---------- .../LoS Analysis/tool_extract_points_los.md | 18 ++++++++-------- .../tool_extract_visibility_parts.md | 20 +++++++++--------- .../tool_extract_visibility_polygons.md | 20 +++++++++--------- 13 files changed, 111 insertions(+), 116 deletions(-) diff --git a/los_tools/processing/doc/tool_export_los.help b/los_tools/processing/doc/tool_export_los.help index 2c31ff5..45d3f02 100644 --- a/los_tools/processing/doc/tool_export_los.help +++ b/los_tools/processing/doc/tool_export_los.help @@ -1,8 +1,8 @@ { - "ALG_DESC": "Export LoS layer (or only selected features) to table suitable for export outside of QGIS. In the output table every row is a single point on specific LoS.", - "ALG_CREATOR": "Jan Caha", - "LoSLayer": "LoS layer to export.", - "CurvatureCorrections": "Should the curvature and refraction corrections be used?", - "RefractionCoefficient": "Value of refraction coefficient. Default value: 0.13.", - "OutputFile": "Output containing exported points." -} + "ALG_DESC": "Exports the LoS layer (or only selected features) to a table suitable for export outside of QGIS. In the output table, each row represents a single point on a specific LoS.", + "ALG_CREATOR": "Jan Caha", + "LoSLayer": "LoS layer to export.", + "CurvatureCorrections": "Should curvature and refraction corrections be applied?", + "RefractionCoefficient": "Value of the refraction coefficient. Default value: 0.13.", + "OutputFile": "Output file containing exported points." +} \ No newline at end of file diff --git a/los_tools/processing/doc/tool_extract_horizon_lines.help b/los_tools/processing/doc/tool_extract_horizon_lines.help index a390dbb..a4a0964 100644 --- a/los_tools/processing/doc/tool_extract_horizon_lines.help +++ b/los_tools/processing/doc/tool_extract_horizon_lines.help @@ -1,9 +1,9 @@ { - "ALG_DESC": "Tool that extracts horizon lines from LoS without target. For other types of LoS this operation does not make sense. For global horizon line it is possible to select value that should be used as M dimension for points creating the line.", - "ALG_CREATOR": "Jan Caha", - "LoSLayer": "LoS layer to analyse.", - "HorizonType": "Type of horizon line to extract. Values: local or global.", - "CurvatureCorrections": "Should the curvature and refraction corrections be used?", - "RefractionCoefficient": "Value of refraction coefficient. Default value: 0.13.", - "OutputLayer": "Output layer containing LoS with new attributes." -} + "ALG_DESC": "This tool extracts horizon lines from LoS without a target. For other types of LoS, this operation is not applicable. For the global horizon line, it is possible to select a value that should be used as the M dimension for points creating the line.", + "ALG_CREATOR": "Jan Caha", + "LoSLayer": "LoS layer to analyze.", + "HorizonType": "Type of horizon line to extract. Values: local or global.", + "CurvatureCorrections": "Should curvature and refraction corrections be applied?", + "RefractionCoefficient": "Value of the refraction coefficient. Default value: 0.13.", + "OutputLayer": "Output layer containing the extracted horizon lines." +} \ No newline at end of file diff --git a/los_tools/processing/doc/tool_extract_horizons.help b/los_tools/processing/doc/tool_extract_horizons.help index 308493c..2733bfd 100755 --- a/los_tools/processing/doc/tool_extract_horizons.help +++ b/los_tools/processing/doc/tool_extract_horizons.help @@ -1,9 +1,9 @@ { - "ALG_DESC": "Tool that extracts horizons as points from LoS. Some combinations of LoS type and horizon to extract might not make a sense. E.g. extracting global horizon from local LoS raises an error.", - "ALG_CREATOR": "Jan Caha", - "LoSLayer": "LoS layer to analyse.", - "HorizonType": "Type of horizon line to extract. Values: local or global.", - "CurvatureCorrections": "Should the curvature and refraction corrections be used? Default value: True.", - "RefractionCoefficient": "Value of refraction coefficient. Default value: 0.13.", - "OutputLayer": "Output point layer of horizon points." -} + "ALG_DESC": "This tool extracts horizons as points from LoS. Some combinations of LoS type and horizon to extract might not make sense. For example, extracting a global horizon from a local LoS raises an error.", + "ALG_CREATOR": "Jan Caha", + "LoSLayer": "LoS layer to analyze.", + "HorizonType": "Type of horizon line to extract. Values: local or global.", + "CurvatureCorrections": "Should curvature and refraction corrections be applied? Default value: True.", + "RefractionCoefficient": "Value of the refraction coefficient. Default value: 0.13.", + "OutputLayer": "Output point layer of horizon points." +} \ No newline at end of file diff --git a/los_tools/processing/doc/tool_extract_los_visibility_parts.help b/los_tools/processing/doc/tool_extract_los_visibility_parts.help index 174a795..b42974d 100644 --- a/los_tools/processing/doc/tool_extract_los_visibility_parts.help +++ b/los_tools/processing/doc/tool_extract_los_visibility_parts.help @@ -1,10 +1,8 @@ { - "ALG_DESC": "Extract individual parts from lines-of-sight. The line is divided into visible and invisible segments.", - "ALG_CREATOR": "Jan Caha", - "LoSLayer": "LoS layer to extract lines from.", - "CurvatureCorrections": "Should the curvature and refraction corrections be used? Default value: True.", - "RefractionCoefficient": "Value of refraction coefficient. Default value: 0.13.", - "OnlyVisiblePoints": "Export only visible points on LoS or export all points on LoS.", - "ExtendedAttributes": "Calculate extended attributes for points.", - "OutputLayer": "Output layer containing points." -} + "ALG_DESC": "Extracts individual parts from lines-of-sight. The line is divided into visible and invisible segments.", + "ALG_CREATOR": "Jan Caha", + "LoSLayer": "LoS layer to extract lines from.", + "CurvatureCorrections": "Should curvature and refraction corrections be applied? Default value: True.", + "RefractionCoefficient": "Value of the refraction coefficient. Default value: 0.13.", + "OutputLayer": "Output layer containing lines." +} \ No newline at end of file diff --git a/los_tools/processing/doc/tool_extract_los_visibility_polygons.help b/los_tools/processing/doc/tool_extract_los_visibility_polygons.help index 0dd21c0..e5996c3 100644 --- a/los_tools/processing/doc/tool_extract_los_visibility_polygons.help +++ b/los_tools/processing/doc/tool_extract_los_visibility_polygons.help @@ -1,8 +1,8 @@ { - "ALG_DESC": "Extract individual parts from lines-of-sight as polygons. Works for LoS without target. The line is divided into visible and invisible segments and extended to polygon by knowing angle step between individual LoS.", - "ALG_CREATOR": "Jan Caha", - "LoSLayer": "LoS layer to extract polygons from.", - "CurvatureCorrections": "Should the curvature and refraction corrections be used? Default value: True.", - "RefractionCoefficient": "Value of refraction coefficient. Default value: 0.13.", - "OutputLayer": "Output layer containing points." -} + "ALG_DESC": "Extracts individual parts from lines-of-sight as polygons. Works for LoS without a target. The line is divided into visible and invisible segments and extended to polygons by knowing the angle step between individual LoS.", + "ALG_CREATOR": "Jan Caha", + "LoSLayer": "LoS layer to extract polygons from.", + "CurvatureCorrections": "Should curvature and refraction corrections be applied? Default value: True.", + "RefractionCoefficient": "Value of the refraction coefficient. Default value: 0.13.", + "OutputLayer": "Output layer containing polygons." +} \ No newline at end of file diff --git a/los_tools/processing/doc/tool_extract_points_los.help b/los_tools/processing/doc/tool_extract_points_los.help index c115429..44421e2 100755 --- a/los_tools/processing/doc/tool_extract_points_los.help +++ b/los_tools/processing/doc/tool_extract_points_los.help @@ -1,10 +1,10 @@ { - "ALG_DESC": "Extract individual points from lines-of-sight. It is possible to extract only visible points and also to calculate extended attributes for these points.", - "ALG_CREATOR": "Jan Caha", - "LoSLayer": "LoS layer to extract points from.", - "CurvatureCorrections": "Should the curvature and refraction corrections be used? Default value: True.", - "RefractionCoefficient": "Value of refraction coefficient. Default value: 0.13.", - "OnlyVisiblePoints": "Export only visible points on LoS or export all points on LoS (not checked).", - "ExtendedAttributes": "Calculate extended attributes of visibility for points (not checked).", - "OutputLayer": "Output layer containing points." -} + "ALG_DESC": "Extracts individual points from lines-of-sight. It is possible to extract only visible points and also to calculate extended attributes for these points.", + "ALG_CREATOR": "Jan Caha", + "LoSLayer": "LoS layer to extract points from.", + "CurvatureCorrections": "Should curvature and refraction corrections be applied? Default value: True.", + "RefractionCoefficient": "Value of the refraction coefficient. Default value: 0.13.", + "OnlyVisiblePoints": "Export only visible points on LoS or export all points on LoS.", + "ExtendedAttributes": "Calculate extended attributes for points.", + "OutputLayer": "Output layer containing points." +} \ No newline at end of file diff --git a/los_tools/processing/doc/tool_limit_angles_vector.help b/los_tools/processing/doc/tool_limit_angles_vector.help index 2ad6a5f..ab5b0e5 100644 --- a/los_tools/processing/doc/tool_limit_angles_vector.help +++ b/los_tools/processing/doc/tool_limit_angles_vector.help @@ -1,8 +1,8 @@ { - "ALG_DESC": "Calculates minimal and maximal azimuth for set of LoS without target that passes through specified layer (either polygon or line).", - "ALG_CREATOR": "Jan Caha", - "LoSLayer": "LoS layer for calculation.", - "ObjectLayer": "The main object which determines the direction.", - "ObjectLayerID": "The field to identify objects from Object layer.", - "OutputTable": "Table containing the result (without geometry)." -} + "ALG_DESC": "Calculates the minimal and maximal azimuth for a set of LoS without a target that passes through a specified layer (either polygon or line).", + "ALG_CREATOR": "Jan Caha", + "LoSLayer": "LoS layer for calculation.", + "ObjectLayer": "The main object which determines the direction.", + "ObjectLayerID": "The field to identify objects from the Object layer.", + "OutputTable": "Table containing the result (without geometry)." +} \ No newline at end of file diff --git a/website/pages/tools/Azimuths/tool_limit_angles_vector.md b/website/pages/tools/Azimuths/tool_limit_angles_vector.md index f0dc430..65b402c 100644 --- a/website/pages/tools/Azimuths/tool_limit_angles_vector.md +++ b/website/pages/tools/Azimuths/tool_limit_angles_vector.md @@ -1,21 +1,21 @@ # Extract Limit Azimuths -Calculates minimal and maximal azimuth for set of LoS without target that passes through specified layer (either polygon or line). +Calculates the minimal and maximal azimuth for a set of LoS without a target that passes through a specified layer (either polygon or line). ## Parameters -| Label | Name | Type | Description | -| --- | --- | --- | --- | -| LoS layer | `LoSLayer` | [vector: line] | LoS layer for calculation. | -| Object layer | `ObjectLayer` | [vector: line, polygon] | The main object which determines the direction. | -| Objects layer ID field | `ObjectLayerID` | [tablefield: numeric] | The field to identify objects from Object layer. | -| Output table | `OutputTable` | [table] | Table containing the result (without geometry). | +| Label | Name | Type | Description | +| ---------------------- | --------------- | ----------------------- | ---------------------------------------------------- | +| LoS layer | `LoSLayer` | [vector: line] | LoS layer for calculation. | +| Object layer | `ObjectLayer` | [vector: line, polygon] | The main object which determines the direction. | +| Objects layer ID field | `ObjectLayerID` | [tablefield: numeric] | The field to identify objects from the Object layer. | +| Output table | `OutputTable` | [table] | Table containing the result (without geometry). | ## Outputs -| Label | Name | Type | Description | -| --- | --- | --- | --- | -| Output table | `OutputTable` | [table] | Table containing the result (without geometry). | +| Label | Name | Type | Description | +| ------------ | ------------- | ------- | ----------------------------------------------- | +| Output table | `OutputTable` | [table] | Table containing the result (without geometry). | ### Fields in the output layer @@ -27,4 +27,3 @@ Calculates minimal and maximal azimuth for set of LoS without target that passes ## Tool screenshot ![Extract Limit Azimuths](../../images/tool_limit_angles_vector.png) - \ No newline at end of file diff --git a/website/pages/tools/Export to Table/tool_export_los.md b/website/pages/tools/Export to Table/tool_export_los.md index c4432d1..5359855 100644 --- a/website/pages/tools/Export to Table/tool_export_los.md +++ b/website/pages/tools/Export to Table/tool_export_los.md @@ -1,21 +1,21 @@ # Export LoS Layer to table -Export LoS layer (or only selected features) to table suitable for export outside of QGIS. In the output table every row is a single point on specific LoS. +Exports the LoS layer (or only selected features) to a table suitable for export outside of QGIS. In the output table, each row represents a single point on a specific LoS. ## Parameters -| Label | Name | Type | Description | -| --- | --- | --- | --- | -| LoS layer | `LoSLayer` | [vector: line] | LoS layer to export. | -| Use curvature corrections? | `CurvatureCorrections` | [boolean]

Default: `True` | Should the curvarture and refraction corrections be used? | -| Refraction coefficient value | `RefractionCoefficient` | [number]

Default:
`0.13` | Value of refraction coefficient. | -| Output file | `OutputFile` | [table] | Output containing exported points. | +| Label | Name | Type | Description | +| ---------------------------- | ----------------------- | ----------------------------------------- | ------------------------------------------------------- | +| LoS layer | `LoSLayer` | [vector: line] | LoS layer to export. | +| Use curvature corrections? | `CurvatureCorrections` | [boolean]

Default: `True` | Should curvature and refraction corrections be applied? | +| Refraction coefficient value | `RefractionCoefficient` | [number]

Default:
`0.13` | Value of the refraction coefficient. | +| Output file | `OutputFile` | [table] | Output file containing exported points. | ## Outputs -| Label | Name | Type | Description | -| --- | --- | --- | --- | -| Output file | `OutputFile` | [table] | Output containing exported points. | +| Label | Name | Type | Description | +| ----------- | ------------ | ------- | --------------------------------------- | +| Output file | `OutputFile` | [table] | Output file containing exported points. | ### Fields in the output layer diff --git a/website/pages/tools/Horizons/tool_extract_horizons.md b/website/pages/tools/Horizons/tool_extract_horizons.md index 5618fb7..1135c68 100755 --- a/website/pages/tools/Horizons/tool_extract_horizons.md +++ b/website/pages/tools/Horizons/tool_extract_horizons.md @@ -1,19 +1,17 @@ # Extract Horizons -Tool that extracts horizons as points from LoS. - -Some combinations of LoS type and horizon to extract might not make a sense. E.g. extracting global horizon from local LoS raises an error. +This tool extracts horizons as points from LoS. Some combinations of LoS type and horizon to extract might not make sense. For example, extracting a global horizon from a local LoS raises an error. ## Parameters -| Label | Name | Type | Description | -| ---------------------------- | ----------------------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| LoS layer | `LoSLayer` | [vector: line] | LoS layer to analyse. | -| Horizon type | `HorizonType` | [enumeration]

Default:
`1` | Type of horizon line to extract.

**Values**:
**0** - local
**1** - global. | -| Output layer | `OutputLayer` | [vector: point] | Output layer of horizon points. | -| Use curvature corrections? | `CurvatureCorrections` | [boolean]

Default: `True` | Should the curvature and refraction corrections be used? | -| Refraction coefficient value | `RefractionCoefficient` | [number]

Default:
`0.13` | Value of refraction coefficient. | -| Output layer | `OutputLayer` | [vector: point] | Output point layer of horizon points. | +| Label | Name | Type | Description | +| ---------------------------- | ----------------------- | ------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| LoS layer | `LoSLayer` | [vector: line] | LoS layer to analyze. | +| Horizon type | `HorizonType` | [enumeration]

Default:
`1` | Type of horizon line to extract.

**Values**:
**0** - local
**1** - global. | +| Output layer | `OutputLayer` | [vector: point] | Output layer of horizon points. | +| Use curvature corrections? | `CurvatureCorrections` | [boolean]

Default: `True` | Should curvature and refraction corrections be applied? | +| Refraction coefficient value | `RefractionCoefficient` | [number]

Default:
`0.13` | Value of the refraction coefficient. | +| Output layer | `OutputLayer` | [vector: point] | Output point layer of horizon points. | ## Outputs diff --git a/website/pages/tools/LoS Analysis/tool_extract_points_los.md b/website/pages/tools/LoS Analysis/tool_extract_points_los.md index 04632d5..7b1b7e4 100755 --- a/website/pages/tools/LoS Analysis/tool_extract_points_los.md +++ b/website/pages/tools/LoS Analysis/tool_extract_points_los.md @@ -1,17 +1,17 @@ # Extract Visible/Invisible Points from LoS -Extract individual points from lines-of-sight. It is possible to extract only visible points and also to calculate extended attributes for these points. +Extracts individual points from lines-of-sight. It is possible to extract only visible points and also to calculate extended attributes for these points. ## Parameters -| Label | Name | Type | Description | -| ----------------------------- | ----------------------- | ----------------------------------------- | ---------------------------------------------------------------------------- | -| LoS layer | `LoSLayer` | [vector: line] | LoS layer to extract points from. | -| Use curvature corrections? | `CurvatureCorrections` | [boolean]

Default: `True` | Should the curvature and refraction corrections be used? | -| Refraction coefficient value | `RefractionCoefficient` | [number]

Default:
`0.13` | Value of refraction coefficient. | -| Export only visible points | `OnlyVisiblePoints` | [boolean]

Default: `False` | Export only visible points on LoS or export all points on LoS (not checked). | -| Calculate extended attributes | `ExtendedAttributes` | [boolean]

Default: `False` | Calculate extended attributes of visibility for points (not checked). | -| Output layer | `OutputLayer` | [vector: point] | Output layer containing points. | +| Label | Name | Type | Description | +| ----------------------------- | ----------------------- | ----------------------------------------- | -------------------------------------------------------------- | +| LoS layer | `LoSLayer` | [vector: line] | LoS layer to extract points from. | +| Use curvature corrections? | `CurvatureCorrections` | [boolean]

Default: `True` | Should curvature and refraction corrections be applied? | +| Refraction coefficient value | `RefractionCoefficient` | [number]

Default:
`0.13` | Value of the refraction coefficient. | +| Export only visible points | `OnlyVisiblePoints` | [boolean]

Default: `False` | Export only visible points on LoS or export all points on LoS. | +| Calculate extended attributes | `ExtendedAttributes` | [boolean]

Default: `False` | Calculate extended attributes for points. | +| Output layer | `OutputLayer` | [vector: point] | Output layer containing points. | ## Outputs diff --git a/website/pages/tools/LoS Analysis/tool_extract_visibility_parts.md b/website/pages/tools/LoS Analysis/tool_extract_visibility_parts.md index 8d19dde..8e058e1 100644 --- a/website/pages/tools/LoS Analysis/tool_extract_visibility_parts.md +++ b/website/pages/tools/LoS Analysis/tool_extract_visibility_parts.md @@ -1,21 +1,21 @@ # Extract Visible/Invisible Lines from LoS -Extract individual parts from lines-of-sight. The line is divided into visible and invisible segments. +Extracts individual parts from lines-of-sight. The line is divided into visible and invisible segments. ## Parameters -| Label | Name | Type | Description | -| ---------------------------- | ----------------------- | ----------------------------------------- | -------------------------------------------------------- | -| LoS layer | `LoSLayer` | [vector: line] | LoS layer to extract lines from. | -| Use curvature corrections? | `CurvatureCorrections` | [boolean]

Default: `True` | Should the curvature and refraction corrections be used? | -| Refraction coefficient value | `RefractionCoefficient` | [number]

Default:
`0.13` | Value of refraction coefficient. | -| Output layer | `OutputLayer` | [vector: point] | Output layer containing points. | +| Label | Name | Type | Description | +| ---------------------------- | ----------------------- | ----------------------------------------- | ------------------------------------------------------- | +| LoS layer | `LoSLayer` | [vector: line] | LoS layer to extract lines from. | +| Use curvature corrections? | `CurvatureCorrections` | [boolean]

Default: `True` | Should curvature and refraction corrections be applied? | +| Refraction coefficient value | `RefractionCoefficient` | [number]

Default:
`0.13` | Value of the refraction coefficient. | +| Output layer | `OutputLayer` | [vector: point] | Output layer containing lines | ## Outputs -| Label | Name | Type | Description | -| ------------ | ------------- | --------------- | ------------------------------- | -| Output layer | `OutputLayer` | [vector: point] | Output layer containing points. | +| Label | Name | Type | Description | +| ------------ | ------------- | --------------- | ------------------------------ | +| Output layer | `OutputLayer` | [vector: point] | Output layer containing lines. | ### Fields in the output layer diff --git a/website/pages/tools/LoS Analysis/tool_extract_visibility_polygons.md b/website/pages/tools/LoS Analysis/tool_extract_visibility_polygons.md index 075187d..7fb75f6 100644 --- a/website/pages/tools/LoS Analysis/tool_extract_visibility_polygons.md +++ b/website/pages/tools/LoS Analysis/tool_extract_visibility_polygons.md @@ -1,21 +1,21 @@ # Extract Visible/Invisible Polygons from LoS -Extract individual parts from lines-of-sight as polygons. Works for LoS without target. The line is divided into visible and invisible segments and extended to polygon by knowing angle step between individual LoS. +Extracts individual parts from lines-of-sight as polygons. Works for LoS without a target. The line is divided into visible and invisible segments and extended to polygons by knowing the angle step between individual LoS. ## Parameters -| Label | Name | Type | Description | -| ---------------------------- | ----------------------- | ----------------------------------------- | -------------------------------------------------------- | -| LoS layer | `LoSLayer` | [vector: line] | LoS layer to extract polygons from. | -| Use curvature corrections? | `CurvatureCorrections` | [boolean]

Default: `True` | Should the curvature and refraction corrections be used? | -| Refraction coefficient value | `RefractionCoefficient` | [number]

Default:
`0.13` | Value of refraction coefficient. | -| Output layer | `OutputLayer` | [vector: point] | Output layer containing points. | +| Label | Name | Type | Description | +| ---------------------------- | ----------------------- | ----------------------------------------- | ------------------------------------------------------- | +| LoS layer | `LoSLayer` | [vector: line] | LoS layer to extract polygons from. | +| Use curvature corrections? | `CurvatureCorrections` | [boolean]

Default: `True` | Should curvature and refraction corrections be applied? | +| Refraction coefficient value | `RefractionCoefficient` | [number]

Default:
`0.13` | Value of the refraction coefficient. | +| Output layer | `OutputLayer` | [vector: point] | Output layer containing polygons. | ## Outputs -| Label | Name | Type | Description | -| ------------ | ------------- | --------------- | ------------------------------- | -| Output layer | `OutputLayer` | [vector: point] | Output layer containing points. | +| Label | Name | Type | Description | +| ------------ | ------------- | --------------- | --------------------------------- | +| Output layer | `OutputLayer` | [vector: point] | Output layer containing polygons. | ### Fields in the output layer From 7f48b095edb7908b12786c1bd0a688f553184fc5 Mon Sep 17 00:00:00 2001 From: Jan Caha Date: Wed, 14 Aug 2024 10:45:11 +0200 Subject: [PATCH 4/5] fix name --- los_tools/processing/create_los/tool_create_notarget_los.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/los_tools/processing/create_los/tool_create_notarget_los.py b/los_tools/processing/create_los/tool_create_notarget_los.py index f01e4d5..ec2ed96 100755 --- a/los_tools/processing/create_los/tool_create_notarget_los.py +++ b/los_tools/processing/create_los/tool_create_notarget_los.py @@ -262,7 +262,7 @@ def processAlgorithm(self, parameters, context, feedback: QgsProcessingFeedback) return {self.OUTPUT_LAYER: dest_id} def name(self): - return "notargetlos2" + return "notargetlos" def displayName(self): return "Create No Target LoS" From 0c343a8a71dbe72c5b3c1af8950373df1edc7886 Mon Sep 17 00:00:00 2001 From: Jan Caha Date: Wed, 14 Aug 2024 10:45:41 +0200 Subject: [PATCH 5/5] update --- .../processing/doc/tool_analyse_los.help | 14 ++++----- .../doc/tool_angle_at_distance_for_size.help | 8 ++--- los_tools/processing/doc/tool_azimuth.help | 16 +++++----- .../doc/tool_create_global_los.help | 24 +++++++------- .../processing/doc/tool_create_local_los.help | 24 +++++++------- .../doc/tool_create_notarget_los.help | 25 +++++++-------- .../doc/tool_create_notarget_los_v2.help | 13 -------- .../doc/tool_distances_for_sizes.help | 9 +++--- .../doc/tool_export_horizon_lines.help | 10 +++--- website/pages/tools/Azimuths/tool_azimuth.md | 22 ++++++------- .../tool_angle_at_distance_for_size.md | 13 ++++---- .../tool_distances_for_sizes.md | 23 +++++++------- .../tool_export_horizon_lines.md | 16 +++++----- .../tools/LoS Analysis/tool_analyse_los.md | 14 ++++----- .../LoS Creation/tool_create_global_los.md | 31 +++++++++---------- .../LoS Creation/tool_create_local_los.md | 31 +++++++++---------- .../LoS Creation/tool_create_notarget_los.md | 30 +++++++++--------- 17 files changed, 152 insertions(+), 171 deletions(-) delete mode 100644 los_tools/processing/doc/tool_create_notarget_los_v2.help diff --git a/los_tools/processing/doc/tool_analyse_los.help b/los_tools/processing/doc/tool_analyse_los.help index 19f2adb..28276fe 100644 --- a/los_tools/processing/doc/tool_analyse_los.help +++ b/los_tools/processing/doc/tool_analyse_los.help @@ -1,8 +1,8 @@ { - "ALG_DESC": "Analyse line-of-sight layer. Calculate the attributes of LoS according to type of line-of-sight.", - "ALG_CREATOR": "Jan Caha", - "LoSLayer": "LoS layer to analyse.", - "CurvatureCorrections": "Should the curvature and refraction corrections be used?", - "RefractionCoefficient": "Value of refraction coefficient. Default value: 0.13.", - "OutputLayer": "Output layer containing LoS with new attributes." -} + "ALG_DESC": "Analyze the line-of-sight layer. Calculate the attributes of LoS according to the type of line-of-sight.", + "ALG_CREATOR": "Jan Caha", + "LoSLayer": "LoS layer to analyze.", + "CurvatureCorrections": "Should curvature and refraction corrections be applied?", + "RefractionCoefficient": "Value of the refraction coefficient. Default value: 0.13.", + "OutputLayer": "Output layer containing LoS with new attributes." +} \ No newline at end of file diff --git a/los_tools/processing/doc/tool_angle_at_distance_for_size.help b/los_tools/processing/doc/tool_angle_at_distance_for_size.help index 9b49074..09757b7 100644 --- a/los_tools/processing/doc/tool_angle_at_distance_for_size.help +++ b/los_tools/processing/doc/tool_angle_at_distance_for_size.help @@ -1,7 +1,7 @@ { - "ALG_DESC": "The tool calculates object angle size based on object size and object distance from observer.

I.e. angular size of 10 meter object that is located 1000 meters away is 0.573 degree.", - "ALG_CREATOR": "Jan Caha", + "ALG_DESC": "This tool calculates the angular size of an object based on its physical size and its distance from the observer.

For example, the angular size of a 10-meter object located 1000 meters away is 0.573 degrees.", + "ALG_CREATOR": "Jan Caha", "Size": "Size of the object in meters.", - "Distance": "Distance of the object from observer in meters.", - "OutputAngle": "Object size in degrees for object of given size at the given distance." + "Distance": "Distance of the object from the observer in meters.", + "OutputAngle": "Angular size of the object in degrees for the given size and distance." } \ No newline at end of file diff --git a/los_tools/processing/doc/tool_azimuth.help b/los_tools/processing/doc/tool_azimuth.help index 4ad0547..5867f3d 100644 --- a/los_tools/processing/doc/tool_azimuth.help +++ b/los_tools/processing/doc/tool_azimuth.help @@ -1,9 +1,9 @@ { - "ALG_DESC": "Calculates azimuths between points in one layer and centroids of polygons or lines in second layer.", - "ALG_CREATOR": "Jan Caha", - "PointLayer": "Layer of points to calculate the azimuth from.", - "PointLayerID": "Field containing ID for points.", - "ObjectLayer": "Layer of lines/polygons to calculate the azimuth to.", - "ObjectLayerID": "Field containing ID for object layer.", - "OutputTable": "Table containing the result (without geometry)." -} + "ALG_DESC": "Calculates azimuths between points in one layer and the centroids of polygons or lines in a second layer.", + "ALG_CREATOR": "Jan Caha", + "PointLayer": "Layer of points from which to calculate the azimuth.", + "PointLayerID": "Field containing IDs for the points.", + "ObjectLayer": "Layer of lines/polygons to which to calculate the azimuth.", + "ObjectLayerID": "Field containing IDs for the object layer.", + "OutputTable": "Table containing the results (without geometry)." +} \ No newline at end of file diff --git a/los_tools/processing/doc/tool_create_global_los.help b/los_tools/processing/doc/tool_create_global_los.help index 778b20c..569cdca 100644 --- a/los_tools/processing/doc/tool_create_global_los.help +++ b/los_tools/processing/doc/tool_create_global_los.help @@ -1,13 +1,13 @@ { - "ALG_DESC": "Create line-of-sight from each point from observers layer through each point in targets layer. Each line-of-sight starts at observer and ends at an edge of DEM raster behind target.", - "ALG_CREATOR": "Jan Caha", - "DemRasters": "Raster DEMs on which the LoS is calculated.", - "ObserverPoints": "Point layer representing the observers.", - "ObserverIdField": "Field containing ID for observer points.", - "ObserverOffset": "Field containing offset above DEM for observer points.", - "TargetPoints": "Point layer representing the targets.", - "TargetIdField": "Field containing ID for target points.", - "TargetOffset": "Field containing offset above DEM for target points.", - "LineDensity": "The distance by which the LoS is segmentized.", - "OutputLayer": "Output layer containing LoS." -} + "ALG_DESC": "Creates a line-of-sight from each point in the observers layer through each point in the targets layer. Each line-of-sight starts at the observer and ends at the edge of the DEM raster behind the target.", + "ALG_CREATOR": "Jan Caha", + "DemRasters": "Raster DEMs on which the LoS is calculated.", + "ObserverPoints": "Point layer representing the observers.", + "ObserverIdField": "Field containing IDs for observer points.", + "ObserverOffset": "Field containing the offset above DEM for observer points.", + "TargetPoints": "Point layer representing the targets.", + "TargetIdField": "Field containing IDs for target points.", + "TargetOffset": "Field containing the offset above DEM for target points.", + "LineDensity": "The distance by which the LoS is segmented.", + "OutputLayer": "Output layer containing the LoS." +} \ No newline at end of file diff --git a/los_tools/processing/doc/tool_create_local_los.help b/los_tools/processing/doc/tool_create_local_los.help index 43f85a4..bdc7563 100644 --- a/los_tools/processing/doc/tool_create_local_los.help +++ b/los_tools/processing/doc/tool_create_local_los.help @@ -1,13 +1,13 @@ { - "ALG_DESC": "Create line-of-sight between each point from observers layer and targets layer. Each line-of-sight starts at observer and ends at target.", - "ALG_CREATOR": "Jan Caha", - "DemRasters": "Raster DEMs on which the LoS is calculated.", - "ObserverPoints": "Point layer representing the observers.", - "ObserverIdField": "Field containing ID for observer points.", - "ObserverOffset": "Field containing offset above DEM for observer points.", - "TargetPoints": "Point layer representing the targets.", - "TargetIdField": "Field containing ID for target points.", - "TargetOffset": "Field containing offset above DEM for target points.", - "LineDensity": "The distance by which the LoS is segmentized.", - "OutputLayer": "Output layer containing LoS." -} + "ALG_DESC": "Creates a line-of-sight between each point in the observers layer and the targets layer. Each line-of-sight starts at the observer and ends at the target.", + "ALG_CREATOR": "Jan Caha", + "DemRasters": "Raster DEMs on which the LoS is calculated.", + "ObserverPoints": "Point layer representing the observers.", + "ObserverIdField": "Field containing IDs for observer points.", + "ObserverOffset": "Field containing the offset above DEM for observer points.", + "TargetPoints": "Point layer representing the targets.", + "TargetIdField": "Field containing IDs for target points.", + "TargetOffset": "Field containing the offset above DEM for target points.", + "LineDensity": "The distance by which the LoS is segmented.", + "OutputLayer": "Output layer containing the LoS." +} \ No newline at end of file diff --git a/los_tools/processing/doc/tool_create_notarget_los.help b/los_tools/processing/doc/tool_create_notarget_los.help index c398a7d..4ed50ec 100644 --- a/los_tools/processing/doc/tool_create_notarget_los.help +++ b/los_tools/processing/doc/tool_create_notarget_los.help @@ -1,14 +1,13 @@ { - "ALG_DESC": "Create line-of-sight between each point from observers layer and targets layer, where `Observer ID field` value from observer is equal to `Target and Observer agreement ID field` of target. This ensures that each point from targets layer is linked to one point from observers layer. Each line-of-sight starts at observer and ends at an edge of DEM raster behind target.", - "ALG_CREATOR": "Jan Caha", - "DemRasters": "Raster DEMs on which the LoS is calculated.", - "ObserverPoints": "Point layer representing the observers.", - "ObserverIdField": "Field containing ID for observer points.", - "ObserverOffset": "Field containing offset above DEM for observer points.", - "TargetPoints": "Point layer representing the targets.", - "TargetIdField": "Field containing ID for target points.", - "TargetDefinitionIdField": "Field that specifies which target point is linked to which observer point. Values in this field are compared to `ObserverIdField`.", - "LineDensity": "The distance by which the LoS is segmentized.", - "MaxLoSLength": "Maximal length of LoS generated.", - "OutputLayer": "Output layer containing LoS." -} + "ALG_DESC": "Creates a line-of-sight between each point in the observers layer and the targets layer, where the `Observer ID field` value from the observer matches the `Target and Observer agreement ID field` of the target. This ensures that each point in the targets layer is linked to one point in the observers layer. Each line-of-sight starts at the observer and ends at the edge of the DEM raster behind the target.", + "ALG_CREATOR": "Jan Caha", + "DemRasters": "List of DEM rasters on which the LoS is calculated. The rasters are ordered from smallest spatial resolution to highest. Elevation for the LoS is taken from the raster with the smallest spatial resolution that has a value.", + "LineSettingsTable": "Distance table specifying the sampling size on the LoS by distance.", + "ObserverPoints": "Point layer representing the observers.", + "ObserverIdField": "Field containing IDs for observer points.", + "ObserverOffset": "Field containing the offset above DEM for observer points.", + "TargetPoints": "Point layer representing the targets.", + "TargetIdField": "Field containing IDs for target points.", + "TargetDefinitionIdField": "Field that specifies which target point is linked to which observer point. Values in this field are compared to the `ObserverIdField`.", + "OutputLayer": "Output layer containing the LoS." +} \ No newline at end of file diff --git a/los_tools/processing/doc/tool_create_notarget_los_v2.help b/los_tools/processing/doc/tool_create_notarget_los_v2.help deleted file mode 100644 index ae4dad3..0000000 --- a/los_tools/processing/doc/tool_create_notarget_los_v2.help +++ /dev/null @@ -1,13 +0,0 @@ -{ - "ALG_DESC": "Create line-of-sight between each point from observers layer and targets layer, where `Observer ID field` value from observer is equal to `Target and Observer agreement ID field` of target. This ensures that each point from targets layer is linked to one point from observers layer. Each line-of-sight starts at observer and ends at an edge of DEM raster behind target.", - "ALG_CREATOR": "Jan Caha", - "DemRasters": "List of DEM rasters on which the LoS is calculated. The rasters are ordered from smallest spatial resolution to highest. Elevation for LoS is taken from the raster with smallest spatial resolution, that has a value.", - "LineSettingsTable": "Distance table, specify sampling size on LoS by distance.", - "ObserverPoints": "Point layer representing the observers.", - "ObserverIdField": "Field containing ID for observer points.", - "ObserverOffset": "Field containing offset above DEM for observer points.", - "TargetPoints": "Point layer representing the targets.", - "TargetIdField": "Field containing ID for target points.", - "TargetDefinitionIdField": "Field that specifies which target point is linked to which observer point. Values in this field are compared to `ObserverIdField`.", - "OutputLayer": "Output layer containing LoS." -} diff --git a/los_tools/processing/doc/tool_distances_for_sizes.help b/los_tools/processing/doc/tool_distances_for_sizes.help index 447dccc..d2ef2ce 100755 --- a/los_tools/processing/doc/tool_distances_for_sizes.help +++ b/los_tools/processing/doc/tool_distances_for_sizes.help @@ -1,9 +1,8 @@ { - "ALG_DESC": "The tool calculates distances at which objects of specified size (specified in the table) have given horizontal angular size.

I.e. at which distances have objects of size 1, 5 and 10 meters angular size of 0.1 degree.", - "ALG_CREATOR": "Jan Caha", + "ALG_DESC": "This tool calculates the distances at which objects of specified sizes (provided in the table) have a given horizontal angular size.

For example, it calculates the distances at which objects of sizes 1, 5, and 10 meters have an angular size of 0.1 degrees.", + "ALG_CREATOR": "Jan Caha", "Angle": "Horizontal angular size that the objects should have (in degrees).", "Size": "Sizes of the objects in meters (table).", - "MaximalDistance": "Add special row to the output used in other tools. The row has size of the object equal to maximum size in the input table and distance -1. This is used to indicate maximal possible legth of LoS.", - "Distance": "Distance of the object from observer in meters.", - "OutputTable": "Output table containing information about angle size, size of objects and relevant distances." + "MaximalDistance": "Add a special row to the output used in other tools. The row has the size of the object equal to the maximum size in the input table and a distance of -1. This is used to indicate the maximum possible length of the LoS.", + "OutputTable": "Output table containing information about angular size, object sizes, and relevant distances." } \ No newline at end of file diff --git a/los_tools/processing/doc/tool_export_horizon_lines.help b/los_tools/processing/doc/tool_export_horizon_lines.help index 6a96eb2..b2149d1 100644 --- a/los_tools/processing/doc/tool_export_horizon_lines.help +++ b/los_tools/processing/doc/tool_export_horizon_lines.help @@ -1,6 +1,6 @@ { - "ALG_DESC": "Export horizon lines layer (or only selected features) to table suitable for export outside of QGIS. In the output table every row is a single point on specific LoS.", - "ALG_CREATOR": "Jan Caha", - "HorizonLinesLayer": "Horizon lines layer to export.", - "OutputFile": "Output containing exported points of horizon lines." -} + "ALG_DESC": "Exports the horizon lines layer (or only selected features) to a table suitable for export outside of QGIS. In the output table, each row represents a single point on a specific LoS.", + "ALG_CREATOR": "Jan Caha", + "HorizonLinesLayer": "Horizon lines layer to export.", + "OutputFile": "Output file containing exported points of horizon lines." +} \ No newline at end of file diff --git a/website/pages/tools/Azimuths/tool_azimuth.md b/website/pages/tools/Azimuths/tool_azimuth.md index e9090e6..3323751 100755 --- a/website/pages/tools/Azimuths/tool_azimuth.md +++ b/website/pages/tools/Azimuths/tool_azimuth.md @@ -1,22 +1,22 @@ # Extract Azimuth between Points and Centroids -Calculates azimuths between points in one layer and centroids of polygons or lines in second layer. +Calculates azimuths between points in one layer and the centroids of polygons or lines in a second layer. ## Parameters -| Label | Name | Type | Description | -| --------------------- | --------------- | ----------------------- | ---------------------------------------------------- | -| Point layer | `PointLayer` | [vector: point] | Layer of points to calculate the azimuth from. | -| Point layer ID field | `PointLayerID` | [tablefield: numeric] | Field containing ID for points. | -| Object layer | `ObjectLayer` | [vector: line, polygon] | Layer of lines/polygons to calculate the azimuth to. | -| Object layer ID field | `ObjectLayerID` | [tablefield: numeric] | Field containing ID for object layer. | -| Output table | `OutputTable` | [table] | Table containing the result (without geometry). | +| Label | Name | Type | Description | +| --------------------- | --------------- | ----------------------- | ---------------------------------------------------------- | +| Point layer | `PointLayer` | [vector: point] | Layer of points from which to calculate the azimuth. | +| Point layer ID field | `PointLayerID` | [tablefield: numeric] | Field containing IDs for the points. | +| Object layer | `ObjectLayer` | [vector: line, polygon] | Layer of lines/polygons to which to calculate the azimuth. | +| Object layer ID field | `ObjectLayerID` | [tablefield: numeric] | Field containing IDs for the object layer. | +| Output table | `OutputTable` | [table] | Table containing the results (without geometry). | ## Outputs -| Label | Name | Type | Description | -| ------------ | ------------- | ------- | ----------------------------------------------- | -| Output table | `OutputTable` | [table] | Table containing the result (without geometry). | +| Label | Name | Type | Description | +| ------------ | ------------- | ------- | ------------------------------------------------ | +| Output table | `OutputTable` | [table] | Table containing the results (without geometry). | For $n$ points and $m$ lines/polygons the output layer will have $n \times m$ rows. diff --git a/website/pages/tools/Calculate Parameters Settings/tool_angle_at_distance_for_size.md b/website/pages/tools/Calculate Parameters Settings/tool_angle_at_distance_for_size.md index a314da3..0c5e5e9 100755 --- a/website/pages/tools/Calculate Parameters Settings/tool_angle_at_distance_for_size.md +++ b/website/pages/tools/Calculate Parameters Settings/tool_angle_at_distance_for_size.md @@ -1,23 +1,22 @@ # Calculate Object Detection Angle -Determines object's angular size based on object size (horizontal) and distance from observer. +This tool calculates the angular size of an object based on its physical size and its distance from the observer. +For example, the angular size of a 10-meter object located 1000 meters away is 0.573 degrees. ## Parameters | Label | Name | Type | Description | | ------------------------------------------------ | ------------- | ---------------------------------------- | ---------------------------------------------------------------------- | -| Size of the object (in meters) | `Size` | [number]

Default:
`1.0` | Size of the object in meters.. | -| Distance of the object from observer (in meters) | `Distance` | [number]

Default:
`1000` | Distance of the object from observer in meters. | | -| Angle size (in degrees) of object | `OutputAngle` | [number] | Object size in degrees for object of given size at the given distance. | - +| Size of the object (in meters) | `Size` | [number]

Default:
`1.0` | Size of the object in meters. | +| Distance of the object from observer (in meters) | `Distance` | [number]

Default:
`1000` | Distance of the object from the observer in meters. | | +| Angle size (in degrees) of object | `OutputAngle` | [number] | Angular size of the object in degrees for the given size and distance. | ## Outputs | Label | Name | Type | Description | | --------------------------------- | ------------- | -------- | ---------------------------------------------------------------------- | -| Angle size (in degrees) of object | `OutputAngle` | [number] | Object size in degrees for object of given size at the given distance. | - +| Angle size (in degrees) of object | `OutputAngle` | [number] | Angular size of the object in degrees for the given size and distance. | ## Tool screenshot diff --git a/website/pages/tools/Calculate Parameters Settings/tool_distances_for_sizes.md b/website/pages/tools/Calculate Parameters Settings/tool_distances_for_sizes.md index cf385c2..d91b8d0 100755 --- a/website/pages/tools/Calculate Parameters Settings/tool_distances_for_sizes.md +++ b/website/pages/tools/Calculate Parameters Settings/tool_distances_for_sizes.md @@ -1,26 +1,25 @@ # Calculate Object Distances -The tool calculates distances at which objects of specified size (specified in the table) have given horizontal angular size. +This tool calculates the distances at which objects of specified sizes (provided in the table) have a given horizontal angular size. -I.e. at which distances will object of size 1, 5 and 10 meters be detected when the angular size of 0.1 degree is set? +For example, it calculates the distances at which objects of sizes 1, 5, and 10 meters have an angular size of 0.1 degrees. To be usable in other plugin tools, there is a necessary parameter to be set maximal distance. It special row into the output table so that it can be later correctly processed. - ## Parameters -| Label | Name | Type | Description | -| ----------------------------------------------------------------------------- | ----------------- | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Angle size of object (in degrees) | `Angle` | [number]

Default:
`0.1` | Horizontal angular size that the objects should have (in degrees). | -| Sizes of object to calculate (in meters) | `Size` | [matrix] | Sizes of the objects in meters (table). | | -| Add maximal distance value (with sampling equal to maximal sampling distance) | `MaximalDistance` | [boolean]

Default: `True` | Add special row to the output used in other tools. The row has size of the object equal to maximum size in the input table and distance -1. This is used to indicate maximal possible legth of LoS. | -| Output table | `OutputTable` | [table] | Output table containing information about angle size, size of objects and relevant distances (without geometry). | +| Label | Name | Type | Description | +| ----------------------------------------------------------------------------- | ----------------- | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Angle size of object (in degrees) | `Angle` | [number]

Default:
`0.1` | Horizontal angular size that the objects should have (in degrees). | +| Sizes of object to calculate (in meters) | `Size` | [matrix] | Sizes of the objects in meters (table). | | +| Add maximal distance value (with sampling equal to maximal sampling distance) | `MaximalDistance` | [boolean]

Default: `True` | Add a special row to the output used in other tools. The row has the size of the object equal to the maximum size in the input table and a distance of -1. This is used to indicate the maximum possible length of the LoS. | +| Output table | `OutputTable` | [table] | Output table containing information about angular size, object sizes, and relevant distances. | ## Outputs -| Label | Name | Type | Description | -| ------------ | ------------- | ------- | ---------------------------------------------------------------------------------------------------------------- | -| Output table | `OutputTable` | [table] | Output table containing information about angle size, size of objects and relevant distances (without geometry). | +| Label | Name | Type | Description | +| ------------ | ------------- | ------- | --------------------------------------------------------------------------------------------- | +| Output table | `OutputTable` | [table] | Output table containing information about angular size, object sizes, and relevant distances. | ### Fields in the output layer diff --git a/website/pages/tools/Export to Table/tool_export_horizon_lines.md b/website/pages/tools/Export to Table/tool_export_horizon_lines.md index ecbbb73..9dd2b08 100644 --- a/website/pages/tools/Export to Table/tool_export_horizon_lines.md +++ b/website/pages/tools/Export to Table/tool_export_horizon_lines.md @@ -1,19 +1,19 @@ # Export Horizon Lines Layer to table -Export horizon lines layer (or only selected features) to table suitable for export outside of QGIS. In the output table every row is a single point on specific LoS. +Exports the horizon lines layer (or only selected features) to a table suitable for export outside of QGIS. In the output table, each row represents a single point on a specific LoS. ## Parameters -| Label | Name | Type | Description | -| ------------------- | ------------------- | -------------- | --------------------------------------------------- | -| Horizon Lines Layer | `HorizonLinesLayer` | [vector: line] | Horizon lines layer to export. | -| Output file | `OutputFile` | [table] | Output containing exported points of horizon lines. | +| Label | Name | Type | Description | +| ------------------- | ------------------- | -------------- | -------------------------------------------------------- | +| Horizon Lines Layer | `HorizonLinesLayer` | [vector: line] | Horizon lines layer to export. | +| Output file | `OutputFile` | [table] | Output file containing exported points of horizon lines. | ## Outputs -| Label | Name | Type | Description | -| ----------- | ------------ | ------- | --------------------------------------------------- | -| Output file | `OutputFile` | [table] | Output containing exported points of horizon lines. | +| Label | Name | Type | Description | +| ----------- | ------------ | ------- | -------------------------------------------------------- | +| Output file | `OutputFile` | [table] | Output file containing exported points of horizon lines. | ### Fields in the output layer diff --git a/website/pages/tools/LoS Analysis/tool_analyse_los.md b/website/pages/tools/LoS Analysis/tool_analyse_los.md index 561d7ae..c6f5c27 100644 --- a/website/pages/tools/LoS Analysis/tool_analyse_los.md +++ b/website/pages/tools/LoS Analysis/tool_analyse_los.md @@ -1,15 +1,15 @@ # Analyse LoS -Analyse line-of-sight layer. Calculate the attributes according to type of line-of-sight (see Outputs). +Analyze the line-of-sight layer. Calculate the attributes of LoS according to the type of line-of-sight (see Outputs). ## Parameters -| Label | Name | Type | Description | -| ---------------------------- | ----------------------- | ----------------------------------------- | -------------------------------------------------------- | -| LoS layer | `LoSLayer` | [vector: line] | LoS layer to analyse. | -| Use curvature corrections? | `CurvatureCorrections` | [boolean]

Default: `True` | Should the curvature and refraction corrections be used? | -| Refraction coefficient value | `RefractionCoefficient` | [number]

Default:
`0.13` | Value of refraction coefficient. | -| Output layer | `OutputLayer` | [vector: line] | Output layer containing LoS with new attributes. | +| Label | Name | Type | Description | +| ---------------------------- | ----------------------- | ----------------------------------------- | ------------------------------------------------------- | +| LoS layer | `LoSLayer` | [vector: line] | LoS layer to analyze. | +| Use curvature corrections? | `CurvatureCorrections` | [boolean]

Default: `True` | Should curvature and refraction corrections be applied? | +| Refraction coefficient value | `RefractionCoefficient` | [number]

Default:
`0.13` | Value of the refraction coefficient. | +| Output layer | `OutputLayer` | [vector: line] | Output layer containing LoS with new attributes. | ## Outputs diff --git a/website/pages/tools/LoS Creation/tool_create_global_los.md b/website/pages/tools/LoS Creation/tool_create_global_los.md index ebb994f..e384c37 100755 --- a/website/pages/tools/LoS Creation/tool_create_global_los.md +++ b/website/pages/tools/LoS Creation/tool_create_global_los.md @@ -1,26 +1,26 @@ # Create Global LoS -Create line-of-sight from each point from observers layer through each point in targets layer. Each line-of-sight starts at observer and ends at an edge of DEM raster behind target. +Creates a line-of-sight from each point in the observers layer through each point in the targets layer. Each line-of-sight starts at the observer and ends at the edge of the DEM raster behind the target. ## Parameters -| Label | Name | Type | Description | -| --------------------- | ----------------- | ---------------------------------------- | ------------------------------------------------------ | -| Raster Layer DEM | `DemRasters` | [raster][list] | Raster DEMs on which the LoS is calculated. | -| Observers point layer | `ObserverPoints` | [vector: point] | Point layer representing the observers. | -| Observer ID field | `ObserverIdField` | [tablefield: numeric] | Field containing ID for observer points. | -| Observer offset field | `ObserverOffset` | [tablefield: numeric] | Field containing offset above DEM for observer points. | -| Targets point layer | `TargetPoints` | [vector: point] | Point layer representing the targets. | -| Target ID field | `TargetIdField` | [tablefield: numeric] | Field containing ID for target points. | -| Target offset field | `TargetOffset` | [tablefield: numeric] | Field containing offset above DEM for target points. | -| LoS sampling distance | `LineDensity` | [distance]

Default:
`1` | The distance by which the LoS is segmentized. | -| Output layer | `OutputLayer` | [vector: line] | Output layer containing LoS. | +| Label | Name | Type | Description | +| --------------------- | ----------------- | ---------------------------------------- | ---------------------------------------------------------- | +| Raster Layer DEM | `DemRasters` | [raster][list] | Raster DEMs on which the LoS is calculated. | +| Observers point layer | `ObserverPoints` | [vector: point] | Point layer representing the observers. | +| Observer ID field | `ObserverIdField` | [tablefield: numeric] | Field containing IDs for observer points. | +| Observer offset field | `ObserverOffset` | [tablefield: numeric] | Field containing the offset above DEM for observer points. | +| Targets point layer | `TargetPoints` | [vector: point] | Point layer representing the targets. | +| Target ID field | `TargetIdField` | [tablefield: numeric] | Field containing IDs for target points. | +| Target offset field | `TargetOffset` | [tablefield: numeric] | Field containing the offset above DEM for target points. | +| LoS sampling distance | `LineDensity` | [distance]

Default:
`1` | The distance by which the LoS is segmented. | +| Output layer | `OutputLayer` | [vector: line] | Output layer containing the LoS. | ## Outputs -| Label | Name | Type | Description | -| ------------ | ------------- | -------------- | ---------------------------- | -| Output layer | `OutputLayer` | [vector: line] | Output layer containing LoS. | +| Label | Name | Type | Description | +| ------------ | ------------- | -------------- | -------------------------------- | +| Output layer | `OutputLayer` | [vector: line] | Output layer containing the LoS. | ### Fields in the output layer @@ -36,4 +36,3 @@ Create line-of-sight from each point from observers layer through each point in ## Tool screenshot ![Create global LoS](../../images/tool_create_global_los.png) - \ No newline at end of file diff --git a/website/pages/tools/LoS Creation/tool_create_local_los.md b/website/pages/tools/LoS Creation/tool_create_local_los.md index 6ef8ee7..0ceda69 100755 --- a/website/pages/tools/LoS Creation/tool_create_local_los.md +++ b/website/pages/tools/LoS Creation/tool_create_local_los.md @@ -1,26 +1,26 @@ # Create Local LoS -Create line-of-sight between each point from observers layer and targets layer. Each line-of-sight starts at observer and ends at target. +Creates a line-of-sight between each point in the observers layer and the targets layer. Each line-of-sight starts at the observer and ends at the target. ## Parameters -| Label | Name | Type | Description | -| --------------------- | ----------------- | ---------------------------------------- | ------------------------------------------------------ | -| Raster Layer DEM | `DemRasters` | [raster][list] | Raster DEMs on which the LoS is calculated. | -| Observers point layer | `ObserverPoints` | [vector: point] | Point layer representing the observers. | -| Observer ID field | `ObserverIdField` | [tablefield: numeric] | Field containing ID for observer points. | -| Observer offset field | `ObserverOffset` | [tablefield: numeric] | Field containing offset above DEM for observer points. | -| Targets point layer | `TargetPoints` | [vector: point] | Point layer representing the targets. | -| Target ID field | `TargetIdField` | [tablefield: numeric] | Field containing ID for target points. | -| Target offset field | `TargetOffset` | [tablefield: numeric] | Field containing offset above DEM for target points. | -| LoS sampling distance | `LineDensity` | [distance]

Default:
`1` | The distance by which the LoS is segmentized. | -| Output layer | `OutputLayer` | [vector: line] | Output layer containing LoS. | +| Label | Name | Type | Description | +| --------------------- | ----------------- | ---------------------------------------- | ---------------------------------------------------------- | +| Raster Layer DEM | `DemRasters` | [raster][list] | Raster DEMs on which the LoS is calculated. | +| Observers point layer | `ObserverPoints` | [vector: point] | Point layer representing the observers. | +| Observer ID field | `ObserverIdField` | [tablefield: numeric] | Field containing IDs for observer points. | +| Observer offset field | `ObserverOffset` | [tablefield: numeric] | Field containing the offset above DEM for observer points. | +| Targets point layer | `TargetPoints` | [vector: point] | Point layer representing the targets. | +| Target ID field | `TargetIdField` | [tablefield: numeric] | Field containing IDs for target points. | +| Target offset field | `TargetOffset` | [tablefield: numeric] | Field containing the offset above DEM for target points. | +| LoS sampling distance | `LineDensity` | [distance]

Default:
`1` | The distance by which the LoS is segmented. | +| Output layer | `OutputLayer` | [vector: line] | Output layer containing the LoS. | ## Outputs -| Label | Name | Type | Description | -| ------------ | ------------- | -------------- | ---------------------------- | -| Output layer | `OutputLayer` | [vector: line] | Output layer containing LoS. | +| Label | Name | Type | Description | +| ------------ | ------------- | -------------- | -------------------------------- | +| Output layer | `OutputLayer` | [vector: line] | Output layer containing the LoS. | ### Fields in the output layer @@ -34,4 +34,3 @@ Create line-of-sight between each point from observers layer and targets layer. ## Tool screenshot ![Create local LoS](../../images/tool_create_local_los.png) - \ No newline at end of file diff --git a/website/pages/tools/LoS Creation/tool_create_notarget_los.md b/website/pages/tools/LoS Creation/tool_create_notarget_los.md index 808f78d..a8f258d 100755 --- a/website/pages/tools/LoS Creation/tool_create_notarget_los.md +++ b/website/pages/tools/LoS Creation/tool_create_notarget_los.md @@ -1,6 +1,6 @@ # Create No Target LoS -Create line-of-sight between each point from observer’s layer and targets layer, where `Observer ID field` value from observer is equal to `Target and Observer agreement ID field` of target. This ensures that each point from target’s layer is linked to one point from observers layer. Each line-of-sight starts at observer and ends at an edge of DEM raster behind target. +Creates a line-of-sight between each point in the observers layer and the targets layer, where the `Observer ID field` value from the observer matches the `Target and Observer agreement ID field` of the target. This ensures that each point in the targets layer is linked to one point in the observers layer. Each line-of-sight starts at the observer and ends at the edge of the DEM raster behind the target. The target points can be and usually should be created by tools [Create points around](../Points Creation/tool_points_around.md) and [Create points in direction](../Points Creation/tool_points_in_direction.md). @@ -10,23 +10,23 @@ This variant of the tool specifies sampling and length of LoS by table `Sampling ## Parameters -| Label | Name | Type | Description | -| -------------------------------------- | ------------------------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| Raster Layer DEM | `DemRasters` | [raster][list] | Raster DEMs on which the LoS is calculated. | -| Sampling distance - distance table | `LineSettingsTable` | [vector: nogeometry] | Distance table, specify sampling size on LoS by distance. | -| Observers point layer | `ObserverPoints` | [vector: point] | Point layer representing the observers. | -| Observer ID field | `ObserverIdField` | [tablefield: numeric] | Field containing ID for observer points. | -| Observer offset field | `ObserverOffset` | [tablefield: numeric] | Field containing offset above DEM for observer points. | -| Targets point layer | `TargetPoints` | [vector: point] | Point layer representing the targets. | -| Target ID field | `TargetIdField` | [tablefield: numeric] | Field containing ID for target points. | -| Target and Observer agreement ID field | `TargetDefinitionIdField` | [tablefield: numeric] | Field that specifies which target point is linked to which observer point. Values in this field are compared to `ObserverIdField`. | -| Output layer | `OutputLayer` | [vector: line] | Output layer containing LoS. | +| Label | Name | Type | Description | +| -------------------------------------- | ------------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Raster Layer DEM | `DemRasters` | [raster][list] | List of DEM rasters on which the LoS is calculated. The rasters are ordered from smallest spatial resolution to highest. Elevation for the LoS is taken from the raster with the smallest spatial resolution that has a value. | +| Sampling distance - distance table | `LineSettingsTable` | [vector: nogeometry] | Distance table specifying the sampling size on the LoS by distance. | +| Observers point layer | `ObserverPoints` | [vector: point] | Point layer representing the observers. | +| Observer ID field | `ObserverIdField` | [tablefield: numeric] | Field containing IDs for observer points. | +| Observer offset field | `ObserverOffset` | [tablefield: numeric] | Field containing the offset above DEM for observer points. | +| Targets point layer | `TargetPoints` | [vector: point] | Point layer representing the targets. | +| Target ID field | `TargetIdField` | [tablefield: numeric] | Field containing IDs for target points. | +| Target and Observer agreement ID field | `TargetDefinitionIdField` | [tablefield: numeric] | Field that specifies which target point is linked to which observer point. Values in this field are compared to the `ObserverIdField`. | +| Output layer | `OutputLayer` | [vector: line] | Output layer containing the LoS. | ## Outputs -| Label | Name | Type | Description | -| ------------ | ------------- | -------------- | ---------------------------- | -| Output layer | `OutputLayer` | [vector: line] | Output layer containing LoS. | +| Label | Name | Type | Description | +| ------------ | ------------- | -------------- | -------------------------------- | +| Output layer | `OutputLayer` | [vector: line] | Output layer containing the LoS. | ### Fields in the output layer