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.pixel.sampling;
031
032import org.openimaj.image.Image;
033import org.openimaj.math.geometry.line.Line2d;
034
035/**
036 * {@link LineSampler} defines an interface for objects capable
037 * of extracting information from pixels along a line in an image.
038 * 
039 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
040 *
041 * @param <I> Type of image
042 * @param <T> Type of the result of the sampling 
043 */
044public interface LineSampler<I extends Image<?, I>, T> {
045        /**
046         * Extract a numSamples samples along the given line
047         * in the given image. Implementors may choose to 
048         * interpret the line in different ways; some may sample
049         * numSamples between the start and end points, whilst
050         * others may choose different sampling points along
051         * the direction of the line.
052         * 
053         * @param line the line
054         * @param image the image to sample from
055         * @param numSamples the number of samples
056         * @return the samples
057         */
058        public abstract T extractSamples(Line2d line, I image, int numSamples);
059        
060        /**
061         * Get the a line representing the extremities of
062         * the pixels that are actually sampled.
063         * @param line the line
064         * @param image the image to sample from
065         * @param numSamples the number of samples
066         * @return the sampling line
067         */
068        public abstract Line2d getSampleLine(Line2d line, I image, int numSamples);
069}