imx 0.1.20

//! IMX: Image Processing and Manipulation Library
//!
//! This crate provides a comprehensive set of tools for image processing, manipulation,
//! and visualization. It includes functionality for:
//!
//! - Image processing operations (resizing, format conversion, transparency handling)
//! - JPEG XL format support and conversion
//! - Numerical operations for image data
//! - XY plotting capabilities for data visualization
//!
//! # Features
//!
//! - Efficient image processing with support for common operations
//! - JPEG XL format handling with conversion to PNG
//! - Letterboxing removal and transparency handling
//! - Data visualization through XY plotting
//!
//! # Example
//!
//! ```rust,no_run
//! use std::path::PathBuf;
//! use imx::{process_image, PlotConfig, create_plot, LabelAlignment};
//! use anyhow::Result;
//!
//! async fn example() -> Result<()> {
//!     // Process an image
//!     let path = PathBuf::from("input.jpg");
//!     process_image(path, |p| async move {
//!         // Process the image here
//!         Ok(())
//!     }).await?;
//!     
//!     // Create a plot
//!     let config = PlotConfig {
//!         images: vec![PathBuf::from("image1.png")],
//!         output: PathBuf::from("output.png"),
//!         rows: 1,
//!         row_labels: vec![],
//!         column_labels: vec![],
//!         column_label_alignment: LabelAlignment::Center,
//!         row_label_alignment: LabelAlignment::Center,
//!         debug_mode: false,
//!         top_padding: 40,
//!         left_padding: 40,
//!         font_size: None,
//!     };
//!     create_plot(&config)?;
//!     
//!     Ok(())
//! }
//! ```

#![warn(clippy::all, clippy::pedantic)]

/// Image processing module providing functions for image manipulation,
/// format conversion, and various transformations.
pub mod image_processing;

/// JPEG XL format support module with functions for handling JXL files
/// and converting them to other formats.
///
/// # Examples
///
/// ```rust,no_run
/// use std::path::Path;
/// use anyhow::Result;
/// use imx::jxl::process_jxl_file;
///
/// async fn example() -> Result<()> {
///     let input = Path::new("image.jxl");
///     
///     // Process with a simple closure
///     process_jxl_file(input, Some(|path| async move {
///         // Custom processing logic here
///         Ok(())
///     })).await?;
///     
///     Ok(())
/// }
/// ```
///
/// You can also use more complex processing logic:
///
/// ```rust,no_run
/// use std::path::Path;
/// use anyhow::Result;
/// use imx::jxl::process_jxl_file;
///
/// async fn example() -> Result<()> {
///     let input = Path::new("image.jxl");
///     
///     // Process with more complex logic
///     process_jxl_file(input, Some(|path| async move {
///         // Load the PNG file
///         let img = image::open(&path)?;
///         
///         // Apply some transformations
///         let processed = img.grayscale();
///         
///         // Save back to the same path
///         processed.save(path)?;
///         Ok(())
///     })).await?;
///     
///     Ok(())
/// }
/// ```
pub mod jxl;

/// Numerical operations module for image data processing and analysis.
pub mod numeric;

/// XY plotting module for creating visualizations and graphs.
///
/// # Examples
///
/// ```rust,no_run
/// use std::path::PathBuf;
/// use imx::{process_image, PlotConfig, create_plot, LabelAlignment};
/// use anyhow::Result;
///
/// async fn example() -> Result<()> {
///     // Process an image
///     let path = PathBuf::from("input.jpg");
///     process_image(path, |p| async move {
///         // Process the image here
///         Ok(())
///     }).await?;
///     
///     // Create a plot
///     let config = PlotConfig {
///         images: vec![PathBuf::from("image1.png")],
///         output: PathBuf::from("output.png"),
///         rows: 1,
///         row_labels: vec![],
///         column_labels: vec![],
///         column_label_alignment: LabelAlignment::Center,
///         row_label_alignment: LabelAlignment::Center,
///         debug_mode: false,
///         top_padding: 40,
///         left_padding: 40,
///         font_size: None,
///     };
///     create_plot(&config)?;
///     
///     Ok(())
/// }
/// ```
///
/// You can also use it with multiple images:
///
/// ```rust,no_run
/// use std::path::PathBuf;
/// use imx::{PlotConfig, create_plot, LabelAlignment};
/// use anyhow::Result;
///
/// fn example() -> Result<()> {
///     let config = PlotConfig {
///         images: vec![
///             PathBuf::from("image1.png"),
///             PathBuf::from("image2.png"),
///         ],
///         output: PathBuf::from("output.png"),
///         rows: 1,
///         row_labels: vec!["Row 1".to_string()],
///         column_labels: vec!["Col 1".to_string(), "Col 2".to_string()],
///         column_label_alignment: LabelAlignment::Center,
///         row_label_alignment: LabelAlignment::Center,
///         debug_mode: false,
///         top_padding: 40,
///         left_padding: 40,
///         font_size: None,
///     };
///     create_plot(&config)?;
///     Ok(())
/// }
/// ```
pub mod xyplot;

/// Layout module for debugging and visualizing image grid layouts
pub mod layout;

/// Image format conversion module with support for various formats
pub mod formats;

// Re-export commonly used types and functions
pub use formats::{ImageFormatOptions, convert_image, convert_images_batch};
pub use image_processing::{
    get_image_dimensions, is_image_file, process_image, remove_letterbox,
    remove_letterbox_with_threshold, remove_transparency,
};
pub use jxl::{convert_jxl_to_png, is_jxl_file, process_jxl_file};
pub use layout::{Layout, LayoutElement, LayoutRect};
pub use xyplot::{LabelAlignment, PlotConfig, create_plot};

#[cfg(test)]
mod tests {
    mod font_tests;
    mod image_processing_tests;
    mod jxl_tests;
    mod numeric_tests;
    mod xyplot_tests;
}