Inheritance diagram for ImageProcessor:

Public Member Functions
int	getWidth ()

int	getHeight ()

ColorModel	getColorModel ()

void	setColorModel (ColorModel cm)

void	invertLut ()

int	getBestIndex (Color c)

boolean	isInvertedLut ()

boolean	isColorLut ()

boolean	isPseudoColorLut ()

abstract void	setColor (Color color)

void	setColor (int value)

abstract void	setValue (double value)

abstract double	getMin ()

abstract double	getMax ()

abstract void	setMinAndMax (double min, double max)

void	resetMinAndMax ()

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

void	resetThreshold ()

double	getMinThreshold ()

double	getMaxThreshold ()

void	setRoi (Rectangle roi)

void	setRoi (int x, int y, int rwidth, int rheight)

void	setRoi (ij.gui.Roi roi)

void	setRoi (Polygon roi)

void	resetRoi ()

Rectangle	getRoi ()

void	setMask (ImageProcessor mask)

ImageProcessor	getMask ()

byte[]	getMaskArray ()

void	setProgressBar (ProgressBar pb)

void	setInterpolate (boolean interpolate)

boolean	getInterpolate ()

boolean	isKillable ()

double[]	getLine (double x1, double y1, double x2, double y2)

void	getRow (int x, int y, int[] data, int length)

void	getColumn (int x, int y, int[] data, int length)

void	putRow (int x, int y, int[] data, int length)

void	putColumn (int x, int y, int[] data, int length)

void	moveTo (int x, int y)

void	setLineWidth (int width)

void	lineTo (int x2, int y2)

void	drawLine (int x1, int y1, int x2, int y2)

void	drawRect (int x, int y, int width, int height)

void	drawPolygon (Polygon p)

void	fillPolygon (Polygon p)

void	drawDot2 (int x, int y)

void	drawDot (int xcenter, int ycenter)

void	drawString (String s)

void	drawString (String s, int x, int y)

void	setJustification (int justification)

void	setFont (Font font)

void	setAntialiasedText (boolean antialiasedText)

int	getStringWidth (String s)

FontMetrics	getFontMetrics ()

void	smooth ()

void	sharpen ()

void	findEdges ()

abstract void	flipVertical ()

void	flipHorizontal ()

ImageProcessor	rotateRight ()

ImageProcessor	rotateLeft ()

void	insert (ImageProcessor ip, int xloc, int yloc)

String	toString ()

void	fill ()

abstract void	fill (ImageProcessor mask)

void	setCalibrationTable (float[] cTable)

void	setHistogramSize (int size)

int	getHistogramSize ()

void	setHistogramRange (double histMin, double histMax)

double	getHistogramMin ()

double	getHistogramMax ()

abstract Object	getPixels ()

abstract Object	getPixelsCopy ()

abstract int	getPixel (int x, int y)

int[]	getPixel (int x, int y, int[] iArray)

void	putPixel (int x, int y, int[] iArray)

abstract double	getInterpolatedPixel (double x, double y)

double	getInterpolatedValue (double x, double y)

abstract void	putPixel (int x, int y, int value)

abstract float	getPixelValue (int x, int y)

abstract void	putPixelValue (int x, int y, double value)

abstract void	drawPixel (int x, int y)

abstract void	setPixels (Object pixels)

abstract void	copyBits (ImageProcessor ip, int xloc, int yloc, int mode)

abstract void	applyTable (int[] lut)

void	invert ()

void	add (int value)

void	add (double value)

void	multiply (double value)

void	and (int value)

void	or (int value)

void	xor (int value)

void	gamma (double value)

void	log ()

void	sqr ()

void	sqrt ()

void	min (double value)

void	max (double value)

abstract Image	createImage ()

abstract ImageProcessor	createProcessor (int width, int height)

abstract void	snapshot ()

abstract void	reset ()

abstract void	reset (ImageProcessor mask)

abstract void	convolve3x3 (int[] kernel)

abstract void	filter (int type)

abstract void	medianFilter ()

abstract void	noise (double range)

abstract ImageProcessor	crop ()

