LinkingLines


NameLinkingLines JSON
Version 2.0.1 PyPI version JSON
download
home_page
SummaryUses Hough Transform and clustering to link line segments and for feature extraction of linear and radial structures
upload_time2023-10-03 23:17:37
maintainer
docs_urlNone
author
requires_python>=3.7
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
# Welcome to LinkingLines!

[![DOI](https://zenodo.org/badge/272334230.svg)](https://zenodo.org/badge/latestdoi/272334230)

[![PyPI](https://img.shields.io/pypi/v/LinkingLines.svg)](https://pypi.org/project/LinkingLines/)

[![ReadtheDocs](https://readthedocs.org/projects/LinkingLines/badge/)](https://linkinglines.readthedocs.io/)

[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)


## 1. Introduction
Welcome to the documentation for our Python module that performs the Hough
Transform on line data from a CSV, clusters it using Agglomerative Clustering,
and provides functionality to export the results into a CSV file.
This module also includes custom plotting scripts and feature extraction
methods to help you analyze and visualize your data effectively.

This code was used to create the results published in
[Kubo Hutchison et al., 2023](https://agupubs.onlinelibrary.wiley.com/doi/full/10.1029/2022GC010842).
Initially, it was designed to link together mapped dike segments in Cartesian space
to find their true lengths. This code can be applied to any linear features including
roads, fractures, and other types of linear data.

- **Data Clustering**: Apply Agglomerative Clustering to group similar data points, this
can be used for data reduction, analysis, and mapping .

- **Data Visualization**: Custom plotting scripts help you visualize and analyze
your data, making it easier to identify patterns and anomalies.

- **Feature Extraction**: Extract meaningful features from clustered data to
perform further analysis, such as linear or radial type features.


Full documentation can be found on [ReadTheDocs](https://linkinglines.readthedocs.io/en/latest/)

## 2. Installation
To use this module, make sure you have Python installed (preferably Python 3.x).
You can install the required packages using pip:

```bash
pip install linkinglines
```

## 3. Quick Start

```python
import pandas as pd
import numpy as np
import matplotlib.pyplot as plt
import linkinglines as ll

data=pd.read_csv('path/to/data')
theta,rho,xc,yc=ll.HoughTransform(data)
data['theta']=theta
data['rho']=rho

dtheta=2 #degrees
drho=500 #meters

dikeset, Z=ll.AggCluster(data)
lines,evaluation=examineCluster(data)
fig,ax=DotsLines(lines, ColorBy='AvgTheta')

```

Follow this indepth [tutorial](DemoLinkingLines.md) to get started!

You are now ready to utilize the power of Hough Line Transform, Agglomerative Clustering, and custom plotting in your data analysis projects. If you have any questions or need further assistance, please refer to the detailed documentation or contact our support team.

Happy coding!


            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "LinkingLines",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "",
    "author": "",
    "author_email": "Allison Kubo <akubo@uoregon.edu>",
    "download_url": "https://files.pythonhosted.org/packages/6e/99/4690a6da18675e6c1532b27640962b7af3c1e1084a0c6369f293b4f4d7a1/LinkingLines-2.0.1.tar.gz",
    "platform": null,
    "description": "\n# Welcome to LinkingLines!\n\n[![DOI](https://zenodo.org/badge/272334230.svg)](https://zenodo.org/badge/latestdoi/272334230)\n\n[![PyPI](https://img.shields.io/pypi/v/LinkingLines.svg)](https://pypi.org/project/LinkingLines/)\n\n[![ReadtheDocs](https://readthedocs.org/projects/LinkingLines/badge/)](https://linkinglines.readthedocs.io/)\n\n[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\n\n## 1. Introduction\nWelcome to the documentation for our Python module that performs the Hough\nTransform on line data from a CSV, clusters it using Agglomerative Clustering,\nand provides functionality to export the results into a CSV file.\nThis module also includes custom plotting scripts and feature extraction\nmethods to help you analyze and visualize your data effectively.\n\nThis code was used to create the results published in\n[Kubo Hutchison et al., 2023](https://agupubs.onlinelibrary.wiley.com/doi/full/10.1029/2022GC010842).\nInitially, it was designed to link together mapped dike segments in Cartesian space\nto find their true lengths. This code can be applied to any linear features including\nroads, fractures, and other types of linear data.\n\n- **Data Clustering**: Apply Agglomerative Clustering to group similar data points, this\ncan be used for data reduction, analysis, and mapping .\n\n- **Data Visualization**: Custom plotting scripts help you visualize and analyze\nyour data, making it easier to identify patterns and anomalies.\n\n- **Feature Extraction**: Extract meaningful features from clustered data to\nperform further analysis, such as linear or radial type features.\n\n\nFull documentation can be found on [ReadTheDocs](https://linkinglines.readthedocs.io/en/latest/)\n\n## 2. Installation\nTo use this module, make sure you have Python installed (preferably Python 3.x).\nYou can install the required packages using pip:\n\n```bash\npip install linkinglines\n```\n\n## 3. Quick Start\n\n```python\nimport pandas as pd\nimport numpy as np\nimport matplotlib.pyplot as plt\nimport linkinglines as ll\n\ndata=pd.read_csv('path/to/data')\ntheta,rho,xc,yc=ll.HoughTransform(data)\ndata['theta']=theta\ndata['rho']=rho\n\ndtheta=2 #degrees\ndrho=500 #meters\n\ndikeset, Z=ll.AggCluster(data)\nlines,evaluation=examineCluster(data)\nfig,ax=DotsLines(lines, ColorBy='AvgTheta')\n\n```\n\nFollow this indepth [tutorial](DemoLinkingLines.md) to get started!\n\nYou are now ready to utilize the power of Hough Line Transform, Agglomerative Clustering, and custom plotting in your data analysis projects. If you have any questions or need further assistance, please refer to the detailed documentation or contact our support team.\n\nHappy coding!\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Uses Hough Transform and clustering to link line segments and for feature extraction of linear and radial structures",
    "version": "2.0.1",
    "project_urls": {
        "Bug Tracker": "https://github.com/aikubo/Linking-and-Clustering-Dikes",
        "Homepage": "https://github.com/aikubo/Linking-and-Clustering-Dikes"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "37a503e4a5ac23e627acb289e8874b2f4df4f491ac3516d5b91b577a4c920077",
                "md5": "14be55ace5089ae0f9a56f46b7abbed8",
                "sha256": "06d285ce7eca6bd7af18e807a7ea17534803eee476343ff74ced29dda5991bca"
            },
            "downloads": -1,
            "filename": "LinkingLines-2.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "14be55ace5089ae0f9a56f46b7abbed8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 54095,
            "upload_time": "2023-10-03T23:17:34",
            "upload_time_iso_8601": "2023-10-03T23:17:34.823468Z",
            "url": "https://files.pythonhosted.org/packages/37/a5/03e4a5ac23e627acb289e8874b2f4df4f491ac3516d5b91b577a4c920077/LinkingLines-2.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6e994690a6da18675e6c1532b27640962b7af3c1e1084a0c6369f293b4f4d7a1",
                "md5": "406765152a21cb62f259effe9f0d971c",
                "sha256": "27dba1fa5beb7441e8cd55f677e0a964383c483300c22814095b0d55fe30ca06"
            },
            "downloads": -1,
            "filename": "LinkingLines-2.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "406765152a21cb62f259effe9f0d971c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 54863,
            "upload_time": "2023-10-03T23:17:37",
            "upload_time_iso_8601": "2023-10-03T23:17:37.016960Z",
            "url": "https://files.pythonhosted.org/packages/6e/99/4690a6da18675e6c1532b27640962b7af3c1e1084a0c6369f293b4f4d7a1/LinkingLines-2.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-03 23:17:37",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "aikubo",
    "github_project": "Linking-and-Clustering-Dikes",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "linkinglines"
}
        
Elapsed time: 0.16197s