.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Image::Seek 3pm"
.TH Image::Seek 3pm "2008-02-09" "perl v5.20.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Image::Seek \- A port of ImgSeek to Perl
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.Vb 1
\&    use Image::Seek qw(loaddb add_image query_id savedb);
\&
\&    loaddb("haar.db");
\&
\&    # EITHER
\&    my $img = GD::Image\->newFromJpeg("photo\-216.jpg", 1);
\&    # OR
\&    my $img = Imager\->new();
\&    $img\->open(file => "photo\-216.jpg");
\&    # OR
\&    my $img = Image::Imlib2\->load("photo\-216.jpg");
\&
\&    # Then...
\&    add_image($img, 216);
\&    savedb("haar.db");
\&
\&    my @results = query_id(216); # What looks like this photo?
\&
\&    remove_id(216); # Just remove id from database.
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
ImgSeek (http://www.imgseek.net/) is an implementation of Haar wavelet
decomposition techniques to find similar pictures in a library. This
module is port of the ImgSeek library to Perl's \s-1XS.\s0 It can deal with
image objects produced by the \f(CW\*(C`Imager\*(C'\fR and \f(CW\*(C`Image::Imlib2\*(C'\fR libraries.
.SH "EXPORT"
.IX Header "EXPORT"
None by default, but the following functions are available:
.SS "savedb($file)"
.IX Subsection "savedb($file)"
Dumps the state of the norms and image buckets to the file \f(CW$file\fR.
.SS "loaddb($file)"
.IX Subsection "loaddb($file)"
Loads a database of image norms produced by savedb
.SS "cleardb"
.IX Subsection "cleardb"
Clears the internal database. Note that \f(CW\*(C`loaddb\*(C'\fR will load into memory
a bunch of data that you may already have \- it will duplicate rather
than replace this data, so results will be skewed if you load a database
multiple times without clearing it in between.
.ie n .SS "add_image($image, $id)"
.el .SS "add_image($image, \f(CW$id\fP)"
.IX Subsection "add_image($image, $id)"
Adds the image object to the database, keyed against the numeric id
\&\f(CW$id\fR. This will compute the Haar transformation for a 128x128
thumbnail of the image, and then store its norms into a database in
memory.
.SS "remove_id($id)"
.IX Subsection "remove_id($id)"
remove id from database, and you should \f(CW\*(C`savedb\*(C'\fR to save the changed database.
.ie n .SS "query_id($id[, $results))"
.el .SS "query_id($id[, \f(CW$results\fP))"
.IX Subsection "query_id($id[, $results))"
This queries the internal database for pictures which are \*(L"like\*(R" number
\&\f(CW$id\fR. It returns a list of \f(CW$results\fR results (by default, 10);
a result is an array reference. The first element is the \s-1ID\s0 of a
picture, the second is a score. So for example:
.PP
.Vb 1
\&    query_id(2481, 5)
.Ve
.PP
returns, in a shoot I have, the following:
.PP
.Vb 6
\&          [ 2481, \-38.3800003528595 ],
\&          [ 2480, \-37.5519620793145 ],
\&          [ 2478, \-37.39896965962   ],
\&          [ 2479, \-37.2777427507208 ],
\&          [ 2584, \-10.0803730081134 ],
\&          [ 2795, \-7.89326129961427 ]
.Ve
.PP
Notice that the scores go the opposite way to what you might imagine:
lower is better. The results come out sorted, and the first result is
the thing you queried for.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
http://www.imgseek.net/
.SH "AUTHOR"
.IX Header "AUTHOR"
Simon Cozens, <simon@cpan.org>
Lilo Huang, <kenwu@cpan.org>
.PP
All the clever bits were written by Ricardo Niederberger Cabral; I just
mangled them to wrap Perl around them.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2005 by Simon Cozens, 2008 by Lilo Huang
.PP
This library is free software; as it is a derivative work of imgseek,
this library is distributed under the same terms (\s-1GPL\s0) as imgseek.