abstract void	threshold (int level)

ImageProcessor	duplicate ()

abstract void	scale (double xScale, double yScale)

abstract ImageProcessor	resize (int dstWidth, int dstHeight)

abstract void	rotate (double angle)

abstract int[]	getHistogram ()

abstract void	erode ()

abstract void	dilate ()

void	setLutAnimation (boolean lutAnimation)

ImageProcessor	convertToByte (boolean doScaling)

ImageProcessor	convertToShort (boolean doScaling)

ImageProcessor	convertToFloat ()

ImageProcessor	convertToRGB ()

abstract void	convolve (float[] kernel, int kernelWidth, int kernelHeight)

void	autoThreshold ()

int	getAutoThreshold ()

int	getAutoThreshold (int[] histogram)

void	setClipRect (Rectangle clipRect)

Static Public Attributes
static final int	BLACK = 0xFF000000

static final double	NO_THRESHOLD = -808080.0

static final int	LEFT_JUSTIFY = 0

static final int	CENTER_JUSTIFY = 1

static final int	RIGHT_JUSTIFY = 2

static final int	RED_LUT =0

Protected Member Functions
void	showProgress (double percentDone)

void	hideProgress ()

void	makeDefaultColorModel ()

String	maskSizeError (ImageProcessor mask)

Protected Attributes
int	lineWidth = 1

int	cx

Font	font

FontMetrics	fontMetrics

boolean	antialiasedText

boolean	boldFont

int	width

int	height

int	roiX

int	xMin

ColorModel	baseCM

ColorModel	cm

byte[]	rLUT1

byte[]	rLUT2

boolean	interpolate

double	minThreshold =NO_THRESHOLD

int	histogramSize = 256

double	histogramMin

float[]	cTable

boolean	lutAnimation

MemoryImageSource	source

Image	img

boolean	newPixels

Color	drawingColor = Color.black

int	clipXMin

int	justification = LEFT_JUSTIFY

boolean	inversionTested = false

boolean	invertedLut

Detailed Description

This abstract class is the superclass for classes that process the four data types (byte, short, float and RGB) supported by ImageJ.

See Also: ByteProcessor; ShortProcessor; FloatProcessor; ColorProcessor

Definition at line 18 of file ImageProcessor.java.

Member Function Documentation

void add ( int value )

inline

Adds 'value' to each pixel in the image or ROI.

Definition at line 1126 of file ImageProcessor.java.

void add ( double value )

inline

Adds 'value' to each pixel in the image or ROI.

Definition at line 1129 of file ImageProcessor.java.

void and ( int value )

inline

Binary AND of each pixel in the image or ROI with 'value'.

Definition at line 1135 of file ImageProcessor.java.

abstract void applyTable ( int[] lut )

pure virtual

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.

Implemented in ColorProcessor, ByteProcessor, ShortProcessor, and FloatProcessor.

void autoThreshold ( )

inline

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

Definition at line 1293 of file ImageProcessor.java.

ImageProcessor convertToByte ( boolean doScaling )

inline

Returns an 8-bit version of this image as a ByteProcessor.

Definition at line 1259 of file ImageProcessor.java.

ImageProcessor convertToFloat ( )

inline

Returns a 32-bit float version of this image as a FloatProcessor. For byte and short images, converts using a calibration function if a calibration table has been set using setCalibrationTable().

Definition at line 1273 of file ImageProcessor.java.

ImageProcessor convertToRGB ( )

inline

Returns an RGB version of this image as a ColorProcessor.

Definition at line 1279 of file ImageProcessor.java.

ImageProcessor convertToShort ( boolean doScaling )

inline

Returns a 16-bit version of this image as a ShortProcessor.

Definition at line 1265 of file ImageProcessor.java.

abstract void convolve	(	float[]	kernel,
		int	kernelWidth,
		int	kernelHeight
	)

pure virtual

Performs a convolution operation using the specified kernel.

KernelWidth and kernelHeight must be odd.

Implemented in ColorProcessor, ByteProcessor, ShortProcessor, and FloatProcessor.

abstract void convolve3x3 ( int[] kernel )

