Struct rxing::common::HybridBinarizer

pub struct HybridBinarizer<LS: LuminanceSource> { /* private fields */ }

This class implements a local thresholding algorithm, which while slower than the GlobalHistogramBinarizer, is fairly efficient for what it does. It is designed for high frequency images of barcodes with black data on white backgrounds. For this application, it does a much better job than a global blackpoint with severe shadows and gradients. However it tends to produce artifacts on lower frequency images and is therefore not a good general purpose binarizer for uses outside ZXing.

This class extends GlobalHistogramBinarizer, using the older histogram approach for 1D readers, and the newer local approach for 2D readers. 1D decoding using a per-row histogram is already inherently local, and only fails for horizontal gradients. We can revisit that problem later, but for now it was not a win to use local blocks for 1D.

This Binarizer is the default for the unit tests and the recommended class for library users.

@author dswitkin@google.com (Daniel Switkin)

Implementations

impl<LS: LuminanceSource> HybridBinarizer<LS>

pub fn new(source: LS) -> Self

Trait Implementations

impl<LS: LuminanceSource> Binarizer for HybridBinarizer<LS>

fn get_black_matrix(&self) -> Result<&BitMatrix>

Calculates the final BitMatrix once for all requests. This could be called once from the constructor instead, but there are some advantages to doing it lazily, such as making profiling easier, and not doing heavy lifting when callers don’t expect it.

type Source = LS

fn get_luminance_source(&self) -> &LS

fn get_black_row(&self, y: usize) -> Result<Cow<'_, BitArray>>

Converts one row of luminance data to 1 bit data. May actually do the conversion, or return cached data. Callers should assume this method is expensive and call it as seldom as possible. This method is intended for decoding 1D barcodes and may choose to apply sharpening. For callers which only examine one row of pixels at a time, the same BitArray should be reused and passed in with each call for performance. However it is legal to keep more than one row at a time if needed.

fn create_binarizer(&self, source: LS) -> Self

Creates a new object with the same type as this Binarizer implementation, but with pristine state. This is needed because Binarizer implementations may be stateful, e.g. keeping a cache of 1 bit data. See Effective Java for why we can’t use Java’s clone() method.

fn get_width(&self) -> usize

fn get_height(&self) -> usize