ij.plugin.filter
Interface PlugInFilter

All Known Implementing Classes:
Analyzer, AVIWriter, BackgroundSubtracter, Benchmark, Binary, BinaryFiller, CalibrationBar, Calibrator, Convolver, Duplicater, EDM, FFTCustomFilter, FFTFilter, Filler, Filters, FractalBoxCounter, GaussianBlur, ImageMath, ImageProperties, Info, LineGraphAnalyzer, LutApplier, LutViewer, MaximumFinder, ParticleAnalyzer, Printer, Profiler, Projector, RankFilters, Resizer, RGBStackSplitter, RoiWriter, SaltAndPepper, ScaleDialog, Shadows, SpecifyROI, ThresholdToSelection, Transformer, UnsharpMask, Writer, XYWriter, ZAxisProfiler

public interface PlugInFilter

ImageJ plugins that process an image should implement this interface.


Field Summary
static int DOES_16
          Set this flag if the filter handles 16-bit images.
static int DOES_32
          Set this flag if the filter handles float images.
static int DOES_8C
          Set this flag if the filter handles 8-bit indexed color images.
static int DOES_8G
          Set this flag if the filter handles 8-bit grayscale images.
static int DOES_ALL
          Set this flag if the filter handles all types of images.
static int DOES_RGB
          Set this flag if the filter handles RGB images.
static int DOES_STACKS
          Set this flag if the filter wants its run() method to be called for all the slices in a stack.
static int DONE
          Set this flag if the filter does not want its run method called.
static int NO_CHANGES
          Set this flag if the filter makes no changes to the pixel data and does not require undo.
static int NO_IMAGE_REQUIRED
          Set this flag if the filter does not require that an image be open.
static int NO_UNDO
          Set this flag if the filter does not require undo.
static int ROI_REQUIRED
          Set this flag if the filter requires an ROI.
static int STACK_REQUIRED
          Set this flag if the filter requires a stack.
static int SUPPORTS_MASKING
          Set this flag if the filter wants ImageJ, for non-rectangular ROIs, to restore that part of the image that's inside the bounding rectangle but outside of the ROI.
 
Method Summary
 void run(ImageProcessor ip)
          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.
 

Field Detail

DOES_8G

static final int DOES_8G
Set this flag if the filter handles 8-bit grayscale images.

See Also:
Constant Field Values

DOES_8C

static final int DOES_8C
Set this flag if the filter handles 8-bit indexed color images.

See Also:
Constant Field Values

DOES_16

static final int DOES_16
Set this flag if the filter handles 16-bit images.

See Also:
Constant Field Values

DOES_32

static final int DOES_32
Set this flag if the filter handles float images.

See Also:
Constant Field Values

DOES_RGB

static final int DOES_RGB
Set this flag if the filter handles RGB images.

See Also:
Constant Field Values

DOES_ALL

static final int DOES_ALL
Set this flag if the filter handles all types of images.

See Also:
Constant Field Values

DOES_STACKS

static final int DOES_STACKS
Set this flag if the filter wants its run() method to be called for all the slices in a stack.

See Also:
Constant Field Values

SUPPORTS_MASKING

static final int SUPPORTS_MASKING
Set this flag if the filter wants ImageJ, for non-rectangular ROIs, to restore that part of the image that's inside the bounding rectangle but outside of the ROI.

See Also:
Constant Field Values

NO_CHANGES

static final int NO_CHANGES
Set this flag if the filter makes no changes to the pixel data and does not require undo.

See Also:
Constant Field Values

NO_UNDO

static final int NO_UNDO
Set this flag if the filter does not require undo.

See Also:
Constant Field Values

NO_IMAGE_REQUIRED

static final int NO_IMAGE_REQUIRED
Set this flag if the filter does not require that an image be open.

See Also:
Constant Field Values

ROI_REQUIRED

static final int ROI_REQUIRED
Set this flag if the filter requires an ROI.

See Also:
Constant Field Values

STACK_REQUIRED

static final int STACK_REQUIRED
Set this flag if the filter requires a stack.

See Also:
Constant Field Values

DONE

static final int DONE
Set this flag if the filter does not want its run method called.

See Also:
Constant Field Values
Method Detail

setup

int setup(java.lang.String arg,
          ImagePlus imp)
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. 'imp' is the currently active image. This method should return a flag word that specifies the filters capabilities.


run

void run(ImageProcessor ip)
Filters use this method to process the image. If the SUPPORTS_STACKS flag was set, it is called for each slice in a stack. ImageJ will lock the image before calling this method and unlock it when the filter is finished.