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.background;
031
032import org.openimaj.image.Image;
033import org.openimaj.image.processor.ImageProcessor;
034
035/**
036 * Basic background subtraction
037 * 
038 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
039 *
040 * @param <I>
041 */
042public class BasicBackgroundSubtract<I extends Image<?,I>> implements ImageProcessor<I> {
043        I background;
044
045        /**
046         * Default constructor
047         */
048        public BasicBackgroundSubtract() {
049                //do nothing
050        }
051        /**
052         * Default constructor
053         * @param background 
054         */
055        public BasicBackgroundSubtract(I background) {
056                this.background = background;
057        }
058        
059        /**
060         * Set the background image
061         * @param background 
062         */
063        public void setBackground(I background) {
064                this.background = background;
065        }
066        
067        /**
068         * Process the input by subtracting the background
069         * 
070         * @see org.openimaj.image.processor.ImageProcessor#processImage(org.openimaj.image.Image)
071         */
072        @Override
073        public void processImage(I image) {
074                image.subtractInplace(background);
075        }
076}