Crop

oar_ocr::utils::crop

Struct Crop 

Source 
pub struct Crop { /* private fields */ }
Expand description

A processor for cropping images with different positioning modes.

The Crop struct provides functionality to crop images to a specified size using different positioning strategies (center, top-left, etc.).

Implementations§

Source§

impl Crop

Source

pub fn new( crop_size: [u32; 2], crop_mode: CropMode, ) -> Result<Self, ImageProcessError>

Creates a new Crop instance with the specified parameters.

§Arguments
  • crop_size - Array containing [width, height] for the crop operation.
  • crop_mode - The positioning mode for the crop operation.
§Returns
  • Ok(Crop) - A new Crop instance.
  • Err(ImageProcessError::InvalidCropSize) - If either dimension is zero.
§Examples
use oar_ocr::utils::crop::Crop;
use oar_ocr::processors::types::CropMode;

let crop = Crop::new([224, 224], CropMode::Center).unwrap();
Source

pub fn crop_size(&self) -> [u32; 2]

Gets the crop size.

§Returns

The crop size as [width, height].

Source

pub fn crop_mode(&self) -> &CropMode

Gets the crop mode.

§Returns

The crop mode.

Source

pub fn process(&self, img: &RgbImage) -> Result<RgbImage, ImageProcessError>

Processes an image by cropping it according to the configured parameters.

§Arguments
  • img - Reference to the input image to be cropped.
§Returns
  • Ok(RgbImage) - The cropped image.
  • Err(ImageProcessError) - If the crop operation fails.
§Examples
use image::RgbImage;
use oar_ocr::utils::crop::Crop;
use oar_ocr::processors::types::CropMode;

let crop = Crop::new([100, 100], CropMode::Center).unwrap();
let img = RgbImage::new(200, 200);
let cropped = crop.process(&img).unwrap();
assert_eq!(cropped.dimensions(), (100, 100));
Source

pub fn process_batch( &self, images: &[RgbImage], ) -> Result<Vec<RgbImage>, ImageProcessError>

Processes multiple images in batch.

§Arguments
  • images - Vector of images to be cropped.
§Returns
  • Ok(Vec<RgbImage>) - Vector of cropped images.
  • Err(ImageProcessError) - If any crop operation fails.
Source

pub fn set_crop_size( &mut self, crop_size: [u32; 2], ) -> Result<(), ImageProcessError>

Updates the crop size.

§Arguments
  • crop_size - New crop size as [width, height].
§Returns
  • Ok(()) - If the size is valid.
  • Err(ImageProcessError::InvalidCropSize) - If either dimension is zero.
Source

pub fn set_crop_mode(&mut self, crop_mode: CropMode)

Updates the crop mode.

§Arguments
  • crop_mode - New crop mode.
Source

pub fn can_crop(&self, img_width: u32, img_height: u32) -> bool

Checks if the crop can be applied to an image with the given dimensions.

§Arguments
  • img_width - Width of the target image.
  • img_height - Height of the target image.
§Returns
  • true - If the crop can be applied.
  • false - If the crop size is too large for the image.
Source

pub fn aspect_ratio(&self) -> f32

Gets the aspect ratio of the crop.

§Returns

The aspect ratio (width / height) of the crop.

Trait Implementations§

Source§

impl Debug for Crop

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Crop

Source§

fn default() -> Self

Creates a default Crop instance with 224x224 center crop.

Auto Trait Implementations§

§

impl Freeze for Crop

§

impl RefUnwindSafe for Crop

§

impl Send for Crop

§

impl Sync for Crop

§

impl Unpin for Crop

§

impl UnwindSafe for Crop

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more