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.contour;
031
032import java.util.ArrayList;
033import java.util.List;
034
035import org.openimaj.image.FImage;
036import org.openimaj.image.pixel.Pixel;
037import org.openimaj.util.function.Operation;
038
039/**
040 * A contour Following strategy implements a Contour Tracing algorithm that
041 * extracts a boundary from an image
042 * <p>
043 * Many examples can be found in <a href=
044 * "http://www.imageprocessingplace.com/downloads_V3/root_downloads/tutorials/contour_tracing_Abeer_George_Ghuneim/index.html"
045 * >this tutorial</a>.
046 * 
047 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
048 */
049public abstract class ContourFollowingStrategy {
050        /**
051         * Follow the contour, adding each pixel to a list. The first pixel in the
052         * list is guaranteed to the be equal to start
053         * 
054         * @param image
055         *            the image
056         * @param start
057         *            the starting point on the contour
058         * @param from
059         *            the pixel that was not a contour
060         * @return a list of contour pixels in the image starting from the start
061         *         pixel
062         */
063        public List<Pixel> contour(FImage image, Pixel start, Pixel from) {
064                final List<Pixel> ret = new ArrayList<Pixel>();
065                contour(image, start, from, new Operation<Pixel>() {
066                        @Override
067                        public void perform(Pixel object) {
068                                ret.add(object);
069                        }
070                });
071                return ret;
072        }
073
074        /**
075         * 
076         * Given some starting pixel in an image on a contour and the direction of a
077         * non starting image, return each pixel on a contour from the start pixel
078         * in the image. The first pixel returned must be the start pixel
079         * 
080         * @param image
081         *            the image
082         * @param start
083         *            the first point on the contour
084         * @param from
085         *            the pixel that was not a contour
086         * @param operation
087         *            the thing to do for each contour pixel found
088         */
089        public abstract void contour(FImage image, Pixel start, Pixel from, final Operation<Pixel> operation);
090
091}