Grider: Image Grid Processing for Rust 🖼️

Badges

Table of Contents

1. Installation
2. Usage
   • Creating a Grid from an Image
   • Accessing Rows and Columns
   • Custom Configuration
   • Debugging with Visual Grid
3. API Documentation
   • Structs
   • Enums
   • Functions
   • Macros
4. Examples
5. Contributing
6. License

Installation

Add grider to your Cargo.toml:

[dependencies]
grider = "0.1"

And include it in your Rust project:

use grider::*;

Usage

Creating a Grid from an Image

use grider::{Grid, GridConfig};
use image::open;

let img = open("path/to/image.png").unwrap();
let config = GridConfig::default();
let grid = Grid::try_from_image_with_config(&img, config).unwrap();

Accessing Rows and Columns

for row in grid.rows() {
    println!("Row at y: {}", row.y);
}

for column in grid.columns() {
    println!("Column at x: {}", column.x);
}

Custom Configuration

let config = GridConfig::new(
    15,          // Threshold block size
    0.9,         // Merge threshold ratio
    false,       // Disable parallel processing
);
let grid = Grid::try_from_image_with_config(&img, config).unwrap();

Debugging with Visual Grid

grider::debug::save_image_with_grid(&img, &grid, "output_with_grid.png", &GridDrawingConfig::default());

API Documentation

Structs

• Grid: Represents the grid of rows and columns extracted from an image.

  • Rows: List of rows in the grid.
  • Columns: List of columns in the grid.

• Row: Represents a row in the grid.

  • y: Y-coordinate of the row.
  • height: Height of the row.
  • kind: Type of the row (Empty or Full).

• Column: Represents a column in the grid.

  • x: X-coordinate of the column.
  • width: Width of the column.
  • kind: Type of the column (Empty or Full).

Enums

• LineKind: Represents the type of a line (row or column).
  • Empty: Indicates an empty line.
  • Full: Indicates a full line.

Functions

• Grid::try_from_image_with_config: Creates a grid from an image with custom configuration.
• Grid::rows: Returns an iterator over all rows in the grid.
• Grid::columns: Returns an iterator over all columns in the grid.
• Grid::filtered_rows: Returns an iterator over filtered rows based on a predicate.
• Grid::filtered_columns: Returns an iterator over filtered columns based on a predicate.
• Grid::count_rows_by_kind: Counts the number of rows with the specified kind.
• Grid::count_columns_by_kind: Counts the number of columns with the specified kind.
• Grid::find_cells: Finds cells based on row and column indices.

Macros

• make_grid!: Creates a grid from rows and columns with a convenient macro.
• make_line!: Creates a row or column from a tuple of parameters.

Examples

• Basic Grid Extraction: Demonstrates how to extract a grid from an image and print row and column information.
• Custom Configuration: Shows how to adjust grid processing parameters for different image types.
• Debugging with Visual Grid: Illustrates how to visualize the grid on the original image for debugging.

Contributing

Contributions are welcome! Please read the CONTRIBUTING.md file for guidelines on how to contribute to this project.

License

Grider is licensed under the MIT License. See the LICENSE file for details.