org.micromanager.api

Class DataProcessor<E>

java.lang.Object

java.lang.Thread

org.micromanager.api.DataProcessor<E>

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

TaggedImageAnalyzer

public abstract class DataProcessor<E>
extends java.lang.Thread

A DataProcessor thread allows for on-the-fly modification of image data during acquisition. Inherit from this class and use the AcquisitionEngine functions addImageProcessor and removeImageProcessor to insert your code into the acquisition pipeline Note that this code will be invoked through its default (null) constructor If you use your own constructor, make sure that it accepts no arguments. If you need to initialize variables, do this in the makeConfigurationGUI method instead. That method is the first to be called.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
DataProcessor()

Method Summary

Modifier and Type	Method and Description
void	dispose() Remove all GUI elements generated by makeConfigurationGUI().
boolean	getIsEnabled() Get whether or not this Processor is enabled.
boolean	isStarted() Returns true if the DataProcessor has started up and objects are being processed as they arrive.
void	makeConfigurationGUI() Generate and show the GUI needed to configure the DataProcessor.
void	requestStop() Request that the data processor stop processing.
void	run() The run method that causes images to be processed.
void	setApp(ScriptInterface gui) Receive the ScriptInterface object.
void	setEnabled(boolean isEnabled) Turn the Processor on or off.
void	setInput(java.util.concurrent.BlockingQueue<E> input) Sets the input queue where objects to be processed are received by the DataProcessor.
void	setOutput(java.util.concurrent.BlockingQueue<E> output) Sets the output queue where objects that have been processed exit the DataProcessor.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DataProcessor

public DataProcessor()

Method Detail

makeConfigurationGUI

public void makeConfigurationGUI()

Generate and show the GUI needed to configure the DataProcessor.

dispose

public void dispose()

Remove all GUI elements generated by makeConfigurationGUI(). If you override makeConfigurationGUI(), then you should also override this function.

setApp

public void setApp(ScriptInterface gui)

Receive the ScriptInterface object. Normally, it is not necessary to override this method. If overriding, make sure to call super.setApp().

run

public void run()

The run method that causes images to be processed. As DataProcessor extends java.lang.Thread, this method will be executed whenever DataProcessor.start() is called. Do not override this method (it should have been final).

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

requestStop

public void requestStop()

Request that the data processor stop processing. The current processing event will continue, but no others will be started. Do not override this method (it should have been final). Do not call this method from DataProcessor subclasses.

isStarted

public boolean isStarted()

Returns true if the DataProcessor has started up and objects are being processed as they arrive. Do not override this method (it should have been final).

setInput

public void setInput(java.util.concurrent.BlockingQueue<E> input)

Sets the input queue where objects to be processed are received by the DataProcessor. Do not override this method (it should have been final). This method is automatically called by the system to set up data processors.

setOutput

public void setOutput(java.util.concurrent.BlockingQueue<E> output)

Sets the output queue where objects that have been processed exit the DataProcessor. Do not override this method (it should have been final). This methods is automatically called by the system to set up data processors.

setEnabled

public void setEnabled(boolean isEnabled)

Turn the Processor on or off. Enabling and disabling the processor is handled automatically by the system. It is usually not necessary to override this method. If overriding, make sure to call super.setEnabled(isEnabled).

getIsEnabled

public boolean getIsEnabled()

Get whether or not this Processor is enabled. Do not override this method (it should have been final).