Skip to content

Commit

Permalink
Add README for corpus_builder app
Browse files Browse the repository at this point in the history
  • Loading branch information
brawer committed Mar 27, 2024
1 parent 395e7f5 commit 6edcba8
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 0 deletions.
21 changes: 21 additions & 0 deletions LICENSES/MIT.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Sascha Brawer

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
31 changes: 31 additions & 0 deletions corpus_builder/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Corpus Builder

![Screenshot](./screenshot.png)

Corpus Builder is an ad-hoc desktop application that was written to
help building the Cadasym image corpus. When the application starts
up, it asks for PDFs with scanned cadastral mutation plans. After
converting them to pixmaps, basic Computer Vision algorithms (from the
OpenCV library) are used to find potential cadastral symbols. The
symbol candidates are presented to the user, who manually classifies
each symbol to build up the image corpus. After a candidate has been
classificed, the corpus builder app stores a cropped 256×256 pixel image
into the `corpus` folder.


## Setup

```sh
git clone https://github.com/brawer/cadasym.git
cd cadasym
python3 -m venv venv
venv/bin/pip3 install -r requirements.txt
venv/bin/python3 -m corpus_builder
```

## License

The source code to this app is eleased under the
[../LICENSES/MIT.txt](MIT license).


Binary file added corpus_builder/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6edcba8

Please sign in to comment.