pure virtual

Convolves the image or ROI with the specified 3x3 integer convolution kernel.

Implemented in ColorProcessor, ShortProcessor, FloatProcessor, and ByteProcessor.

abstract void copyBits	(	ImageProcessor	ip,
		int	xloc,
		int	yloc,
		int	mode
	)

pure virtual

Copies the image contained in 'ip' to (xloc, yloc) using one of the transfer modes defined in the Blitter interface.

Implemented in ColorProcessor, ByteProcessor, ShortProcessor, and FloatProcessor.

abstract Image createImage ( )

pure virtual

Returns a copy of this image is the form of an AWT Image.

Implemented in FloatProcessor, ShortProcessor, ColorProcessor, and ByteProcessor.

abstract ImageProcessor createProcessor	(	int	width,
		int	height
	)

pure virtual

Returns a new, blank processor with the specified width and height.

Implemented in FloatProcessor, ShortProcessor, ColorProcessor, and ByteProcessor.

abstract ImageProcessor crop ( )

pure virtual

Creates a new processor containing an image that corresponds to the current ROI.

Implemented in ShortProcessor, ColorProcessor, FloatProcessor, and ByteProcessor.

abstract void dilate ( )

pure virtual

Dilates the image or ROI using a 3x3 minimum filter. Requires 8-bit or RGB image.

Implemented in ShortProcessor, FloatProcessor, ColorProcessor, and ByteProcessor.

void drawDot	(	int	xcenter,
		int	ycenter
	)

inline

Draws a dot using the current line width and fill/draw value.

Definition at line 771 of file ImageProcessor.java.

void drawDot2	(	int	x,
		int	y
	)

inline

Obsolete

Definition at line 763 of file ImageProcessor.java.

void drawLine	(	int	x1,
		int	y1,
		int	x2,
		int	y2
	)

inline

Draws a line from (x1,y1) to (x2,y2).

Definition at line 731 of file ImageProcessor.java.

abstract void drawPixel	(	int	x,
		int	y
	)

pure virtual

Sets the pixel at (x,y) to the current fill/draw value.

Implemented in ColorProcessor, FloatProcessor, ShortProcessor, and ByteProcessor.

void drawPolygon ( Polygon p )

inline

Draws a polygon.

Definition at line 748 of file ImageProcessor.java.

void drawRect	(	int	x,
		int	y,
		int	width,
		int	height
	)

inline

Draws a rectangle.

Definition at line 737 of file ImageProcessor.java.

void drawString ( String s )

inline

Draws a string at the current location using the current fill/draw value.

Definition at line 795 of file ImageProcessor.java.

void drawString	(	String	s,
		int	x,
		int	y
	)

inline

Draws a string at the specified location using the current fill/draw value.

Definition at line 860 of file ImageProcessor.java.

ImageProcessor duplicate ( )

inline

Returns a duplicate of this image.

Definition at line 1201 of file ImageProcessor.java.

abstract void erode ( )

pure virtual

Erodes the image or ROI using a 3x3 maximum filter. Requires 8-bit or RGB image.

Implemented in ShortProcessor, FloatProcessor, ColorProcessor, and ByteProcessor.

void fill ( )

inline

Fills the image or ROI with the current fill/draw value.

Definition at line 1000 of file ImageProcessor.java.

abstract void fill ( ImageProcessor mask )

pure virtual

Fills pixels that are within the ROI and part of the mask (i.e. pixels that have a value=BLACK in the mask array). Throws and IllegalArgumentException if the mask is null or the size of the mask is not the same as the size of the ROI.

Implemented in ShortProcessor, FloatProcessor, ColorProcessor, and ByteProcessor.

void fillPolygon ( Polygon p )

inline

Fills a polygon.

Definition at line 756 of file ImageProcessor.java.

abstract void filter ( int type )

pure virtual

A 3x3 filter operation, where the argument (BLUR_MORE, FIND_EDGES, etc.) determines the filter type.

Implemented in ColorProcessor, ShortProcessor, FloatProcessor, and ByteProcessor.

void findEdges ( )

inline

