Struct rxing::BinaryBitmap

pub struct BinaryBitmap { /* private fields */ }

This class is the core bitmap class used by ZXing to represent 1 bit data. Reader objects accept a BinaryBitmap and attempt to decode it.

@author dswitkin@google.com (Daniel Switkin)

Implementations

impl BinaryBitmap

pub fn new(binarizer: Rc<dyn Binarizer>) -> Self

pub fn getWidth(&self) -> usize

@return The width of the bitmap.

pub fn getHeight(&self) -> usize

@return The height of the bitmap.

pub fn getBlackRow(
    &self,
    y: usize,
    row: &mut BitArray
) -> Result<BitArray, Exceptions>

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.

@param y The row to fetch, which must be in [0, bitmap height) @param row An optional preallocated array. If null or too small, it will be ignored. If used, the Binarizer will call BitArray.clear(). Always use the returned object. @return The array of bits for this row (true means black). @throws NotFoundException if row can’t be binarized

pub fn getBlackMatrixMut(&mut self) -> &mut BitMatrix

Converts a 2D array of luminance data to 1 bit. As above, assume this method is expensive and do not call it repeatedly. This method is intended for decoding 2D barcodes and may or may not apply sharpening. Therefore, a row from this matrix may not be identical to one fetched using getBlackRow(), so don’t mix and match between them.

@return The 2D array of bits for the image (true means black). @throws NotFoundException if image can’t be binarized to make a matrix

pub fn getBlackMatrix(&self) -> &BitMatrix

Converts a 2D array of luminance data to 1 bit. As above, assume this method is expensive and do not call it repeatedly. This method is intended for decoding 2D barcodes and may or may not apply sharpening. Therefore, a row from this matrix may not be identical to one fetched using getBlackRow(), so don’t mix and match between them.

@return The 2D array of bits for the image (true means black). @throws NotFoundException if image can’t be binarized to make a matrix

pub fn isCropSupported(&self) -> bool

@return Whether this bitmap can be cropped.

pub fn crop(
    &self,
    left: usize,
    top: usize,
    width: usize,
    height: usize
) -> BinaryBitmap

Returns a new object with cropped image data. Implementations may keep a reference to the original data rather than a copy. Only callable if isCropSupported() is true.

@param left The left coordinate, which must be in [0,getWidth()) @param top The top coordinate, which must be in [0,getHeight()) @param width The width of the rectangle to crop. @param height The height of the rectangle to crop. @return A cropped version of this object.

pub fn isRotateSupported(&self) -> bool

@return Whether this bitmap supports counter-clockwise rotation.

pub fn rotateCounterClockwise(&self) -> BinaryBitmap

Returns a new object with rotated image data by 90 degrees counterclockwise. Only callable if {@link #isRotateSupported()} is true.

@return A rotated version of this object.

pub fn rotateCounterClockwise45(&self) -> BinaryBitmap

Returns a new object with rotated image data by 45 degrees counterclockwise. Only callable if {@link #isRotateSupported()} is true.

@return A rotated version of this object.

Trait Implementations

impl Clone for BinaryBitmap

fn clone(&self) -> BinaryBitmap

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Display for BinaryBitmap

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.