pojos
Class ROIData

java.lang.Object
  extended by pojos.DataObject
      extended by pojos.ROIData

public class ROIData
extends DataObject

Converts the ROI object.

Since:
3.0-Beta4
Version:
3.0 (Internal version: $Revision: $Date: $)
Author:
Jean-Marie Burel      j.burel@dundee.ac.uk, Donald MacDonald      donald@lifesci.dundee.ac.uk

Constructor Summary
ROIData(omero.model.Roi roi)
          Creates a new instance.
 
Method Summary
 ROICoordinate firstPlane()
          Return the first plane that the ROI starts on.
 Iterator<List<ShapeData>> getIterator()
          Returns the iterator of the collection of the map.
 List<ShapeData> getShapes(int z, int t)
          Returns the list of shapes on a given plane.
 Iterator<List<ShapeData>> getShapesInRange(ROICoordinate start, ROICoordinate end)
          Returns an iterator of the Shapes in the ROI in the range [start, end].
 ROICoordinate lastPlane()
          Returns the last plane that the ROI ends on.
 
Methods inherited from class pojos.DataObject
asAnnotation, asChannel, asDataset, asExperimenter, asGroup, asIAnnotated, asImage, asIObject, asPixels, asPlate, asPojo, asPojos, asPojos, asProject, asScreen, asWell, asWellSample, getCreated, getDetails, getId, getOwner, getPermissions, getUpdated, getVersion, isDirty, isLoaded, nullDetails, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, setDirty, setId, setValue, setVersion, timeOfEvent, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ROIData

public ROIData(omero.model.Roi roi)
Creates a new instance.

Parameters:
roi - The ROI hosted by the component.
Method Detail

getShapes

public List<ShapeData> getShapes(int z,
                                 int t)
Returns the list of shapes on a given plane.

Parameters:
z - The z-section.
t - The timepoint.
Returns:
See above.

getIterator

public Iterator<List<ShapeData>> getIterator()
Returns the iterator of the collection of the map.

Returns:
See above.

firstPlane

public ROICoordinate firstPlane()
Return the first plane that the ROI starts on.

Returns:
See above.

lastPlane

public ROICoordinate lastPlane()
Returns the last plane that the ROI ends on.

Returns:
See above.

getShapesInRange

public Iterator<List<ShapeData>> getShapesInRange(ROICoordinate start,
                                                  ROICoordinate end)
Returns an iterator of the Shapes in the ROI in the range [start, end].

Parameters:
start - The starting plane where the Shapes should reside.
end - The final plane where the Shapes should reside.
Returns:
See above.


OmeroJava Api

Version: Beta-4.1.1-r5927-b91

Copyright © 2009 The University of Dundee. All Rights Reserved.