Finds edges in the image or ROI using a Sobel operator.

Definition at line 924 of file ImageProcessor.java.

void flipHorizontal ( )

inline

Flips the image or ROI horizontally.

Definition at line 945 of file ImageProcessor.java.

abstract void flipVertical ( )

pure virtual

Flips the image or ROI vertically.

Implemented in ColorProcessor, ByteProcessor, ShortProcessor, and FloatProcessor.

void gamma ( double value )

inline

Performs gamma correction of the image or ROI.

Definition at line 1144 of file ImageProcessor.java.

int getAutoThreshold ( )

inline

Returns a pixel value (threshold) that can be used to divide the image into objects and background. It does this by taking a test threshold and computing the average of the pixels at or below the threshold and pixels above. It then computes the average of those two, increments the threshold, and repeats the process. Incrementing stops when the threshold is larger than the composite average. That is, threshold = (average background + average objects)/2. This description was posted to the ImageJ mailing list by Jordan Bevic.

Definition at line 1304 of file ImageProcessor.java.

int getAutoThreshold ( int[] histogram )

inline

This is a version of getAutoThreshold() that uses a histogram passed as an argument.

Definition at line 1309 of file ImageProcessor.java.

int getBestIndex ( Color c )

inline

Returns the LUT index that's the best match for this color.

Definition at line 157 of file ImageProcessor.java.

ColorModel getColorModel ( )

inline

Returns this processor's color model. For non-RGB processors, this is the base lookup table (LUT), not the one that may have been modified by setMinAndMax() or setThreshold().

Definition at line 97 of file ImageProcessor.java.

void getColumn	(	int	x,
		int	y,
		int[]	data,
		int	length
	)

inline

Returns the pixel values down the column starting at (x,y).

Definition at line 667 of file ImageProcessor.java.

FontMetrics getFontMetrics ( )

inline

Returns the current FontMetrics.

Definition at line 902 of file ImageProcessor.java.

int getHeight ( )

inline

Returns the height of this image in pixels.

Definition at line 90 of file ImageProcessor.java.

abstract int [] getHistogram ( )

pure virtual

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

Implemented in ColorProcessor, ShortProcessor, ByteProcessor, and FloatProcessor.

double getHistogramMax ( )

inline

Returns the maximum histogram value used for histograms of float images.

Definition at line 1046 of file ImageProcessor.java.

double getHistogramMin ( )

inline

Returns the minimum histogram value used for histograms of float images.

Definition at line 1041 of file ImageProcessor.java.

int getHistogramSize ( )

inline

Returns the number of float image histogram bins. The bin count is fixed at 256 for the other three data types.

Definition at line 1025 of file ImageProcessor.java.

boolean getInterpolate ( )

inline

Returns the value of the interpolate field.

Definition at line 549 of file ImageProcessor.java.

abstract double getInterpolatedPixel	(	double	x,
		double	y
	)

pure virtual

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

Implemented in ColorProcessor, FloatProcessor, ShortProcessor, and ByteProcessor.

double getInterpolatedValue	(	double	x,
		double	y
	)

inline

For color and float images, this is the same as getInterpolatedPixel().

Definition at line 1086 of file ImageProcessor.java.

double [] getLine	(	double	x1,
		double	y1,
		double	x2,
		double	y2
	)

inline

Returns an array containing the pixel values along the line starting at (x1,y1) and ending at (x2,y2). For byte and short images, returns calibrated values if a calibration table has been set using setCalibrationTable().

See Also: ImageProcessor::setInterpolate

Definition at line 632 of file ImageProcessor.java.

ImageProcessor getMask ( )

inline

For images with irregular ROIs, returns a mask, otherwise, returns null. Pixels outside the mask have a value of zero.

Definition at line 527 of file ImageProcessor.java.

byte [] getMaskArray ( )

inline

Returns the mask byte array, or null if there is no mask.

Definition at line 532 of file ImageProcessor.java.

abstract double getMax ( )

pure virtual

Returns the largest displayed pixel value.

Implemented in ByteProcessor, ShortProcessor, FloatProcessor, and ColorProcessor.

