AcquisitionAPI (AcqEngJ 0.28.2 API)

All Known Subinterfaces:

XYTiledAcquisitionAPI

All Known Implementing Classes:

Acquisition, XYTiledAcquisition
```
public interface AcquisitionAPI
```
General interface for acquisitions

Author:

henrypinkard

Field Summary

Fields
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`	`EVENT_GENERATION_HOOK`

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
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`	`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
`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`	`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()` Has abort 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.

- Field Detail
  - EVENT_GENERATION_HOOK
```
static final int EVENT_GENERATION_HOOK
```
    See Also:
    
    Constant Field Values
  - BEFORE_HARDWARE_HOOK
```
static final int BEFORE_HARDWARE_HOOK
```
    See Also:
    
    Constant Field Values
  - AFTER_HARDWARE_HOOK
```
static final int AFTER_HARDWARE_HOOK
```
    See Also:
    
    Constant Field Values
  - AFTER_CAMERA_HOOK
```
static final int AFTER_CAMERA_HOOK
```
    See Also:
    
    Constant Field Values
  - AFTER_EXPOSURE_HOOK
```
static final int AFTER_EXPOSURE_HOOK
```
    See Also:
    
    Constant Field Values
- Method Detail
  - start
```
@Deprecated
void start()
```
    Deprecated.
    
    Call to ready acquisition to start receiving acquisiton events. No more hooks or image processors should be added after this has been called This method is no longer needed, because it is called automatically when the first call to submitEventIterator is made
  - waitForCompletion
```
void waitForCompletion()
```
    Block until acquisition finished and all resources complete.
  - finish
```
void finish()
```
    Signal the acquisition to complete once all events are done
  - areEventsFinished
```
boolean areEventsFinished()
```
    returns true if all acquisition events have been processed and hardware control is complete. This does not, however signal that all images are finished writing to disk (if DataSink is not null). This occurs after events are finished, and the DataSink should provide that information directly
    
    Returns:
  - abort
```
void abort()
```
    Cancel any pending events and shutdown
  - abort
```
void abort(Exception e)
```
    Abort, and provide an exception that is the reason for the abort. This is useful for passing exceptions across threads
    
    Parameters:
    
    e -
  - isAbortRequested
```
boolean isAbortRequested()
```
    Has abort been called?
  - isPaused
```
boolean isPaused()
```
    return if acquisition is paused (i.e. not acquiring new data but not finished)
    
    Returns:
  - isStarted
```
boolean isStarted()
```
    return if acquisition is started by the first call to submitEventIterator
  - setPaused
```
void setPaused(boolean pause)
```
    Pause or unpause
  - getSummaryMetadata
```
mmcorej.org.json.JSONObject getSummaryMetadata()
```
    Get the summary metadata for this acquisition
    
    Returns:
  - anythingAcquired
```
boolean anythingAcquired()
```
    Returns true once any data has been acquired
    
    Returns:
  - addImageMetadataProcessor
```
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. Metadata can also be modified through an ImageProcessor. This method is more lightweight--it should not be doing an significant computation, unlike Image Processors, which run // * /on their own dedicated Thread()
  - addImageProcessor
```
void addImageProcessor(TaggedImageProcessor p)
```
    Add an image processor for modifying images before saving or diverting them to some other purpose
    
    Parameters:
    
    p -
  - addHook
```
void addHook(AcquisitionHook hook,
             int type)
```
    Add a an arbitrary piece of code (i.e. a hook) to be executed at a specific time in the acquisition loop
    
    Parameters:
    
    hook - Code to run
    
    type - BEFORE_HARDWARE_HOOK, AFTER_HARDWARE_HOOK, AFTER_SAVE_HOOK
  - submitEventIterator
```
Future submitEventIterator(Iterator<AcquisitionEvent> evt)
```
    Submit a list of acquisition events for acquisition. Acquisition engine will automatically optimize over this list (i.e. implement hardware sequencing). If start() has not already been called on the acquisition, it will automatically be called here
    
    Parameters:
    
    evt -
  - getDataSink
```
AcqEngJDataSink getDataSink()
```
    Get the DataSink used by this acquisition. This could be null (since) ImageProcessors allow data to be intercepted and diverted
    
    Returns:
  - isDebugMode
```
boolean isDebugMode()
```
    Should debug logging be printed
  - checkForExceptions
```
void checkForExceptions()
                 throws Exception
```
    Throws an exception if an exception occured on a thread managed by the acquisiton
    
    Throws:
    
    Exception
  - setDebugMode
```
void setDebugMode(boolean debug)
```
    Activate debug logging

Interface AcquisitionAPI

Field Summary

Method Summary

Field Detail

EVENT_GENERATION_HOOK

BEFORE_HARDWARE_HOOK

AFTER_HARDWARE_HOOK

AFTER_CAMERA_HOOK

AFTER_EXPOSURE_HOOK

Method Detail

start

waitForCompletion

finish

areEventsFinished

abort

abort

isAbortRequested

isPaused

isStarted

setPaused

getSummaryMetadata

anythingAcquired

addImageMetadataProcessor

addImageProcessor

addHook

submitEventIterator

getDataSink

isDebugMode

checkForExceptions

setDebugMode