fast_morphology 0.3.2

Fast morphological operations for images
Documentation
/*
 * Copyright (c) Radzivon Bartoshyk. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1.  Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2.  Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3.  Neither the name of the copyright holder nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
use crate::arena::make_arena;
use crate::border_mode::{BorderMode, MorphScalar};
use crate::filter::Row2DFilter;
use crate::filter_op_declare::MorthOpFilterFlat2DRow;
use crate::morph_base::MorphNativeOp;
use crate::op_type::MorphOp;
use crate::se_scan::scan_se;
use crate::structuring_element::KernelShape;
use crate::unsafe_slice::UnsafeSlice;
use crate::{ImageSize, MorphologyThreadingPolicy};
use num_traits::AsPrimitive;
use std::sync::Arc;

pub(crate) fn make_morphology<T, const OP_TYPE: u8, const CN: usize>(
    src: &[T],
    dst: &mut [T],
    image_size: ImageSize,
    structuring_element: &[u8],
    structuring_element_size: KernelShape,
    border_mode: BorderMode,
    border_constant: MorphScalar,
    threading_policy: MorphologyThreadingPolicy,
) -> Result<(), String>
where
    T: Copy + Default + 'static + Send + Sync + MorphNativeOp<T> + Row2DFilter<T>,
    f64: AsPrimitive<T>,
{
    unsafe {
        if src.len() != dst.len() {
            return Err("Source slice size and destination must match"
                .parse()
                .unwrap());
        }

        let kernel_width = structuring_element_size.width;
        let kernel_height = structuring_element_size.height;
        if kernel_height * kernel_width != structuring_element.len() {
            return Err(format!(
                "Structuring element expected to be {} but it was {}",
                kernel_height * kernel_width,
                structuring_element.len()
            ));
        }

        let width = image_size.width;
        let height = image_size.height;

        if src.len() != width * height * CN {
            return Err(format!(
                "Image size expected to be {} but it was {}",
                width * height,
                src.len()
            ));
        }

        let analyzed_se = scan_se(structuring_element, structuring_element_size);

        if analyzed_se.is_empty {
            for (src, dst) in src.iter().zip(dst.iter_mut()) {
                *dst = *src;
            }
            return Ok(());
        }

        let op_type: MorphOp = OP_TYPE.into();

        let filter = Arc::new(T::get_filter(op_type));

        let arena = make_arena::<T, CN>(
            src,
            width as u32,
            height as u32,
            structuring_element_size,
            border_mode,
            border_constant,
        );
        let arena_arc = Arc::new(arena);

        if let Some(pool) = threading_policy.get_pool(image_size) {
            pool.scope(|scope| {
                let unsafe_slice = UnsafeSlice::new(dst);

                for y in 0..height {
                    let cloned_se = analyzed_se.clone();
                    let cloned_filter = filter.clone();
                    let arena_clone = arena_arc.clone();
                    scope.spawn(move |_| {
                        cloned_filter.dispatch_row(
                            &arena_clone,
                            &unsafe_slice,
                            image_size,
                            cloned_se,
                            y,
                        );
                    });
                }
            })
        } else {
            for y in 0..height {
                let unsafe_slice = UnsafeSlice::new(dst);
                let arena_clone = arena_arc.clone();
                filter.dispatch_row(
                    &arena_clone,
                    &unsafe_slice,
                    image_size,
                    analyzed_se.clone(),
                    y,
                );
            }
        }
    }

    Ok(())
}