classcounter 0.1.0__tar.gz

classcounter-0.1.0/.gitignore

@@ -0,0 +1,208 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+uv.lock

classcounter-0.1.0/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+All notable changes to ClassCounter are documented in this file.
+
+## [0.1.0] - 2026-02-23
+
+### Added
+- Initial public release
+- NumPy, Numba, and PyTorch backends for fast class counting
+- GeoTIFF support via rasterio
+- Name mapping for readable output
+- Percentage calculation mode
+- Automatic backend selection based on input type
+- GPU acceleration (CUDA) via PyTorch
+- Full test suite

classcounter-0.1.0/Examples.ipynb

@@ -0,0 +1,382 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# ClassCounter Examples\n",
+    "\n",
+    "This notebook demonstrates how to use `classcounter` to count occurrences of class values in arrays and tensors."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import numpy as np\n",
+    "\n",
+    "from classcounter import count_classes"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Basic Usage\n",
+    "\n",
+    "Pass a numpy array to `count_classes` and get back a dict mapping each unique value to its count."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{0: 2022, 1: 1993, 2: 2077, 3: 1967, 4: 1941}"
+      ]
+     },
+     "execution_count": 2,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "rng = np.random.default_rng(42)\n",
+    "arr = rng.integers(0, 5, size=(100, 100), dtype=np.int32)\n",
+    "\n",
+    "count_classes(arr)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Name Mapping\n",
+    "\n",
+    "Use the `names` parameter to map integer class IDs to human-readable labels. Unmapped classes are preserved with their integer key (a warning is emitted)."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'water': 2022, 'forest': 1993, 'urban': 2077, 'crop': 1967, 'bare': 1941}"
+      ]
+     },
+     "execution_count": 3,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "names = {0: \"water\", 1: \"forest\", 2: \"urban\", 3: \"crop\", 4: \"bare\"}\n",
+    "\n",
+    "count_classes(arr, names=names)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Percentage Output\n",
+    "\n",
+    "Set `percent=True` to get results as percentages (0–100) instead of raw counts. This combines with `names` too."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'water': 20.22, 'forest': 19.93, 'urban': 20.77, 'crop': 19.67, 'bare': 19.41}"
+      ]
+     },
+     "execution_count": 4,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "count_classes(arr, names=names, percent=True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## PyTorch Tensors\n",
+    "\n",
+    "Pass a torch tensor and the torch backend is used automatically. Install with `pip install classcounter[torch]`."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{0: 1944, 1: 2004, 2: 2037, 3: 2004, 4: 2011}"
+      ]
+     },
+     "execution_count": 5,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "import torch\n",
+    "\n",
+    "tensor = torch.randint(0, 5, (100, 100))\n",
+    "count_classes(tensor)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Performance\n",
+    "\n",
+    "With `classcounter[numba]` installed, numpy arrays are automatically counted with a JIT-compiled loop — no code changes needed. PyTorch is another fast option, especially on GPU."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 15,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Elements: 400,000,000\n",
+      "263 ms ± 14.2 ms per loop (mean ± std. dev. of 7 runs, 1 loop each)\n"
+     ]
+    }
+   ],
+   "source": [
+    "big = rng.integers(0, 10, size=(20000, 20000), dtype=np.int32)\n",
+    "print(f\"Elements: {big.size:,}\")\n",
+    "\n",
+    "%timeit count_classes(big)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Using device: cuda\n",
+      "802 ms ± 63.6 ms per loop (mean ± std. dev. of 7 runs, 1 loop each)\n",
+      "33.2 ms ± 600 μs per loop (mean ± std. dev. of 7 runs, 10 loops each)\n"
+     ]
+    }
+   ],
+   "source": [
+    "device = \"cuda\" if torch.cuda.is_available() else \"cpu\"\n",
+    "print(f\"Using device: {device}\")\n",
+    "\n",
+    "big_tensor = torch.randint(0, 10, (20000, 20000), device=device)\n",
+    "\n",
+    "# CPU baseline\n",
+    "big_cpu = big_tensor.cpu()\n",
+    "%timeit count_classes(big_cpu)\n",
+    "\n",
+    "# GPU (or same CPU if no GPU available)\n",
+    "%timeit count_classes(big_tensor)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## GeoTIFF Support\n",
+    "\n",
+    "Install with `pip install classcounter[geo]`. Pass a file path directly to count classes in a raster."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 8,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Created: /tmp/tmpr0hwn1go/land_cover.tif\n"
+     ]
+    }
+   ],
+   "source": [
+    "import tempfile\n",
+    "from pathlib import Path\n",
+    "\n",
+    "import rasterio\n",
+    "from rasterio.transform import from_bounds\n",
+    "\n",
+    "# Create a small land-cover raster (5 classes, 100x100 pixels)\n",
+    "land_cover = rng.integers(0, 5, size=(100, 100), dtype=np.uint8)\n",
+    "sample_tif = Path(tempfile.mkdtemp()) / \"land_cover.tif\"\n",
+    "transform = from_bounds(115.0, -33.0, 116.0, -32.0, 100, 100)\n",
+    "\n",
+    "with rasterio.open(\n",
+    "    sample_tif,\n",
+    "    \"w\",\n",
+    "    driver=\"GTiff\",\n",
+    "    height=100,\n",
+    "    width=100,\n",
+    "    count=1,\n",
+    "    dtype=\"uint8\",\n",
+    "    transform=transform,\n",
+    "    crs=\"EPSG:4326\",\n",
+    ") as dst:\n",
+    "    dst.write(land_cover, 1)\n",
+    "\n",
+    "print(f\"Created: {sample_tif}\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 9,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'water': 1932, 'forest': 2068, 'urban': 2024, 'crop': 1978, 'bare': 1998}"
+      ]
+     },
+     "execution_count": 9,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "count_classes(sample_tif, names=names)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Saving Results to GeoTIFF Metadata\n",
+    "\n",
+    "Use `save_metadata=True` to write class counts back into the raster's GDAL metadata tags (one tag per class, e.g. `CLASS_COUNT_0=1234`). For more control, use the standalone `save_counts_to_raster` function."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 10,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{0: 1932, 1: 2068, 2: 2024, 3: 1978, 4: 1998}"
+      ]
+     },
+     "execution_count": 10,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "from classcounter import save_counts_to_raster\n",
+    "\n",
+    "# One-liner: count and write CLASS_COUNT_ tags in one step\n",
+    "count_classes(sample_tif, save_metadata=True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 11,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'CLASS_COUNT_0': '1932',\n",
+       " 'CLASS_COUNT_1': '2068',\n",
+       " 'CLASS_COUNT_2': '2024',\n",
+       " 'CLASS_COUNT_3': '1978',\n",
+       " 'CLASS_COUNT_4': '1998'}"
+      ]
+     },
+     "execution_count": 11,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "# Verify the tags were written\n",
+    "with rasterio.open(sample_tif) as src:\n",
+    "    tags = src.tags()\n",
+    "\n",
+    "{k: v for k, v in tags.items() if k.startswith(\"CLASS_\")}"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "With `percent=True` the prefix switches to `CLASS_PERCENT_`. You can also set a custom prefix with `metadata_prefix`, or call `save_counts_to_raster` directly:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 12,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Percent metadata\n",
+    "count_classes(sample_tif, percent=True, save_metadata=True)\n",
+    "\n",
+    "# Custom prefix\n",
+    "count_classes(sample_tif, save_metadata=True, metadata_prefix=\"LAND_\")\n",
+    "\n",
+    "# Standalone function with named classes\n",
+    "counts = count_classes(sample_tif, names=names)\n",
+    "save_counts_to_raster(sample_tif, counts, prefix=\"NAMED_\")"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "classcounter",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.13.7"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

classcounter-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 DPIRD-DMA
+
+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.