ImageScience 3.0.0

imagescience.segment
Class Extremizer

java.lang.Object
  extended by imagescience.segment.Extremizer

public class Extremizer
extends java.lang.Object

Finds local extrema in images.


Field Summary
static int DETECT
          The detection mode.
static int EXTRACT
          The extraction mode.
static int MAXIMA
          The maxima type.
 Messenger messenger
          The object used for message displaying.
static int MINIMA
          The minima type.
 Progressor progressor
          The object used for progress displaying.
 
Constructor Summary
Extremizer()
          Default constructor.
 
Method Summary
 java.util.Vector<java.util.Vector<Coordinates>> run(Image image, int type, int mode)
          Finds local extrema in an image.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DETECT

public static final int DETECT
The detection mode.

See Also:
Constant Field Values

EXTRACT

public static final int EXTRACT
The extraction mode.

See Also:
Constant Field Values

MAXIMA

public static final int MAXIMA
The maxima type.

See Also:
Constant Field Values

MINIMA

public static final int MINIMA
The minima type.

See Also:
Constant Field Values

messenger

public final Messenger messenger
The object used for message displaying.


progressor

public final Progressor progressor
The object used for progress displaying.

Constructor Detail

Extremizer

public Extremizer()
Default constructor.

Method Detail

run

public java.util.Vector<java.util.Vector<Coordinates>> run(Image image,
                                                           int type,
                                                           int mode)
Finds local extrema in an image. A local extremum is defined as an image element whose value is either larger (maximum) or smaller (minimum) than those of all its neighboring elements. If the size of the image in the z-dimension equals 1, this method considers 8-connected neighbors in x-y space, otherwise it considers 26-connected neighbors in x-y-z space. For border elements, neighboring positions outside the image are ignored. The method searches for local extrema in every x-y(-z) subimage in a 5D image.

Parameters:
image - The input image in which local extrema are to be found.
type - The type of extrema to be found. Can be any or both (by addition) of MAXIMA or MINIMA.
mode - Determines how the found extrema are stored and returned. Can be any or both (by addition) of DETECT or EXTRACT.
Returns:
If mode includes DETECT, the image is overwritten with the detection results: local maxima are set to 255, local minima to 127, and all other elements to 0. Otherwise the image is left unaltered. If mode includes EXTRACT, a new two-element Vector of Vector<Coordinates> objects is returned, containing the coordinates of all found local maxima (element 0) and local minima (element 1). Otherwise the method returns null.
Throws:
java.lang.NullPointerException - If image is null.

ImageScience 3.0.0

Copyright (C) Erik Meijering. Permission to use this software and corresponding documentation for educational, research, and not-for-profit purposes, without a fee and without a signed licensing agreement, is granted, subject to the following terms and conditions.

IT IS NOT ALLOWED TO REDISTRIBUTE, SELL, OR LEASE THIS SOFTWARE, OR DERIVATIVE WORKS THEREOF, WITHOUT PERMISSION IN WRITING FROM THE COPYRIGHT HOLDER. THE COPYRIGHT HOLDER IS FREE TO MAKE VERSIONS OF THE SOFTWARE AVAILABLE FOR A FEE OR COMMERCIALLY ONLY.

IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, OF ANY KIND WHATSOEVER, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.

THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE EXPRESS OR IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE AND CORRESPONDING DOCUMENTATION IS PROVIDED "AS IS". THE COPYRIGHT HOLDER HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.