ij.plugin.filter
Class AVIWriter

java.lang.Object
  ij.plugin.filter.AVIWriter

All Implemented Interfaces:

PlugInFilter

public class AVIWriter
extends java.lang.Object
implements PlugInFilter

This plugin saves stacks in AVI format. It is based on the FileAvi class written by William Gandler. The FileAvi class is part of Matthew J. McAuliffe's MIPAV program, available from http://mipav.cit.nih.gov/.

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, NO_CHANGES, NO_IMAGE_REQUIRED, NO_UNDO, PARALLELIZE_STACKS, ROI_REQUIRED, SNAPSHOT, STACK_REQUIRED, SUPPORTS_MASKING

Constructor Summary

AVIWriter()

Method Summary

void	createLUT()
(package private) double	getFrameRate()
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.
void	writeByteFrame(int slice)
void	writeImage(ImagePlus imp)
(package private) void	writeInt(int v)
void	writeRGBFrame(int slice)
(package private) void	writeShort(int v)
(package private) void	writeString(java.lang.String s)

Methods inherited from class java.lang.Object

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

Constructor Detail

AVIWriter

public AVIWriter()

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

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

writeImage

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

Throws:

java.io.IOException

writeByteFrame

public void writeByteFrame(int slice)
                    throws java.io.IOException

Throws:

java.io.IOException

writeRGBFrame

public void writeRGBFrame(int slice)
                   throws java.io.IOException

Throws:

java.io.IOException

createLUT

public void createLUT()

getFrameRate

double getFrameRate()

writeString

final void writeString(java.lang.String s)
                throws java.io.IOException

Throws:

java.io.IOException

writeInt

final void writeInt(int v)
             throws java.io.IOException

Throws:

java.io.IOException

writeShort

final void writeShort(int v)
               throws java.io.IOException

Throws:

java.io.IOException