Interface SummaryMetadata
public interface SummaryMetadata
This class defines the summary metadata that applies to all images in a
dataset. It is immutable; construct it with a SummaryMetadataBuilder. All
fields of the SummaryMetadata that are not explicitly initialized will
default to null. You are not expected to implement this interface; it is here
to describe how you can interact with SummaryMetadata created by
Micro-Manager itself. If you need to create a new SummaryMetadata, either use
the getSummaryMetadataBuilder() method of the DataManager class, or call the
copy() method of an existing SummaryMetadata instance.
This class uses a Builder pattern. Please see https://micro-manager.org/wiki/Using_Builders for more information.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfaceBuilder for SummaryMetadata.static interfaceDeprecated.- Use SummaryMetadata.Builder instead -
Method Summary
Modifier and TypeMethodDescriptioncopy()Deprecated.- Use SummaryMetadata.Builder.copyBuilder insteadString[]Deprecated.- Use getOrdereddAxes() insteadThe config group that was used to switch between channels.String[]Deprecated.- Use getChannelNameList() insteadThe name of the computer the data was collected on.Double[]Deprecated.- Use double[] getCustomIntervalsMsArray() insteaddouble[]When using a variable amount of time between timepoints, this array has the list of wait times.The directory the data was originally saved to.ImageHeight in pixels.ImageWidth in pixels.Device properties at the start of the acquisition.The expected number of images along each axis that were to be collected.For acquisitions with more than one channel, whether or not the shutter was left open in between each channel.For acquisitions with more than one Z slice, whether or not the shutter was left open in between each slice.The version of the metadata when the data was collected.The version of Micro-Manager used to collect the data.Provides information about the MultiWellPlate used in the acquisition.The order in which axes changed when adding images to the dataset.The user-supplied portion of the filename, plus any additional numerical identifier needed to ensure uniqueness.The name of the Micro-Manager profile used to collect this data.getSafeChannelName(int index) Retrieve the name of the specified channel.Settings that define the Multi-Dimensional Acquisition specified by the user to acquire this data set.The stage positions that were to be visited in the acquisition.Deprecated.- Use getStagePositionList() insteadThe date and time at which the acquisition started.Any general-purpose user meta data.The signed-in user of the machine that collected this data.Amount of time to wait between timepoints.Distance between slices in a volume of data, in microns.
-
Method Details
-
copyBuilder
SummaryMetadata.Builder copyBuilder() -
copy
Deprecated.- Use SummaryMetadata.Builder.copyBuilder insteadDeprecated.- Returns:
- - A copy of the SummaryMetadataBuilder
-
getPrefix
String getPrefix()The user-supplied portion of the filename, plus any additional numerical identifier needed to ensure uniqueness. This should in practice be the name of the directory that the data is saved in.- Returns:
- user-supplied portion of the filename.
-
getUserName
String getUserName()The signed-in user of the machine that collected this data.- Returns:
- signed-in user of the machine that collected this data
-
getProfileName
String getProfileName()The name of the Micro-Manager profile used to collect this data.- Returns:
- name of the micro-Manager profile used to collect this data
-
getMicroManagerVersion
String getMicroManagerVersion()The version of Micro-Manager used to collect the data.- Returns:
- version of Micro-Manager used to collect the data
-
getMetadataVersion
String getMetadataVersion()The version of the metadata when the data was collected.- Returns:
- version of the metadata when the data was collected
-
getComputerName
String getComputerName()The name of the computer the data was collected on.- Returns:
- name of the computer the data was collected on
-
getDirectory
String getDirectory()The directory the data was originally saved to.- Returns:
- directory the data was originally saved to
-
getChannelGroup
String getChannelGroup()The config group that was used to switch between channels.- Returns:
- name of the channel config group
-
getChannelNameList
-
getChannelNames
Deprecated.- Use getChannelNameList() insteadDeprecated.- Returns:
- Array with channelname
-
getSafeChannelName
Retrieve the name of the specified channel. Ordinarily this is simply an index into the channelNames array (per getChannelNames()), but if there is no name there (channelNames is unset, or not long enough, or contains a null), then the name will be "channel N" where N is the channel index.- Parameters:
index- Channel index to get the name for.- Returns:
- Name of the channel.
-
getZStepUm
Double getZStepUm()Distance between slices in a volume of data, in microns.- Returns:
- distance between slices in a volume of data, in microns
-
getWaitInterval
Double getWaitInterval()Amount of time to wait between timepoints.- Returns:
- amount of time to wait between timepoints
-
getCustomIntervalsMsList
-
getCustomIntervalsMsArray
double[] getCustomIntervalsMsArray() -
getCustomIntervalsMs
Deprecated.- Use double[] getCustomIntervalsMsArray() insteadDeprecated.- Returns:
- - Array with custom intervals
-
getOrderedAxes
The order in which axes changed when adding images to the dataset. The first entry in this array is the first axis to have a nonzero value; the second entry is the second to have a nonzero value, etc. In other words, the entries should be ordered from changes-most-frequently to changes-least-frequently. RewritableDatastores will automatically update this property as images are added to the Datastore, if the property is not set manually. Other Datastore types cannot change the SummaryMetadata as images are added; thus this property will need to be set manually in those cases.- Returns:
- Axis names in order of change rate.
-
getAxisOrder
Deprecated.- Use getOrdereddAxes() insteadDeprecated.- Returns:
- - Array with Axis ordered as described for getOrderedAxes()
-
getIntendedDimensions
Coords getIntendedDimensions()The expected number of images along each axis that were to be collected. The actual dimensions may differ if the acquisition was aborted partway through for any reason.- Returns:
- expected number of images along each axis that were to be collected
-
getKeepShutterOpenSlices
Boolean getKeepShutterOpenSlices()For acquisitions with more than one Z slice, whether or not the shutter was left open in between each slice.- Returns:
- whether shutter was left open between Z slices.
-
getKeepShutterOpenChannels
Boolean getKeepShutterOpenChannels()For acquisitions with more than one channel, whether or not the shutter was left open in between each channel.- Returns:
- whether shutter was left open between channels.
-
getStartDate
String getStartDate()The date and time at which the acquisition started.- Returns:
- date and time at which the acquisition started
-
getStagePositionList
List<MultiStagePosition> getStagePositionList()The stage positions that were to be visited in the acquisition.- Returns:
- stage positions that were to be visited in the acquisition
-
getMultiWellPlate
MultiWellPlate getMultiWellPlate()Provides information about the MultiWellPlate used in the acquisition. Can be null.- Returns:
- MultiWellPlate instance.
-
getStagePositions
Deprecated.- Use getStagePositionList() insteadDeprecated.- Returns:
- see getStagePostionList()
-
getUserData
PropertyMap getUserData()Any general-purpose user meta data.- Returns:
- Any general-purpose user meta data
-
getInitialScopeData
PropertyMap getInitialScopeData()Device properties at the start of the acquisition.This is analogous to Metadata.getScopeData(), which contains the device properties at the time of each image capture. InitialScopeData contains the device properties at the start of the acquisition, before any acquisition-related changes.
- Returns:
- PropertyMap with device properties in "DeviceLabel-PropertyName" format
-
getSequenceSettings
SequenceSettings getSequenceSettings()Settings that define the Multi-Dimensional Acquisition specified by the user to acquire this data set.- Returns:
- The settings that define this MDA.
-
getImageWidth
Integer getImageWidth()ImageWidth in pixels.- Returns:
- ImageWidth in pixels. Null if Image Width is not known.
-
getImageHeight
Integer getImageHeight()ImageHeight in pixels.- Returns:
- ImageHeight in pixels. Null if Image Height is not know.
-