double getMaxThreshold ( )

inline

Returns the upper threshold level.

Definition at line 396 of file ImageProcessor.java.

abstract double getMin ( )

pure virtual

Returns the smallest displayed pixel value.

Implemented in ByteProcessor, ShortProcessor, FloatProcessor, and ColorProcessor.

double getMinThreshold ( )

inline

Returns the lower threshold level. Returns NO_THRESHOLD if thresholding is not enabled.

Definition at line 391 of file ImageProcessor.java.

abstract int getPixel	(	int	x,
		int	y
	)

pure virtual

Returns the value of the pixel at (x,y). For RGB images, the argb values are packed in an int. For float images, the the value must be converted using Float.intBitsToFloat(). Returns zero if either the x or y coodinate is out of range.

Implemented in ColorProcessor, FloatProcessor, ShortProcessor, and ByteProcessor.

int [] getPixel	(	int	x,
		int	y,
		int[]	iArray
	)

inline

Returns the samples for the pixel at (x,y) in an int array. RGB pixels have three samples, all others have one. Returns zeros if the the coordinates are not in bounds. iArray is an optional preallocated array.

Definition at line 1070 of file ImageProcessor.java.

abstract Object getPixels ( )

pure virtual

Returns a reference to this image's pixel array. The array type (byte[], short[], float[] or int[]) varies depending on the image type.

Implemented in ColorProcessor, ShortProcessor, FloatProcessor, and ByteProcessor.

abstract Object getPixelsCopy ( )

pure virtual

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.

Implemented in ShortProcessor, FloatProcessor, ByteProcessor, and ColorProcessor.

abstract float getPixelValue	(	int	x,
		int	y
	)

pure virtual

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.

Implemented in ColorProcessor, ShortProcessor, FloatProcessor, and ByteProcessor.

Rectangle getRoi ( )

inline

Returns a Rectangle that represents the current region of interest.

Definition at line 514 of file ImageProcessor.java.

void getRow	(	int	x,
		int	y,
		int[]	data,
		int	length
	)

inline

Returns the pixel values along the horizontal line starting at (x,y).

Definition at line 661 of file ImageProcessor.java.

int getStringWidth ( String s )

inline

Returns the width in pixels of the specified string.

Definition at line 888 of file ImageProcessor.java.

int getWidth ( )

inline

Returns the width of this image in pixels.

Definition at line 85 of file ImageProcessor.java.

void insert	(	ImageProcessor	ip,
		int	xloc,
		int	yloc
	)

inline

Inserts the image contained in 'ip' at (xloc, yloc).

Definition at line 990 of file ImageProcessor.java.

void invert ( )

inline

Inverts the image or ROI.

Definition at line 1123 of file ImageProcessor.java.

void invertLut ( )

inline

Inverts the values in this image's LUT (indexed color model). Does nothing if this is a ColorProcessor.

Definition at line 133 of file ImageProcessor.java.

boolean isColorLut ( )

inline

Returns true if this image uses a color LUT.

Definition at line 214 of file ImageProcessor.java.

boolean isInvertedLut ( )

inline

Returns true if this image uses an inverted LUT.

Definition at line 193 of file ImageProcessor.java.

boolean isKillable ( )

inline

Obsolete.

Definition at line 554 of file ImageProcessor.java.

boolean isPseudoColorLut ( )

inline

Returns true if this image uses a pseudocolor or grayscale LUT, in other words, is this an image that can be filtered.

Definition at line 238 of file ImageProcessor.java.

void lineTo	(	int	x2,
		int	y2
	)

inline

Draws a line from the current drawing location to (x,y).

Definition at line 706 of file ImageProcessor.java.

void log ( )

inline

Performs a log transform on the image or ROI.

Definition at line 1147 of file ImageProcessor.java.

void max ( double value )

inline

Pixels greater than 'value' are set to 'value'.

Definition at line 1159 of file ImageProcessor.java.

abstract void medianFilter ( )

pure virtual

A 3x3 median filter. Requires 8-bit or RGB image.

Implemented in ShortProcessor, FloatProcessor, ColorProcessor, and ByteProcessor.

