ij.process
Class FloatProcessor

java.lang.Object
  extended by ij.process.ImageProcessor
      extended by ij.process.FloatProcessor
Direct Known Subclasses:
FHT

public class FloatProcessor
extends ImageProcessor

This is an 32-bit floating-point image and methods that operate on that image.


Field Summary
 
Fields inherited from class ij.process.ImageProcessor
antialiasedText, baseCM, BLACK, BLACK_AND_WHITE_LUT, bLUT1, bLUT2, boldFont, CENTER_JUSTIFY, clipXMax, clipXMin, clipYMax, clipYMin, cm, cm2, cTable, cx, cy, defaultColorModel, drawingColor, font, fontMetrics, gLUT1, gLUT2, height, histogramMax, histogramMin, histogramSize, image, img, interpolate, inversionTested, invertedLut, justification, LEFT_JUSTIFY, lineWidth, lutAnimation, lutUpdateMode, maxThreshold, minThreshold, newPixels, NO_LUT_UPDATE, NO_THRESHOLD, OVER_UNDER_LUT, raster, RED_LUT, RIGHT_JUSTIFY, rLUT1, rLUT2, roiHeight, roiWidth, roiX, roiY, sampleModel, snapshotHeight, snapshotWidth, source, width, xMax, xMin, yMax, yMin
 
Constructor Summary
FloatProcessor(float[][] array)
          Creates a FloatProcessor from a float[][] array using the default LUT.
FloatProcessor(int[][] array)
          Creates a FloatProcessor from an int[][] array.
FloatProcessor(int width, int height)
          Creates a blank FloatProcessor using the default grayscale LUT that displays zero as black.
FloatProcessor(int width, int height, double[] pixels)
          Creates a FloatProcessor from a double array using the default grayscale LUT.
FloatProcessor(int width, int height, float[] pixels, java.awt.image.ColorModel cm)
          Creates a new FloatProcessor using the specified pixel array and ColorModel.
FloatProcessor(int width, int height, int[] pixels)
          Creates a FloatProcessor from an int array using the default grayscale LUT.
 
