colorfilters - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #react #typescript #llm #go #deep-learning #linux #cli #kubernetes #vue #pytorch #ios #open-source

colorfilters

(★ 102)

Image thresholding in multiple colorspaces.

File Explorer

Download Latest Version (.zip)

- __init__.py
- __main__.py
.gitignore
LICENSE
readme-example.png
README.md
setup.py

# Installation Guide

1. Get the code

git clone https://github.com/alkasm/colorfilters

Downloads the entire project code from GitHub to your computer.

cd colorfilters

Moves into the project folder you just downloaded.

2. Python

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

$ python3 -m venv venv

Runs the Python script (or module).

(venv) $ pip install git+https://github.com/alkasm/colorfilters

Installs the Python libraries listed in requirements.txt (or similar).

(venv) $ python3 -m colorfilters path/to/image.png hsv

Runs the Python script (or module).

(venv) $ python3 -m colorfilters --help

Runs the Python script (or module).

✅ If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# colorfilters

Threshold your images in any colorspace!

* BGR (RGB)
* HSV
* HLS (HSL)
* Lab (CIELAB/L\*a\*b\*)
* Luv (L\*u\*v\*)
* YCrCb (YCbCr/YCC)
* XYZ (CIEXYZ)
* Grayscale (single channel)

![Example Image](https://raw.githubusercontent.com/alkasm/colorfilters/master/readme-example.png)

## Getting Started

Install into a Python virtual environment, as you would any other Python project.

```sh
$ python3 -m venv venv
$ source venv/bin/activate
(venv) $ pip install git+https://github.com/alkasm/colorfilters
```

Run the module as a script on any image you want:

```sh
(venv) $ python3 -m colorfilters path/to/image.png hsv
```

## Usage

As a script, just run the module directly as above. You can always check the `--help` flag when running the module as a script for more info:

```sh
(venv) $ python3 -m colorfilters --help
usage: test color thresholding of images in different colorspaces
       [-h] image {bgr,hsv,hls,lab,luv,ycc,xyz,gray}

positional arguments:
  image                 path to image
  {bgr,hsv,hls,lab,luv,ycc,xyz,gray}
                        colorspace to filter in

optional arguments:
  -h, --help            show this help message and exit
```

Use inside your own Python projects:

```python
>>> from colorfilters import HSVFilter
>>> import cv2 as cv
>>> 
>>> img = cv.imread("lane.jpg")
>>> window = HSVFilter(img)
>>> window.show()
>>> 
>>> print(f"Image filtered in HSV between {window.lowerb} and {window.upperb}.")
Image filtered in HSV between [51, 0, 183] and [63, 255, 255].
```

The window object has a few properties you might be interested in after successfully filtering your image:

```python
>>> window.lowerb     # lower bound used for cv.inRange()
>>> window.upperb     # upper bound used for cv.inRange()
>>> window.mask       # mask from cv.inRange()
>>> window.masked     # image with mask applied
>>> window.img        # image input into the window
>>> window.converted  # image converted into the corresponding colorspace
```