Skip to main content

Don't reinvent the wheel every time! This library offers a curated collection of commonly used image manipulation functions for computer vision projects.

Project description

Common Image Tools

Latest Stable Version PyPI - Downloads

Poetry Ruff Coverage Status example workflow

Description

common_image_tools is a repository containing a curated collection of commonly used image manipulation functions for computer vision projects. These tools provide a set of handy functions for performing various image processing tasks, such as resizing, cropping, filtering, and more.

Features

  • Resizing: Easily resize images to desired dimensions.
  • Cropping: Crop images to focus on specific regions.
  • Filtering: Apply various filters to enhance or modify images.
  • Conversion: Convert images between different formats.
  • Visualization: Tools for visualizing image data.
  • Video Source: Flexible interface for handling different types of video inputs.

Installation

To install common_image_tools, run the following command:

pip install common-image-tools

or using poetry:

poetry add common-image-tools

Usage

Video Source

The VideoSource class provides a flexible interface for handling different types of video inputs with support for various OpenCV backends and hardware acceleration on Jetson devices.

Features

  • Support for multiple video source types:
    • RTSP streams
    • Video files (MP4)
    • Webcam devices
  • Configurable frame dimensions and FPS
  • Multiple backend options:
    • OpenCV default
    • GStreamer
    • GStreamer with Jetson hardware acceleration
  • Automatic backend selection based on system capabilities

Basic Usage

from common_image_tools import VideoSource
import cv2

# Create a video source
source = VideoSource(
    "video.mp4",
    target_frame_height=720,
    target_frame_width=1280,
    target_fps=30
)

# Use with OpenCV
cap = cv2.VideoCapture(source.parsed_source)

Different Source Types

# RTSP Stream
rtsp_source = VideoSource("rtsp://example.com/stream")

# Video File
file_source = VideoSource("path/to/video.mp4")

# Webcam
webcam_source = VideoSource("/dev/video0")

# Webcam
webcam_source = VideoSource(0)

Backend Selection

from common_image_tools import VideoSource, OpencvBackendMode

# Auto backend selection (default)
source = VideoSource("video.mp4")

# Force OpenCV default backend
source = VideoSource(
    "video.mp4",
    opencv_backend=OpencvBackendMode.OPENCV_DEFAULT
)

# Force GStreamer backend
source = VideoSource(
    "video.mp4",
    opencv_backend=OpencvBackendMode.OPENCV_GSTREAMER
)

# Use Jetson-optimized GStreamer backend
source = VideoSource(
    "video.mp4",
    opencv_backend=OpencvBackendMode.OPENCV_GSTREAMER_JETSON
)

API Reference

VideoSource
VideoSource(
    source,
    target_frame_height: int = None,
    target_frame_width: int = None,
    target_fps: int = None,
    opencv_backend: OpencvBackendMode = OpencvBackendMode.AUTO
)

Conversion

Operation

Tool

Verification

Visualization

Contributing

Contributions are welcome! If you have any suggestions, improvements, or new features to add, please open an issue or submit a pull request. Make sure to follow the existing coding style and include appropriate tests.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

common_image_tools-0.5.19.tar.gz (11.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

common_image_tools-0.5.19-py3-none-any.whl (12.7 kB view details)

Uploaded Python 3

File details

Details for the file common_image_tools-0.5.19.tar.gz.

File metadata

  • Download URL: common_image_tools-0.5.19.tar.gz
  • Upload date:
  • Size: 11.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for common_image_tools-0.5.19.tar.gz
Algorithm Hash digest
SHA256 5f2bb95409513c9efe347760590b3cb95e767f290f6fb276f197ad093f8b7332
MD5 ff705130f76b11ff21ea4a1c6eb4f7b2
BLAKE2b-256 cee0124b03fed7fd03cfc05c3f19e0b736eee25153cbdb0463407d029bccc5de

See more details on using hashes here.

Provenance

The following attestation bundles were made for common_image_tools-0.5.19.tar.gz:

Publisher: release.yml on lanzani/common-image-tools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file common_image_tools-0.5.19-py3-none-any.whl.

File metadata

File hashes

Hashes for common_image_tools-0.5.19-py3-none-any.whl
Algorithm Hash digest
SHA256 2f4a6959f1676afcfdccaf71427f56473ad0f5f2c04b2bc92ab1d6a5bffe23d5
MD5 a3d6bc175d2e777b9ec5a416877fde40
BLAKE2b-256 e366bfcdbdb4b266152470eaccc7b099858666e171aee0e918e3d42b93b4fd39

See more details on using hashes here.

Provenance

The following attestation bundles were made for common_image_tools-0.5.19-py3-none-any.whl:

Publisher: release.yml on lanzani/common-image-tools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page