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.background;
31
32 import org.openimaj.image.Image;
33 import org.openimaj.image.processor.ImageProcessor;
34
35 /**
36 * Basic background subtraction
37 *
38 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
39 *
40 * @param <I>
41 */
42 public class BasicBackgroundSubtract<I extends Image<?,I>> implements ImageProcessor<I> {
43 I background;
44
45 /**
46 * Default constructor
47 */
48 public BasicBackgroundSubtract() {
49 //do nothing
50 }
51 /**
52 * Default constructor
53 * @param background
54 */
55 public BasicBackgroundSubtract(I background) {
56 this.background = background;
57 }
58
59 /**
60 * Set the background image
61 * @param background
62 */
63 public void setBackground(I background) {
64 this.background = background;
65 }
66
67 /**
68 * Process the input by subtracting the background
69 *
70 * @see org.openimaj.image.processor.ImageProcessor#processImage(org.openimaj.image.Image)
71 */
72 @Override
73 public void processImage(I image) {
74 image.subtractInplace(background);
75 }
76 }