Skip to content

Commit 107cf68

Browse files
authored
Add documentation for check geometry: Lines intersecting other layer (#10168)
2 parents d8d9049 + c11f52e commit 107cf68

1 file changed

Lines changed: 126 additions & 0 deletions

File tree

docs/user_manual/processing_algs/qgis/checkgeometry.rst

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -634,6 +634,132 @@ Python code
634634
:end-before: **end_algorithm_code_section**
635635

636636

637+
.. _qgischeckgeometrylinelayerintersection:
638+
639+
Lines intersecting other layer
640+
------------------------------
641+
642+
Checks if the input line layer features intersect with the check layer features.
643+
An input feature that intersects with a check layer feature is an error.
644+
645+
.. seealso:: :ref:`qgislineintersections`, :ref:`qgisintersection`, :ref:`qgischeckgeometryselfintersections`
646+
647+
Parameters
648+
..........
649+
650+
Basic parameters
651+
^^^^^^^^^^^^^^^^
652+
653+
.. list-table::
654+
:header-rows: 1
655+
:widths: 20 20 20 40
656+
:class: longtable
657+
658+
* - Label
659+
- Name
660+
- Type
661+
- Description
662+
* - **Input layer**
663+
- ``INPUT``
664+
- [vector: line]
665+
- Layer with the geometries to check.
666+
* - **Unique feature identifier**
667+
- ``UNIQUE_ID``
668+
- [tablefield: any]
669+
- Field storing unique values for feature identification.
670+
* - **Check layer**
671+
- ``CHECK_LAYER``
672+
- [vector: line, polygon]
673+
- Layer with the geometries to check against.
674+
* - **Line intersecting other layer errors**
675+
- ``ERRORS``
676+
- [vector: point]
677+
678+
Default: ``[Create temporary layer]``
679+
- Specification of the output point layer containing the locations of intersection errors.
680+
:ref:`One of <output_parameter_widget>`:
681+
682+
.. include:: ../algs_include.rst
683+
:start-after: **layer_output_types**
684+
:end-before: **end_layer_output_types**
685+
* - **Line intersecting other layer features**
686+
687+
Optional
688+
- ``OUTPUT``
689+
- [line]
690+
691+
Default: ``[Skip output]``
692+
- Line layer with the input features that intersect features in the check layer.
693+
:ref:`One of <output_parameter_widget>`:
694+
695+
.. include:: ../algs_include.rst
696+
:start-after: **layer_output_types_skip**
697+
:end-before: **end_layer_output_types_skip**
698+
699+
Advanced parameters
700+
^^^^^^^^^^^^^^^^^^^
701+
702+
.. list-table::
703+
:header-rows: 1
704+
:widths: 20 20 20 40
705+
:class: longtable
706+
707+
* - Label
708+
- Name
709+
- Type
710+
- Description
711+
* - **Tolerance**
712+
- ``TOLERANCE``
713+
- [numeric: integer]
714+
715+
Default: 8
716+
- Numerical precision of geometric operations, given as an integer n,
717+
meaning that two vertices less than 10\ :sup:`-n` apart (in map units)
718+
are considered to be merged.
719+
720+
Outputs
721+
.......
722+
723+
.. list-table::
724+
:header-rows: 1
725+
:widths: 20 20 20 40
726+
:class: longtable
727+
728+
* - Label
729+
- Name
730+
- Type
731+
- Description
732+
* - **Line intersecting other layer errors**
733+
- ``ERRORS``
734+
- [vector: point]
735+
- Output point layer representing the error location and information.
736+
Other than the ``UNIQUE_ID`` field, the output layer also contains the following fields:
737+
738+
- ``gc_layerid``: the ID of the input layer.
739+
- ``gc_layername``: the name of the input layer.
740+
- ``gc_partidx``: the index of the feature's geometry part where the intersection occurs.
741+
- ``gc_ringidx``
742+
- ``gc_vertidx``
743+
- ``gc_errorx``: the x coordinate of the intersection point.
744+
- ``gc_errory``: the y coordinate of the intersection point.
745+
- ``gc_error``: the index of the check layer where the intersection occurs.
746+
* - **Line intersecting other layer features**
747+
- ``OUTPUT``
748+
- [vector: line]
749+
- Output layer containing, for each identified intersection, the input feature it belongs to.
750+
If no intersections are found, the output layer will be empty.
751+
Additional fields are available (see ``ERRORS`` output).
752+
753+
Python code
754+
...........
755+
756+
**Algorithm ID**: ``native:checkgeometrylinelayerintersection``
757+
758+
.. include:: ../algs_include.rst
759+
:start-after: **algorithm_code_section**
760+
:end-before: **end_algorithm_code_section**
761+
762+
637763
.. _qgischeckgeometryselfintersections:
638764

639765
Self-intersections

0 commit comments

Comments
 (0)