Skip to content

Commit

Permalink
metric examples
Browse files Browse the repository at this point in the history
  • Loading branch information
KellyMWhitehead committed Apr 18, 2024
1 parent e5af5ef commit 12761fe
Show file tree
Hide file tree
Showing 7 changed files with 28 additions and 1 deletion.
3 changes: 3 additions & 0 deletions docs/content/page/software-help/metrics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,6 @@ banner: true
description: Metrics are calculations that are applied to the data capture events to quantify the riverscape.
---

[Managing Metrics](/technical-reference/managing_metrics)

[Metric Calculations](/technical-reference/metric_calculations)
26 changes: 25 additions & 1 deletion docs/content/page/technical-reference/metric_calculations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ The following calcuations functions are availble to create Metrics in QRiS. Each
## Count
This calculation counts the number of features from any number of DCE layers (with the addition of an optional count field) that fall within the sample frame. DCE layers may have an optional attribute filter applied. For lines and polygons, the count is prorated by length and area respectively. This function can also apply a valley centerline normalization.

![Count Calculation](/images/technical-reference/metrics/metric-count.png)

*Count calculation example. Sample Frames are shown in orange dashed outline and labeled 1 and 2. Geomorphic Unit Points are mapped as red ("Mound") and orange ("Saddle") points. Depending on how the metric calculation is configured, the count could include all the Geomorphic Unit features that fall within the Sample Frame, or only those that are within the Sample Frame and have a specific attribute value (e.g. type = "Mound").*

calculation_name: `count`

metric params:
Expand All @@ -24,20 +28,28 @@ To apply a valley centerline normalization, the following parameter can be used:
## Length
The length calculation sums the length of all features from any number of DCE layers that fall within the sample frame. DCE layers may have an optional attribute filter applied. This function can also apply a valley centerline normalization.

![Length Calculation](/images/technical-reference/metrics/metric-length.png)

*Length calculation example. Sample Frames are shown in orange dashed outline and labeled 1 and 2. The Active Channel Centerline feature is shown in blue. The metric calculation will sum the length of all Active Channel Centerline features that fall within the area of each Sample Frame.*

calculation_name: `length`

metric params:
- `layers`: A list of DCE [layers](../managing_metrics#layers) to sum lengths from.

Each layer can have the following parameters:
- `attribute_filter`: An optional [attribute filter](../managing_metrics#attribute-filters) to apply to the DCE layers.
- `attribute_filter`: An optional [attribute filter](/technical-reference/managing_metrics#attribute-filters) to apply to the DCE layers.

To apply a valley centerline normalization, the following parameter can be used:
- `normalization: centerline'

## Area
The area calculation sums the area of all features from any number of DCE layers that fall within the sample frame. DCE layers may have an optional attribute filter applied. This function can also apply a valley centerline normalization.

![Area Calculation](/images/technical-reference/metrics/metric-area.png)

*Area calculation example. Sample Frames are shown in orange dashed outline and labeled 1 and 2. The area of the vegetation extent polygon feature is shown in green. The metric calculation will sum the area of all vegetation extent features that fall within the area of each Sample Frame.*

calculation_name: `area`

metric params:
Expand All @@ -52,6 +64,10 @@ To apply a valley centerline normalization, the following parameter can be used:
## Sinusoity
The sinuosity calculation first clips a line feature to the sample frameElement, thene divides the length of the clipped line feature by the straight-line distance between the start and end points of the line.

![Sinuosity Calculation](/images/technical-reference/metrics/metric-sinuosity.png)

*Sinuosity calculation example. Sample Frames are shown in orange dashed outline and labeled 1 and 2. The Active Channel Centerline feature is shown in blue. The straight line distance of the Active Channel Centerline within Sample Frame #2 is shown in the white dashed line. The sinuosity for Sample Frame #2 is calculated as the length of the Active Channel Centerline within the Sample Frame divided by the straight line distance.

calculation_name: `sinuosity`

metric params:
Expand All @@ -60,6 +76,10 @@ metric params:
## Gradient
The gradient calculation calculates the average gradient of a line feature. The gradient is calculated as the difference in elevation between the start and end points of the line divided by the length of the line. Elevation is determined by the DEM layer.

![Gradient Calculation](/images/technical-reference/metrics/metric-length.png)

*Gradient calculation example. Sample Frames are shown in orange dashed outline and labeled 1 and 2. The Active Channel Centerline feature is shown in blue. Elevation from the dem (not displayed) is sampled at the start and end points of the Active Channel Centerline clipped to the Sample Frame. The gradient is calculated as the difference in elevation between the start and end points of the Active Channel Centerline within the Sample Frame divided by the length of the Active Channel Centerline within the Sample Frame.*

calculation_name: `gradient`

metric params:
Expand All @@ -71,6 +91,10 @@ The area proportion calculation calculates the proportion of the area of a polyg

calculation_name: `area_proportion`

![Area Proportion Calculation](/images/technical-reference/metrics/metric-area_proportion.png)

*Area Proportion calculation example. Sample Frames are shown in orange dashed outline and labeled 1 and 2. Geomorphic Unit Polygons for "Free Flowing" (magenta) and "Ponded" (blue) are shown. Several types of area proportion metrics could be calculated from these layers, such as the proportion of the area of "Free Flowing" Geomorphic Units within the total area of the Sample Frame or the proportion of area of "Free Flowing" to total area of the Geomorphic Units (i.e. "Free Flowing" / ("Free Flowing" + "Ponded")).*

metric params:
- `layers`: A list of DCE [layers](../managing_metrics#layers) to calculate area proportions from.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 12761fe

Please sign in to comment.