Uses of Interface
org.micromanager.data.Coords

Packages that use Coords

Package	Description
org.micromanager.data	This package contains classes related to the storage and internal representation of image data and metadata.
org.micromanager.display	This package contains classes related to Micro-Manager's display windows, which are used to show image data and metadata to the user.

Uses of Coords in org.micromanager.data

Methods in org.micromanager.data that return Coords

Modifier and Type	Method	Description
Coords	Coords.Builder.build()
Coords	Coords.CoordsBuilder.build()
Coords	Coords.copyRemovingAxes(String... axes)	Removes the axes provided as varargs from this Coord.
Coords	Coords.copyRetainingAxes(String... axes)	Name of this function is very unclear.
Coords	DataManager.createCoords(String def)	Deprecated. use of Strings for Coords is discouraged
static Coords	Coordinates.fromPropertyMap(PropertyMap pmap)	Constructs a Coords instance from a PropertyMap.
Coords	DataProviderHasNewImageEvent.getCoords()	Returns Coords for the image.
Coords	Image.getCoords()	Retrieve the Coords of this Image.
Coords	SummaryMetadata.getIntendedDimensions()	The expected number of images along each axis that were to be collected.
Coords	DataProvider.getMaxIndices()	Deprecated. Use DataProvider.getNextIndex(String axis) instead
Coords	Storage.getMaxIndices()	Return a Coords that provides the maximum index along all available axes.

Methods in org.micromanager.data that return types with arguments of type Coords

Modifier and Type	Method	Description
Iterable<Coords>	DataProvider.getUnorderedImageCoords()
Iterable<Coords>	Storage.getUnorderedImageCoords()	Return an Iterable that provides access to all image coordinates in the Storage, in arbitrary order.

Methods in org.micromanager.data with parameters of type Coords

Modifier and Type	Method	Description
Image	DataManager.convertTaggedImage(mmcorej.TaggedImage tagged, Coords coords, Metadata metadata)	Given a TaggedImage input, output an Image based on the TaggedImage, but with the Coords and/or Metadata optionally overridden.
Image	Image.copyAtCoords(Coords coords)	Generate a copy of this Image, except with different coordinates.
Image	Image.copyWith(Coords coords, Metadata metadata)	Generate a copy of this Image, except with different coordinates and metadata.
Image	DataManager.createImage(Object pixels, int width, int height, int bytesPerPixel, int numComponents, Coords coords, Metadata metadata)	Generate a new Image with the provided pixel data, rules for interpreting that pixel data, coordinates, and metadata.
Image	ImageJConverter.createImage(ij.process.ImageProcessor processor, Coords coords, Metadata metadata)	Create a new Image based on the provided ImageProcessor and metadata.
void	RewritableDatastore.deleteImage(Coords coords)	Delete an image from the Datastore.
void	RewritableStorage.deleteImage(Coords coords)	Delete an image from the Storage.
void	RewritableDatastore.deleteImagesMatching(Coords coords)	Delete all images from the Datastore whose coordinates match the provided Coords object, which may be underspecified.
Image	DataProvider.getImage(Coords coords)	Returns the image at the given position.
Image	Storage.getImage(Coords coords)	Retrieve the Image located at the specified coordinates.
PropertyMap	Annotation.getImageAnnotation(Coords coords)	Return a PropertyMap of information stored by this Annotation related to the image at the specified coordinates.
List<Image>	DataProvider.getImagesIgnoringAxes(Coords coords, String... ignoreTheseAxes)	Returns a list of image in the DataProvider's collection that have identical coords after removing the given axes from both source and target.
List<Image>	Storage.getImagesIgnoringAxes(Coords coords, String... ignoreTheseAxes)	Retrieve a list of images with Coords identical to the given Coords instance, except for the axes listed in the exception list.
List<Image>	DataProvider.getImagesMatching(Coords coords)	Deprecated. - instead use getImagesIgnoringAxes
List<Image>	Storage.getImagesMatching(Coords coords)	Retrieve a list of all images whose Coords match the given incomplete Coords instance.
boolean	DataProvider.hasImage(Coords coords)
boolean	Storage.hasImage(Coords coords)	Returns whether or not an image exists at the specified coordinates.
SummaryMetadata.Builder	SummaryMetadata.Builder.intendedDimensions(Coords intendedDimensions)
SummaryMetadata.SummaryMetadataBuilder	SummaryMetadata.SummaryMetadataBuilder.intendedDimensions(Coords intendedDimensions)	Deprecated.
boolean	Coords.matches(Coords alt)	Deprecated. Use equality (after removing specific axes) instead
void	Annotation.setImageAnnotation(Coords coords, PropertyMap newData)	Replace the data this Annotation has for the specified Image with the provided PropertyMap.
Image	DataManager.wrapImage(Object pixels, int width, int height, int bytesPerPixel, int numComponents, Coords coords, Metadata metadata)	Generate a new Image with the provided pixel data, rules for interpreting that pixel data, coordinates, and metadata.

Uses of Coords in org.micromanager.display

Methods in org.micromanager.display that return Coords

Modifier and Type	Method	Description
final Coords	AbstractDataViewer.getDisplayPosition()	Implements getDisplayPosition.
Coords	DataViewer.getDisplayPosition()	Get the coordinates for the currently displayed images.
Coords	DisplayPositionChangedEvent.getDisplayPosition()	returns the new display position.
Coords	DisplayPositionChangedEvent.getPreviousDisplayPosition()	Returns the previously displayed position.
protected abstract Coords	AbstractDataViewer.handleDisplayPosition(Coords position)

Methods in org.micromanager.display with parameters of type Coords

Modifier and Type	Method	Description
final boolean	AbstractDataViewer.compareAndSetDisplayPosition(Coords oldPosition, Coords newPosition)
final boolean	AbstractDataViewer.compareAndSetDisplayPosition(Coords oldPosition, Coords newPosition, boolean forceRedisplay)	Implements compareAndSetDisplayPosition.
boolean	DataViewer.compareAndSetDisplayPosition(Coords originalPosition, Coords newPosition)	Set the display position only if the current position is the expected one.
boolean	DataViewer.compareAndSetDisplayPosition(Coords originalPosition, Coords newPosition, boolean forceRedisplay)	Set the display position only if the current position is the expected one.
protected abstract Coords	AbstractDataViewer.handleDisplayPosition(Coords position)
final void	AbstractDataViewer.setDisplayedImageTo(Coords coords)	Deprecated. user code should call setDisplayPosition
void	DataViewer.setDisplayedImageTo(Coords position)	Deprecated. use DataViewer.setDisplayPosition(Coords) instead
final void	AbstractDataViewer.setDisplayPosition(Coords position)
final void	AbstractDataViewer.setDisplayPosition(Coords position, boolean forceRedisplay)	Implements setDisplayPosition.
void	DataViewer.setDisplayPosition(Coords position)	Display the images at the specified coordinates in the data provider.
void	DataViewer.setDisplayPosition(Coords position, boolean forceRedisplay)	Display the images at the specified coordinates in the data provider.