org.micromanager.data

Interface Metadata.Builder

All Superinterfaces:

Metadata.MetadataBuilder

Enclosing interface:

Metadata

public static interface Metadata.Builder
extends Metadata.MetadataBuilder

Builder for Metadata.

Method Summary

Modifier and Type	Method and Description
Metadata.Builder	binning(java.lang.Integer binning)
Metadata.Builder	bitDepth(java.lang.Integer bitDepth)
Metadata.Builder	camera(java.lang.String camera)
Metadata.Builder	elapsedTimeMs(java.lang.Double elapsedTimeMs)
Metadata.Builder	exposureMs(java.lang.Double exposureMs)
Metadata.Builder	fileName(java.lang.String filename)
Metadata.Builder	generateUUID()
Metadata.Builder	imageNumber(java.lang.Long imageNumber)
Metadata.Builder	pixelAspect(java.lang.Double pixelAspect)
Metadata.Builder	pixelSizeAffine(java.awt.geom.AffineTransform aff)
Metadata.Builder	pixelSizeUm(java.lang.Double pixelSizeUm)
Metadata.Builder	positionName(java.lang.String positionName)
Metadata.Builder	receivedTime(java.lang.String receivedTime)
Metadata.Builder	roi(java.awt.Rectangle roi)
Metadata.Builder	ROI(java.awt.Rectangle roi) Same as roi(java.awt.Rectangle).
Metadata.Builder	scopeData(PropertyMap scopeData) Add device property data.
Metadata.Builder	userData(PropertyMap userData) Add user-defined data.
Metadata.Builder	uuid() Deprecated. Use generateUUID().
Metadata.Builder	uuid(java.util.UUID uuid)
Metadata.Builder	xPositionUm(java.lang.Double xPositionUm)
Metadata.Builder	yPositionUm(java.lang.Double yPositionUm)
Metadata.Builder	zPositionUm(java.lang.Double zPositionUm)

Methods inherited from interface org.micromanager.data.Metadata.MetadataBuilder

build

Method Detail

binning

Metadata.Builder binning(java.lang.Integer binning)

Specified by:

binning in interface Metadata.MetadataBuilder

bitDepth

Metadata.Builder bitDepth(java.lang.Integer bitDepth)

Specified by:

bitDepth in interface Metadata.MetadataBuilder

camera

Metadata.Builder camera(java.lang.String camera)

Specified by:

camera in interface Metadata.MetadataBuilder

elapsedTimeMs

Metadata.Builder elapsedTimeMs(java.lang.Double elapsedTimeMs)

Specified by:

elapsedTimeMs in interface Metadata.MetadataBuilder

exposureMs

Metadata.Builder exposureMs(java.lang.Double exposureMs)

Specified by:

exposureMs in interface Metadata.MetadataBuilder

imageNumber

Metadata.Builder imageNumber(java.lang.Long imageNumber)

Specified by:

imageNumber in interface Metadata.MetadataBuilder

pixelAspect

Metadata.Builder pixelAspect(java.lang.Double pixelAspect)

Specified by:

pixelAspect in interface Metadata.MetadataBuilder

pixelSizeUm

Metadata.Builder pixelSizeUm(java.lang.Double pixelSizeUm)

Specified by:

pixelSizeUm in interface Metadata.MetadataBuilder

pixelSizeAffine

Metadata.Builder pixelSizeAffine(java.awt.geom.AffineTransform aff)

Specified by:

pixelSizeAffine in interface Metadata.MetadataBuilder

positionName

Metadata.Builder positionName(java.lang.String positionName)

Specified by:

positionName in interface Metadata.MetadataBuilder

receivedTime

Metadata.Builder receivedTime(java.lang.String receivedTime)

Specified by:

receivedTime in interface Metadata.MetadataBuilder

ROI

Metadata.Builder ROI(java.awt.Rectangle roi)

Same as roi(java.awt.Rectangle). Use roi in new code.

Specified by:

ROI in interface Metadata.MetadataBuilder

roi

Metadata.Builder roi(java.awt.Rectangle roi)

scopeData

Metadata.Builder scopeData(PropertyMap scopeData)

Add device property data. This method will remove all previously added scope data from this builder.

Specified by:

scopeData in interface Metadata.MetadataBuilder

Parameters:

scopeData - device properties; keys should be in "DeviceLabel-PropertyName" format, and values should be strings (numbers will be converted to strings)

userData

Metadata.Builder userData(PropertyMap userData)

Add user-defined data. This method will remove all previously added user data from this builder.

Specified by:

userData in interface Metadata.MetadataBuilder

Parameters:

userData - any valid (potentially nested) property map containing user data

uuid

@Deprecated
Metadata.Builder uuid()

Deprecated. Use generateUUID().

Deprecated.

Specified by:

uuid in interface Metadata.MetadataBuilder

uuid

Metadata.Builder uuid(java.util.UUID uuid)

Specified by:

uuid in interface Metadata.MetadataBuilder

generateUUID

Metadata.Builder generateUUID()

xPositionUm

Metadata.Builder xPositionUm(java.lang.Double xPositionUm)

Specified by:

xPositionUm in interface Metadata.MetadataBuilder

yPositionUm

Metadata.Builder yPositionUm(java.lang.Double yPositionUm)

Specified by:

yPositionUm in interface Metadata.MetadataBuilder

zPositionUm

Metadata.Builder zPositionUm(java.lang.Double zPositionUm)

Specified by:

zPositionUm in interface Metadata.MetadataBuilder

fileName

Metadata.Builder fileName(java.lang.String filename)