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 kernel processor interface for objects that are able to process
036 *      an image using convolution. Patches are generated for every pixel in
037 *      the image where a patch of the size required by this class can be placed.
038 *      The {@link #processKernel(Image)} function will then generate a single
039 *      value which is used to build the convolved image.
040 * 
041 *  @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
042 *  @param <Q> The pixel type that is processed
043 *  @param <I> The image type that is processed
044 */
045public interface KernelProcessor<Q, I extends Image<Q,I>>  extends Processor<I>
046{
047        /**
048         *      Get the height of the kernel required by this processor.
049         * 
050         *  @return The height of the kernel required by this processor
051         */
052        public abstract int getKernelHeight();
053        
054        /**
055         *      Get the width of the kernel required by this processor.
056         * 
057         *  @return The width of the kernel required by this processor. 
058         */
059        public abstract int getKernelWidth();
060        
061        /**
062         *      Process the patch with this kernel processor and return a value
063         *      that will be used to build the convolved image. 
064         * 
065         *  @param patch The patch of pixels from the image to process
066         *  @return A value to place in the final convolved image.
067         */
068        public abstract Q processKernel(I patch);
069}