org.micromanager.acqj.util

Class ImageProcessorBase

java.lang.Object

org.micromanager.acqj.util.ImageProcessorBase

All Implemented Interfaces:

TaggedImageProcessor

Direct Known Subclasses:

WorthlessImageProcessor

public abstract class ImageProcessorBase
extends Object
implements TaggedImageProcessor

An abstract class that handles a the threading to implement an image processor that runs asynchronously--i.e. on its own thread that is different from the one that is pulling images from the Core, and different from any subsequent processors/writing images to disk (if applicable)

Author:

henrypinkard

Field Summary

Fields

Modifier and Type	Field and Description
protected BlockingQueue<mmcorej.TaggedImage>	sink_
protected BlockingQueue<mmcorej.TaggedImage>	source_

Constructor Summary

Constructors

Constructor and Description
ImageProcessorBase()

Method Summary

Modifier and Type	Method and Description
protected void	addToOutputQueue(mmcorej.TaggedImage img)
protected abstract mmcorej.TaggedImage	processImage(mmcorej.TaggedImage img)
void	setAcqAndDequeues(AcquisitionAPI acq, LinkedBlockingDeque<mmcorej.TaggedImage> source, LinkedBlockingDeque<mmcorej.TaggedImage> sink)
void	setAcqAndQueues(AcquisitionAPI acq, BlockingQueue<mmcorej.TaggedImage> source, BlockingQueue<mmcorej.TaggedImage> sink) Class for modifying/adding/deleting images after they're acquired before saving.

Methods inherited from class java.lang.Object

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

Field Detail

source_

protected volatile BlockingQueue<mmcorej.TaggedImage> source_

sink_

protected volatile BlockingQueue<mmcorej.TaggedImage> sink_

Constructor Detail

ImageProcessorBase

public ImageProcessorBase()

Method Detail

processImage

protected abstract mmcorej.TaggedImage processImage(mmcorej.TaggedImage img)

addToOutputQueue

protected void addToOutputQueue(mmcorej.TaggedImage img)

setAcqAndQueues

public void setAcqAndQueues(AcquisitionAPI acq,
                            BlockingQueue<mmcorej.TaggedImage> source,
                            BlockingQueue<mmcorej.TaggedImage> sink)

Description copied from interface: TaggedImageProcessor

Class for modifying/adding/deleting images after they're acquired before saving. Expects the implementing class to be pulling data off of the front of the source Dequeue, and then optionally adding it to the end of the sink Dequeue. This method will get called immediately after adding the TaggedImageProcessor.

Specified by:

setAcqAndQueues in interface TaggedImageProcessor

Parameters:

acq - The acquisition which this processor will operate on

source - The source of images that should be processed

sink - The destination of any processed results

setAcqAndDequeues

public void setAcqAndDequeues(AcquisitionAPI acq,
                              LinkedBlockingDeque<mmcorej.TaggedImage> source,
                              LinkedBlockingDeque<mmcorej.TaggedImage> sink)

Specified by:

setAcqAndDequeues in interface TaggedImageProcessor