Skip to content

Commit 0f1287f

Browse files
authored
Transect (fixed interval) alg (#10798)
2 parents fee79f8 + e128829 commit 0f1287f

File tree

3 files changed

+145
-11
lines changed

3 files changed

+145
-11
lines changed
-4.7 KB
Loading
28.9 KB
Loading

docs/user_manual/processing_algs/qgis/vectorgeometry.rst

Lines changed: 145 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7542,16 +7542,7 @@ Creates transects on vertices for (multi)linestring.
75427542
A transect is a line oriented from an angle (by default perpendicular)
75437543
to the input polylines (at vertices).
75447544

7545-
Field(s) from feature(s) are returned in the transect with these
7546-
new fields:
7547-
7548-
* TR_FID: ID of the original feature
7549-
* TR_ID: ID of the transect. Each transect have an unique ID
7550-
* TR_SEGMENT: ID of the segment of the linestring
7551-
* TR_ANGLE: Angle in degrees from the original line at the vertex
7552-
* TR_LENGTH: Total length of the transect returned
7553-
* TR_ORIENT: Side of the transect (only on the left or right of
7554-
the line, or both side)
7545+
The output transect layer includes the original feature fields along with new transect fields.
75557546

75567547
.. warning::
75577548
This algorithm drops existing primary keys or FID values and regenerates them in output layers.
@@ -7561,6 +7552,8 @@ new fields:
75617552

75627553
Dashed red lines represent the transect of the input line layer
75637554

7555+
.. seealso:: :ref:`qgistransectfixeddistance`
7556+
75647557
Parameters
75657558
..........
75667559

@@ -7597,7 +7590,17 @@ Parameters
75977590
* 0 --- Left
75987591
* 1 --- Right
75997592
* 2 --- Both
7593+
* - **Direction**
76007594

7595+
Optional
7596+
- ``DIRECTION``
7597+
- [enumeration]
7598+
7599+
Default: ``0``
7600+
- Orientation direction for transects:
7601+
7602+
* 0 --- Left to Right
7603+
* 1 --- Right to Left
76017604
* - **Transect**
76027605
- ``OUTPUT``
76037606
- [vector: line]
@@ -7625,7 +7628,15 @@ Outputs
76257628
* - **Transect**
76267629
- ``OUTPUT``
76277630
- [vector: line]
7628-
- Output line layer
7631+
- Output line layer.
7632+
The output layer contains the following fields:
7633+
7634+
- ``TR_FID``: ID of the original feature
7635+
- ``TR_ID``: ID of the transect. Each transect have a unique ID
7636+
- ``TR_SEGMENT``: ID of the segment of the linestring
7637+
- ``TR_ANGLE``: Angle in degrees from the original line at the vertex
7638+
- ``TR_LENGTH``: Total length of the transect returned
7639+
- ``TR_ORIENT``: Side of the transect (only on the left or right of the line, or both side)
76297640

76307641
Python code
76317642
...........
@@ -7636,6 +7647,129 @@ Python code
76367647
:start-after: **algorithm_code_section**
76377648
:end-before: **end_algorithm_code_section**
76387649

7650+
.. _qgistransectfixeddistance:
7651+
7652+
Transect (fixed distance)
7653+
-------------------------
7654+
7655+
Creates transects at fixed distance intervals along (multi)linestrings.
7656+
7657+
A transect is a line oriented from an angle (by default perpendicular)
7658+
to the input polylines at regular intervals.
7659+
7660+
The output transect layer includes the original feature fields along with new transect fields.
7661+
7662+
.. warning::
7663+
This algorithm drops existing primary keys or FID values and regenerates them in output layers.
7664+
7665+
.. figure:: img/transect_fixed_distance.png
7666+
:align: center
7667+
7668+
Transects (red lines) created at fixed intervals along the input line layer (blue lines)
7669+
7670+
.. seealso:: :ref:`qgistransect`
7671+
7672+
Parameters
7673+
..........
7674+
7675+
.. list-table::
7676+
:header-rows: 1
7677+
:widths: 20 20 20 40
7678+
:class: longtable
7679+
7680+
* - Label
7681+
- Name
7682+
- Type
7683+
- Description
7684+
* - **Input layer**
7685+
- ``INPUT``
7686+
- [vector: line]
7687+
- Input line vector layer
7688+
* - **Fixed sampling interval**
7689+
- ``INTERVAL``
7690+
- [numeric: double]
7691+
7692+
Default: ``10.0``
7693+
- Distance between transects along the line
7694+
* - **Length of the transect**
7695+
- ``LENGTH``
7696+
- [numeric: double] |dataDefine|
7697+
7698+
Default: ``5.0``
7699+
- Total length of each transect line
7700+
* - **Angle from original line at the vertices**
7701+
- ``ANGLE``
7702+
- [numeric: double] |dataDefine|
7703+
7704+
Default: ``90.0``
7705+
- Angle in degrees from the original line. A value of 90° creates
7706+
perpendicular transects
7707+
* - **Side to create the transects**
7708+
- ``SIDE``
7709+
- [enumeration]
7710+
7711+
Default: ``0``
7712+
- Which side of the line to create transects on (relative to the line
7713+
digitizing direction):
7714+
7715+
* 0 --- Left
7716+
* 1 --- Right
7717+
* 2 --- Both
7718+
* - **Direction**
7719+
Optional
7720+
- ``DIRECTION``
7721+
- [enumeration]
7722+
7723+
Default: ``0``
7724+
- Orientation direction for transects:
7725+
7726+
* 0 --- Left to Right
7727+
* 1 --- Right to Left
7728+
* - **Transect**
7729+
- ``OUTPUT``
7730+
- [vector: line]
7731+
7732+
Default: ``[Create temporary layer]``
7733+
- Specification of the output line layer.
7734+
:ref:`One of <output_parameter_widget>`:
7735+
7736+
.. include:: ../algs_include.rst
7737+
:start-after: **file_output_types**
7738+
:end-before: **end_file_output_types**
7739+
7740+
Outputs
7741+
.......
7742+
7743+
.. list-table::
7744+
:header-rows: 1
7745+
:widths: 20 20 20 40
7746+
:class: longtable
7747+
7748+
* - Label
7749+
- Name
7750+
- Type
7751+
- Description
7752+
* - **Transect**
7753+
- ``OUTPUT``
7754+
- [vector: line]
7755+
- Output line layer containing the generated transects.
7756+
The output layer contains the following fields:
7757+
7758+
- ``TR_FID``: ID of the original feature
7759+
- ``TR_ID``: ID of the transect. Each transect have a unique ID
7760+
- ``TR_SEGMENT``: ID of the segment of the linestring
7761+
- ``TR_ANGLE``: Angle in degrees from the original line at the vertex
7762+
- ``TR_LENGTH``: Total length of the transect returned
7763+
- ``TR_ORIENT``: Side of the transect (only on the left or right of the line, or both side)
7764+
7765+
Python code
7766+
...........
7767+
7768+
**Algorithm ID**: ``native:transectfixeddistance``
7769+
7770+
.. include:: ../algs_include.rst
7771+
:start-after: **algorithm_code_section**
7772+
:end-before: **end_algorithm_code_section**
76397773

76407774
.. _qgistranslategeometry:
76417775

0 commit comments

Comments
 (0)