PlugInFilter Interface Reference

Inheritance diagram for PlugInFilter:

Public Member Functions
int	setup (String arg, ImagePlus imp)
void	run (ImageProcessor ip)

Data Fields
int	DOES_8G = 1
int	DOES_8C = 2
int	DOES_16 = 4
int	DOES_32 = 8
int	DOES_RGB = 16
int	DOES_ALL = DOES_8G+DOES_8C+DOES_16+DOES_32+DOES_RGB
int	DOES_STACKS = 32
int	SUPPORTS_MASKING = 64
int	NO_CHANGES = 128
int	NO_UNDO = 256
int	NO_IMAGE_REQUIRED = 512
int	ROI_REQUIRED = 1024
int	STACK_REQUIRED = 2048
int	DONE = 4096

Detailed Description

ImageJ plugins that process an image should implement this interface.

Definition at line 6 of file PlugInFilter.java.

Member Function Documentation

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.

Implemented in CalibrationBar, Convolver, FFTFilter, Filler, BoxFilter, Binary, BackgroundSubtracter, ImageMath, Filters, Resizer, Scaler, BinaryFiller, ImageProperties, Transformer, Rotator, Benchmark, Info, Shadows, and SaltAndPepper.

int setup	(	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.

Implemented in CalibrationBar, Analyzer, FFTFilter, Convolver, BoxFilter, ImageMath, BackgroundSubtracter, ImageProperties, Filler, Benchmark, Filters, Resizer, Binary, Info, Rotator, Scaler, Transformer, Shadows, SaltAndPepper, and BinaryFiller.

Field Documentation

int DOES_16 = 4

Set this flag if the filter handles short images.

Definition at line 26 of file PlugInFilter.java.

int DOES_32 = 8

Set this flag if the filter handles float images.

Definition at line 28 of file PlugInFilter.java.

int DOES_8C = 2

Set this flag if the filter handles 8-bit indexed color images.

Definition at line 24 of file PlugInFilter.java.

int DOES_8G = 1

Set this flag if the filter handles 8-bit grayscale images.

Definition at line 22 of file PlugInFilter.java.

int DOES_ALL = DOES_8G+DOES_8C+DOES_16+DOES_32+DOES_RGB

Set this flag if the filter handles all types of images.

Definition at line 32 of file PlugInFilter.java.

int DOES_RGB = 16

Set this flag if the filter handles RGB images.

Definition at line 30 of file PlugInFilter.java.

int DOES_STACKS = 32

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

Definition at line 35 of file PlugInFilter.java.

int DONE = 4096

Set this flag if the filter does not want its run method called.

Definition at line 51 of file PlugInFilter.java.

int NO_CHANGES = 128

Set this flag if the filter makes no changes to the pixel data.

Definition at line 41 of file PlugInFilter.java.

int NO_IMAGE_REQUIRED = 512

Set this flag if the filter does not require that an image be open.

Definition at line 45 of file PlugInFilter.java.

int NO_UNDO = 256

Set this flag if the filter does not require undo.

Definition at line 43 of file PlugInFilter.java.

int ROI_REQUIRED = 1024

Set this flag if the filter requires an ROI.

Definition at line 47 of file PlugInFilter.java.

int STACK_REQUIRED = 2048

Set this flag if the filter requires a stack.

Definition at line 49 of file PlugInFilter.java.

int SUPPORTS_MASKING = 64

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.

Definition at line 39 of file PlugInFilter.java.

---

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

• /Users/webmaster/Desktop/squiz_matrix/fudge/image_editor/src/ij/plugin/filter/PlugInFilter.java