Method Summary
 void abs()
          If this is a 32-bit or signed 16-bit image, performs an absolute value transform, otherwise does nothing.
 void add(double value)
          Adds 'value' to each pixel in the image or ROI.
 void add(int value)
          Adds 'value' to each pixel in the image or ROI.
 void and(int value)
          Binary AND of each pixel in the image or ROI with 'value'.
 void applyTable(int[] lut)
          Transforms the image or ROI using a lookup table.
 void autoThreshold()
          Not implemented.
 void convolve(float[] kernel, int kernelWidth, int kernelHeight)
          Performs a convolution operation using the specified kernel.
 void convolve3x3(int[] kernel)
          3x3 convolution contributed by Glynne Casteel.
 void copyBits(ImageProcessor ip, int xloc, int yloc, int mode)
          Copies the image contained in 'ip' to (xloc, yloc) using one of the transfer modes defined in the Blitter interface.
 java.awt.Image createImage()
          Returns a copy of this image is the form of an AWT Image.
 ImageProcessor createProcessor(int width, int height)
          Returns a new, blank FloatProcessor with the specified width and height.
 ImageProcessor crop()
          Creates a new processor containing an image that corresponds to the current ROI.
 void dilate()
          Not implemented.
 void drawPixel(int x, int y)
          Draws a pixel in the current foreground color.
 ImageProcessor duplicate()
          Returns a duplicate of this image.
 void erode()
          Not implemented.
 void exp()
          Performs a exponential transform on the image or ROI.
 void fill()
          Fills the current rectangular ROI.
 void fill(ImageProcessor mask)
          Fills pixels that are within roi and part of the mask.
 void filter(int type)
          Filters using a 3x3 neighborhood.
 void findMinAndMax()
          Calculates the minimum and maximum pixel value for the entire image.
 void flipVertical()
          Flips the image or ROI vertically.
 void gamma(double value)
          Performs gamma correction of the image or ROI.
 int get(int x, int y)
          This is a faster version of getPixel() that does not do bounds checking.
 float getf(int x, int y)
           
 int[] getHistogram()
          Not implemented.
 double getInterpolatedPixel(double x, double y)
          Uses bilinear interpolation to find the pixel value at real coordinates (x,y).
 double getMax()
          Returns the largest displayed pixel value.
 double getMin()
          Returns the smallest displayed pixel value.
 int getPixel(int x, int y)
          Returns a pixel value that must be converted using Float.intBitsToFloat().
 int[] getPixel(int x, int y, int[] iArray)
          Returns the value of the pixel at (x,y) in a one element int array.
 java.lang.Object getPixels()
          Returns a reference to the float array containing this image's pixel data.
 java.lang.Object getPixelsCopy()
          Returns a reference to this image's snapshot (undo) array if it is not null and 'snapshotCopyMode' is true.
 float getPixelValue(int x, int y)
          Returns the value of the pixel at (x,y) as a float.
 void invert()
          Inverts the image or ROI.
 void log()
          Performs a log transform on the image or ROI.
 void max(double value)
          Pixels greater than 'value' are set to 'value'.
 void medianFilter()
          Not implemented.
 void min(double value)
          Pixels less than 'value' are set to 'value'.
 void multiply(double value)
          Multiplies each pixel in the image or ROI by 'value'.
 void noise(double range)
          Adds random noise to the image or ROI.
 void or(int value)
          Binary OR of each pixel in the image or ROI with 'value'.
 void putPixel(int x, int y, int value)
          Stores the specified value at (x,y).
 void putPixel(int x, int y, int[] iArray)
          Sets a pixel in the image using a one element int array.
 void putPixelValue(int x, int y, double value)
          Stores the specified real value at (x,y).
 void reset()
          Restores the pixel data from the snapshot (undo) buffer.
 void reset(ImageProcessor mask)
          Restores pixels from the snapshot buffer that are within the rectangular roi but not part of the mask.
 void resetMinAndMax()
          Recalculates the min and max values used to scale pixel values to 0-255 for display.
 ImageProcessor resize(int dstWidth, int dstHeight)
          Creates a new FloatProcessor containing a scaled copy of this image or selection.
 void rotate(double angle)
          Rotates the image or ROI 'angle' degrees clockwise.
 void scale(double xScale, double yScale)
          Scales the image or selection using the specified scale factors.
 void set(int x, int y, int value)
          This is a faster version of putPixel() that does not clip out of range values and does not do bounds checking.
 void setBackgroundValue(double value)
          Does nothing.
 void setColor(java.awt.Color color)
          Sets the foreground fill/draw color.
 void setf(int x, int y, float value)
           
 void setMinAndMax(double min, double max)
          Sets the min and max variables that control how real pixel values are mapped to 0-255 screen values.
 void setPixels(java.lang.Object pixels)
          Sets a new pixel array for the image.
 void setSnapshotPixels(java.lang.Object pixels)
          Sets a new pixel array for the snapshot (undo) buffer.
 void setThreshold(double minThreshold, double maxThreshold, int lutUpdate)
          Sets the lower and upper threshold levels.
 void setValue(double value)
          Sets the default fill/draw value.
 void snapshot()
          Makes a copy of this image's pixel data.
 void sqr()
          Performs a square transform on the image or ROI.
 void sqrt()
          Performs a square root transform on the image or ROI.
 void threshold(int level)
          Not implemented.
 void xor(int value)
          Binary exclusive OR of each pixel in the image or ROI with 'value'.
 
Methods inherited from class ij.process.ImageProcessor
addColor, addColor, addPlotString, clearPlotStrings, convertToByte, convertToFloat, convertToRGB, convertToShort, drawDot, drawDot2, drawLine, drawOval, drawPolygon, drawRect, drawString, drawString, fillOval, fillPolygon, findEdges, flipHorizontal, getAutoThreshold, getAutoThreshold, getBestIndex, getCalibrationTable, getColorModel, getColumn, getCurrentColorModel, getDefaultColorModel, getFloatArray, getFontMetrics, getHeight, getHistogramMax, getHistogramMin, getHistogramSize, getIndexSampleModel, getIntArray, getInterpolate, getInterpolatedValue, getLine, getLutUpdateMode, getMask, getMaskArray, getMaxThreshold, getMinThreshold, getRoi, getRow, getStringWidth, getWidth, hideProgress, insert, invertLut, isColorLut, isInvertedLut, isKillable, isPseudoColorLut, lineTo, makeDefaultColorModel, maskSizeError, moveTo, plotStrings, putColumn, putRow, resetBinaryThreshold, resetRoi, resetThreshold, resize, rotateLeft, rotateRight, setAntialiasedText, setCalibrationTable, setClipRect, setColor, setColorModel, setFloatArray, setFont, setHistogramRange, setHistogramSize, setIntArray, setInterpolate, setJustification, setLineWidth, setLutAnimation, setMask, setProgressBar, setRoi, setRoi, setRoi, setRoi, setSnapshotCopyMode, sharpen, showProgress, smooth, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FloatProcessor

