View Javadoc

1   /**
2    * Copyright (c) 2011, The University of Southampton and the individual contributors.
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without modification,
6    * are permitted provided that the following conditions are met:
7    *
8    *   * 	Redistributions of source code must retain the above copyright notice,
9    * 	this list of conditions and the following disclaimer.
10   *
11   *   *	Redistributions in binary form must reproduce the above copyright notice,
12   * 	this list of conditions and the following disclaimer in the documentation
13   * 	and/or other materials provided with the distribution.
14   *
15   *   *	Neither the name of the University of Southampton nor the names of its
16   * 	contributors may be used to endorse or promote products derived from this
17   * 	software without specific prior written permission.
18   *
19   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20   * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21   * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
23   * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
26   * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27   * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28   * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29   */
30  package org.openimaj.image.analysis.watershed;
31  
32  import java.util.ArrayList;
33  import java.util.List;
34  
35  import org.openimaj.image.FImage;
36  import org.openimaj.image.analysis.watershed.event.ComponentStackMergeListener;
37  import org.openimaj.image.analysis.watershed.feature.ComponentFeature;
38  import org.openimaj.image.pixel.IntValuePixel;
39  
40  /**
41   * Detector for Maximally-Stable Extremal Regions. The actual image analysis is
42   * in the class {@link WatershedProcessorAlgorithm} to allow this class to be
43   * re-used efficiently.
44   *
45   * @author David Dupplaw (dpd@ecs.soton.ac.uk)
46   *
47   */
48  public class WatershedProcessor
49  {
50  	/** This is where we start "pouring" our water */
51  	private IntValuePixel startPixel = new IntValuePixel(0, 0);
52  
53  	/** A list of objects that want to know what components on the stack merge */
54  	private List<ComponentStackMergeListener> csmListeners = null;
55  
56  	private Class<? extends ComponentFeature>[] featureClasses;
57  
58  	/**
59  	 * Default constructor.
60  	 * 
61  	 * @param featureClasses
62  	 *            classes for feature creation
63  	 */
64  	@SafeVarargs
65  	public WatershedProcessor(Class<? extends ComponentFeature>... featureClasses)
66  	{
67  		this.csmListeners = new ArrayList<ComponentStackMergeListener>();
68  		this.featureClasses = featureClasses;
69  	}
70  
71  	/**
72  	 * Process the given image.
73  	 *
74  	 * @param greyscaleImage
75  	 *            The image to process
76  	 */
77  	public void processImage(FImage greyscaleImage) {
78  		final WatershedProcessorAlgorithm d = new WatershedProcessorAlgorithm(greyscaleImage, this.startPixel,
79  				featureClasses);
80  
81  		for (final ComponentStackMergeListener csm : csmListeners)
82  			d.addComponentStackMergeListener(csm);
83  
84  		d.startPour();
85  	}
86  
87  	/**
88  	 * Add a component stack merge listener
89  	 *
90  	 * @param csml
91  	 *            The {@link ComponentStackMergeListener} to add
92  	 */
93  	public void addComponentStackMergeListener(ComponentStackMergeListener csml)
94  	{
95  		csmListeners.add(csml);
96  	}
97  
98  }