hash

package

v2.3.0 Latest Latest Go to latest Published: Apr 17, 2024 License: GPL-3.0 Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Cache struct {
	// contains filtered or unexported fields
}

Cache stores an array of image hashes from corona10/goimagehash

func NewCache(cacheFileName, promNamespace string, numFiles int) (*Cache, error)

NewCache reads the given file to rebuild its map from the last time it was run. If the file does not exist, it will be created.

func (c *Cache) GetHash(fileName string) (*Image, error)

GetHash gets the hash from cache or if it does not exist it calcs it

func (c *Cache) Persist() error

Persist writes the cache to disk

func (c *Cache) Stats() (int, int)

Stats returns the number of images in the cache

type DiffResult struct {
	One     string
	Two     string
	OneArea int
	TwoArea int
}

DiffResult are two images that are the "same", i.e. within the given distance

type Differ struct {
	// contains filtered or unexported fields
}

Differ diffs images

func NewDiffer(numWorkers, distanceThreshold int, inputImages chan types.Pair, cache *Cache, promNamespace string) *Differ

NewDiffer is the constructor, Run() must be called to start diffing

func (d *Differ) Run(ctx context.Context) (chan DiffResult, chan error)

Run starts the diff workers

func (d *Differ) Shutdown()

Shutdown unregisters prom stats

type Image struct {
	*goimagehash.ImageHash
	image.Config `json:"-"`
}

Image is the minimal data needed to compare images and is held in-memory by HashCache.Cache