org.micromanager.api

Class MultiStagePosition

java.lang.Object

org.micromanager.api.MultiStagePosition

public final class MultiStagePosition
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
MultiStagePosition() Default constructor.
MultiStagePosition(java.lang.String xyStage, double x, double y, java.lang.String zStage, double z) Convenient constructor where the motion system consists of one XY stage and one focus stage.

Method Summary

Modifier and Type	Method and Description
void	add(StagePosition sp) Add one stage position point
StagePosition	get(int idx) Return stage position based on index
StagePosition	get(java.lang.String stageName) Returns position for a specific stage.
java.lang.String	getDefaultXYStage()
java.lang.String	getDefaultZStage()
int	getGridColumn() Returns rectangular grid column.
int	getGridRow() Returns rectangular grid row.
java.lang.String	getLabel() Returns position label.
java.lang.String	getProperty(java.lang.String key) Returns property value for a given key (name)
java.lang.String[]	getPropertyNames() Return the array of property keys (names) associated with this position
double	getX() Returns "X" coordinate of the position.
double	getY() Returns "Y" coordinate of the position.
double	getZ() Returns "Z" - focus coordinate of the position.
static void	goToPosition(MultiStagePosition msp, mmcorej.CMMCore core_) Moves all stages to the specified positions.
boolean	hasProperty(java.lang.String key) Checks if the position has a particular property
static MultiStagePosition	newInstance(MultiStagePosition aMps) Copy constructor.
void	remove(StagePosition sp)
void	setDefaultXYStage(java.lang.String stage) Defines which stage serves as the XY motion control device
void	setDefaultZStage(java.lang.String stage) Defines which stage serves as focus control
void	setGridCoordinates(int row, int col) Sets grid parameters for the rectangular grid
void	setLabel(java.lang.String lab) Sets position label (such as well name, etc.)
void	setProperty(java.lang.String key, java.lang.String value) Add a generalized property-value par to the position.
int	size() Number of stages.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiStagePosition

public MultiStagePosition()

Default constructor.

MultiStagePosition

public MultiStagePosition(java.lang.String xyStage,
                          double x,
                          double y,
                          java.lang.String zStage,
                          double z)

Convenient constructor where the motion system consists of one XY stage and one focus stage.

Parameters:

xyStage - name

x - - coordinate in microns

y - - coordinate in microns

zStage - name

z - - focus position in microns

Method Detail

newInstance

public static MultiStagePosition newInstance(MultiStagePosition aMps)

Copy constructor.

Parameters:

aMps - - another instance of the MultiStagePoswition class

Returns:

multistageposition

add

public void add(StagePosition sp)

Add one stage position point

remove

public void remove(StagePosition sp)

size

public int size()

Number of stages.

get

public StagePosition get(int idx)

Return stage position based on index

Parameters:

idx - - position index

Returns:

stageposition

setProperty

public void setProperty(java.lang.String key,
                        java.lang.String value)

Add a generalized property-value par to the position.

getPropertyNames

public java.lang.String[] getPropertyNames()

Return the array of property keys (names) associated with this position

hasProperty

public boolean hasProperty(java.lang.String key)

Checks if the position has a particular property

getProperty

public java.lang.String getProperty(java.lang.String key)

Returns property value for a given key (name)

get

public StagePosition get(java.lang.String stageName)

Returns position for a specific stage.

getLabel

public java.lang.String getLabel()

Returns position label.

setLabel

public void setLabel(java.lang.String lab)

Sets position label (such as well name, etc.)

setDefaultZStage

public void setDefaultZStage(java.lang.String stage)

Defines which stage serves as focus control

getDefaultZStage

public java.lang.String getDefaultZStage()

getDefaultXYStage

public java.lang.String getDefaultXYStage()

setDefaultXYStage

public void setDefaultXYStage(java.lang.String stage)

Defines which stage serves as the XY motion control device

goToPosition

public static void goToPosition(MultiStagePosition msp,
                                mmcorej.CMMCore core_)
                         throws java.lang.Exception

Moves all stages to the specified positions.

Parameters:

core_ - - microscope API

Throws:

java.lang.Exception

getX

public double getX()

Returns "X" coordinate of the position.

getY

public double getY()

Returns "Y" coordinate of the position.

getZ

public double getZ()

Returns "Z" - focus coordinate of the position.

setGridCoordinates

public void setGridCoordinates(int row,
                               int col)

Sets grid parameters for the rectangular grid

Parameters:

row -

col -

getGridRow

public int getGridRow()

Returns rectangular grid row.

Returns:

row

getGridColumn

public int getGridColumn()

Returns rectangular grid column.

Returns:

column