Metadata-Version: 2.4
Name: scitex-cv
Version: 0.1.3
Summary: Small cv2/Pillow image-processing utilities (load/save, resize/rotate/crop, blur/sharpen/edge, drawing) — standalone module from the SciTeX ecosystem
Author-email: Yusuke Watanabe <ywatanabe@scitex.ai>
License-Expression: AGPL-3.0-only
Project-URL: Homepage, https://github.com/ywatanabe1989/scitex-cv
Project-URL: Repository, https://github.com/ywatanabe1989/scitex-cv
Project-URL: Documentation, https://scitex-cv.readthedocs.io
Keywords: scitex,computer-vision,opencv,image-processing
Classifier: Development Status :: 3 - Alpha
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Multimedia :: Graphics
Classifier: Topic :: Scientific/Engineering :: Image Processing
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: opencv-python
Requires-Dist: Pillow
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx>=7.0; extra == "docs"
Requires-Dist: sphinx-rtd-theme>=2.0; extra == "docs"
Requires-Dist: myst-parser>=2.0; extra == "docs"
Requires-Dist: sphinx-copybutton>=0.5; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints>=1.25; extra == "docs"
Provides-Extra: all
Requires-Dist: scitex-cv[dev,docs]; extra == "all"
Dynamic: license-file

# scitex-cv

<!-- scitex-badges:start -->
[![PyPI](https://img.shields.io/pypi/v/scitex-cv.svg)](https://pypi.org/project/scitex-cv/)
[![Python](https://img.shields.io/pypi/pyversions/scitex-cv.svg)](https://pypi.org/project/scitex-cv/)
[![Tests](https://github.com/ywatanabe1989/scitex-cv/actions/workflows/test.yml/badge.svg)](https://github.com/ywatanabe1989/scitex-cv/actions/workflows/test.yml)
[![Install Test](https://github.com/ywatanabe1989/scitex-cv/actions/workflows/install-test.yml/badge.svg)](https://github.com/ywatanabe1989/scitex-cv/actions/workflows/install-test.yml)
[![Coverage](https://codecov.io/gh/ywatanabe1989/scitex-cv/graph/badge.svg)](https://codecov.io/gh/ywatanabe1989/scitex-cv)
[![Docs](https://readthedocs.org/projects/scitex-cv/badge/?version=latest)](https://scitex-cv.readthedocs.io/en/latest/)
[![License: AGPL v3](https://img.shields.io/badge/license-AGPL_v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
<!-- scitex-badges:end -->

<p align="center">
  <a href="https://scitex.ai">
    <img src="docs/scitex-logo-blue-cropped.png" alt="SciTeX" width="400">
  </a>
</p>

<p align="center"><b>Small cv2-based image utilities — I/O, transform, filters, drawing.</b></p>

<p align="center">
  <a href="https://scitex-cv.readthedocs.io/">Full Documentation</a> · <code>pip install scitex-cv</code>
</p>

---

## Installation

```bash
pip install scitex-cv
```

## Quick Start

```python
import scitex_cv as cv

img = cv.load("input.png")
img = cv.resize(img, scale=0.5)
img = cv.blur(img, ksize=5)
edges = cv.edge_detect(img, method="canny")
cv.save(edges, "edges.png")
```

## 1 Interfaces

<details>
<summary><strong>Python API</strong></summary>

<br>

```python
import scitex_cv as cv

# I/O
img = cv.load("input.png")
cv.save(img, "out.png")
gray = cv.to_gray(img); rgb = cv.to_rgb(img); bgr = cv.to_bgr(img)

# Transform
cv.resize(img, scale=0.5)
cv.rotate(img, angle=90)
cv.flip(img, direction="horizontal")
cv.crop(img, x=10, y=10, width=100, height=100)
cv.pad(img, top=10, bottom=10, left=10, right=10)

# Filters
cv.blur(img, ksize=5); cv.sharpen(img)
cv.edge_detect(img, method="canny")
cv.threshold(img, thresh=128); cv.denoise(img)

# Drawing
cv.rectangle(img, (5, 5), (30, 30), color=(0, 255, 0))
cv.circle(img, (50, 50), radius=10)
cv.line(img, (0, 0), (100, 100))
cv.arrow(img, (0, 0), (50, 50))
cv.text(img, "label", (10, 30))
cv.polylines(img, points=np.array([[0, 0], [100, 0], [100, 100]]))
```

</details>

## Status

Standalone fork of `scitex.cv`. Only deps are numpy + opencv-python.
The umbrella package's `scitex.cv` import path is preserved via a
`sys.modules`-alias bridge.

## Part of SciTeX

`scitex-cv` is part of [**SciTeX**](https://scitex.ai).

>Four Freedoms for Research
>
>0. The freedom to **run** your research anywhere — your machine, your terms.
>1. The freedom to **study** how every step works — from raw data to final manuscript.
>2. The freedom to **redistribute** your workflows, not just your papers.
>3. The freedom to **modify** any module and share improvements with the community.
>
>AGPL-3.0 — because we believe research infrastructure deserves the same freedoms as the software it runs on.

## License

AGPL-3.0-only (see [LICENSE](./LICENSE)).

---

<p align="center">
  <a href="https://scitex.ai" target="_blank"><img src="docs/scitex-icon-navy-inverted.png" alt="SciTeX" width="40"/></a>
</p>
