: Class ImagePlus

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

ij
Class ImagePlus

java.lang.Object
  |
  +--ij.ImagePlus

All Implemented Interfaces:: java.awt.image.ImageObserver, Measurements

Direct Known Subclasses:: BMP, Colors, DICOM, DVHCalc, FITS, LutLoader, PGM_Reader, Zip_Reader

public class ImagePlus
extends java.lang.Object
implements java.awt.image.ImageObserver, Measurements

This is an extended image class that supports 8-bit, 16-bit, 32-bit (real) and RGB images. It also provides support for 3D image stacks.

See Also:: ImageProcessor, ImageStack, ImageWindow, ImageCanvas

Field Summary

boolean changes
          True if any changes have been made to this image.

static int COLOR_256
          8-bit indexed color

static int COLOR_RGB
          32-bit RGB color

static int GRAY16
          16-bit grayscale (unsigned)

static int GRAY32
          32-bit floating-point grayscale

static int GRAY8
          8-bit grayscale (unsigned)

double pixelDepth
          Obsolete.

double pixelHeight
          Obsolete.

double pixelWidth
          Obsolete.

boolean sCalibrated
          Obsolete.

java.lang.String unit
          Obsolete.

java.lang.String units
          Obsolete.

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Fields inherited from interface ij.measure.Measurements

AREA, CENTER_OF_MASS, CENTROID, ELLIPSE, LABELS, LIMIT, MAX_STANDARDS, MEAN, MIN_MAX, MODE, PERIMETER, RECT, STD_DEV

Constructor Summary

ImagePlus()
          Constructs an uninitialized ImagePlus.

ImagePlus(java.lang.String pathOrURL)
          Constructs an ImagePlus from a TIFF, BMP, DICOM, FITS, PGM, GIF or JPRG specified by a path or from a TIFF, GIF or JPEG specified by a URL.

ImagePlus(java.lang.String title, java.awt.Image img)
          Constructs an ImagePlus from an AWT Image.

ImagePlus(java.lang.String title, ImageProcessor ip)
          Constructs an ImagePlus from an ImageProcessor.

ImagePlus(java.lang.String title, ImageStack stack)
          Constructs an ImagePlus from a stack.

Method Summary

void copyScale(ImagePlus imp)
          Copies the calibration of the specified image to this image.

ImageStack createEmptyStack()
          Returns an empty image stack that has the same width, height and color table as this image.

ImagePlus createImagePlus()
          Returns a new ImagePlus with this ImagePlus' attributes (e.g.

LookUpTable createLut()
          Creates a LookUpTable object corresponding to this image.

void createNewRoi(int x, int y)
          Creates a new selection.

void draw()
          Displays this image.

void draw(int x, int y, int width, int height)
          Draws image and roi outline using a clip rect.

void flush()
          Sets the image arrays to null to help the garbage collector do its job.

Calibration getCalibration()
          Returns this image's calibration.

int getCurrentSlice()
          Returns the current stack slice number or 1 if this is a single image.

FileInfo getFileInfo()
          Returns a FileInfo object containing information, including the pixel array, needed to save this image.

int getHeight()


int getID()
          Returns this image's unique numeric ID.

java.awt.Image getImage()
          Returns the current AWT image.

java.lang.String getLocationAsString(int x, int y)
          Converts the current cursor location to a string.

int[] getMask()
          For images with irregular ROIs, returns a binary mask, otherwise, returns null.

FileInfo getOriginalFileInfo()
          Returns the FileInfo object that was used to open this image.

int[] getPixel(int x, int y)
          Returns the pixel value at (x,y) as a 4 element array.

ImageProcessor getProcessor()
          Returns a reference to the current ImageProcessor.

java.util.Properties getProperties()
          Returns this image's Properties.

java.lang.Object getProperty(java.lang.String key)
          Returns the property associated with 'key'.

Roi getRoi()


java.lang.String getShortTitle()
          Returns a shortened version of image name.

ImageStack getStack()
          Returns the image stack.