public FloatProcessor(int width,
                      int height,
                      float[] pixels,
                      java.awt.image.ColorModel cm)
Creates a new FloatProcessor using the specified pixel array and ColorModel. Set 'cm' to null to use the default grayscale LUT.


FloatProcessor

public FloatProcessor(int width,
                      int height)
Creates a blank FloatProcessor using the default grayscale LUT that displays zero as black. Call invertLut() to display zero as white.


FloatProcessor

public FloatProcessor(int width,
                      int height,
                      int[] pixels)
Creates a FloatProcessor from an int array using the default grayscale LUT.


FloatProcessor

public FloatProcessor(int width,
                      int height,
                      double[] pixels)
Creates a FloatProcessor from a double array using the default grayscale LUT.


FloatProcessor

public FloatProcessor(float[][] array)
Creates a FloatProcessor from a float[][] array using the default LUT.


FloatProcessor

public FloatProcessor(int[][] array)
Creates a FloatProcessor from an int[][] array.

Method Detail

findMinAndMax

public void findMinAndMax()
Calculates the minimum and maximum pixel value for the entire image. Returns without doing anything if fixedScale has been set true as a result of calling setMinAndMax(). In this case, getMin() and getMax() return the fixed min and max defined by setMinAndMax(), rather than the calculated min and max.

See Also:
getMin(), getMin()

setMinAndMax

public void setMinAndMax(double min,
                         double max)
Sets the min and max variables that control how real pixel values are mapped to 0-255 screen values. Use resetMinAndMax() to enable auto-scaling;

Specified by:
setMinAndMax in class ImageProcessor
See Also:
ContrastAdjuster

resetMinAndMax

public void resetMinAndMax()
Recalculates the min and max values used to scale pixel values to 0-255 for display. This ensures that this FloatProcessor is set up to correctly display the image.

Overrides:
resetMinAndMax in class ImageProcessor

getMin

public double getMin()
Returns the smallest displayed pixel value.

Specified by:
getMin in class ImageProcessor

getMax

public double getMax()
Returns the largest displayed pixel value.

Specified by:
getMax in class ImageProcessor

createImage

public java.awt.Image createImage()
Description copied from class: ImageProcessor
Returns a copy of this image is the form of an AWT Image.

Specified by:
createImage in class ImageProcessor

createProcessor

public ImageProcessor createProcessor(int width,
                                      int height)
Returns a new, blank FloatProcessor with the specified width and height.

Specified by:
createProcessor in class ImageProcessor

snapshot

public void snapshot()
Description copied from class: ImageProcessor
Makes a copy of this image's pixel data.

Specified by:
snapshot in class ImageProcessor

reset

public void reset()
Description copied from class: ImageProcessor
Restores the pixel data from the snapshot (undo) buffer.

Specified by:
reset in class ImageProcessor

reset

public void reset(ImageProcessor mask)
Description copied from class: ImageProcessor
Restores pixels from the snapshot buffer that are within the rectangular roi but not part of the mask.

Specified by:
reset in class ImageProcessor

setSnapshotPixels

public void setSnapshotPixels(java.lang.Object pixels)
Description copied from class: ImageProcessor
Sets a new pixel array for the snapshot (undo) buffer.

Specified by:
setSnapshotPixels in class ImageProcessor

getPixel

public int getPixel(int x,
                    int y)
Returns a pixel value that must be converted using Float.intBitsToFloat().

Specified by:
getPixel in class ImageProcessor

get

public final int get(int x,
                     int y)
Description copied from class: ImageProcessor
This is a faster version of getPixel() that does not do bounds checking.

Specified by:
get in class ImageProcessor

set

public final void set(int x,
                      int y,
                      int value)
Description copied from class: ImageProcessor
This is a faster version of putPixel() that does not clip out of range values and does not do bounds checking.

Specified by:
set in class ImageProcessor

getf

public final float getf(int x,
                        int y)
Specified by:
getf in class ImageProcessor

setf

public final void setf(int x,
                       int y,
                       float value)
