.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 >0, 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
.\" ========================================================================
.\"
.IX Title "ZBar::Symbol 3pm"
.TH ZBar::Symbol 3pm 2024-02-06 "perl v5.38.2" "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
Barcode::ZBar::Symbol \- bar code scan result object
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 6
\&    my @symbols = $image\->get_symbols();
\&    foreach my $sym (@symbols) {
\&        print("decoded: " . $sym\->get_type() .
\&              ":" . $sym\->get_data().
\&              "(" . $sym\->get_count() . ")");
\&    }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Barcode::ZBar::Symbol objects are constant results returned for each
bar code scanned from images or video.  This object wraps the raw
symbol data with additional information about the decode (symbology,
confidence, location, etc)
.SH REFERENCE
.IX Header "REFERENCE"
.SS Methods
.IX Subsection "Methods"
.IP \fBget_type()\fR 4
.IX Item "get_type()"
The type of bar code "symbology" from which the data was decoded.
.IP \fBget_data()\fR 4
.IX Item "get_data()"
The decoded data string.  Note that some symbologies can encode binary
data.
.IP \fBget_quality()\fR 4
.IX Item "get_quality()"
Confidence metric.  An unscaled integer value that indicates something
(intentionally unspecified) about the reliability of this result
relative to another.  Larger values are better than smaller values,
where "large" and "small" are application dependent.  Expect this
definition to become more specific as the metric is enhanced.
.IP \fBget_count()\fR 4
.IX Item "get_count()"
Current cache count of the symbol.  This integer value provides
inter-scan reliability and redundancy information if enabled at the
Barcode::ZBar::ImageScanner.
.IP \fBget_orientation()\fR 4
.IX Item "get_orientation()"
General orientation of decoded symbol.  This returns one of the
Barcode::ZBar::Orient constants, which provide a coarse, axis-aligned
indication of symbol orientation.
.IP \fBget_components()\fR 4
.IX Item "get_components()"
Components of a composite result.  This yields an array of physical
component symbols that were combined to form a composite result.
.IP \fBget_configs()\fR 4
.IX Item "get_configs()"
Retrieve symbology boolean config settings.  Returns a bitmask
indicating which configs were set for the detected
symbology during decoding.
.IP \fBget_modifiers()\fR 4
.IX Item "get_modifiers()"
Retrieve symbology modifier flag settings.  Returns a bitmask
indicating which characteristics were detected during decoding.
.IP \fBget_loc()\fR 4
.IX Item "get_loc()"
Retrieve an array of symbol location points (x,y)
.RS 4
.IP \(bu 2
A negative value indicates that this result is still uncertain
.IP \(bu 2
A zero value indicates the first occurrence of this result with high
confidence
.IP \(bu 2
A positive value indicates a duplicate scan
.RE
.RS 4
.RE
.SS Constants
.IX Subsection "Constants"
Bar code type "symbology" constants:
.IP NONE 4
.IX Item "NONE"
.PD 0
.IP PARTIAL 4
.IX Item "PARTIAL"
.IP EAN13 4
.IX Item "EAN13"
.IP EAN8 4
.IX Item "EAN8"
.IP UPCA 4
.IX Item "UPCA"
.IP UPCE 4
.IX Item "UPCE"
.IP ISBN10 4
.IX Item "ISBN10"
.IP ISBN13 4
.IX Item "ISBN13"
.IP I25 4
.IX Item "I25"
.IP CODABAR 4
.IX Item "CODABAR"
.IP CODE39 4
.IX Item "CODE39"
.IP CODE93 4
.IX Item "CODE93"
.IP CODE128 4
.IX Item "CODE128"
.IP QRCODE 4
.IX Item "QRCODE"
.IP PDF417 4
.IX Item "PDF417"
.PD
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Barcode::ZBar, Barcode::ZBar::Image
.PP
\&\fBzbarimg\fR\|(1), \fBzbarcam\fR\|(1)
.PP
http://zbar.sf.net
.SH AUTHOR
.IX Header "AUTHOR"
Jeff Brown, <spadix@users.sourceforge.net>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2008\-2010 (c) Jeff Brown <spadix@users.sourceforge.net>
.PP
The ZBar Bar Code Reader is free software; you can redistribute it
and/or modify it under the terms of the GNU Lesser Public License as
published by the Free Software Foundation; either version 2.1 of
the License, or (at your option) any later version.