Class StagePosition
java.lang.Object
org.micromanager.StagePosition
Description of the position of a 1 or 2 axis stage.
-
Field Summary
FieldsModifier and TypeFieldDescriptionintDeprecated.Deprecated.Useset1DPosition(String, double)orset2DPosition(String, double, double)to set; usegetStageDeviceLabel()to access.doubleDeprecated.Use methods instead.doubleDeprecated.Use methods instead.doubleDeprecated. -
Constructor Summary
ConstructorsConstructorDescriptionDeprecated.Usecreate1D(String, double)orcreate2D(String, double, double)instead. -
Method Summary
Modifier and TypeMethodDescriptionstatic StagePositionCreates a new StapePosition for a 1 axis drive.static StagePositionCreates a new StapePosition for a 2 axis drive.booleanCompare us against the provided StagePosition and return true only if we are equal in all respects.static StagePositionfromPropertyMap(PropertyMap pmap) Returns the given PrropertyMap as a StagePosition.doubledoubledoubleintVerbose description of this StagePosition.inthashCode()booleanbooleanstatic StagePositionnewInstance(StagePosition aPos) Creates a copy of a StagePosition object.voidset1DPosition(String stageDeviceLabel, double z) Sets the position of a stage device in this StagePosition instance.voidset2DPosition(String stageDeviceLabel, double x, double y) Sets the position of an XY stage device in this StagePosition instance.Returns this StagePosition instance as a PropertyMap.toString()
-
Field Details
-
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
-
z
-
stageName
Deprecated.Useset1DPosition(String, double)orset2DPosition(String, double, double)to set; usegetStageDeviceLabel()to access.The stage device label. -
numAxes
Deprecated.Useset1DPosition(String, double)orset2DPosition(String, double, double)to set; usegetNumberOfStageAxes(),is1DStagePosition(), oris2DStagePosition()to access.The number of stage axes. Must be 1 or 2.
-
-
Constructor Details
-
StagePosition
Deprecated.Usecreate1D(String, double)orcreate2D(String, double, double)instead.Default constructor.
-
-
Method Details
-
create1D
Creates a new StapePosition for a 1 axis drive.- Parameters:
stageDeviceLabel- name of the stage/drivez- position- Returns:
- StagePosition object based on the input
-
create2D
Creates a new StapePosition for a 2 axis drive.- Parameters:
stageDeviceLabel- name of the stage/drivex- position-xy- position-y- Returns:
- StagePosition object based on the input
-
newInstance
Creates a copy of a StagePosition object.- Parameters:
aPos- StagePosition to be copied. Should not be null/- Returns:
- Copy of the given StagePosition
-
set2DPosition
Sets the position of an XY stage device in this StagePosition instance.- Parameters:
stageDeviceLabel- String identifying the stagex- New x positiony- New Y position
-
set1DPosition
Sets the position of a stage device in this StagePosition instance.- Parameters:
stageDeviceLabel- String identifying the stagez- New position
-
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
Verbose description of this StagePosition.- Returns:
- Description of this StagePosition as a String.
-
equals
-
hashCode
-
toString
-
toPropertyMap
Returns this StagePosition instance as a PropertyMap.- Returns:
- PropertyMap representation of this StagePosition.
-
fromPropertyMap
Returns the given PrropertyMap as a StagePosition.- Parameters:
pmap- Input PropertyMap- Returns:
- StagePosition representation of this PropertyMap.
-
set1DPosition(String, double)orset2DPosition(String, double, double)to set; usegetNumberOfStageAxes(),is1DStagePosition(), oris2DStagePosition()to access.