com.github.ojil.algorithm.RgbMaskPoly Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ojil-core Show documentation
Open Java Imaging Library.
There is a newer version: 0.0.11
/*
 * Copyright 2008 by Jon pA. Webb
 *     This program is free software: you can redistribute it and/or modify
 *    it under the terms of the GNU Lesser General Public License as published by
 *    the Free Software Foundation, either version 3 of the License, or
 *    (at your option) any later version.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR pA PARTICULAR PURPOSE.  See the
 *    GNU Lesser General Public License for more details.
 *
 *    You should have received a copy of the Lesser GNU General Public License
 *    along with this program.  If not, see .
 */

package com.github.ojil.algorithm;

import com.github.ojil.core.Image;
import com.github.ojil.core.ImageError;
import com.github.ojil.core.PipelineStage;
import com.github.ojil.core.Point;
import com.github.ojil.core.Quad;
import com.github.ojil.core.Rect;
import com.github.ojil.core.RgbImage;
import com.github.ojil.core.RgbMaskedImage;

/**
 * Masks a polygon in an RgbImage, setting the area inside or outside the
 * polygon to masked, depending on a parameter.
 * 
 * @author webb
 */
public class RgbMaskPoly extends PipelineStage {
    
    private final boolean bInside;
    private final Point points[];
    private BinaryHeap hx[];
    private Integer[][] rnX;
    
    /**
     * Initialize class, setting polygon to mask and inside/outside choice.
     * 
     * @param points
     *            list of points to mask, in clockwise order (interior on
     *            right).
     * @param bInside
     *            if true then area inside the polygon is masked; if false, the
     *            area outside.
     */
    public RgbMaskPoly(final Point points[], final boolean bInside) {
        this.points = points;
        this.bInside = bInside;
    }
    
    /**
     * Mask a quadrilateral.
     * 
     * @param quad
     *            quadrilateral to mask
     * @param bInside
     *            if true interior of quadrilateral is masked, if false exterior
     * @throws ImageError
     *             if Error thrown from getCorner.
     */
    public RgbMaskPoly(final Quad quad, final boolean bInside) throws ImageError {
        points = new Point[4];
        points[0] = quad.getCorner(0);
        points[1] = quad.getCorner(1);
        points[2] = quad.getCorner(2);
        points[3] = quad.getCorner(3);
        this.bInside = bInside;
    }
    
    /**
     * Mask a rectangle.
     * 
     * @param rect
     *            rectangle to mask
     * @param bInside
     *            if true, interior is masked; if false, exterior.
     */
    public RgbMaskPoly(final Rect rect, final boolean bInside) {
        points = new Point[4];
        points[0] = new Point(rect.getLeft(), rect.getTop());
        points[1] = new Point(rect.getRight(), rect.getTop());
        points[2] = new Point(rect.getRight(), rect.getBottom());
        points[3] = new Point(rect.getLeft(), rect.getBottom());
        this.bInside = bInside;
    }
    
    /**
     * Build a vector of intersection points of the polygon for every row in the
     * output image.
     * 
     * @param nWidth
     *            output image width
     * @param nHeight
     *            output image height
     * @throws ImageError
     *             if the BinaryHeap code does.
     */
    private void buildVector(final int nWidth, final int nHeight) throws ImageError {
        hx = new BinaryHeap[nHeight];
        for (int i = 0; i < nHeight; i++) {
            hx[i] = new BinaryHeap();
        }
        for (int i = 0; i < (points.length - 1); i++) {
            drawLine(points[i], points[i + 1]);
        }
        drawLine(points[points.length - 1], points[0]);
        
        rnX = new Integer[nHeight][];
        for (int i = 0; i < nHeight; i++) {
            int j = 0;
            if (!bInside) {
                rnX[i] = new Integer[hx[i].size() + 2];
                rnX[i][0] = 0;
                j = 1;
                
            }
            if (hx[i].size() > 0) {
                if (bInside) {
                    rnX[i] = new Integer[hx[i].size()];
                }
                while (!hx[i].isEmpty()) {
                    rnX[i][j++] = ((BinaryHeap.ComparableInt) hx[i].deleteMin()).intValue();
                }
            }
            if (!bInside) {
                rnX[i][j] = nWidth;
            }
        }
    }
    
    /**
     * Starting at p1 and ending at p2, add all the intersection points for a
     * scanline to the array hx.
     * 
     * @param p1
     *            starting point
     * @param p2
     *            ending point
     * @throws ImageError
     *             if the BinaryHeap code does
     */
    private void drawLine(Point p1, Point p2) throws ImageError {
        if (p1.getY() > p2.getY()) {
            final Point pSwap = p1;
            p1 = p2;
            p2 = pSwap;
        }
        final int yDiff = p2.getY() - p1.getY();
        for (int y = 0; y < yDiff; y++) {
            final int x = p2.getX() + (((p1.getX() - p2.getX()) * (yDiff - y)) / yDiff);
            hx[y + p1.getY()].insert(new BinaryHeap.ComparableInt(x));
        }
    }
    
    /**
     * Mask the polygon in the input image. The algorithm used first finds all
     * intersections of the polygon with each row in the output image and builds
     * an array containing the x locations of those intersections in sorted
     * order. Then it scans the output image, setting the mask value, for each
     * row, starting and ending at each even-numbered pair of intersection
     * points.
 This code was strongly influenced by Darel Rex Finley's code
     * described at 
     * http://alienryderflex.com/polygon_fill/.
     * 
     * @param imageInput
     *            input RgbImage
     * @throws ImageError
     *             if input is not RgbImage or the BinaryHeap code used to do
     *             the sorting throws.
     */
    @Override
    public void push(final Image imageInput) throws ImageError {
        if (!(imageInput instanceof RgbImage)) {
            throw new ImageError(ImageError.PACKAGE.ALGORITHM, AlgorithmErrorCodes.IMAGE_NOT_RGBIMAGE, imageInput.toString(), null, null);
        }
        final RgbImage rgbInput = (RgbImage) imageInput;
        final RgbMaskedImage rgbOutput = new RgbMaskedImage<>(rgbInput);
        buildVector(rgbInput.getWidth(), rgbInput.getHeight());
        for (int i = 0; i < rgbInput.getHeight(); i++) {
            if (rnX[i] != null) {
                for (int j = 0; j < rnX[i].length; j += 2) {
                    for (int k = rnX[i][j]; k < rnX[i][j + 1]; k++) {
                        rgbOutput.setMask(i, k);
                    }
                }
            }
        }
        super.setOutput(rgbOutput);
    }
}