Package omeis.providers.re.data

Class PlaneDef

  • All Implemented Interfaces:
    java.io.Serializable
    public class PlaneDef
extends java.lang.Object
implements java.io.Serializable
    Identifies a 2D-plane in the XYZ moving frame of the 3D stack. Tells which plane the wavelengths to render belong to.
    Since:
    OME2.2
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      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

      Constructors 
      Constructor Description
      PlaneDef​(int slice, int t)
      Creates a new instance.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object o)
      Overridden to reflect equality of abstract values (data object) as opposite to object identity.
      RegionDef getRegion()
      Returns the region to render.
      boolean getRenderShapes()
      Returns whether or not the shapes (masks) will be rendered.
      java.util.List<java.lang.Long> getShapeIds()
      Returns whether or not the shapes (masks) will be rendered.
      int getSlice()
      Returns an identifier to tell which kind of plane this object identifies.
      int getStride()
      Returns the stride.
      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 setRegion​(RegionDef region)
      Sets the region to render.
      void setRenderShapes​(boolean renderShapes)
      Sets whether or not to render the shapes (masks).
      void setShapeIds​(java.util.List<java.lang.Long> shapeIds)
      Sets whether or not to render the shapes (masks).
      void setStride​(int stride)
      Returns the stride.
      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.
      java.lang.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

    • Constructor Detail

      • PlaneDef

        public PlaneDef​(int slice,
                int t)
        Creates a new instance. This new object will identify the plane belonging to the set specified by slice and t and having a 0 index. Call the appropriate setXXX method to set another index.
        Parameters:
        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.
        Throws:
        java.lang.IllegalArgumentException - If bad arguments are passed in.

    • Method Detail

      • setX

        public void setX​(int x)
        Selects a plane in the set identified by this object. Can only be called in the context of an ZY-plane.
        Parameters:
        x - The plane index.
        Throws:
        java.lang.IllegalArgumentException - If bad arguments are passed in or this is not an ZY-plane.

      • setY

        public void setY​(int y)
        Selects a plane in the set identified by this object. Can only be called in the context of an XZ-plane.
        Parameters:
        y - The plane index.
        Throws:
        java.lang.IllegalArgumentException - If bad arguments are passed in or this is not an XZ-plane.

      • setZ

        public void setZ​(int z)
        Selects a plane in the set identified by this object. Can only be called in the context of an XY-plane.
        Parameters:
        z - The plane index.
        Throws:
        java.lang.IllegalArgumentException - If bad arguments are passed in or this is not an XY-plane.

      • getSlice

        public int getSlice()
        Returns an identifier to tell which kind of plane this object identifies.
        Returns:
        One of the XY, XZ or ZY constants defined by this class.

      • getT

        public int getT()
        Returns the timepoint.
        Returns:
        See above.

      • getX

        public int getX()
        Returns the index of the plane in the set identified by this object. Only relevant in the case of an YZ-plane.
        Returns:
        See above.

      • getY

        public int getY()
        Returns the index of the plane in the set identified by this object. Only relevant in the case of an XZ-plane.
        Returns:
        See above.

      • getZ

        public int getZ()
        Returns the index of the plane in the set identified by this object. Only relevant in the case of an XY-plane.
        Returns:
        See above.

      • setRegion

        public void setRegion​(RegionDef region)
        Sets the region to render.
        Parameters:
        region - The region to render.

      • getRegion

        public RegionDef getRegion()
        Returns the region to render.
        Returns:
        See above.

      • setStride

        public void setStride​(int stride)
        Returns the stride.
        Parameters:
        stride - The value to set.

      • getStride

        public int getStride()
        Returns the stride.
        Returns:
        See above.

      • getRenderShapes

        public boolean getRenderShapes()
        Returns whether or not the shapes (masks) will be rendered.
        Returns:
        See above.

      • setRenderShapes

        public void setRenderShapes​(boolean renderShapes)
        Sets whether or not to render the shapes (masks).
        Parameters:
        renderShapes - The value to set.

      • getShapeIds

        public java.util.List<java.lang.Long> getShapeIds()
        Returns whether or not the shapes (masks) will be rendered.
        Returns:
        See above.

      • setShapeIds

        public void setShapeIds​(java.util.List<java.lang.Long> shapeIds)
        Sets whether or not to render the shapes (masks).
        Parameters:
        shapeIds - The value to set.

      • equals

        public boolean equals​(java.lang.Object o)
        Overridden to reflect equality of abstract values (data object) as opposite to object identity.
        Overrides:
        equals in class java.lang.Object
        See Also:
        Object.equals(Object)

      • hashCode

        public int hashCode()
        Overridden to reflect equality of abstract values (data object) as opposite to object identity.
        Overrides:
        hashCode in class java.lang.Object
        See Also:
        Object.hashCode()

      • toString

        public java.lang.String toString()
        Overrides generic toString method to provide a specific string representation of this object.
        Overrides:
        toString in class java.lang.Object
        See Also:
        Object.toString()