void min ( double value )

inline

Pixels less than 'value' are set to 'value'.

Definition at line 1156 of file ImageProcessor.java.

void moveTo	(	int	x,
		int	y
	)

inline

Sets the current drawing location.

See Also: ImageProcessor::lineTo; ImageProcessor::drawString

Definition at line 694 of file ImageProcessor.java.

void multiply ( double value )

inline

Multiplies each pixel in the image or ROI by 'value'.

Definition at line 1132 of file ImageProcessor.java.

abstract void noise ( double range )

pure virtual

Adds random noise to the image or ROI.

Parameters

range the range of random numbers

Implemented in ShortProcessor, FloatProcessor, ByteProcessor, and ColorProcessor.

void or ( int value )

inline

Binary OR of each pixel in the image or ROI with 'value'.

Definition at line 1138 of file ImageProcessor.java.

void putColumn	(	int	x,
		int	y,
		int[]	data,
		int	length
	)

inline

Inserts the pixels contained in 'data' into a column starting at (x,y).

Definition at line 681 of file ImageProcessor.java.

void putPixel	(	int	x,
		int	y,
		int[]	iArray
	)

inline

Sets a pixel in the image using an int array of samples. RGB pixels have three samples, all others have one.

Definition at line 1078 of file ImageProcessor.java.

abstract void putPixel	(	int	x,
		int	y,
		int	value
	)

pure virtual

Stores the specified value at (x,y). For RGB images, the argb values are packed in 'value'. For float images, 'value' is expected to be a float converted to an int using Float.floatToIntBits().

Implemented in ColorProcessor, ByteProcessor, FloatProcessor, and ShortProcessor.

abstract void putPixelValue	(	int	x,
		int	y,
		double	value
	)

pure virtual

Stores the specified value at (x,y).

Implemented in ColorProcessor, FloatProcessor, ShortProcessor, and ByteProcessor.

void putRow	(	int	x,
		int	y,
		int[]	data,
		int	length
	)

inline

Inserts the pixels contained in 'data' into a horizontal line starting at (x,y).

Definition at line 674 of file ImageProcessor.java.

abstract void reset ( )

pure virtual

Restores the pixel data from the snapshot (undo) buffer.

Implemented in FloatProcessor, ColorProcessor, ShortProcessor, and ByteProcessor.

abstract void reset ( ImageProcessor mask )

pure virtual

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

Implemented in FloatProcessor, ColorProcessor, ShortProcessor, and ByteProcessor.

void resetMinAndMax ( )

inline

For short and float images, recalculates the min and max image values needed to correctly display the image. For ByteProcessors, resets the LUT.

Definition at line 300 of file ImageProcessor.java.

void resetRoi ( )

inline

Sets the ROI (Region of Interest) and clipping rectangle to the entire image.

Definition at line 505 of file ImageProcessor.java.

void resetThreshold ( )

inline

Disables thresholding.

Definition at line 378 of file ImageProcessor.java.

abstract ImageProcessor resize	(	int	dstWidth,
		int	dstHeight
	)

pure virtual

Creates a new ImageProcessor containing a scaled copy of this image or ROI.

See Also: ij.process.ImageProcessor::setInterpolate

Implemented in ColorProcessor, ShortProcessor, FloatProcessor, and ByteProcessor.

abstract void rotate ( double angle )

pure virtual

Rotates the image or selection 'angle' degrees clockwise.

See Also: ImageProcessor::setInterpolate

Implemented in ColorProcessor, ByteProcessor, ShortProcessor, and FloatProcessor.

ImageProcessor rotateLeft ( )

inline

Rotates the entire image 90 degrees counter-clockwise. Returns a new ImageProcessor that represents the rotated image.

Definition at line 973 of file ImageProcessor.java.

ImageProcessor rotateRight ( )

inline

Rotates the entire image 90 degrees clockwise. Returns a new ImageProcessor that represents the rotated image.

Definition at line 959 of file ImageProcessor.java.

abstract void scale	(	double	xScale,
		double	yScale
	)

pure virtual

