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