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.processor;
031
032import org.openimaj.image.Image;
033
034/**
035 * A KernelProcessor for single band images.
036 * 
037 * @see KernelProcessor
038 * 
039 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
040 *
041 * @param <T> The pixel type that is processed
042 * @param <I> The image type that is processed
043 */
044public interface SinglebandKernelProcessor<T, I extends Image<T,I>> extends KernelProcessor<T, I> {
045        /**
046         * Interfaces for objects that allow themselves to be processed by a
047         * SinglebandKernelProcessor.
048         *
049         * @param <T> The pixel type that is processed
050         * @param <S> The image type of the underlying single band images
051         * @param <I> The image type that is processed
052         */
053        public interface Processable<T, S extends Image<T,S>, I extends Image<?,I>> {
054                /**
055                 * @see Image#process(KernelProcessor)
056                 * @param p the processor
057                 * @return the processed image
058                 */
059                public I process(SinglebandKernelProcessor<T,S> p);
060                
061                /**
062                 * @see Image#process(KernelProcessor)
063                 * @param p the processor
064                 * @return the processed image
065                 */
066                public I processInplace(SinglebandKernelProcessor<T,S> p);
067                
068                /**
069                 * @see Image#process(KernelProcessor, boolean)
070                 * @param p the processor
071                 * @param pad Should the image be zero padded so the 
072                 *                              kernel reaches the edges of the output
073                 * @return the processed image
074                 */
075                public I process(SinglebandKernelProcessor<T,S> p, boolean pad);
076                
077                /**
078                 * @see Image#processInplace(KernelProcessor, boolean)
079                 * @param p the processor
080                 * @param pad Should the image be zero padded so the 
081                 *                              kernel reaches the edges of the output
082                 * @return the processed image
083                 */
084                public I processInplace(SinglebandKernelProcessor<T,S> p, boolean pad);
085        }
086}