All Classes and Interfaces
Class
Description
Abstract implementation of the
DataViewer interface.A panel containing a section of the inspector window.
Abstract implementation of
Overlay.This event signifies that an acquisition has been ended.
This interface provides access to methods related to the acquisition engine
for performing experiments.
This variant of the AcquisitionStartedEvent is used for acquisitions that
can be described by a
SequenceSettings, it provides access to those
SequenceSettings.The default implementation of this event posts on the Studio event bus,
so subscribe to this event using
EventManager.This class signals that an acquisition is starting, and provides access to
the Datastore that images from the acquisition will be put into.
Interface for interacting with the Album, an implicit Datastore that
Micro-Manager uses as a "scratch pad" for image data.
An Alert is a temporary, undecorated message that is displayed to the user
in the Messages window.
The AlertManager allows you to show non-intrusive messages to the user,
which will be displayed in a special window, the Messages window.
A Annotation is a container for mutable information that is associated with
a Datastore.
Provides access to and control of various aspects of the user interface,
allowing code to directly update and control the GUI.
Provides access to methods dealing with the "skin" or "look and feel" of the
user interface.
Available skins used by the application.
This event is posted when the ApplicationSkin is set via
ApplicationSkin.setSkin(org.micromanager.ApplicationSkin.SkinMode).This entity provides access to methods for controlling autofocus of the
microscope.
This interface is used for a java-based autofocus plugin.
Deprecated.
use
This event is posted when autoshutter is enabled or disabled.
Stores the display settings for individual channels Coords of image to be displayed.
Builder for ChannelDisplaySettings.
This class signals when the exposure time for one of the channels of the
current channel group has been changed.
Event signaling that the "Channel Group" changed.
The intensity (brightness/contrast) scaling ranges for all components of one channel.
Builder for
ChannelIntensityRanges.A ChannelSpec is a description of how a specific channel will be used in an
MDA (multi-dimensional acquisition).
ChannelSpec Builder.
Legacy interface that implements some methods from the old 1.4 API.
Certain cameras (such as RGB cameras) can produce images where each pixel has multiple
components.
Interface for ComponentDisplaySettings Builder.
The intensity (brightness/contrast) scaling range for a single image component.
Builder for
ComponentIntensityRange.Event signaling that the "active" preset in a config group changed.
Static helper functions to assist working with Coords.
The multi-dimensional coordinate of a 2D image within a dataset.
The real Builder for Coords.
Not sure why there is a Builder and CoordsBuilder.
This class provides general utility functions for working with
Micro-Manager data.
Read-only access to multi-dimensional image data.
This class signifies that an image has been added to a DataProvider.
This event posts when the DataStore gets a new name, i.e.
This class signifies that new summary metadata has been set for a
DataProvider.
Read/write access to multi-dimensional image data.
The file format to save to.
This class signifies that a Datastore's close() method has been called, and
thus that all resources associated with that Datastore, and references to
the Datastore, should be removed so that it can be garbage collected.
This class signifies that a Datastore has become frozen and can no longer
be written to (but read actions may still occur).
An unchecked exception thrown when an attempt is made to modify a Datastore
that has been frozen.
An unchecked exception thrown when an attempt is made to overwrite data in
a non-rewritable datastore.
General interface for any user interface displaying image data.
Adds an item to the gear menu of a viewer that is a
DataViewer but not
a DisplayWindow, such as the TiledDataViewer.Simple interface dedicated to the question if a dataviewer can be closed or not.
This event posts when a DataViewer displays an image(s).
DisplayGearMenuPlugins add items to be shown in the "gear menu" shown in
each DisplayWindow.
The intensity (brightness/contrast) scaling ranges for all channels and components
of a display.
Builder for
DisplayIntensityRanges.This interface declares generic display-related methods.
This event posts when the position (i.e., Channel, Time, Position, Slice,
possibly other Axes) in the display changed.
This class defines the parameters that control how a given DisplayWindow
displays data from the Datastore.
Builder for DisplaySettings.
ColorMode enums.
Deprecated.
TODO: explain
Deprecated.
Use DisplaySettings.Builder instead
Event used internally by a data viewer to respond to requests to update
the display settings.
A DisplayWindow is the interface to Micro-Manager's image display windows.
A ControlsFactory is used to provide custom controls for a DisplayWindow.
This interface provides access to the application-wide EventBus, on which
the events in the org.micromanager.events package are posted.
Any object that bears an internal event bus to which other objects can
subscribe to receive events.
This class signals when the exposure time for a given camera has changed.
This event posts whenever the GUI refreshes its state from the Core
(e.g.
Deprecated.
an improved API will be provided soon
A 2-dimensional pixel plane with associated multi-dimensional coordinates
and metadata.
This class signifies that an image has been deleted in the Datastore.
ImageExporters are used to generate linear sequences of images-as-rendered
by a DisplayWindow.
Allowed export formats.
This class provides access to utility methods for interoperating with
ImageJ.
This class signifies that an image has been overwritten in the Datastore.
An unchecked exception thrown when an image is put into a datastore that
already has an image of a different size and that does not support images
differing in size (currently non of the MM Datastores support images
differing in size.
A plugin providing a panel in the Inspector window.
IntroPlugins are used to customize the intro dialog that prompts the user
for which config file and profile to use.
This class signals that live mode has been turned on or off.
Provides access to logging and message display routines.
A MenuPlugin is a plugin that should appear under the "Plugins" menu.
This interface defines the metadata for Images.
Builder for Metadata.
Deprecated.
Use
Metadata.Builder insteadInterface that all events in Micro-Manager should inherit from.
Micro-Manager plugin interface.
This interface is the base interface for all Micro-Manager plugins.
Definition of a position in space in terms of available stages/drives.
Metadata describing a multi-well plate, modelled after the OME Plate element.
Builder for MultiWellPlate, see
MultiWellPlate for function descriptions.An interface to a property-map-like object that can be modified.
This class signifies that the configuration of the application pipeline
has changed, giving entities that use that pipeline an opportunity to make
a new copy of it (by invoking DataManager.copyApplicationPipeline()).
This event posts when the application's Stage Position List changes
(positions added, removed, or moved).
A graphic object displayed over images.
A plugin providing overlays.
Interface for data viewers that support MM Inspector overlays without
implementing the full
DisplayWindow.Pipelines are used to apply a sequence of Processors to Images prior to
those images being inserted into a Datastore.
This exception is thrown when Pipeline.insertImage() has been called after
an error occurred in one of the Processors in the Pipeline.
This event posts when the affine transform, describing the relation between
stage movement and camera coordinates, changes.
This event posts when the pixel size, the size of a camera pixel in the object
plane, changes.
This class provides access to plugins that have been detected by
Micro-Manager at startup.
Navigation list of positions for the Stages.
Provides an iterator for a PositionList.
This entity provides access to methods for interacting with the Stage
PositionList.
Processors manipulate images before they are added to a Datastore.
ProcessorPluginConfigurators are used to generate the PropertyMaps needed
to set up a ProcessorFactory.
A ProcessorContext is an object that allows Processors to communicate with
the ProcessorPipeline.
A ProcessorFactory is an object that generates new DataProcessors.
A ProcessorPlugin is the "root" class for creating Processors, which
are used to modify images as they are collected by Micro-Manager.
This class signals when any property of the microscope has changed.
This class provides information when a specific property changes.
Provides access to PropertyMaps.
An immutable typed key-value store for various settings.
Builder for
PropertyMap.A value that can be stored in a property map.
Deprecated.
Deprecated.
If necessary, catch ClassCastException instead.
Static methods to create PropertyMap instances.
The QuickAccessManager provides API access to the Quick Access Panel(s).
QuickAccessPlugins are used for controls that can show up in the Quick-
Access Window, which shows frequently-used controls.
RewritableDatastores are Datastores that allow images and SummaryMetadata
to be deleted or overwritten after they have been inserted.
This interface is for Storage entities that allow the overwriting and
deletion of Images and SummaryMetadata, as per RewritableDatastore.
Utility functions for validating and applying ScopeData (PropertyMap from
image metadata) to hardware.
Options for controlling how ScopeData is applied to hardware.
Builder for ApplyOptions.
Result of applying ScopeData to hardware.
Represents a property change with both previous and new values.
Represents a single property entry from ScopeData.
Represents a property that failed to apply with error information.
Result of validating ScopeData against current hardware configuration.
Provides access to some utility methods for use in the Beanshell scripting
panel.
This exception signifies that the Beanshell interpreter has a stop
request pending, which prevents most interactions with the system.
SequenceSettings objects contain the parameters describing how to run a
single acquisition.
SequenceSettings Builder.
This event posts when the user requests the program to shut down.
This event posts when the shutter opens or closes.
This class provides access to the shutter controls, allowing you to
open or close the shutter, as well as turn autoshutter on or off.
Event that may fire when a Shutter opened or closed
(at the discretion of the device adapter).
This plugin type is used for buttons that can be embedded in the
Quick-Access Window.
This interface posts when the exposure time for a given Spatial Light Modulator
(such as a Digital Mirror Device) changes.
Interface for interacting with the Snap/Live display and live mode.
Description of the position of a 1 or 2 axis stage.
This class signals when a single-axis drive has moved.
This event signifies that the system finished starting up.
Storages are responsible for providing image data to Datastores when
requested.
Interface to execute commands in the main panel.
This class defines the summary metadata that applies to all images in a
dataset.
Builder for SummaryMetadata.
Deprecated.
- Use SummaryMetadata.Builder instead
This interface signals when a configuration file is loaded.
Opens a tiled (pyramidal) dataset in a viewer of its own choosing.
This plugin type is used for buttons that can be embedded in the
Quick-Access Window.
UpdatableAlerts are Alerts whose message texts can be changed after they have
been posted.
A user profile, where user preferences can be stored.
Interface for object providing user profile setting migration.
Automatically migrate user profile settings.
This plugin allows arbitrary controls ("widgets") to be included in the
Quick-Access Window.
This class signals when any XY stage changes position.