SixLabors / SixLabors/ImageSharp

Expose ImageComparer API

Open
#1,129 7 comments 12 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

API feature request
Dominant language
C#
Stars
8k
Forks
899
Avg merge
1d 5h
Merged PRs (30d)
7

Description

The image comparison logic implemented in TolerantImageComparer might be interesting for users, eg. for testing purposes.

We should expose a similar feature from the core library.

The current ImageComparer API returns a list of detected pixel differences, which did not turn out to be useful. Shouldn't we return a difference image instead? Or should we return both?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with tests/ImageSharp.Tests/TestUtilities/ImageComparison/TolerantImageComparer.cs and inspect the current ImageComparer API and PixelDifference result. Determine whether the core library should expose a difference image, pixel differences, or both; the work is done when that API and its expected result are agreed and exposed from the core library.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
api, computer-graphics
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.