visfeats 0.1__tar.gz

visfeats-0.1/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

visfeats-0.1/.github/workflows/ci.yml

@@ -0,0 +1,46 @@
+name: CI
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Run pre-commit
+        run: |
+          python -m pip install pre-commit
+          pre-commit run --all-files --show-diff-on-failure
+
+  pytest:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install package
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install ".[dev]"
+
+      - name: Run pytest
+        run: python -m pytest

visfeats-0.1/.github/workflows/python-publish.yml

@@ -0,0 +1,67 @@
+# This workflow will upload a Python Package to PyPI when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Build release distributions
+        run: |
+          # NOTE: put your own distribution build steps here.
+          python -m pip install build
+          python -m build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    # Dedicated environments with protections for publishing are strongly recommended.
+    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
+    environment:
+      name: pypi
+      url: https://pypi.org/p/VisFeats
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

visfeats-0.1/.gitignore

@@ -0,0 +1,187 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# 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
+.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/
+
+# 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
+
+# AGENTS.md
+AGENTS.md
+
+# VS Code settings and workspace files
+/.vscode

visfeats-0.1/.pre-commit-config.yaml

@@ -0,0 +1,5 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.6
+    hooks:
+      - id: ruff-format

visfeats-0.1/LICENSE

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

visfeats-0.1/PKG-INFO