Scales the image by the specified factors. Does not change the image size.

See Also: ImageProcessor::setInterpolate; ImageProcessor::resize

Implemented in ShortProcessor, FloatProcessor, ByteProcessor, and ColorProcessor.

void setAntialiasedText ( boolean antialiasedText )

inline

Specifies whether or not text is drawn using antialiasing. Antialiased test requires Java 2 and an 8 bit or RGB image.

Definition at line 880 of file ImageProcessor.java.

void setCalibrationTable ( float[] cTable )

inline

Set a lookup table used by getPixelValue(), getLine() and convertToFloat() to calibrate pixel values. The length of the table must be 256 for byte images and 65536 for short images. RGB and float processors do not do calibration.

Definition at line 1014 of file ImageProcessor.java.

void setClipRect ( Rectangle clipRect )

inline

Updates the clipping rectangle used by lineTo(), drawLine(), drawDot() and drawPixel(). The clipping rectangle is reset by passing a null argument or by calling resetRoi().

Definition at line 1352 of file ImageProcessor.java.

abstract void setColor ( Color color )

pure virtual

Sets the default fill/draw value to the pixel value closest to the specified color.

Implemented in ShortProcessor, FloatProcessor, ByteProcessor, and ColorProcessor.

void setColor ( int value )

inline

Obsolete (use setValue)

Definition at line 277 of file ImageProcessor.java.

void setColorModel ( ColorModel cm )

inline

Sets the color model. Must be an IndexColorModel (aka LUT) for all processors except the ColorProcessor.

Definition at line 108 of file ImageProcessor.java.

void setFont ( Font font )

inline

Sets the font used by drawString().

Definition at line 872 of file ImageProcessor.java.

void setHistogramRange	(	double	histMin,
		double	histMax
	)

inline

Set the range used for histograms of float images. The image range is used if both histMin and histMax are zero.

Definition at line 1031 of file ImageProcessor.java.

void setHistogramSize ( int size )

inline

Set the number of bins to be used for histograms of float images.

Definition at line 1019 of file ImageProcessor.java.

void setInterpolate ( boolean interpolate )

inline

Setting 'interpolate' true causes scale(), resize(), rotate() and getLine() to do bilinear interpolation.

Definition at line 544 of file ImageProcessor.java.

void setJustification ( int justification )

inline

Sets the justification used by drawString(), where justification is CENTER_JUSTIFY, RIGHT_JUSTIFY or LEFT_JUSTIFY. The default is LEFT_JUSTIFY.

Definition at line 867 of file ImageProcessor.java.

void setLineWidth ( int width )

inline

Sets the line width used by lineTo() and drawDot().

Definition at line 700 of file ImageProcessor.java.

void setLutAnimation ( boolean lutAnimation )

inline

For 16 and 32 bit processors, set 'lutAnimation' true to have createImage() use the cached 8-bit version of the image.

Definition at line 1242 of file ImageProcessor.java.

void setMask ( ImageProcessor mask )

inline

Defines a byte mask that limits processing to an irregular ROI. Background pixels in the mask have a value of zero.

Definition at line 521 of file ImageProcessor.java.

abstract void setMinAndMax	(	double	min,
		double	max
	)

pure virtual

This image will be displayed by mapping pixel values in the range min-max to screen values in the range 0-255. For byte images, this mapping is done by updating the LUT. For short and float images, it's done by generating 8-bit AWT images. For RGB images, it's done by changing the pixel values.

Implemented in ByteProcessor, ShortProcessor, ColorProcessor, and FloatProcessor.

abstract void setPixels ( Object pixels )

pure virtual

Sets a new pixel array for the image and resets the snapshot buffer. The length of the array must be equal to width*height.

Implemented in ColorProcessor, ShortProcessor, FloatProcessor, and ByteProcessor.

void setProgressBar ( ProgressBar pb )

inline

Assigns a progress bar to this processor. Set 'pb' to null to disable the progress bar.

Definition at line 538 of file ImageProcessor.java.

void setRoi ( Rectangle roi )

inline

