Package omero.gateway.model

Class ROIData

java.lang.Object

omero.gateway.model.DataObject

omero.gateway.model.ROIData

public class ROIData
extends DataObject

Converts the ROI object.

Since:

3.0-Beta4

Constructor Summary

Constructors

Constructor	Description
ROIData()	Create a new instance of an ROIData object.
ROIData(omero.model.Roi roi)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	addShapeData(ShapeData shape)	Adds ShapeData object to ROIData.
ROICoordinate	firstPlane()	Deprecated. Will be removed in future.
java.util.Collection<FolderData>	getFolders()	Get the folders this ROI is part of
ImageData	getImage()	Returns the image for the ROI.
java.util.Iterator<java.util.List<ShapeData>>	getIterator()	Returns the iterator of the collection of the map.
int	getPlaneCount()	Deprecated. Will be removed in future.
int	getShapeCount()	Returns the number of shapes in the ROI.
java.util.List<ShapeData>	getShapes()	Returns a list of all shapes.
java.util.List<ShapeData>	getShapes(int z, int t)	Returns a list of shapes on a given plane, including shapes which are not specifically attached to the plane (span over all z planes and/or timepoints).
java.util.List<ShapeData>	getShapes(int z, int t, boolean excludeUnspecific)	Returns a list of shapes on a given plane.
java.util.Iterator<java.util.List<ShapeData>>	getShapesInRange(ROICoordinate start, ROICoordinate end)	Deprecated. Will be removed in future.
java.lang.String	getUuid()	Get the UUID
boolean	isClientSide()	Returns true if the object a client-side object, false otherwise.
ROICoordinate	lastPlane()	Deprecated. Will be removed in future.
void	removeShapeData(ShapeData shape)	Removes the ShapeData object from ROIData.
void	setClientSide(boolean clientSide)	Sets the flag indicating if the object is a client-side object or not.
void	setImage(omero.model.Image image)	Sets the image for the ROI.
void	setUuid(java.lang.String uuid)	Set the UUID

Methods inherited from class omero.gateway.model.DataObject

asAnnotation, asChannel, asDataset, asExperimenter, asFolder, asGroup, asIAnnotated, asImage, asIObject, asPixels, asPlaneInfo, asPlate, asPojo, asPojos, asPojos, asProject, asScreen, asWell, asWellSample, canAnnotate, canChgrp, canChown, canDelete, canEdit, canLink, getCreated, getDetails, getGroupId, getId, getOwner, getPermissions, getUpdated, getVersion, isDirty, isLoaded, nullDetails, nullSafe, 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.

ROIData

public ROIData()

Create a new instance of an ROIData object.

Method Detail

setImage

public void setImage(omero.model.Image image)

Sets the image for the ROI.

Parameters:

image - See above.

getImage

public ImageData getImage()

Returns the image for the ROI.

Returns:

See above.

addShapeData

public void addShapeData(ShapeData shape)

Adds ShapeData object to ROIData.

Parameters:

shape - See above.

removeShapeData

public void removeShapeData(ShapeData shape)

Removes the ShapeData object from ROIData.

Parameters:

shape - See above.

getPlaneCount

@Deprecated
public int getPlaneCount()

Deprecated.

Will be removed in future. Does not work as expected if the ROI contains shapes which are associated with all planes (Z, C, T == -1)

Returns the number of planes occupied by the ROI.

Returns:

See above.

getShapeCount

public int getShapeCount()

Returns the number of shapes in the ROI.

Returns:

See above.

getShapes

public java.util.List<ShapeData> getShapes()

Returns a list of all shapes.

Returns:

See above.

getShapes

public java.util.List<ShapeData> getShapes(int z,
                                           int t)

Returns a list of shapes on a given plane, including shapes which are not specifically attached to the plane (span over all z planes and/or timepoints).

Parameters:

z - The z-section (-1 to get only shapes which are available to all z planes).

t - The timepoint (-1 to get only shapes which are available to all timepoints).

Returns:

See above.

getShapes

public java.util.List<ShapeData> getShapes(int z,
                                           int t,
                                           boolean excludeUnspecific)

Returns a list of shapes on a given plane.

Parameters:

z - The z-section (-1 to get only shapes which are available to all z planes).

t - The timepoint (-1 to get only shapes which are available to all timepoints).

excludeUnspecific - Pass true to only get shapes which are specifically bound to the given z/t plane, excluding shapes which are available to all z planes and/or timepoints.

Returns:

See above.

getIterator

public java.util.Iterator<java.util.List<ShapeData>> getIterator()

Returns the iterator of the collection of the map.

Returns:

See above.

firstPlane

@Deprecated
public ROICoordinate firstPlane()

Deprecated.

Will be removed in future. Does not work as expected if the ROI contains shapes which are associated with all planes (Z, C, T == -1)

Return the first plane that the ROI starts on.

Returns:

See above.

lastPlane

@Deprecated
public ROICoordinate lastPlane()

Deprecated.

Will be removed in future. Does not work as expected if the ROI contains shapes which are associated with all planes (Z, C, T == -1)

Returns the last plane that the ROI ends on.

Returns:

See above.

getShapesInRange

@Deprecated
public java.util.Iterator<java.util.List<ShapeData>> getShapesInRange(ROICoordinate start,
                                                                      ROICoordinate end)

Deprecated.

Will be removed in future. Does not work as expected if the ROI contains shapes which are associated with all planes (Z, C, T == -1)

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.

isClientSide

public boolean isClientSide()

Returns true if the object a client-side object, false otherwise.

Returns:

See above.

setClientSide

public void setClientSide(boolean clientSide)

Sets the flag indicating if the object is a client-side object or not.

Parameters:

clientSide - Passed true if it is a client-side object, false otherwise.

getFolders

public java.util.Collection<FolderData> getFolders()

Get the folders this ROI is part of

Returns:

See above.

getUuid

public java.lang.String getUuid()

Get the UUID

Returns:

See above

setUuid

public void setUuid(java.lang.String uuid)

Set the UUID

Parameters:

uuid - The UUID