001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.image.processing.threshold;
031
032import org.openimaj.image.FImage;
033import org.openimaj.image.processor.SinglebandImageProcessor;
034
035/**
036 * Abstract base class for local thresholding operations. Local thresholding
037 * operations determine their threshold based on a rectangular image patch.
038 * 
039 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
040 */
041public abstract class AbstractLocalThreshold implements SinglebandImageProcessor<Float, FImage> {
042        protected int sizeX;
043        protected int sizeY;
044
045        /**
046         * Construct the AbstractLocalThreshold with the given patch size (the patch
047         * will be square).
048         * 
049         * @param size
050         *            the length of the patch side.
051         */
052        public AbstractLocalThreshold(int size) {
053                this(size, size);
054        }
055
056        /**
057         * Construct the AbstractLocalThreshold with the given patch size.
058         * 
059         * @param size_x
060         *            the width of the patch.
061         * @param size_y
062         *            the height of the patch.
063         */
064        public AbstractLocalThreshold(int size_x, int size_y) {
065                this.sizeX = size_x;
066                this.sizeY = size_y;
067        }
068
069        /**
070         * Get the height of the local sampling rectangle
071         * 
072         * @return the height of the local sampling rectangle
073         */
074        public int getKernelHeight() {
075                return sizeY;
076        }
077
078        /**
079         * Get the width of the local sampling rectangle
080         * 
081         * @return the width of the local sampling rectangle
082         */
083        public int getKernelWidth() {
084                return sizeX;
085        }
086}