Module ij

Package ij.plugin.filter

Class RoiWriter

java.lang.Object

ij.plugin.filter.RoiWriter

All Implemented Interfaces:

PlugInFilter

public class RoiWriter
extends java.lang.Object
implements PlugInFilter

Saves the current ROI outline to a file. RoiDecoder.java has a description of the file format.

See Also:

RoiDecoder, RoiReader

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, NO_UNDO_RESET, PARALLELIZE_IMAGES, PARALLELIZE_STACKS, ROI_REQUIRED, SNAPSHOT, STACK_REQUIRED, SUPPORTS_MASKING

Constructor Summary

Constructors

Constructor	Description
RoiWriter()

Method Summary

Modifier and Type	Method	Description
void	run(ImageProcessor ip)	Filters use this method to process the image.
void	saveRoi(ImagePlus imp)
int	setup(java.lang.String arg, ImagePlus imp)	This method is called once when the filter is loaded.

Methods inherited from class java.lang.Object

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

Constructor Detail

RoiWriter

public RoiWriter()

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 PlugInFilter.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 ip)

Description copied from interface: PlugInFilter

Filters use this method to process the image. If the PlugInFilter.DOES_STACKS flag was set, it is called for each slice in a stack. With PlugInFilter.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 PlugInFilter.NO_IMAGE_REQUIRED flag and not the PlugInFilter.DONE flag, run(ip) is called once with the argument null.

Specified by:

run in interface PlugInFilter

saveRoi

public void saveRoi(ImagePlus imp)
             throws java.io.IOException

Throws:

java.io.IOException