org.micromanager.acqj.api

Interface AcqEngJDataSink

All Known Implementing Classes:

BlackHoleDataSink

public interface AcqEngJDataSink

Where the acquisition sends data to. Conventionally would be saving + image display. When using AcqEngJ, either a DataSink or a custom TaggedImageProcessor that intercepts and diverts images rather than passing them along should be implemented. Either one represents a valid destination for images.

Method Summary

Modifier and Type	Method and Description
boolean	anythingAcquired() Has putImage been called yet?
void	finish() Called when no more data will be collected.
void	initialize(Acquisition acq, mmcorej.org.json.JSONObject summaryMetadata) Called when the Acquisition is initialized
boolean	isFinished() Is this sink and all associated resources complete (e.g.
Object	putImage(mmcorej.TaggedImage image) Add a new image to saving/display etc.

Method Detail

initialize

void initialize(Acquisition acq,
                mmcorej.org.json.JSONObject summaryMetadata)

Called when the Acquisition is initialized

Parameters:

acq -

summaryMetadata -

finish

void finish()

Called when no more data will be collected. Block until all relevent resources are freed.

isFinished

boolean isFinished()

Is this sink and all associated resources complete (e.g. all data written to disk)

putImage

Object putImage(mmcorej.TaggedImage image)

Add a new image to saving/display etc. If saving to disk, do not return until the image written

Parameters:

image -

Returns:

An optional object describing the image's location in the data set

anythingAcquired

boolean anythingAcquired()

Has putImage been called yet?

Returns: