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.analysis.watershed;
031
032import java.util.ArrayList;
033import java.util.List;
034
035import org.openimaj.image.FImage;
036import org.openimaj.image.analysis.watershed.event.ComponentStackMergeListener;
037import org.openimaj.image.analysis.watershed.feature.ComponentFeature;
038import org.openimaj.image.pixel.IntValuePixel;
039
040/**
041 * Detector for Maximally-Stable Extremal Regions. The actual image analysis is
042 * in the class {@link WatershedProcessorAlgorithm} to allow this class to be
043 * re-used efficiently.
044 *
045 * @author David Dupplaw (dpd@ecs.soton.ac.uk)
046 *
047 */
048public class WatershedProcessor
049{
050        /** This is where we start "pouring" our water */
051        private IntValuePixel startPixel = new IntValuePixel(0, 0);
052
053        /** A list of objects that want to know what components on the stack merge */
054        private List<ComponentStackMergeListener> csmListeners = null;
055
056        private Class<? extends ComponentFeature>[] featureClasses;
057
058        /**
059         * Default constructor.
060         * 
061         * @param featureClasses
062         *            classes for feature creation
063         */
064        @SafeVarargs
065        public WatershedProcessor(Class<? extends ComponentFeature>... featureClasses)
066        {
067                this.csmListeners = new ArrayList<ComponentStackMergeListener>();
068                this.featureClasses = featureClasses;
069        }
070
071        /**
072         * Process the given image.
073         *
074         * @param greyscaleImage
075         *            The image to process
076         */
077        public void processImage(FImage greyscaleImage) {
078                final WatershedProcessorAlgorithm d = new WatershedProcessorAlgorithm(greyscaleImage, this.startPixel,
079                                featureClasses);
080
081                for (final ComponentStackMergeListener csm : csmListeners)
082                        d.addComponentStackMergeListener(csm);
083
084                d.startPour();
085        }
086
087        /**
088         * Add a component stack merge listener
089         *
090         * @param csml
091         *            The {@link ComponentStackMergeListener} to add
092         */
093        public void addComponentStackMergeListener(ComponentStackMergeListener csml)
094        {
095                csmListeners.add(csml);
096        }
097
098}