1 /**
2 * Copyright (c) 2011, The University of Southampton and the individual contributors.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without modification,
6 * are permitted provided that the following conditions are met:
7 *
8 * * Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 *
11 * * Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 *
15 * * Neither the name of the University of Southampton nor the names of its
16 * contributors may be used to endorse or promote products derived from this
17 * software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30 package org.openimaj.image.processing.threshold;
31
32 import org.openimaj.image.FImage;
33 import org.openimaj.image.processor.SinglebandImageProcessor;
34
35 /**
36 * Abstract base class for local thresholding operations. Local thresholding
37 * operations determine their threshold based on a rectangular image patch.
38 *
39 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
40 */
41 public abstract class AbstractLocalThreshold implements SinglebandImageProcessor<Float, FImage> {
42 protected int sizeX;
43 protected int sizeY;
44
45 /**
46 * Construct the AbstractLocalThreshold with the given patch size (the patch
47 * will be square).
48 *
49 * @param size
50 * the length of the patch side.
51 */
52 public AbstractLocalThreshold(int size) {
53 this(size, size);
54 }
55
56 /**
57 * Construct the AbstractLocalThreshold with the given patch size.
58 *
59 * @param size_x
60 * the width of the patch.
61 * @param size_y
62 * the height of the patch.
63 */
64 public AbstractLocalThreshold(int size_x, int size_y) {
65 this.sizeX = size_x;
66 this.sizeY = size_y;
67 }
68
69 /**
70 * Get the height of the local sampling rectangle
71 *
72 * @return the height of the local sampling rectangle
73 */
74 public int getKernelHeight() {
75 return sizeY;
76 }
77
78 /**
79 * Get the width of the local sampling rectangle
80 *
81 * @return the width of the local sampling rectangle
82 */
83 public int getKernelWidth() {
84 return sizeX;
85 }
86 }