001/*******************************************************************************
002 * This software is provided as a supplement to the authors' textbooks on digital
003 * image processing published by Springer-Verlag in various languages and editions.
004 * Permission to use and distribute this software is granted under the BSD 2-Clause
005 * "Simplified" License (see http://opensource.org/licenses/BSD-2-Clause).
006 * Copyright (c) 2006-2023 Wilhelm Burger, Mark J. Burge. All rights reserved.
007 * Visit https://imagingbook.com for additional details.
008 ******************************************************************************/
009
010package imagingbook.common.threshold;
011
012import ij.process.ByteProcessor;
013
014/**
015 * Common interface to be implemented by all thresholders (global and adaptive).
016 * 
017 * @author WB
018 * @version 2022/08/02
019 *
020 */
021public interface Thresholder {
022
023        /**
024         * Enum type to discriminate if the image background is assumed to be bright or dark.
025         */
026        public enum BackgroundMode {
027                /** bright background */
028                BRIGHT,
029                /** dark background */
030                DARK}
031
032        /**
033         * Thresholds the specified {@link ByteProcessor} (8-bit image), which is modified. Does nothing and returns
034         * {@code true} if no valid threshold could be found (e.g., if all image pixels have the same value).
035         *
036         * @param ip a {@link ByteProcessor} (8-bit image)
037         * @return {@code true} iff the operation was successful
038         */
039        public boolean threshold(ByteProcessor ip);
040
041}