org.micromanager.api

Class MMWindow

java.lang.Object

org.micromanager.api.MMWindow

public class MMWindow
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
MMWindow(ij.ImagePlus imp)

Method Summary

Modifier and Type	Method and Description
org.json.JSONObject	getImageMetadata(int channel, int slice, int frame, int position) Note: this function is preliminary.
ij.ImagePlus	getImagePlus(int position) Returns an ImageJ ImagePlus for a given position Does not update the display
ij.process.ImageProcessor	getImageProcessor(int channel, int slice, int frame, int position)
int	getNumberOfChannels()
int	getNumberOfFrames()
int	getNumberOfPositions()
int	getNumberOfSlices()
int	getPosition() Returns the current position of the image viewer Positions are 1-based
org.json.JSONObject	getSummaryMetaData() Note: this function is preliminary.
mmcorej.TaggedImage	getTaggedImage(int channel, int slice, int frame, int position)
boolean	isMMWindow()
void	setPosition(int position) Sets the display to the given position Position are 1-based

Methods inherited from class java.lang.Object

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

Constructor Detail

MMWindow

public MMWindow(ij.ImagePlus imp)

Method Detail

isMMWindow

public boolean isMMWindow()

getNumberOfPositions

public int getNumberOfPositions()

getNumberOfChannels

public int getNumberOfChannels()

getNumberOfSlices

public int getNumberOfSlices()

getNumberOfFrames

public int getNumberOfFrames()

setPosition

public void setPosition(int position)
                 throws org.micromanager.utils.MMScriptException

Sets the display to the given position Position are 1-based

Parameters:

position -

Throws:

org.micromanager.utils.MMScriptException

getPosition

public int getPosition()
                throws org.micromanager.utils.MMScriptException

Returns the current position of the image viewer Positions are 1-based

Returns:

The current position of the image viewer

Throws:

org.micromanager.utils.MMScriptException

getImagePlus

public ij.ImagePlus getImagePlus(int position)

Returns an ImageJ ImagePlus for a given position Does not update the display

Parameters:

position -

Returns:

ImageJ ImagePlus

getImageProcessor

public ij.process.ImageProcessor getImageProcessor(int channel,
                                                   int slice,
                                                   int frame,
                                                   int position)
                                            throws org.micromanager.utils.MMScriptException

Throws:

org.micromanager.utils.MMScriptException

getSummaryMetaData

public org.json.JSONObject getSummaryMetaData()

Note: this function is preliminary. It is likely to be removed/replaced soon. Do not use.

Returns:

Summary metadata associated with underling virtual acquistion

getImageMetadata

public org.json.JSONObject getImageMetadata(int channel,
                                            int slice,
                                            int frame,
                                            int position)

Note: this function is preliminary. It is likely to be removed/replaced soon. Do not use. Returns image metadata of specified image

Parameters:

channel -

slice -

frame -

position -

Returns:

metadata in JSON format

getTaggedImage

public mmcorej.TaggedImage getTaggedImage(int channel,
                                          int slice,
                                          int frame,
                                          int position)