ij.process
Class FloatProcessor

java.lang.Object
  ij.process.ImageProcessor
      ij.process.FloatProcessor

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

baseCM, BLACK, BLACK_AND_WHITE_LUT, bLUT1, bLUT2, cm, cTable, cx, cy, font, fontMetrics, gLUT1, gLUT2, height, histogramSize, imageSource, interpolate, inversionTested, invertedLut, lineWidth, lutAnimation, maxThreshold, minThreshold, NO_LUT_UPDATE, NO_THRESHOLD, RED_LUT, rLUT1, rLUT2, roiHeight, roiWidth, roiX, roiY, snapshotHeight, snapshotWidth, width, xMax, xMin, yMax, yMin

Constructor Summary

FloatProcessor(int width, int height)
Creates a blank FloatProcessor using the default grayscale LUT that displays zero as black.

FloatProcessor(int width, int height, float[] pixels, java.awt.image.ColorModel cm)
Creates a new FloatProcessor using the specified pixel array and ColorModel.

Method Summary

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() For byte images, converts to binary using an automatically determined threshold.
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() Dilates the image or ROI using a 3x3 minimum filter.
void	drawPixel(int x, int y) Draws a pixel in the current foreground color.
void	erode() Erodes the image or ROI using a 3x3 maximum filter.
void	fill() Fills the current rectangular ROI.
void	fill(int[] 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	gamma(double value) Performs gamma correction of the image or ROI.
int[]	getHistogram() Returns the histogram of the image or ROI.
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().
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.
float	getPixelValue(int x, int y) Returns the value of the pixel at (x,y).
void	invert() Inverts the image or ROI.
void	log() Performs a log transform on the image or ROI.
void	medianFilter() A 3x3 median filter.
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	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(int[] mask) Restore pixels that are within 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	setColor(java.awt.Color color) Sets the foreground fill/draw color.
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 and resets the snapshot 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	threshold(int level)
void	xor(int value) Binary exclusive OR of each pixel in the image or ROI with 'value'.

Methods inherited from class ij.process.ImageProcessor

convertToByte, convertToFloat, convertToRGB, convertToShort, drawDot, drawDot2, drawString, duplicate, findEdges, flipHorizontal, flipVertical, getBestIndex, getColorModel, getColumn, getHeight, getHistogramSize, getImageSource, getLine, getMask, getMaxThreshold, getMinThreshold, getRoi, getRow, getStringWidth, getWidth, hideProgress, insert, invertLut, isInvertedLut, isKillable, lineTo, makeDefaultColorModel, moveTo, putColumn, putRow, rotateLeft, rotateRight, setCalibrationTable, setColor, setColorModel, setFont, setHistogramSize, setInterpolate, setLineWidth, setLutAnimation, setMask, setProgressBar, setRoi, setRoi, 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.

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(int[] mask)

Description copied from class: ImageProcessor

Restore pixels that are within roi but not part of the mask.

Specified by:

reset 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

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)

Description copied from class: ImageProcessor

Returns the value of the pixel at (x,y). For byte and short images, returns a calibrated value if a calibration table has been set using setCalibraionTable(). For RGB images, returns the luminance value.

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()

Description copied from class: ImageProcessor

Returns a reference to this image's snapshot (undo) array. If the snapshot array is null, returns a copy of the pixel data. The array type varies depending on the image type.

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 and resets the snapshot buffer. The length of the array must be equal to width*height.

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

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

fill

public void fill()

Fills the current rectangular ROI.

Overrides:

fill in class ImageProcessor

fill

public void fill(int[] mask)

Fills pixels that are within roi and part of the mask.

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)

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

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

setThreshold

public void setThreshold(double minThreshold,
                         double maxThreshold,
                         int lutUpdate)

Description copied from class: ImageProcessor

Sets the lower and upper threshold levels. If 'lutUdate' is true, recalculates the LUT. Thresholding of RGB images is not supported.

Overrides:

setThreshold in class ImageProcessor

threshold

public void threshold(int level)

autoThreshold

public void autoThreshold()

Description copied from class: ImageProcessor

For byte images, converts to binary using an automatically determined threshold. For RGB images, converts each channel to binary. For short and float images, does nothing.

Specified by:

autoThreshold in class ImageProcessor

medianFilter

public void medianFilter()

Description copied from class: ImageProcessor

A 3x3 median filter.

Specified by:

medianFilter in class ImageProcessor

getHistogram

public int[] getHistogram()

Description copied from class: ImageProcessor

Returns the histogram of the image or ROI. Returns a luminosity histogram for RGB images and null for float images.

Specified by:

getHistogram in class ImageProcessor

erode

public void erode()

Description copied from class: ImageProcessor

Erodes the image or ROI using a 3x3 maximum filter.

Specified by:

erode in class ImageProcessor

dilate

public void dilate()

Description copied from class: ImageProcessor

Dilates the image or ROI using a 3x3 minimum filter.

Specified by:

dilate in class ImageProcessor