org.micromanager.acqj.example

Class BlackHoleDataSink

java.lang.Object

org.micromanager.acqj.example.BlackHoleDataSink

All Implemented Interfaces:

AcqEngJDataSink

public class BlackHoleDataSink
extends Object
implements AcqEngJDataSink

This is a minimal implementation of a DataSink meant for demonstration purposes only. This DataSink acts as a black hole, immediately discarding every image it recieves forever. In practice, DataSinks should instead do something useful (e.g. save and display) with the images they receive

Constructor Summary

Constructors

Constructor and Description
BlackHoleDataSink()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

BlackHoleDataSink

public BlackHoleDataSink()

Method Detail

initialize

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

Description copied from interface: AcqEngJDataSink

Called when the Acquisition is initialized

Specified by:

initialize in interface AcqEngJDataSink

finish

public void finish()

Description copied from interface: AcqEngJDataSink

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

Specified by:

finish in interface AcqEngJDataSink

isFinished

public boolean isFinished()

Description copied from interface: AcqEngJDataSink

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

Specified by:

isFinished in interface AcqEngJDataSink

putImage

public Object putImage(mmcorej.TaggedImage image)

Description copied from interface: AcqEngJDataSink

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

Specified by:

putImage in interface AcqEngJDataSink

Returns:

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

anythingAcquired

public boolean anythingAcquired()

Description copied from interface: AcqEngJDataSink

Has putImage been called yet?

Specified by:

anythingAcquired in interface AcqEngJDataSink

Returns: