|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectomeis.providers.re.data.PlaneDef
public class PlaneDef
Identifies a 2D-plane in the XYZ moving frame of the 3D stack. Tells which plane the wavelengths to render belong to.
Field Summary | |
---|---|
static int |
XY
Flag to identify an XY-plane. |
static int |
XZ
Flag to identify an XZ-plane. |
static int |
ZY
Flag to identify an YZ-plane. |
Constructor Summary | |
---|---|
PlaneDef(int slice,
int t)
Creates a new instance. |
Method Summary | |
---|---|
boolean |
equals(Object o)
Overridden to reflect equality of abstract values (data object) as opposite to object identity. |
int |
getSlice()
Returns an identifier to tell which kind of plane this object identifies. |
int |
getT()
Returns the timepoint. |
int |
getX()
Returns the index of the plane in the set identified by this object. |
int |
getY()
Returns the index of the plane in the set identified by this object. |
int |
getZ()
Returns the index of the plane in the set identified by this object. |
int |
hashCode()
Overridden to reflect equality of abstract values (data object) as opposite to object identity. |
void |
setX(int x)
Selects a plane in the set identified by this object. |
void |
setY(int y)
Selects a plane in the set identified by this object. |
void |
setZ(int z)
Selects a plane in the set identified by this object. |
String |
toString()
Overrides generic toString method to provide a specific
string representation of this object. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int XY
public static final int ZY
public static final int XZ
Constructor Detail |
---|
public PlaneDef(int slice, int t)
slice
and t
and
having a 0
index. Call the appropriate setXXX
method to set another index.
slice
- Tells which kind of plane this object identifies. Must be one
of the XY
, XZ
, ZY
constants
defined by this class.t
- The selected timepoint.
IllegalArgumentException
- If bad arguments are passed in.Method Detail |
---|
public void setX(int x)
x
- The plane index.
IllegalArgumentException
- If bad arguments are passed in or this is not an ZY-plane.public void setY(int y)
y
- The plane index.
IllegalArgumentException
- If bad arguments are passed in or this is not an XZ-plane.public void setZ(int z)
z
- The plane index.
IllegalArgumentException
- If bad arguments are passed in or this is not an XY-plane.public int getSlice()
XY
, XZ
or ZY
constants
defined by this class.public int getT()
public int getX()
public int getY()
public int getZ()
public boolean equals(Object o)
equals
in class Object
Object.equals(Object)
public int hashCode()
hashCode
in class Object
Object.hashCode()
public String toString()
toString
method to provide a specific
string representation of this object.
toString
in class Object
Object.toString()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Version: Beta4.2.1-r8614-Beta4.2-b41
Copyright © 2009 The University of Dundee. All Rights Reserved.