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.analysis.watershed.event;
034
035import java.util.EventListener;
036
037import org.openimaj.image.analysis.watershed.Component;
038
039
040/**
041 *      
042 *
043 *      @author David Dupplaw (dpd@ecs.soton.ac.uk)
044 *      
045 */
046public interface ComponentStackMergeListener extends EventListener
047{
048        /**
049         *      Called when component c2 is merged into component c1. This
050         *      will be called <b>before</b> the merge occurs, so component c1
051         *      will not contain the pixels of c2.
052         * 
053         *      @param c1 The component that is receiving the merge
054         *      @param c2 The component that is providing the merge.
055         */
056        public void componentsMerged( Component c1, Component c2 );
057        
058        /**
059         *      Called when the given component c1 is upwardly promoted to
060         *      a higher intensity value. The component will contain all the pixels
061         *      at the higher level.
062         *      @param c1 The component being promoted.
063         */
064        public void componentPromoted( Component c1 );
065}