Specified by:
setf in class ImageProcessor

getPixel

public int[] getPixel(int x,
                      int y,
                      int[] iArray)
Returns the value of the pixel at (x,y) in a one element int array. iArray is an optiona preallocated array.

Overrides:
getPixel in class ImageProcessor

putPixel

public void putPixel(int x,
                     int y,
                     int[] iArray)
Sets a pixel in the image using a one element int array.

Overrides:
putPixel in class ImageProcessor

getInterpolatedPixel

public double getInterpolatedPixel(double x,
                                   double y)
Uses bilinear interpolation to find the pixel value at real coordinates (x,y).

Specified by:
getInterpolatedPixel in class ImageProcessor

putPixel

public void putPixel(int x,
                     int y,
                     int value)
Stores the specified value at (x,y). The value is expected to be a float that has been converted to an int using Float.floatToIntBits().

Specified by:
putPixel in class ImageProcessor

putPixelValue

public void putPixelValue(int x,
                          int y,
                          double value)
Stores the specified real value at (x,y).

Specified by:
putPixelValue in class ImageProcessor

getPixelValue

public float getPixelValue(int x,
                           int y)
Returns the value of the pixel at (x,y) as a float.

Specified by:
getPixelValue in class ImageProcessor

drawPixel

public void drawPixel(int x,
                      int y)
Draws a pixel in the current foreground color.

Specified by:
drawPixel in class ImageProcessor

getPixels

public java.lang.Object getPixels()
Returns a reference to the float array containing this image's pixel data.

Specified by:
getPixels in class ImageProcessor

getPixelsCopy

public java.lang.Object getPixelsCopy()
Returns a reference to this image's snapshot (undo) array if it is not null and 'snapshotCopyMode' is true. Otherwise, returns a copy of the pixel data.

Specified by:
getPixelsCopy in class ImageProcessor

setPixels

public void setPixels(java.lang.Object pixels)
Description copied from class: ImageProcessor
Sets a new pixel array for the image. The length of the array must be equal to width*height. Use setSnapshotPixels(null) to clear the snapshot buffer.

Specified by:
setPixels in class ImageProcessor

copyBits

public void copyBits(ImageProcessor ip,
                     int xloc,
                     int yloc,
                     int mode)
Copies the image contained in 'ip' to (xloc, yloc) using one of the transfer modes defined in the Blitter interface.

Specified by:
copyBits in class ImageProcessor

applyTable

public void applyTable(int[] lut)
Description copied from class: ImageProcessor
Transforms the image or ROI using a lookup table. The length of the table must be 256 for byte images and 65536 for short images. RGB and float images are not supported.

Specified by:
applyTable in class ImageProcessor

invert

public void invert()
Description copied from class: ImageProcessor
Inverts the image or ROI.

Overrides:
invert in class ImageProcessor

add

public void add(int value)
Description copied from class: ImageProcessor
Adds 'value' to each pixel in the image or ROI.

Overrides:
add in class ImageProcessor

add

public void add(double value)
Description copied from class: ImageProcessor
Adds 'value' to each pixel in the image or ROI.

Overrides:
add in class ImageProcessor

multiply

public void multiply(double value)
Description copied from class: ImageProcessor
Multiplies each pixel in the image or ROI by 'value'.

Overrides:
multiply in class ImageProcessor

and

public void and(int value)
Description copied from class: ImageProcessor
Binary AND of each pixel in the image or ROI with 'value'.

Overrides:
and in class ImageProcessor

or

public void or(int value)
Description copied from class: ImageProcessor
Binary OR of each pixel in the image or ROI with 'value'.

Overrides:
or in class ImageProcessor

xor

public void xor(int value)
Description copied from class: ImageProcessor
Binary exclusive OR of each pixel in the image or ROI with 'value'.

Overrides:
xor in class ImageProcessor

gamma

public void gamma(double value)
Description copied from class: ImageProcessor
Performs gamma correction of the image or ROI.

Overrides:
gamma in class ImageProcessor

log

public void log()
Description copied from class: ImageProcessor
Performs a log transform on the image or ROI.

Overrides:
log in class ImageProcessor

exp

public void exp()
Description copied from class: ImageProcessor
Performs a exponential transform on the image or ROI.

Overrides:
exp in class ImageProcessor

sqr

public void sqr()
Description copied from class: ImageProcessor
Performs a square transform on the image or ROI.

