Struct PatchExtractor 

pub struct PatchExtractor { /* private fields */ }

Patch Extractor with Builder Pattern

A configurable patch extractor that provides a clean interface for patch extraction with various sampling strategies and optimization options.

Builder Pattern

The extractor uses the builder pattern for clean configuration:

• Chainable method calls for easy setup
• Sensible defaults for quick usage
• Comprehensive validation of parameters

Configuration Options

• Patch Size: Dimensions of extracted patches
• Max Patches: Limit on number of patches to extract
• Random State: Seed for reproducible random sampling
• Sampling Strategy: How to select patch positions

Examples

use sklears_feature_extraction::image::patch_extraction::PatchExtractor;
use scirs2_core::ndarray::Array2;

let image = Array2::from_shape_vec((10, 10), (0..100).map(|x| x as f64).collect()).expect("shape and data length match");
let extractor = PatchExtractor::new()
    .patch_size((3, 3))
    .max_patches(Some(10))
    .random_state(Some(42));
let patches = extractor.extract(&image.view()).expect("valid image and extractor config produce patches");

Implementations

impl PatchExtractor

pub fn new() -> Self

Create a new PatchExtractor with default settings

Default configuration:

• Patch size: 8x8 pixels
• Max patches: None (extract all)
• Random state: None (non-deterministic)
• Sampling: UniformGrid

pub fn patch_size(self, patch_size: (usize, usize)) -> Self

Set the patch size

Parameters

• patch_size - Dimensions of patches as (height, width)

Panics

Panics if either dimension is zero

pub fn max_patches(self, max_patches: Option<usize>) -> Self

Set the maximum number of patches to extract

Parameters

• max_patches - Maximum patches (None for all possible)

pub fn random_state(self, random_state: Option<u64>) -> Self

Set the random state for reproducible sampling

Parameters

• random_state - Random seed (None for non-deterministic)

pub fn sampling_strategy(self, strategy: SamplingStrategy) -> Self

Set the sampling strategy

Parameters

• strategy - Sampling strategy to use

pub fn extract(&self, image: &ArrayView2<'_, Float>) -> SklResult<Array3<Float>>

Extract patches from image using configured settings

Parameters

• image - Input 2D image to extract patches from

Returns

3D array of extracted patches

pub fn summary(&self) -> String

Get the current configuration summary

Returns

Configuration parameters as formatted string

Trait Implementations

impl Clone for PatchExtractor

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PatchExtractor

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

Formats the value using the given formatter.

impl Default for PatchExtractor

fn default() -> Self

Returns the “default value” for a type.