@@ -0,0 +1,125 @@
+Metadata-Version: 2.4
+Name: visfeats
+Version: 0.1
+Summary: A library for extracting global visual features
+Author-email: Qian Chu <qianchu99@gmail.com>
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: scikit-image
+Provides-Extra: resmem
+Requires-Dist: resmem; extra == "resmem"
+Provides-Extra: dev
+Requires-Dist: resmem; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Dynamic: license-file
+
+# VisFeats: Extraction of Global Visual Features from Images
+
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+![Python Version](https://img.shields.io/badge/python-3.10%2B-blue)
+
+VisFeats is a library for extracting global visual features from images.
+
+## Installation
+
+VisFeats is installable via PyPI:
+
+```bash
+pip install visfeats
+```
+
+Or via GitHub (for the latest development version):
+
+```bash
+pip install git+https://github.com/ncc-brain/VisFeats.git
+```
+
+## Usage
+
+To use VisFeats, first load an image using PIL:
+
+```python
+from PIL import Image
+image = Image.open("path/to/your/image.jpg")
+```
+
+All functions in VisFeats take a PIL ``Image.Image`` as input and return the corresponding feature values. Available features are described below.
+
+### Extract multiple features
+
+Use `extract_all_features` to collect all package-level features, or pass a
+feature name or list of names to select a subset. The result is a flat
+dictionary.
+
+```python
+from visfeats import extract_all_features
+
+features = extract_all_features(image, features=["rms", "hsv_features"])
+```
+
+### Mean and entropy of HSV channels
+
+Chromatic features describe color in HSV (Hue, Saturation, Value) space, including channel means and entropies. The `hsv_features` function returns a dictionary with six keys:
+
+- `hue_mean`
+- `saturation_mean`
+- `value_mean`
+- `hue_entropy`
+- `saturation_entropy`
+- `value_entropy`
+
+```python
+from visfeats import hsv_features
+features = hsv_features(image)
+```
+
+### Spatial frequency features
+
+Spatial frequency features capture the distribution of different spatial frequencies in an image, which relate to the level of detail and texture. The `spatial_frequency_features` function extracts these features:
+
+- `fourier_slope`
+- `fourier_sigma`
+- `dimensionality`
+- `spectral_centroid`
+- `spectral_variance`
+
+```python
+from visfeats import spatial_frequency_features
+features = spatial_frequency_features(image)
+```
+
+### Memorability
+
+While memorability is often considered a subjective property, recent research has shown that it can be predicted from image content. Here the `memorability_resmem` function estimates intrinsic memorability using the pretrained ResMem model described by [Needell and Bainbridge (2022)](https://doi.org/10.1007/s42113-022-00126-5).
+
+ResMem is an optional dependency. It can be installed along with VisFeats using:
+
+```bash
+pip install "visfeats[resmem]"
+```
+
+Or separately with:
+
+```bash
+pip install resmem
+```
+
+Then you can use the `memorability_resmem` function to estimate the memorability of an image:
+
+```python
+from visfeats import memorability_resmem
+resmem_score = memorability_resmem(image)
+```
+
+### Other features
+
+#### RMS contrast
+
+The `rms` function computes the root-mean-square contrast as the population standard deviation of the image's grayscale pixel intensities.
+
+```python
+from visfeats import rms
+rms_contrast = rms(image)
+```

visfeats-0.1/README.md

@@ -0,0 +1,108 @@
+# VisFeats: Extraction of Global Visual Features from Images
+
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+![Python Version](https://img.shields.io/badge/python-3.10%2B-blue)
+
+VisFeats is a library for extracting global visual features from images.
+
+## Installation
+
+VisFeats is installable via PyPI:
+
+```bash
+pip install visfeats
+```
+
+Or via GitHub (for the latest development version):
+
+```bash
+pip install git+https://github.com/ncc-brain/VisFeats.git
+```
+
+## Usage
+
+To use VisFeats, first load an image using PIL:
+
+```python
+from PIL import Image
+image = Image.open("path/to/your/image.jpg")
+```
+
+All functions in VisFeats take a PIL ``Image.Image`` as input and return the corresponding feature values. Available features are described below.
+
+### Extract multiple features
+
+Use `extract_all_features` to collect all package-level features, or pass a
+feature name or list of names to select a subset. The result is a flat
+dictionary.
+
+```python
+from visfeats import extract_all_features
+
+features = extract_all_features(image, features=["rms", "hsv_features"])
+```
+
+### Mean and entropy of HSV channels
+
+Chromatic features describe color in HSV (Hue, Saturation, Value) space, including channel means and entropies. The `hsv_features` function returns a dictionary with six keys:
+
+- `hue_mean`
+- `saturation_mean`
+- `value_mean`
+- `hue_entropy`
+- `saturation_entropy`
+- `value_entropy`
+
+```python
+from visfeats import hsv_features
+features = hsv_features(image)
+```
+
+### Spatial frequency features
+
+Spatial frequency features capture the distribution of different spatial frequencies in an image, which relate to the level of detail and texture. The `spatial_frequency_features` function extracts these features:
+
+- `fourier_slope`
+- `fourier_sigma`
+- `dimensionality`
+- `spectral_centroid`
+- `spectral_variance`
+
+```python
+from visfeats import spatial_frequency_features
+features = spatial_frequency_features(image)
+```
+
+### Memorability
+
+While memorability is often considered a subjective property, recent research has shown that it can be predicted from image content. Here the `memorability_resmem` function estimates intrinsic memorability using the pretrained ResMem model described by [Needell and Bainbridge (2022)](https://doi.org/10.1007/s42113-022-00126-5).
+
+ResMem is an optional dependency. It can be installed along with VisFeats using:
+
+```bash
+pip install "visfeats[resmem]"
+```
+
+Or separately with:
+
+```bash
+pip install resmem
+```
+
+Then you can use the `memorability_resmem` function to estimate the memorability of an image:
+
+```python
+from visfeats import memorability_resmem
+resmem_score = memorability_resmem(image)
+```
+
+### Other features
+
+#### RMS contrast
+
+The `rms` function computes the root-mean-square contrast as the population standard deviation of the image's grayscale pixel intensities.
+
+```python
+from visfeats import rms
+rms_contrast = rms(image)
+```

visfeats-0.1/pyproject.toml

@@ -0,0 +1,22 @@
+[build-system]
+requires = ["setuptools>=80", "setuptools-scm>=8"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "visfeats"
+dynamic = ["version"]
+description = "A library for extracting global visual features"
+readme = "README.md"
+authors = [{ name = "Qian Chu", email = "qianchu99@gmail.com" }]
+requires-python = ">=3.10"
+dependencies = ["scikit-image"]
+
+[project.optional-dependencies]
+resmem = ["resmem"]
+dev = ["resmem", "pytest", "pre-commit"]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools_scm]
+local_scheme = "node-and-date"

visfeats-0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

visfeats-0.1/src/visfeats/__init__.py

@@ -0,0 +1,85 @@
+import logging
+from collections.abc import Sequence
+from importlib.util import find_spec
+from typing import Dict, Union
+
+from PIL import Image
+
+from .chromatic import hsv_features
+from .spatial_frequency import spatial_frequency_features
+from .memorability import memorability_resmem
+from .misc import rms
+
+logger = logging.getLogger(__name__)
+
+_FEATURES = {
+    "hsv_features": hsv_features,
+    "spatial_frequency_features": spatial_frequency_features,
+    "rms": rms,
+    "memorability_resmem": memorability_resmem,
+}
+
+__all__ = [
+    "extract_all_features",
+    "spatial_frequency_features",
+    "hsv_features",
+    "rms",
+    "memorability_resmem",
+]
+
+
+def extract_all_features(
+    image: Image.Image,
+    features: Union[str, Sequence[str]] = "all",
+) -> Dict[str, float]:
+    """Extract selected visual features from an image.
+
+    Parameters
+    ----------
+    image : PIL.Image.Image
+        Input image in any Pillow mode.
+    features : str or sequence of str, default="all"
+        ``"all"`` selects every package-level feature. A feature name or
+        sequence of feature names selects only those features. Available
+        names are ``"hsv_features"``, ``"spatial_frequency_features"``,
+                ``"rms"``, and ``"memorability_resmem"``.
+
+    Returns
+    -------
+    dict of {str: float}
+        A flat mapping of feature names to values. Multi-value features
+        contribute their own keys. ``memorability_resmem`` is skipped with a
+        warning if the optional ``resmem`` package is not installed.
+
+    Raises
+    ------
+    ValueError
+        If any requested feature name is not available.
+    """
+    if isinstance(features, str):
+        selected = list(_FEATURES) if features == "all" else [features]
+    else:
+        selected = list(dict.fromkeys(features))
+
+    unknown = set(selected) - _FEATURES.keys()
+    if unknown:
+        names = ", ".join(sorted(unknown))
+        raise ValueError(f"Unknown feature name(s): {names}")
+
+    extracted: Dict[str, float] = {}
+    for name in selected:
+        if name == "memorability_resmem" and find_spec("resmem") is None:
+            logger.warning(
+                "Skipping memorability_resmem because the optional `resmem` "
+                "package is not installed. Install it with: "
+                "pip install 'visfeats[resmem]'"
+            )
+            continue
+
+        result = _FEATURES[name](image)
+        if isinstance(result, dict):
+            extracted.update(result)
+        else:
+            extracted[name] = float(result)
+
+    return extracted