Overrides:
sqr in class ImageProcessor

sqrt

public void sqrt()
Description copied from class: ImageProcessor
Performs a square root transform on the image or ROI.

Overrides:
sqrt in class ImageProcessor

abs

public void abs()
Description copied from class: ImageProcessor
If this is a 32-bit or signed 16-bit image, performs an absolute value transform, otherwise does nothing.

Overrides:
abs in class ImageProcessor

min

public void min(double value)
Description copied from class: ImageProcessor
Pixels less than 'value' are set to 'value'.

Overrides:
min in class ImageProcessor

max

public void max(double value)
Description copied from class: ImageProcessor
Pixels greater than 'value' are set to 'value'.

Overrides:
max in class ImageProcessor

fill

public void fill()
Fills the current rectangular ROI.

Overrides:
fill in class ImageProcessor

fill

public void fill(ImageProcessor mask)
Fills pixels that are within roi and part of the mask. Does nothing if the mask is not the same as the the ROI.

Specified by:
fill in class ImageProcessor

convolve3x3

public void convolve3x3(int[] kernel)
3x3 convolution contributed by Glynne Casteel.

Specified by:
convolve3x3 in class ImageProcessor

filter

public void filter(int type)
Filters using a 3x3 neighborhood.

Specified by:
filter in class ImageProcessor

rotate

public void rotate(double angle)
Rotates the image or ROI 'angle' degrees clockwise.

Specified by:
rotate in class ImageProcessor
See Also:
ImageProcessor.setInterpolate(boolean)

flipVertical

public void flipVertical()
Description copied from class: ImageProcessor
Flips the image or ROI vertically.

Specified by:
flipVertical in class ImageProcessor

noise

public void noise(double range)
Description copied from class: ImageProcessor
Adds random noise to the image or ROI.

Specified by:
noise in class ImageProcessor
Parameters:
range - the range of random numbers

crop

public ImageProcessor crop()
Description copied from class: ImageProcessor
Creates a new processor containing an image that corresponds to the current ROI.

Specified by:
crop in class ImageProcessor

duplicate

public ImageProcessor duplicate()
Returns a duplicate of this image.

Specified by:
duplicate in class ImageProcessor

scale

public void scale(double xScale,
                  double yScale)
Scales the image or selection using the specified scale factors.

Specified by:
scale in class ImageProcessor
See Also:
ImageProcessor.setInterpolate(boolean)

resize

public ImageProcessor resize(int dstWidth,
                             int dstHeight)
Creates a new FloatProcessor containing a scaled copy of this image or selection.

Specified by:
resize in class ImageProcessor
See Also:
ImageProcessor.setInterpolate(boolean)

setColor

public void setColor(java.awt.Color color)
Sets the foreground fill/draw color.

Specified by:
setColor in class ImageProcessor

setValue

public void setValue(double value)
Sets the default fill/draw value.

Specified by:
setValue in class ImageProcessor

setBackgroundValue

public void setBackgroundValue(double value)
Does nothing. The rotate() and scale() methods always zero fill.

Specified by:
setBackgroundValue in class ImageProcessor

setThreshold

public void setThreshold(double minThreshold,
                         double maxThreshold,
                         int lutUpdate)
Description copied from class: ImageProcessor
Sets the lower and upper threshold levels. The 'lutUpdate' argument can be RED_LUT, BLACK_AND_WHITE_LUT, OVER_UNDER_LUT or NO_LUT_UPDATE. Thresholding of RGB images is not supported.

Overrides:
setThreshold in class ImageProcessor

convolve

public void convolve(float[] kernel,
                     int kernelWidth,
                     int kernelHeight)
Performs a convolution operation using the specified kernel.

Specified by:
convolve in class ImageProcessor

threshold

public void threshold(int level)
Not implemented.

Specified by:
threshold in class ImageProcessor

autoThreshold

public void autoThreshold()
Not implemented.

Overrides:
autoThreshold in class ImageProcessor

medianFilter

public void medianFilter()
Not implemented.

Specified by:
medianFilter in class ImageProcessor

getHistogram

public int[] getHistogram()
Not implemented.

Specified by:
getHistogram in class ImageProcessor

erode

public void erode()
Not implemented.

Specified by:
erode in class ImageProcessor

dilate

public void dilate()
Not implemented.

Specified by:
dilate in class ImageProcessor