org.micromanager

Class StagePosition

java.lang.Object

org.micromanager.StagePosition

public class StagePosition
extends java.lang.Object

Description of the position of a 1 or 2 axis stage.

Field Summary

Fields

Modifier and Type	Field and Description
int	numAxes Deprecated. Use set1DPosition(java.lang.String, double) or set2DPosition(java.lang.String, double, double) to set; use getNumberOfStageAxes(), is1DStagePosition(), or is2DStagePosition() to access.
java.lang.String	stageName Deprecated. Use set1DPosition(java.lang.String, double) or set2DPosition(java.lang.String, double, double) to set; use getStageDeviceLabel() to access.
double	x Deprecated. Use methods instead.
double	y Deprecated. Use methods instead.
double	z Deprecated.

Constructor Summary

Constructors

Constructor and Description
StagePosition() Deprecated. Use create1D(java.lang.String, double) or create2D(java.lang.String, double, double) instead.

Method Summary

Modifier and Type	Method and Description
static StagePosition	create1D(java.lang.String stageDeviceLabel, double z) Creates a new StapePosition for a 1 axis drive.
static StagePosition	create2D(java.lang.String stageDeviceLabel, double x, double y) Creates a new StapePosition for a 2 axis drive.
boolean	equals(java.lang.Object alt) Compare us against the provided StagePosition and return true only if we are equal in all respects.
static StagePosition	fromPropertyMap(PropertyMap pmap) Returns the given PrropertyMap as a StagePosition.
double	get1DPosition()
double	get2DPositionX()
double	get2DPositionY()
int	getNumberOfStageAxes()
java.lang.String	getStageDeviceLabel()
java.lang.String	getVerbose() Verbose description of this StagePosition.
int	hashCode()
boolean	is1DStagePosition()
boolean	is2DStagePosition()
static StagePosition	newInstance(StagePosition aPos) Creates a copy of a StagePosition object.
void	set1DPosition(java.lang.String stageDeviceLabel, double z) Sets the position of a stage device in this StagePosition instance.
void	set2DPosition(java.lang.String stageDeviceLabel, double x, double y) Sets the position of an XY stage device in this StagePosition instance.
PropertyMap	toPropertyMap() Returns this StagePosition instance as a PropertyMap.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

x

@Deprecated
public double x

Deprecated. Use methods instead.

For two-axis stages, the X position; for one-axis stages, the only stage position. For example, if using a Z focus drive, its position would be given by the "x" parameter.

y

@Deprecated
public double y

Deprecated. Use methods instead.

The Y position for two-axis stages.

z

@Deprecated
public double z

Deprecated.

RESERVED: do not use.

stageName

@Deprecated
public java.lang.String stageName

Deprecated. Use set1DPosition(java.lang.String, double) or set2DPosition(java.lang.String, double, double) to set; use getStageDeviceLabel() to access.

The stage device label.

numAxes

@Deprecated
public int numAxes

Deprecated. Use set1DPosition(java.lang.String, double) or set2DPosition(java.lang.String, double, double) to set; use getNumberOfStageAxes(), is1DStagePosition(), or is2DStagePosition() to access.

The number of stage axes. Must be 1 or 2.

Constructor Detail

StagePosition

@Deprecated
public StagePosition()

Deprecated. Use create1D(java.lang.String, double) or create2D(java.lang.String, double, double) instead.

Default constructor.

Method Detail

create1D

public static StagePosition create1D(java.lang.String stageDeviceLabel,
                                     double z)

Creates a new StapePosition for a 1 axis drive.

Parameters:

stageDeviceLabel - name of the stage/drive

z - position

Returns:

StagePosition object based on the input

create2D

public static StagePosition create2D(java.lang.String stageDeviceLabel,
                                     double x,
                                     double y)

Creates a new StapePosition for a 2 axis drive.

Parameters:

stageDeviceLabel - name of the stage/drive

x - position-x

y - position-y

Returns:

StagePosition object based on the input

newInstance

public static StagePosition newInstance(StagePosition aPos)

Creates a copy of a StagePosition object.

Parameters:

aPos - StagePosition to be copied. Should not be null/

Returns:

Copy of the given StagePosition

set2DPosition

public void set2DPosition(java.lang.String stageDeviceLabel,
                          double x,
                          double y)

Sets the position of an XY stage device in this StagePosition instance.

Parameters:

stageDeviceLabel - String identifying the stage

x - New x position

y - New Y position

set1DPosition

public void set1DPosition(java.lang.String stageDeviceLabel,
                          double z)

Sets the position of a stage device in this StagePosition instance.

Parameters:

stageDeviceLabel - String identifying the stage

z - New position

getStageDeviceLabel

public java.lang.String getStageDeviceLabel()

getNumberOfStageAxes

public int getNumberOfStageAxes()

is2DStagePosition

public boolean is2DStagePosition()

is1DStagePosition

public boolean is1DStagePosition()

get2DPositionX

public double get2DPositionX()

get2DPositionY

public double get2DPositionY()

get1DPosition

public double get1DPosition()

getVerbose

public java.lang.String getVerbose()

Verbose description of this StagePosition.

Returns:

Description of this StagePosition as a String.

equals

public boolean equals(java.lang.Object alt)

Compare us against the provided StagePosition and return true only if we are equal in all respects.

Overrides:

equals in class java.lang.Object

Parameters:

alt - Other StagePosition to compare against.

Returns:

true if every field in alt equals our corresponding field.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toPropertyMap

public PropertyMap toPropertyMap()

Returns this StagePosition instance as a PropertyMap.

Returns:

PropertyMap representation of this StagePosition.

fromPropertyMap

public static StagePosition fromPropertyMap(PropertyMap pmap)

Returns the given PrropertyMap as a StagePosition.

Parameters:

pmap - Input PropertyMap

Returns:

StagePosition representation of this PropertyMap.