pylineament 0.1.2__tar.gz → 0.1.3__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2025 epokus
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ MIT License
2
+
3
+ Copyright (c) 2025 epokus
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: pylineament
3
- Version: 0.1.2
3
+ Version: 0.1.3
4
4
  Summary: Python Geological Lineament extraction package
5
5
  Author-email: Epo Kusumah <epo.pk@universiaspertamina.ac.id>
6
6
  License-Expression: MIT
@@ -1,101 +1,101 @@
1
- # PyLineament
2
-
3
- **PyLineament** is a Python-based, open-source toolkit for **automatic and regional-scale lineament extraction** from Digital Elevation Models (DEMs) and remote sensing imagery.
4
-
5
- It is designed for geological and geomorphological analysis — providing a **fully automated, reproducible**, and **scalable** workflow for extracting, reducing, and mapping lineaments across local to regional scales.
6
-
7
- ---
8
-
9
- ## Installation
10
-
11
- ```bash
12
- pip install pylineament
13
- ```
14
- Or from source:
15
-
16
- ```bash
17
- git clone https://github.com/epokus/pylineament.git
18
- cd pylineament
19
- pip install -e .
20
- ```
21
-
22
- ## Quick Start (Command Line)
23
-
24
- Once installed, simply open your terminal or command prompt and run:
25
-
26
- ```bash
27
- pylineament
28
- ```
29
-
30
- ## Key Features
31
- - Interactive UI — Run `pylineament` in the terminal to open the GUI.
32
- - Automated Workflow — Full end-to-end lineament extraction.
33
- - Customizable Parameters — Control edge detection thresholds, segment length, and merging distance.
34
- - Multi-Resolution Support — Works with various DEM/image resolutions.
35
- - Scalable — Efficient for large-area or regional-scale mapping.
36
- - Reproducible — Transparent parameters and open-source implementation.
37
-
38
- ## Core Functions
39
- | Function | Description |
40
- | ---------------------------- | ------------------------------------------------------------ |
41
- | `read_raster()` | Reads and preprocesses a raster (DEM or image). |
42
- | `extract_lineament_points()` | Detects lineament-like edge points using gradient filters. |
43
- | `convert_points_to_line()` | Converts clustered edge points into connected line segments. |
44
- | `reduce_lines()` | Simplifies and merges overlapping or redundant lineaments. |
45
- | `hillshade()` | Generates a hillshade image for visualization. |
46
- | `dem_to_line()` | Extracts lineaments directly from a DEM file. |
47
- | `dem_to_shp()` | Full workflow: extract + merge + export to shapefile. |
48
-
49
-
50
- ## Example Workflow
51
- - Input your DEM or satellite image.
52
- - Optionally apply hillshade() or downscale for efficiency.
53
- - Extract edge points using extract_lineament_points().
54
- - Convert points to lines and merge them with reduce_lines().
55
- - Save as shapefile using dem_to_shp() or merge_lines_csv_to_shp().
56
-
57
- ## example how to use this Library with CLI or python
58
-
59
- ```python
60
- from pylineament import dem_to_shp
61
- dem_to_shp("data/srtm_sample.tif", shp_name= "lineamentsExtract")
62
- ```
63
- shp file will be saved in "lineamentsExtract" folder.
64
- see more examples in example folder
65
- ![PyLineament UI Preview](examples/lienament_extracted.png)
66
-
67
-
68
- ## Parameters Overview
69
- | Parameter | Description | Typical Range |
70
- | ------------ | ------------------------------------- | ----------------- |
71
- | `eps` | Edge detection sensitivity | 0.8 – 2.0 |
72
- | `thresh` | Edge detection threshold | 20 – 80 |
73
- | `z_multip` | Vertical exaggeration factor | 0.5 – 2.0 |
74
- | `min_dist` | Minimum distance between merged lines | 5 – 20 pixels |
75
- | `seg_len` | Minimum segment length | 5 – 20 pixels |
76
- | `split_size` | DEM/image tile size for processing | 250 – 1000 pixels |
77
-
78
-
79
-
80
- ## Why PyLineament?
81
- Typical “automatic” lineament extraction tools are limited by:
82
- - Fixed image resolution and poor scalability,
83
- - Heavy preprocessing requirements,
84
- - Loss of geological meaning across scales,
85
- - Slow performance in large regions.
86
-
87
- ## PyLineament addresses these by providing:
88
- - Automated but parameter-controllable extraction,
89
- - Multi-resolution and downscaling support,
90
- - Robust reduction and merging algorithms,
91
- - Compatibility with both small-area (detailed) and large-area datasets (regional mapping).
92
-
93
- ## Citation
94
- If you use PyLineament in your research, please cite:
95
- Prasetya Kusumah, E. (2025). PyLineament: A Python Toolkit for Regional-Scale Lineament Extraction.
96
- Version 1.0. https://github.com/epokus/pylineament
97
-
98
- ## License
99
- This project is licensed under the MIT License — see the LICENSE
100
- file for details.
101
-
1
+ # PyLineament
2
+
3
+ **PyLineament** is a Python-based, open-source toolkit for **automatic and regional-scale lineament extraction** from Digital Elevation Models (DEMs) and remote sensing imagery.
4
+
5
+ It is designed for geological and geomorphological analysis — providing a **fully automated, reproducible**, and **scalable** workflow for extracting, reducing, and mapping lineaments across local to regional scales.
6
+
7
+ ---
8
+
9
+ ## Installation
10
+
11
+ ```bash
12
+ pip install pylineament
13
+ ```
14
+ Or from source:
15
+
16
+ ```bash
17
+ git clone https://github.com/epokus/pylineament.git
18
+ cd pylineament
19
+ pip install -e .
20
+ ```
21
+
22
+ ## Quick Start (Command Line)
23
+
24
+ Once installed, simply open your terminal or command prompt and run:
25
+
26
+ ```bash
27
+ pylineament
28
+ ```
29
+
30
+ ## Key Features
31
+ - Interactive UI — Run `pylineament` in the terminal to open the GUI.
32
+ - Automated Workflow — Full end-to-end lineament extraction.
33
+ - Customizable Parameters — Control edge detection thresholds, segment length, and merging distance.
34
+ - Multi-Resolution Support — Works with various DEM/image resolutions.
35
+ - Scalable — Efficient for large-area or regional-scale mapping.
36
+ - Reproducible — Transparent parameters and open-source implementation.
37
+
38
+ ## Core Functions
39
+ | Function | Description |
40
+ | ---------------------------- | ------------------------------------------------------------ |
41
+ | `read_raster()` | Reads and preprocesses a raster (DEM or image). |
42
+ | `extract_lineament_points()` | Detects lineament-like edge points using gradient filters. |
43
+ | `convert_points_to_line()` | Converts clustered edge points into connected line segments. |
44
+ | `reduce_lines()` | Simplifies and merges overlapping or redundant lineaments. |
45
+ | `hillshade()` | Generates a hillshade image for visualization. |
46
+ | `dem_to_line()` | Extracts lineaments directly from a DEM file. |
47
+ | `dem_to_shp()` | Full workflow: extract + merge + export to shapefile. |
48
+
49
+
50
+ ## Example Workflow
51
+ - Input your DEM or satellite image.
52
+ - Optionally apply hillshade() or downscale for efficiency.
53
+ - Extract edge points using extract_lineament_points().
54
+ - Convert points to lines and merge them with reduce_lines().
55
+ - Save as shapefile using dem_to_shp() or merge_lines_csv_to_shp().
56
+
57
+ ## example how to use this Library with CLI or python
58
+
59
+ ```python
60
+ from pylineament import dem_to_shp
61
+ dem_to_shp("data/srtm_sample.tif", shp_name= "lineamentsExtract")
62
+ ```
63
+ shp file will be saved in "lineamentsExtract" folder.
64
+ see more examples in example folder
65
+ ![PyLineament UI Preview](examples/lienament_extracted.png)
66
+
67
+
68
+ ## Parameters Overview
69
+ | Parameter | Description | Typical Range |
70
+ | ------------ | ------------------------------------- | ----------------- |
71
+ | `eps` | Edge detection sensitivity | 0.8 – 2.0 |
72
+ | `thresh` | Edge detection threshold | 20 – 80 |
73
+ | `z_multip` | Vertical exaggeration factor | 0.5 – 2.0 |
74
+ | `min_dist` | Minimum distance between merged lines | 5 – 20 pixels |
75
+ | `seg_len` | Minimum segment length | 5 – 20 pixels |
76
+ | `split_size` | DEM/image tile size for processing | 250 – 1000 pixels |
77
+
78
+
79
+
80
+ ## Why PyLineament?
81
+ Typical “automatic” lineament extraction tools are limited by:
82
+ - Fixed image resolution and poor scalability,
83
+ - Heavy preprocessing requirements,
84
+ - Loss of geological meaning across scales,
85
+ - Slow performance in large regions.
86
+
87
+ ## PyLineament addresses these by providing:
88
+ - Automated but parameter-controllable extraction,
89
+ - Multi-resolution and downscaling support,
90
+ - Robust reduction and merging algorithms,
91
+ - Compatibility with both small-area (detailed) and large-area datasets (regional mapping).
92
+
93
+ ## Citation
94
+ If you use PyLineament in your research, please cite:
95
+ Prasetya Kusumah, E. (2025). PyLineament: A Python Toolkit for Regional-Scale Lineament Extraction.
96
+ Version 1.0. https://github.com/epokus/pylineament
97
+
98
+ ## License
99
+ This project is licensed under the MIT License — see the LICENSE
100
+ file for details.
101
+
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: pylineament
3
- Version: 0.1.2
3
+ Version: 0.1.3
4
4
  Summary: Python Geological Lineament extraction package
5
5
  Author-email: Epo Kusumah <epo.pk@universiaspertamina.ac.id>
6
6
  License-Expression: MIT
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "pylineament"
7
- version = "0.1.2"
7
+ version = "0.1.3"
8
8
  description = "Python Geological Lineament extraction package"
9
9
  readme = "README.md"
10
10
  authors = [{ name="Epo Kusumah", email="epo.pk@universiaspertamina.ac.id" }]
File without changes