AcquisitionEvent (AcqEngJ 0.34.2 API)

java.lang.Object
- org.micromanager.acqj.main.AcquisitionEvent

```
public class AcquisitionEvent
extends Object
```
Information about the acquisition of a single image or a sequence of image.

Field Summary

Fields
Modifier and Type Field and Description

Acquisition acquisition_

Fields
Modifier and Type	Field and Description
`Acquisition`	`acquisition_`

Constructor Summary

Constructors
Constructor and Description
`AcquisitionEvent(AcquisitionAPI acq)`
`AcquisitionEvent(List<AcquisitionEvent> sequence)` Constructor used for running a list of events in a sequence.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AcquisitionEvent`	`copy()`
`static AcquisitionEvent`	`createAcquisitionFinishedEvent(AcquisitionAPI acq)`
`static AcquisitionEvent`	`createAcquisitionSequenceEndEvent(AcquisitionAPI acq)`
`static AcquisitionEvent`	`fromJSON(mmcorej.org.json.JSONObject json, AcquisitionAPI acq)` Create an event or sequence of events from JSON
`List<String[]>`	`getAdditonalProperties()`
`String`	`getAxesAsJSONString()` Convert the event's axes to a JSONObject, or if it is a sequence event, then convert to a json array of json objects
`Object`	`getAxisPosition(String label)`
`HashMap<String,Object>`	`getAxisPositions()`
`String`	`getCameraDeviceName()`
`HashMap<String,Integer>`	`getCameraImageCounts(String defaultCameraDeviceName)` Get the number of images to be acquired on each camera in a sequence event.
`String`	`getConfigGroup()`
`String`	`getConfigPreset()`
`Set<String>`	`getDefinedAxes()`
`String`	`getDeviceAxisName(String deviceName)`
`Point2D.Double[]`	`getDisplayPositionCorners()` Get the stage coordinates of the corners of the camera field of view
`Double`	`getExposure()`
`Long`	`getMinimumStartTimeAbsolute()` Get the minimum start time in system time.
`String`	`getPositionName()`
`List<AcquisitionEvent>`	`getSequence()`
`Object`	`getSLMImage()`
`Set<String>`	`getStageDeviceNames()`
`Double`	`getStageSingleAxisStagePosition(String deviceName)`
`HashMap<String,String>`	`getTags()`
`Double`	`getTimeout_ms()`
`Integer`	`getTIndex()`
`Double`	`getXPosition()`
`Double`	`getYPosition()`
`Integer`	`getZIndex()`
`Double`	`getZPosition()`
`boolean`	`hasConfigGroup()`
`boolean`	`isAcquisitionFinishedEvent()`
`boolean`	`isAcquisitionSequenceEndEvent()`
`boolean`	`isConfigGroupSequenced()`
`boolean`	`isExposureSequenced()`
`boolean`	`isXYSequenced()`
`boolean`	`isZSequenced()`
`void`	`setAxisPosition(String label, Object position)`
`void`	`setCameraDeviceName(String camera)`
`void`	`setChannelName(String name)`
`void`	`setConfigGroup(String group)`
`void`	`setConfigPreset(String config)`
`void`	`setExposure(double exposure)`
`void`	`setMinimumStartTime(Long l)` Set the minimum start time in ms relative to when the acq started.
`void`	`setProperty(String device, String property, String value)`
`void`	`setStageCoordinate(String deviceName, double v)`
`void`	`setStageCoordinate(String deviceName, double v, String axisName)`
`void`	`setTags(HashMap<String,String> tags)`
`void`	`setTimeIndex(int index)`
`void`	`setX(double x)`
`void`	`setY(double y)`
`void`	`setZ(Integer index, Double position)`
`boolean`	`shouldAcquireImage()`
`mmcorej.org.json.JSONObject`	`toJSON()` Return JSONArray or JSONObject for sequence vs single event
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail
- acquisition_
```
public Acquisition acquisition_
```

Constructor Detail
- AcquisitionEvent
```
public AcquisitionEvent(AcquisitionAPI acq)
```
- AcquisitionEvent
```
public AcquisitionEvent(List<AcquisitionEvent> sequence)
```
  Constructor used for running a list of events in a sequence. It should have already been verified that these events are sequencable. This constructor figures out which device types need a sequence and which ones can be left with a single value
  
  Parameters:
  
  sequence -

Method Detail

copy
```
public AcquisitionEvent copy()
```

getAxesAsJSONString
```
public String getAxesAsJSONString()
```
Convert the event's axes to a JSONObject, or if it is a sequence event, then convert to a json array of json objects

toJSON
```
public mmcorej.org.json.JSONObject toJSON()
```
Return JSONArray or JSONObject for sequence vs single event

Returns:

fromJSON

public static AcquisitionEvent fromJSON(mmcorej.org.json.JSONObject json,
                                        AcquisitionAPI acq)

Create an event or sequence of events from JSON

getCameraDeviceName
```
public String getCameraDeviceName()
```

setCameraDeviceName

public void setCameraDeviceName(String camera)

getAdditonalProperties

public List<String[]> getAdditonalProperties()

shouldAcquireImage
```
public boolean shouldAcquireImage()
```

hasConfigGroup
```
public boolean hasConfigGroup()
```

getConfigPreset
```
public String getConfigPreset()
```

getConfigGroup
```
public String getConfigGroup()
```

setConfigPreset

public void setConfigPreset(String config)

setConfigGroup

public void setConfigGroup(String group)

getExposure
```
public Double getExposure()
```

setExposure

public void setExposure(double exposure)

setProperty

public void setProperty(String device,
                        String property,
                        String value)

setMinimumStartTime
```
public void setMinimumStartTime(Long l)
```
Set the minimum start time in ms relative to when the acq started.

Parameters:

l - Minimum start time in ms.

getDefinedAxes
```
public Set<String> getDefinedAxes()
```

setAxisPosition

public void setAxisPosition(String label,
                            Object position)

setStageCoordinate

public void setStageCoordinate(String deviceName,
                               double v)

setStageCoordinate

public void setStageCoordinate(String deviceName,
                               double v,
                               String axisName)

getStageSingleAxisStagePosition

public Double getStageSingleAxisStagePosition(String deviceName)

getAxisPositions

public HashMap<String,Object> getAxisPositions()

getAxisPosition

public Object getAxisPosition(String label)

getTimeout_ms
```
public Double getTimeout_ms()
```

setTimeIndex
```
public void setTimeIndex(int index)
```

setChannelName

public void setChannelName(String name)

getSLMImage
```
public Object getSLMImage()
```

setZ

public void setZ(Integer index,
                 Double position)

getTIndex
```
public Integer getTIndex()
```

getZIndex
```
public Integer getZIndex()
```

getDeviceAxisName

public String getDeviceAxisName(String deviceName)

getStageDeviceNames

public Set<String> getStageDeviceNames()

createAcquisitionFinishedEvent

public static AcquisitionEvent createAcquisitionFinishedEvent(AcquisitionAPI acq)

isAcquisitionFinishedEvent

public boolean isAcquisitionFinishedEvent()

createAcquisitionSequenceEndEvent

public static AcquisitionEvent createAcquisitionSequenceEndEvent(AcquisitionAPI acq)

isAcquisitionSequenceEndEvent

public boolean isAcquisitionSequenceEndEvent()

getZPosition
```
public Double getZPosition()
```

getMinimumStartTimeAbsolute
```
public Long getMinimumStartTimeAbsolute()
```
Get the minimum start time in system time.

Returns:

getSequence

public List<AcquisitionEvent> getSequence()

isExposureSequenced
```
public boolean isExposureSequenced()
```

isConfigGroupSequenced

public boolean isConfigGroupSequenced()

isXYSequenced
```
public boolean isXYSequenced()
```

isZSequenced
```
public boolean isZSequenced()
```

getDisplayPositionCorners
```
public Point2D.Double[] getDisplayPositionCorners()
```
Get the stage coordinates of the corners of the camera field of view

Returns:

getCameraImageCounts
```
public HashMap<String,Integer> getCameraImageCounts(String defaultCameraDeviceName)
```
Get the number of images to be acquired on each camera in a sequence event. For a non-sequence event, the number of images is 1, and the camera is the core camera This is passed in as an argument in order to avoid this class talking to the core directly

Parameters:

defaultCameraDeviceName -

Returns:

getXPosition
```
public Double getXPosition()
```

getYPosition
```
public Double getYPosition()
```

getPositionName
```
public String getPositionName()
```

setX
```
public void setX(double x)
```

setY
```
public void setY(double y)
```

setTags

public void setTags(HashMap<String,String> tags)

getTags

public HashMap<String,String> getTags()

toString
```
public String toString()
```
Overrides:

toString in class Object

Class AcquisitionEvent

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

acquisition_

Constructor Detail

AcquisitionEvent

AcquisitionEvent

Method Detail

copy

getAxesAsJSONString

toJSON

fromJSON

getCameraDeviceName

setCameraDeviceName

getAdditonalProperties

shouldAcquireImage

hasConfigGroup

getConfigPreset

getConfigGroup

setConfigPreset

setConfigGroup

getExposure

setExposure

setProperty

setMinimumStartTime

getDefinedAxes

setAxisPosition

setStageCoordinate

setStageCoordinate

getStageSingleAxisStagePosition

getAxisPositions

getAxisPosition

getTimeout_ms

setTimeIndex

setChannelName

getSLMImage

setZ

getTIndex

getZIndex

getDeviceAxisName

getStageDeviceNames

createAcquisitionFinishedEvent

isAcquisitionFinishedEvent

createAcquisitionSequenceEndEvent

isAcquisitionSequenceEndEvent

getZPosition

getMinimumStartTimeAbsolute

getSequence

isExposureSequenced

isConfigGroupSequenced

isXYSequenced

isZSequenced

getDisplayPositionCorners

getCameraImageCounts

getXPosition

getYPosition

getPositionName

setX

setY

setTags

getTags

toString