int getStackSize()
          If this is a stack, return the number of slices, else return 1.

long getStartTime()
          Returns the time in milliseconds when startTiming() was last called.

ImageStatistics getStatistics()
          Returns an ImageStatistics object generated using the standard measurement options (area, mean, mode, min and max).

ImageStatistics getStatistics(int mOptions)
          Returns an ImageStatistics object generated using the specified measurement options.

ImageStatistics getStatistics(int mOptions, int nBins)
          Returns an ImageStatistics object generated using the specified measurement options and histogram bin count.

java.lang.String getTitle()
          Returns the image name.

int getType()
          Returns the current image type.

int getWidth()


ImageWindow getWindow()
          Returns the ImageWindow that is being used to display this image.

void hide()
          Closes the window, if any, that is displaying this image.

boolean imageUpdate(java.awt.Image img, int flags, int x, int y, int w, int h)
          Used by ImagePlus to monitor loading of images.

boolean isInvertedLut()
          Returns true is this image uses an inverted LUT that displays zero as white.

boolean isProcessor()


void killProcessor()
          Obsolete.

void killRoi()
          Deletes the current region of interest.

void killStack()


boolean lock()
          Locks the image so other threads can test to see if it is in use.

boolean lockSilently()
          Similar to lock, but doesn't beep and display an error message if the attempt to lock the image fails.

void mouseMoved(int x, int y)
          Displays the cursor coordinates and pixel value in the status bar.

void repaintWindow()
          Calls draw to draw the image and also repaints the image window to force the information displayed above the image (dimension, type, size) to be updated.

void restoreRoi()


void setCalibration(Calibration cal)
          Sets this image's calibration.

void setColor(java.awt.Color c)
          Sets current foreground color.

void setFileInfo(FileInfo fi)
          Saves this image's FileInfo so it can be later retieved using getOriginalFileInfo().

void setGlobalCalibration(Calibration global)
          Sets the system-wide calibration.

void setImage(java.awt.Image img)
          Replaces the AWT image, if any, with the one specified.

void setProcessor(java.lang.String title, ImageProcessor ip)
          Replaces the ImageProcessor, if any, with the one specified.

void setProperty(java.lang.String key, java.lang.Object value)
          Adds a key-value pair to this image's properties.

void setRoi(int x, int y, int width, int height)
          Creates a rectangular selection.

void setRoi(java.awt.Rectangle r)
          Creates a rectangular selection.

void setRoi(Roi roi)


void setSlice(int index)
          Activates the specified slice.

void setStack(java.lang.String title, ImageStack stack)
          Replaces the stack, if any, with the one specified.

void setTitle(java.lang.String title)
          Sets the image name.

void setWindow(ImageWindow win)
          This method should only be called from an ImageWindow.

void show()
          Opens a window to display this image and clears the status bar.

void show(java.lang.String statusMessage)
          Opens a window to display this image and displays 'statusMessage' in the status bar.

void startTiming()
          Calls System.currentTimeMillis() to save the current time so it can be retrieved later using getStartTime() to calculate the elapsed time of an operation.

java.lang.String toString()


void trimProcessor()
          Frees RAM by setting the snapshot (undo) buffer in the current ImageProcessor to null.

void unlock()
          Unlocks the image.

void updateAndDraw()
          Updates this image from the pixel data in its associated ImageProcessor, then displays it.

void updateAndRepaintWindow()
          Calls updateAndDraw to update from the pixel data and draw the image, and also repaints the image window to force the information displayed above the image (dimension, type, size) to be updated.

void updateImage()
          ImageCanvas.paint() calls this method when the ImageProcessor has generated new image.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

GRAY8

public static final int GRAY8

8-bit grayscale (unsigned)

GRAY16

public static final int GRAY16

16-bit grayscale (unsigned)

GRAY32

public static final int GRAY32

32-bit floating-point grayscale

COLOR_256

public static final int COLOR_256

8-bit indexed color

COLOR_RGB

public static final int COLOR_RGB

32-bit RGB color

changes

public boolean changes

True if any changes have been made to this image.