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.processor.connectedcomponent.render;
031
032import java.util.List;
033
034import org.openimaj.image.Image;
035import org.openimaj.image.pixel.ConnectedComponent;
036import org.openimaj.image.pixel.Pixel;
037import org.openimaj.image.pixel.ConnectedComponent.ConnectMode;
038
039/**
040 *      Draws the border of the connected component into the given image.
041 * 
042 *  @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
043 *      
044 *  @param <T> The type of image to draw into
045 */
046public class BorderRenderer<T> extends AbstractRenderer<T> 
047{
048        /** The connect mode to use to get the boundary */
049        ConnectMode mode;
050        
051        /**
052         *      Default constructor that takes the image to draw into, the colour
053         *      to draw the boundary and the connect mode to use to extract the
054         *      boundary.
055         * 
056         *  @param image The image to draw into.
057         *  @param colour The colour to use to draw the boundary
058         *  @param mode The {@link ConnectMode} to use to extract the boundary.
059         */
060        public BorderRenderer(Image<T,?> image, T colour, ConnectMode mode) {
061                super(image, colour);
062                this.mode = mode;
063        }
064        
065        /**
066         *      Constructor that creates the image to draw into, and takes the colour
067         *      to draw the boundary and the connect mode to use to extract the
068         *      boundary.
069         * @param width The width of the image to create
070         * @param height The height of the image to create
071         * @param colour The colour to use to draw the boundary
072         * @param mode The {@link ConnectMode} to use to extract the boundary.
073         */
074        public BorderRenderer(int width, int height, T colour, ConnectMode mode) {
075                super(width, height, colour);
076                this.mode = mode;
077        }
078        
079        /**
080         *      Draws the boundary of the connected component into the image.   
081         * 
082         *  {@inheritDoc}
083         *  @see org.openimaj.image.processor.connectedcomponent.ConnectedComponentProcessor#process(org.openimaj.image.pixel.ConnectedComponent)
084         */
085        @Override
086        public void process(ConnectedComponent cc) {
087                List<Pixel> pset = cc.getInnerBoundary(mode);
088
089                for (Pixel p : pset) {
090                        image.setPixel(p.x, p.y, colour);
091                }
092        }
093}