Defines a rectangular region of interest and sets the mask to null if this ROI is not the same size as the previous one.

See Also: ImageProcessor::resetRoi

Definition at line 404 of file ImageProcessor.java.

void setRoi	(	int	x,
		int	y,
		int	rwidth,
		int	rheight
	)

inline

Defines a rectangular region of interest and sets the mask to null if this ROI is not the same size as the previous one.

See Also: ImageProcessor::resetRoi

Definition at line 415 of file ImageProcessor.java.

void setRoi ( ij.gui.Roi roi )

inline

Defines a non-rectangular region of interest that will consist of a rectangular ROI and a mask. After processing, call reset(mask) to restore non-masked pixels. Here is an example:

ip.setRoi(new OvalRoi(50, 50, 100, 50));
ip.fill();
ip.reset(ip.getMask());

The example assumes snapshot() has been called, which is the case for code executed in the run() method of plugins that implement the PlugInFilter interface.

See Also: ij.ImagePlus::getRoi

Definition at line 459 of file ImageProcessor.java.

void setRoi ( Polygon roi )

inline

Defines a polygonal region of interest that will consist of a rectangular ROI and a mask. After processing, call reset(mask) to restore non-masked pixels. Here is an example:

Polygon p = new Polygon();
p.addPoint(50, 0); p.addPoint(100, 100); p.addPoint(0, 100);
ip.setRoi(triangle);
ip.invert();
ip.reset(ip.getMask());

The example assumes snapshot() has been called, which is the case for code executed in the run() method of plugins that implement the PlugInFilter interface.

See Also: ij.gui.Roi::getPolygon; ImageProcessor::drawPolygon; ImageProcessor::fillPolygon

Definition at line 485 of file ImageProcessor.java.

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

inline

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.

Definition at line 305 of file ImageProcessor.java.

abstract void setValue ( double value )

pure virtual

Sets the default fill/draw value.

Implemented in ShortProcessor, FloatProcessor, ByteProcessor, and ColorProcessor.

void sharpen ( )

inline

Sharpens the image or ROI using a 3x3 convolution kernel.

Definition at line 914 of file ImageProcessor.java.

void smooth ( )

inline

Replaces each pixel with the 3x3 neighborhood mean.

Definition at line 908 of file ImageProcessor.java.

abstract void snapshot ( )

pure virtual

Makes a copy of this image's pixel data.

Implemented in FloatProcessor, ColorProcessor, ShortProcessor, and ByteProcessor.

void sqr ( )

inline

Performs a square transform on the image or ROI.

Definition at line 1150 of file ImageProcessor.java.

void sqrt ( )

inline

Performs a square root transform on the image or ROI.

Definition at line 1153 of file ImageProcessor.java.

abstract void threshold ( int level )

pure virtual

Sets pixels less than or equal to level to 0 and all other pixels to 255. Only works with 8-bit and 16-bit images.

Implemented in ColorProcessor, ShortProcessor, ByteProcessor, and FloatProcessor.

String toString ( )

inline

Returns a string containing information about this ImageProcessor.

Definition at line 995 of file ImageProcessor.java.

void xor ( int value )

inline

Binary exclusive OR of each pixel in the image or ROI with 'value'.

Definition at line 1141 of file ImageProcessor.java.

Field Documentation

final int BLACK = 0xFF000000

static

Value of pixels included in masks.

Definition at line 21 of file ImageProcessor.java.

final int CENTER_JUSTIFY = 1

static

Center justify text.

Definition at line 29 of file ImageProcessor.java.

final int LEFT_JUSTIFY = 0

static

Left justify text.

Definition at line 27 of file ImageProcessor.java.

final double NO_THRESHOLD = -808080.0

static

Value returned by getMinThreshold() when thresholding is not enabled.

Definition at line 24 of file ImageProcessor.java.

final int RIGHT_JUSTIFY = 2

static

Right justify text.

Definition at line 31 of file ImageProcessor.java.

The documentation for this class was generated from the following file:

/Users/webmaster/Desktop/squiz_matrix/fudge/image_editor/src/ij/process/ImageProcessor.java

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

Field Documentation