Class SequenceSettings.Builder

java.lang.Object

org.micromanager.acquisition.SequenceSettings.Builder

Enclosing class:

SequenceSettings

public static final class SequenceSettings.Builder
extends Object

SequenceSettings Builder.

Constructor Summary

Constructors

Constructor	Description
Builder()
Builder(SequenceSettings s)	Construct a Builder using the given SequenceSettings (copy builder).

Method Summary

Modifier and Type	Method	Description
SequenceSettings.Builder	acqOrderMode(int a)	Sets acquisition order of axes.
SequenceSettings	build()	Constructs SequenceSettings.
SequenceSettings.Builder	cameraTimeout(int ct)
SequenceSettings.Builder	channelGroup(String c)
SequenceSettings.Builder	channels(ArrayList<ChannelSpec> c)	Sets the ChannelSpecs to be used in this builder.
SequenceSettings.Builder	comment(String c)
SequenceSettings.Builder	customIntervalsMs(ArrayList<Double> c)
SequenceSettings.Builder	displayTimeUnit(int d)
SequenceSettings.Builder	intervalMs(double d)
SequenceSettings.Builder	isTestAcquisition(boolean isTest)	Sets whether this is a test acquisition.
SequenceSettings.Builder	keepShutterOpenChannels(boolean k)
SequenceSettings.Builder	keepShutterOpenSlices(boolean k)
SequenceSettings.Builder	numFrames(int nFrames)
SequenceSettings.Builder	prefix(String p)
SequenceSettings.Builder	relativeZSlice(boolean r)
SequenceSettings.Builder	root(String r)
SequenceSettings.Builder	save(boolean s)
SequenceSettings.Builder	saveMode(Datastore.SaveMode s)
SequenceSettings.Builder	shouldDisplayImages(boolean s)
SequenceSettings.Builder	skipAutofocusCount(int s)
SequenceSettings.Builder	slices(ArrayList<Double> s)
SequenceSettings.Builder	slicesFirst(boolean s)
SequenceSettings.Builder	sliceZBottomUm(double s)
SequenceSettings.Builder	sliceZStepUm(double s)
SequenceSettings.Builder	sliceZTopUm(double s)
SequenceSettings.Builder	timeFirst(boolean t)
SequenceSettings.Builder	useAutofocus(boolean u)
SequenceSettings.Builder	useChannels(boolean u)
SequenceSettings.Builder	useCustomIntervals(boolean use)
SequenceSettings.Builder	useFrames(boolean u)
SequenceSettings.Builder	usePositionList(boolean u)
SequenceSettings.Builder	useSlices(boolean u)
SequenceSettings.Builder	zReference(double z)

Methods inherited from class Object

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

Constructor Details

Builder

public Builder()

Builder

public Builder(SequenceSettings s)

Construct a Builder using the given SequenceSettings (copy builder).

Parameters:

s - SequenceSettings to apply to this builder.

Method Details

numFrames

public SequenceSettings.Builder numFrames(int nFrames)

intervalMs

public SequenceSettings.Builder intervalMs(double d)

displayTimeUnit

public SequenceSettings.Builder displayTimeUnit(int d)

useCustomIntervals

public SequenceSettings.Builder useCustomIntervals(boolean use)

customIntervalsMs

public SequenceSettings.Builder customIntervalsMs(ArrayList<Double> c)

channels

public SequenceSettings.Builder channels(ArrayList<ChannelSpec> c)

Sets the ChannelSpecs to be used in this builder.

Parameters:

c - List of ChannelSpec to be used.

Returns:

Builder instance for convenience.

slices

public SequenceSettings.Builder slices(ArrayList<Double> s)

relativeZSlice

public SequenceSettings.Builder relativeZSlice(boolean r)

slicesFirst

public SequenceSettings.Builder slicesFirst(boolean s)

timeFirst

public SequenceSettings.Builder timeFirst(boolean t)

keepShutterOpenSlices

public SequenceSettings.Builder keepShutterOpenSlices(boolean k)

keepShutterOpenChannels

public SequenceSettings.Builder keepShutterOpenChannels(boolean k)

useAutofocus

public SequenceSettings.Builder useAutofocus(boolean u)

skipAutofocusCount

public SequenceSettings.Builder skipAutofocusCount(int s)

save

public SequenceSettings.Builder save(boolean s)

saveMode

public SequenceSettings.Builder saveMode(Datastore.SaveMode s)

root

public SequenceSettings.Builder root(String r)

prefix

public SequenceSettings.Builder prefix(String p)

zReference

public SequenceSettings.Builder zReference(double z)

comment

public SequenceSettings.Builder comment(String c)

channelGroup

public SequenceSettings.Builder channelGroup(String c)

usePositionList

public SequenceSettings.Builder usePositionList(boolean u)

cameraTimeout

public SequenceSettings.Builder cameraTimeout(int ct)

shouldDisplayImages

public SequenceSettings.Builder shouldDisplayImages(boolean s)

useSlices

public SequenceSettings.Builder useSlices(boolean u)

useFrames

public SequenceSettings.Builder useFrames(boolean u)

useChannels

public SequenceSettings.Builder useChannels(boolean u)

sliceZStepUm

public SequenceSettings.Builder sliceZStepUm(double s)

sliceZBottomUm

public SequenceSettings.Builder sliceZBottomUm(double s)

sliceZTopUm

public SequenceSettings.Builder sliceZTopUm(double s)

acqOrderMode

public SequenceSettings.Builder acqOrderMode(int a)

Sets acquisition order of axes. See SequenceSettings for definitions.

Parameters:

a - integer representing acquisition order.

Returns:

Builder instance for convenience.

isTestAcquisition

public SequenceSettings.Builder isTestAcquisition(boolean isTest)

Sets whether this is a test acquisition. Test acquisitions are not saved to disk and are used for testing purposes.

Parameters:

isTest - true if this is a test acquisition, false otherwise

Returns:

Builder instance for convenience.

build

public SequenceSettings build()

Constructs SequenceSettings.

Returns:

immutable instance of SequenceSettings.