public final class PositionInformation
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
POSITION_TYPE_CAMERA
Position type for multi-camera imaging.
|
static java.lang.String |
POSITION_TYPE_MAIN_POSITION
Position type for non-microplate measurements, which nevertheless have a main counter of the positions, which might be however arbitrary.
|
static java.lang.String |
POSITION_TYPE_XTILE
Position type representing the index of a tile in the x-direction
|
static java.lang.String |
POSITION_TYPE_YTILE
Position type representing the index of a tile in the y-direction
|
static java.lang.String |
POSITION_TYPE_ZSTACK
Position type representing the index of a job in a focus/z- stack.
|
Constructor and Description |
---|
PositionInformation()
Creates a new position information, representing the root of a position hierarchy.
|
PositionInformation(PositionInformation parentInformation,
java.lang.String positionType,
int position)
Creates a new position information out of a parent position information.
|
PositionInformation(Well well)
Creates a new position information, representing a given position in a well.
|
Modifier and Type | Method and Description |
---|---|
PositionInformation |
clone() |
boolean |
equals(java.lang.Object obj) |
int |
getNumPositions()
Returns the number of logical position types the job is executed in.
|
int |
getPosition(int idx)
Returns the n-th logical position the job is executed in.
|
int[] |
getPositions()
Returns all logical positions the job is in as an array, where the first element represents the outermost and the last the innermost position.
|
java.lang.String |
getPositionsString()
Returns a string with the position informations, separated by dashes.
|
java.lang.String |
getPositionString(int idx)
Returns a string representation composed of the position type and the position.
|
java.lang.String |
getPositionType(int idx)
Returns the n-th logical position type the job is executed in.
|
java.lang.String[] |
getPositionTypes()
Returns the types of positioning the logical positions of the job describe as an array, where the first element represents the outermost and the last the innermost position.
|
Well |
getWell()
Returns the well the job is executed in.
|
int |
hashCode() |
java.lang.String |
toString() |
public static final java.lang.String POSITION_TYPE_YTILE
public static final java.lang.String POSITION_TYPE_MAIN_POSITION
public static final java.lang.String POSITION_TYPE_XTILE
public static final java.lang.String POSITION_TYPE_ZSTACK
public static final java.lang.String POSITION_TYPE_CAMERA
public PositionInformation(Well well)
PositionInformation(PositionInformation parentInformation, String positionType, int position)
to add additional position information to sub-jobs, but keeping the information upper the hierarchy.well
- The well where the job gets evaluated.public PositionInformation()
PositionInformation(PositionInformation parentInformation, String positionType, int position)
to add additional position information to sub-jobs, but keeping the information upper the hierarchy.public PositionInformation(PositionInformation parentInformation, java.lang.String positionType, int position)
parentInformation
- The position information which is copied by this information. Must not be null.positionType
- The type of the position. Use constants defined in this class when possible, and otherwise strings with a length of at least 3 characters.position
- The position in the position type, starting at 0.public int[] getPositions()
public java.lang.String getPositionsString()
public java.lang.String[] getPositionTypes()
public java.lang.String toString()
toString
in class java.lang.Object
public Well getWell()
public int getNumPositions()
public int getPosition(int idx)
idx
- index of the position.public java.lang.String getPositionType(int idx)
idx
- index of the position type.public java.lang.String getPositionString(int idx)
idx
- index of the position for which a string representation should be extracted.public PositionInformation clone()
clone
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object