Struct rxing::BinaryBitmap

pub struct BinaryBitmap<B: Binarizer> { /* 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<B: Binarizer> BinaryBitmap<B>

pub fn new(binarizer: B) -> Self

pub fn get_width(&self) -> usize

@return The width of the bitmap.

pub fn get_height(&self) -> usize

@return The height of the bitmap.

pub 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.

@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 get_black_matrix_mut(&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.

Panics if the binarizer cannot be created.

@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 get_black_matrix(&mut 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.

Panics if the binarizer cannot be created.

@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 is_crop_supported(&self) -> bool

@return Whether this bitmap can be cropped.

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

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.

Panics if the binarizer cannot be created.

@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 is_rotate_supported(&self) -> bool

@return Whether this bitmap supports counter-clockwise rotation.

pub fn rotate_counter_clockwise(&mut self) -> Self

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

Panics if the binarizer cannot be created.

@return A rotated version of this object.

pub fn rotate_counter_clockwise_45(&self) -> Self

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

Panics if the binarizer cannot be created.

@return A rotated version of this object.

Trait Implementations

impl<B: Binarizer> Display for BinaryBitmap<B>

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

Formats the value using the given formatter.