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 */
030/**
031 * 
032 */
033package org.openimaj.image.processor;
034
035import org.openimaj.image.Image;
036
037/**
038 *      A processor that will process an image in a grid-wise fashion returning
039 *      a single value for each grid element.
040 *
041 *      @author David Dupplaw (dpd@ecs.soton.ac.uk)
042 *      
043 *  @param <T> the pixel type
044 *  @param <I> the image type 
045 */
046public interface GridProcessor<T,I extends Image<T,I>> extends Processor<I>
047{
048        /**
049         *      Returns the number of columns in the grid.
050         *  @return the number of columns in the grid.
051         */
052        public abstract int getHorizontalGridElements();
053        
054        /**
055         *      Returns the number of rows in the grid.
056         *  @return the number of rows in the grid.
057         */
058        public abstract int getVerticalGridElements();
059        
060        /**
061         *      Process the given grid element (<code>patch</code>) and returns
062         *      a single pixel value for that element.
063         * 
064         *  @param patch The patch of the grid to process 
065         *  @return A single pixel value
066         */
067        public abstract T processGridElement( I patch );
068}