README
¶
Duplicate Image Search in GO
This package is still a work in progress, but it works well in my own testing.
Example
package main
import "fmt"
import "github.com/abates/disgo"
func main() {
// Create a disgo database with the default radix index
db, _ := disgo.New()
// load an image into the database and get the hash back
file, _ := os.Open("test.png")
hash, _ := db.AddFile(file)
fmt.Printf("Image Hash: %08x\n", hash)
// search for all hashes with a Hamming distance of 3
// or less
matches, _ := db.SearchByHash(hash, 3)
fmt.Printf("Matches: %v\n", matches)
}
TODO
- make radix index save/load functions thread safe
- add record storage (e.g. file path) to database
Documentation
¶
Index ¶
- Variables
- type DB
- func (db *DB) Add(img image.Image) (PHash, error)
- func (db *DB) AddFile(reader io.Reader) (hash PHash, err error)
- func (db *DB) AddHash(hash PHash) error
- func (db *DB) Load(reader io.Reader) error
- func (db *DB) MarshalBinary() ([]byte, error)
- func (db *DB) Save(writer io.Writer) error
- func (db *DB) Search(img image.Image, maxDistance int) (matches []PHash, err error)
- func (db *DB) SearchByFile(reader io.Reader, maxDistance int) (matches []PHash, err error)
- func (db *DB) SearchByHash(hash PHash, maxDistance int) ([]PHash, error)
- func (db *DB) UnmarshalBinary(buf []byte) error
- type ImageInfo
- type Index
- type LinearIndex
- type Node
- func (n *Node) Decode(reader io.Reader) error
- func (n *Node) Encode(writer io.Writer) error
- func (n *Node) Equal(other *Node) bool
- func (n *Node) Insert(value *Node)
- func (n *Node) IsLeaf() bool
- func (n *Node) Match(value PHash) (length uint8)
- func (n *Node) Search(search PHash, match PHash, distance int) []PHash
- func (n *Node) String() string
- type PHash
- type RadixIndex
- type SearchCriteria
Constants ¶
This section is empty.
Variables ¶
View Source
var ( ErrNotFound = errors.New("Image not found") ErrNotSupported = errors.New("Underlying index does not support loading or saving") )
Functions ¶
This section is empty.
Types ¶
type DB ¶
type DB struct {
// contains filtered or unexported fields
}
func (*DB) MarshalBinary ¶
func (*DB) SearchByFile ¶
func (*DB) UnmarshalBinary ¶
type LinearIndex ¶
type LinearIndex struct {
// contains filtered or unexported fields
}
func NewLinearIndex ¶
func NewLinearIndex() *LinearIndex
func (*LinearIndex) Insert ¶
func (li *LinearIndex) Insert(phash PHash) error
func (*LinearIndex) MarshalBinary ¶
func (li *LinearIndex) MarshalBinary() ([]byte, error)
func (*LinearIndex) Search ¶
func (li *LinearIndex) Search(phash PHash, maxDistance int) ([]PHash, error)
func (*LinearIndex) UnmarshalBinary ¶
func (li *LinearIndex) UnmarshalBinary(buf []byte) error
type RadixIndex ¶
type RadixIndex struct {
// contains filtered or unexported fields
}
func NewRadixIndex ¶
func NewRadixIndex() *RadixIndex
func (*RadixIndex) Insert ¶
func (ri *RadixIndex) Insert(hash PHash) error
func (*RadixIndex) MarshalBinary ¶
func (ri *RadixIndex) MarshalBinary() ([]byte, error)
func (*RadixIndex) UnmarshalBinary ¶
func (ri *RadixIndex) UnmarshalBinary(buf []byte) error
type SearchCriteria ¶
Source Files
Click to show internal directories.
Click to hide internal directories.