Skip to main content

imgmatch: Image Template Matching Tool

Project description

imgmatch: Image Template Matching Tool

imgmatch is a command-line interface (CLI) tool designed for efficient template matching in images, making it a great asset for computer vision, digital forensics, and automated image analysis. It offers a streamlined approach to detect and analyze templates in a variety of image sizes and formats.

Key Features

  • Multi-Scale Template Matching: Detects templates at multiple scales, providing thorough matching across diverse image dimensions.
  • Rotation and Flip Detection: Capable of recognizing templates that are rotated or flipped, enhancing its effectiveness in complex imaging scenarios.
  • Parallel Processing: Leverages multi-processing for speedy template matching, especially useful for processing large image datasets.
  • Customizable Search Parameters: Allows adjustments of scale range, rotation angles, and confidence thresholds to meet specific requirements.
  • User-Friendly Interface: Offers a simple and intuitive CLI, making it accessible for both beginners and experienced users. Clear documentation ensures ease of use.
  • Python Integration: Built using Python and popular libraries like OpenCV and NumPy, ensuring robust and reliable performance.

Ideal Use Cases

  • Suitable for computer vision professionals and enthusiasts.
  • Useful for researchers and students in digital image processing and related fields.
  • A tool for practitioners in digital forensics and content authentication.
  • Applicable for automated quality inspection in manufacturing and industrial environments.

Getting Started

Installation

To install imgmatch, use the following command:

pipx install imgmatch

Usage

Run imgmatch on your desired image or directory of images:

imgmatch /path/to/image/or/directory --scale-start 0.5 --scale-end 2.1 --confidence 0.8 --num-processes 4

Customizing Parameters

You can customize the search parameters to fit your specific needs. Here are some of the options you can adjust:

  • --scale-start: Starting scale (default is 0.5).
  • --scale-end: Ending scale (default is 5.1).
  • --confidence: Confidence threshold for template matching (default is 0.8).
  • --num-processes: Number of processes for parallel execution (default is 6).
  • --angle-start: Starting angle for rotation (default is 0).
  • --angle-end: Ending angle for rotation (default is 360).
  • --angle-step: Angle step for rotation (default is 90).
  • --template: Path to template image (default is None).
  • --output-dir: Path to output directory (default is current directory).

Contributing

Contributions to imgmatch are welcome! Whether it involves fixing bugs, improving documentation, or suggesting new features, we value your input.

License

imgmatch is released under the MIT License.

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

imgmatch-0.1.0.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

imgmatch-0.1.0-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

Details for the file imgmatch-0.1.0.tar.gz.

File metadata

  • Download URL: imgmatch-0.1.0.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.10.12 Darwin/23.1.0

File hashes

Hashes for imgmatch-0.1.0.tar.gz
Algorithm Hash digest
SHA256 43bb285cfb53f42bc392ee261f5a9d3e2696e8dff5f7c18192330278e58e1c94
MD5 bb028f3dbde8b6efa8524e2adb087633
BLAKE2b-256 2c6c4d95bc96e3c3b5fddef6efc8162c9cc51d10e7b4da283f222a93ab431005

See more details on using hashes here.

File details

Details for the file imgmatch-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: imgmatch-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 5.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.10.12 Darwin/23.1.0

File hashes

Hashes for imgmatch-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 981fa6ac3142c8ac0c97d29b9cd389f0a3804d757cd129422a6bf5bf210a54e4
MD5 97aae3c6e84638a92c6b6107a397881e
BLAKE2b-256 4eedf901bfef1b4f0be57f47b1be2e37b461ce2f1d9a6f3870fabb873c2267ae

See more details on using hashes here.

Supported by

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