Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

jaitools.imageutils
Class FloodFiller

java.lang.Object
  jaitools.imageutils.FloodFiller

public class FloodFiller
extends java.lang.Object

    

  

  
A flood-filling algorithm to use with rasters.

  
The code is adapted from an algorithm published in C# by J. Dunlap at:

  
   http://www.codeproject.com/KB/GDI-plus/queuelinearfloodfill.aspx
which was subsequently ported to Java by Owen Kaluza. The JAI-tools implementation is substantially different and any bugs should not be blamed on the above authors.
  
This version works with a source RenderedImage and a destination WritableRenderedImage, both of which are accessed using JAI iterators.

  

  

  

    
Since:

    
1.0

    
Version:

    
$Id: FloodFiller.java 1610 2011-03-31 04:44:28Z michael.bedward $

    
Author:

    
Michael Bedward

  

  

  

  

    

      Nested Class Summary
    

    

      static class
      
FloodFiller.ScanSegment

                Records a segment of contiguous pixels in a single row that will become part of a filled region.		
    

  
  
  

    

      Constructor Summary
    

    

      
FloodFiller(java.awt.image.RenderedImage sourceImage, int sourceBand, java.awt.image.WritableRenderedImage destImage, int destBand, double tolerance, boolean diagonal)

                Create a FloodFiller to work with the given source image		
    

  
  
  

    

      Method Summary
    

    

       FillResult
      
fill(int x, int y, int fillValue)

                Fills the region connected to the specified start pixel.		
    

    

       FillResult
      
fill(int x, int y, int fillValue, double refValue)

                Fills the region connected to the specified start pixel.		
    

    

       FillResult
      
fillRadius(int x, int y, int fillValue, double radius)

                Fills the region connected to the specified start pixel and lying within radius pixels of the start pixel.		
    

    

       FillResult
      
fillRadius(int x, int y, int fillValue, double refValue, double radius)

                Fills the region connected to the specified start pixel and lying within radius pixels of the start pixel.		
    

  
 
  

    

      Methods inherited from class java.lang.Object
    

    

      clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    

  
 
  

  

    

      Constructor Detail
    

  


  
FloodFiller

  
public FloodFiller(java.awt.image.RenderedImage sourceImage,
                   int sourceBand,
                   java.awt.image.WritableRenderedImage destImage,
                   int destBand,
                   double tolerance,
                   boolean diagonal)

  

    

      Create a FloodFiller to work with the given source image
      

      

        
Parameters:

        

sourceImage - the source image

        

destImage - the destination image

        

sourceBand - the source image band to be processed

        

destBand - the destination image band to write to

        

tolerance - the maximum absolute difference in value for a pixel to be included in the region

        

diagonal - set to true to include sub-regions that are only connected diagonally; set to false to require orthogonal connections

      

    

  


  

    

      Method Detail
    

  


  
fill

  
public FillResult fill(int x,
                       int y,
                       int fillValue)

  

    

      Fills the region connected to the specified start pixel. A pixel belongs to this region if there is a path between it and the starting pixel which passes only through pixels of value v within the range start_pixel_value - tolerance .
      

    


    

      

        
Parameters:

        

x - start pixel x coordinate

        

y - start pixel y coordinate

        

fillValue - the value to write to the destination image for this region

        
Returns:

        
a new FillResult

      

    

  

  

  
  
fillRadius

  
public FillResult fillRadius(int x,
                             int y,
                             int fillValue,
                             double radius)

  

    

      Fills the region connected to the specified start pixel and lying within radius pixels of the start pixel.
      
A pixel belongs to this region if there is a path between it and the starting pixel which passes only through pixels of value v within the range start_pixel_value - tolerance .

      

    

    

      

        
Parameters:

        

x - start pixel x coordinate

        

y - start pixel y coordinate

        

fillValue - the value to write to the destination image for this region

        

radius - maximum distance (pixels) that a candidate pixel can be from the start pixel

        
Returns:

        
a new FillResult

      

    

  

  

  
  
fill

  
public FillResult fill(int x,
                       int y,
                       int fillValue,
                       double refValue)

  

    

      Fills the region connected to the specified start pixel. A pixel belongs to this region if there is a path between it and the starting pixel which passes only through pixels of value v within the range refValue - tolerance .
      

    


    

      

        
Parameters:

        

x - start pixel x coordinate

        

y - start pixel y coordinate

        

fillValue - the value to write to the destination image for this region

        

refValue - the source image reference value for the region

        
Returns:

        
a new FillResult

      

    

  

  

  
  
fillRadius

  
public FillResult fillRadius(int x,
                             int y,
                             int fillValue,
                             double refValue,
                             double radius)

  

    

      Fills the region connected to the specified start pixel and lying within radius pixels of the start pixel.
      
A pixel belongs to this region if there is a path between it and the starting pixel which passes only through pixels of value v within the range refValue - tolerance .

      

    

    

      

        
Parameters:

        

x - start pixel x coordinate

        

y - start pixel y coordinate

        

fillValue - the value to write to the destination image for this region

        

refValue - the source image reference value for the region

        

radius - maximum distance (pixels) that a candidate pixel can be from the start pixel

        
Returns:

        
a new FillResult

      

    

  

  

   
  

    

      
        
        

          

            
Overview 
            
Package 
             Class 
            
Use 
            
Tree 
            
Deprecated 
            
Index 
            
Help 
          

        

      		
      
    

    

       PREV CLASS   NEXT CLASS
      FRAMES    NO FRAMES     
       
    

    

      SUMMARY: NESTED | FIELD | CONSTR | METHOD
      DETAIL: FIELD | CONSTR | METHOD
    

  


  

  Copyright © 2009-2011. All Rights Reserved.