Skip to content

Commit da46ff0

Browse files
committed
Example update
1 parent 66eb4be commit da46ff0

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
# pclines-python
22

3-
This package implements a Hough Trenaform for lines from paper `Dubska et al, PCLines - Line detection with parallel coordinates, CVPR 2011` with few little improvements.
3+
This package implements a PCLines Transform for line detection in images.
4+
5+
Cite:
6+
```
7+
Dubska et al,PCLines - Line detection with parallel coordinates, CVPR 2011
8+
```
49

510
# Requrements
611

@@ -9,10 +14,36 @@ This package implements a Hough Trenaform for lines from paper `Dubska et al, PC
914
* numba
1015
* scikit-image
1116

17+
# Installation
18+
19+
The package is on [PyPI](https://pypi.org/project/pclines/), so just run following command and install the package.
20+
21+
```shell
22+
> pip install pclines
23+
```
24+
25+
Alternatively, you can download this repository and install manually.
26+
27+
1228
# Example
1329

30+
1. Import package
31+
32+
```python
33+
import pclines as pcl
34+
```
35+
36+
2. Accumulation of observations
37+
The observations are 2D weighted coordinates enclosed by a known bounding box.
38+
39+
```python
40+
A = pcl.accumulate()
41+
```
42+
1443
TBD
1544

45+
46+
1647
# Contribute
1748

1849
If you have a suggestion for improvement, let us know by filling an issue. Or you can fork the project and submit a pull request.

0 commit comments

Comments
 (0)