====================================
Identify Clusters of Connected Lines
====================================

Identifies clusters
of connected lines in a view. This is useful to for data cleaning to see if a network is fully connected.

Parameter
---------

+--------------------------------+------------------------+------------------------------------------------------------------------------------------------+
|        Name                    |          Type          |       Description                                                                              |
+================================+========================+================================================================================================+
|view_name                       | STRING                 | Name of network view                                                                           |
+--------------------------------+------------------------+------------------------------------------------------------------------------------------------+



Data-stream
-----------

+--------------------+---------------------------+------------------+-------+---------------------------------------------+
|        View        |          Attribute        |       Type       |Access |    Description                              |
+====================+===========================+==================+=======+=============================================+
| view_name          |                           | EDGE             | read  |                                             |
+--------------------+---------------------------+------------------+-------+---------------------------------------------+
|                    | start_id                  | INT              | read  |                                             |
+--------------------+---------------------------+------------------+-------+---------------------------------------------+
|                    | end_id                    | INT              | read  |                                             |
+--------------------+---------------------------+------------------+-------+---------------------------------------------+
|                    | cluster_id                | INT              | write |                                             |
+--------------------+---------------------------+------------------+-------+---------------------------------------------+

Model Name
----------

:index:`GDALClusterNetwork <GDALModules; GDALClusterNetwork | Identify Clusters of Connected Lines>`

Sample Code for Python Simulation
---------------------------------
.. code-block:: python

    #calculate length of edges in network
    cluster = sim.add_module('GDALClusterNetwork',
                             {'view_name': 'drainage'},
                             network)
..