public interface AcquisitionAPI
| Modifier and Type | Field and Description |
|---|---|
static int |
AFTER_CAMERA_HOOK |
static int |
AFTER_EXPOSURE_HOOK |
static int |
AFTER_HARDWARE_HOOK |
static int |
BEFORE_HARDWARE_HOOK |
static int |
BEFORE_Z_DRIVE_HOOK |
static int |
EVENT_GENERATION_HOOK |
| Modifier and Type | Method and Description |
|---|---|
void |
abort()
Cancel any pending events and shutdown.
|
void |
abort(Exception e)
Abort, and provide an exception that is the reason for the abort.
|
void |
addAcqNotificationListener(AcqNotificationListener listener)
Add a AcqNotificationListener to receive asynchronous notifications about the acquisition.
|
void |
addHook(AcquisitionHook hook,
int type)
Add a an arbitrary piece of code (i.e.
|
void |
addImageMetadataProcessor(Consumer<mmcorej.org.json.JSONObject> modifier)
Add a Consumer that will receive the metadata JSONObject for each image
that is generated and modify it as needed.
|
void |
addImageProcessor(TaggedImageProcessor p)
Add an image processor for modifying images before saving or diverting
them to some other purpose
|
static boolean |
anyAcquisitionsRunning()
Are there any unfinished acquisitions?
|
boolean |
anythingAcquired()
Returns true once any data has been acquired
|
boolean |
areEventsFinished()
returns true if all acquisition events have been processed and
hardware control is complete.
|
void |
blockUntilEventsFinished(Double timeoutSeconds)
Block until all acquisitions events are finished or timeout is reached.
|
void |
checkForExceptions()
Throws an exception if an exception occured on a thread managed by the acquisiton
|
void |
finish()
Signal the acquisition to complete once all events are done
|
AcqEngJDataSink |
getDataSink()
Get the DataSink used by this acquisition.
|
mmcorej.org.json.JSONObject |
getSummaryMetadata()
Get the summary metadata for this acquisition
|
boolean |
isAbortRequested()
Wether abort has been called.
|
boolean |
isDebugMode()
Should debug logging be printed
|
boolean |
isPaused()
Return if acquisition is paused (i.e.
|
boolean |
isStarted()
return if acquisition is started by the first call to submitEventIterator
|
void |
setDebugMode(boolean debug)
Activate debug logging
|
void |
setPaused(boolean pause)
Pause or unpause
|
void |
start()
Deprecated.
|
Future |
submitEventIterator(Iterator<AcquisitionEvent> evt)
Submit a list of acquisition events for acquisition.
|
void |
waitForCompletion()
Block until acquisition finished and all resources complete.
|
static final int EVENT_GENERATION_HOOK
static final int BEFORE_HARDWARE_HOOK
static final int BEFORE_Z_DRIVE_HOOK
static final int AFTER_HARDWARE_HOOK
static final int AFTER_CAMERA_HOOK
static final int AFTER_EXPOSURE_HOOK
@Deprecated void start()
This method is no longer needed, because it is called automatically when the first call to submitEventIterator is made
void addAcqNotificationListener(AcqNotificationListener listener)
void waitForCompletion()
void finish()
boolean areEventsFinished()
void blockUntilEventsFinished(Double timeoutSeconds) throws InterruptedException
timeoutSeconds - wait a maximum of this many seconds.InterruptedExceptionvoid abort()
void abort(Exception e)
e - Exception that caused the abort.boolean isAbortRequested()
boolean isPaused()
boolean isStarted()
void setPaused(boolean pause)
mmcorej.org.json.JSONObject getSummaryMetadata()
boolean anythingAcquired()
void addImageMetadataProcessor(Consumer<mmcorej.org.json.JSONObject> modifier)
void addImageProcessor(TaggedImageProcessor p)
p - void addHook(AcquisitionHook hook, int type)
hook - Code to runtype - BEFORE_HARDWARE_HOOK, AFTER_HARDWARE_HOOK, AFTER_SAVE_HOOKFuture submitEventIterator(Iterator<AcquisitionEvent> evt)
If start() has not already been called on the acquisition, it will automatically be called here
evt - AcqEngJDataSink getDataSink()
boolean isDebugMode()
void checkForExceptions()
throws Exception
Exceptionvoid setDebugMode(boolean debug)
static boolean anyAcquisitionsRunning()
Copyright © 2025. All rights reserved.