ij.plugin.filter
Class CalibrationBar

java.lang.Object
  ij.plugin.filter.CalibrationBar

All Implemented Interfaces:

PlugInFilter

public class CalibrationBar
extends java.lang.Object
implements PlugInFilter

This plugin displays a calibration bar on the active image. Bob Dougherty, OptiNav, Inc., 4/14/2002 Based largely on HistogramWindow.java by Wayne Rasband. Version 0 4/14/2002 Version 1 6/14/2002 Many revisions, including addition of the legend to the image. Version 2 6/15/2002 Control over colors, including none. Automatic box width. Version 3 6/17/2002 0 decimal places by default. Option for manual box width. July 2002: Modified by Daniel Marsh and renamed CalibrationBar.

Field Summary

Fields inherited from interface ij.plugin.filter.PlugInFilter

CONVERT_TO_FLOAT, DOES_16, DOES_32, DOES_8C, DOES_8G, DOES_ALL, DOES_RGB, DOES_STACKS, DONE, FINAL_PROCESSING, KEEP_THRESHOLD, NO_CHANGES, NO_IMAGE_REQUIRED, NO_UNDO, PARALLELIZE_STACKS, ROI_REQUIRED, SNAPSHOT, STACK_REQUIRED, SUPPORTS_MASKING

Constructor Summary

CalibrationBar()

Method Summary

void	drawColorBar(ImagePlus imp, int x, int y)
protected void	drawColorBar(ImageProcessor ip, int xOffset, int yOffset)
void	run(ImageProcessor ipPassed) Filters use this method to process the image.
int	setup(java.lang.String arg, ImagePlus imp) This method is called once when the filter is loaded.
void	verticalColorBar(ImageProcessor ip, int x, int y, int thickness, int length)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CalibrationBar

public CalibrationBar()

Method Detail

setup

public int setup(java.lang.String arg,
                 ImagePlus imp)

Description copied from interface: PlugInFilter

This method is called once when the filter is loaded. 'arg', which may be blank, is the argument specified for this plugin in IJ_Props.txt or in the plugins.config file of a jar archive containing the plugin. 'imp' is the currently active image. This method should return a flag word that specifies the filters capabilities.

For Plugin-filters specifying the FINAL_PROCESSING flag, the setup method will be called again, this time with arg = "final" after all other processing is done.

Specified by:

setup in interface PlugInFilter

run

public void run(ImageProcessor ipPassed)

Description copied from interface: PlugInFilter

Filters use this method to process the image. If the SUPPORTS_STACKS flag was set, it is called for each slice in a stack. With CONVERT_TO_FLOAT, the filter is called with the image data converted to a FloatProcessor (3 times per image for RGB images). ImageJ will lock the image before calling this method and unlock it when the filter is finished. For PlugInFilters specifying the NO_IMAGE_REQUIRED flag and not the DONE flag, run(ip) is called once with the argument null.

Specified by:

run in interface PlugInFilter

verticalColorBar

public void verticalColorBar(ImageProcessor ip,
                             int x,
                             int y,
                             int thickness,
                             int length)

drawColorBar

protected void drawColorBar(ImageProcessor ip,
                            int xOffset,
                            int yOffset)

drawColorBar

public void drawColorBar(ImagePlus imp,
                         int x,
                         int y)