OmeroBlitz API

omero::api::IRoi

Overview

[ "ami", "amd" ] interface IRoi extends ServiceInterface

Interface for working with regions of interest.

Operation Index

findByRoi

Returns a RoiResult with a single Roi member.

Deprecated.

findByImage

Returns all the Rois in an Image, indexed via Shape.

Deprecated.

findByPlane

Returns all the Rois on the given plane, indexed via Shape.

Deprecated.

getPoints

Calculate the points contained within a given shape

Deprecated.

getRoiStats

Calculate stats for all the shapes within the given Roi.

Deprecated.

getShapeStats

Calculate the stats for the points within the given Shape.

Deprecated.

getShapeStatsList

Calculate the stats for the points within the given Shapes.

Deprecated.

getShapeStatsRestricted

Calculate the stats for the points within the given Shapes.

Deprecated.

getRoiMeasurements

Returns a list of model::FileAnnotation instances with the namespace openmicroscopy.org/measurements which are attached to the model::Plate containing the given image AND which are attached to at least one model::Roi

Deprecated.

getMeasuredRois

Loads the ROIs which are linked to by the given model::FileAnnotation id for the given image.

Deprecated.

getMeasuredRoisMap

Returns a map from model::FileAnnotation ids to RoiResult instances.

Deprecated.

getTable

Returns the OMERO.tables service via the model::FileAnnotation id returned by {@code getImageMeasurements}.

Deprecated.

uploadMask

Deprecated.

Operations

RoiResult findByRoi(long roiId, RoiOptions opts) throws ServerError

Returns a RoiResult with a single Roi member. Shape linkages are properly created. All Shapes are loaded, as is the Pixels and Image object. TODO: Annotations?

IROI is deprecated.

RoiResult findByImage(long imageId, RoiOptions opts) throws ServerError

Returns all the Rois in an Image, indexed via Shape. Loads Rois as findByRoi.

IROI is deprecated.

RoiResult findByPlane(long imageId, int z, int t, RoiOptions opts) throws ServerError

Returns all the Rois on the given plane, indexed via Shape. Loads Rois as findByRoi.

IROI is deprecated.

ShapePoints getPoints(long shapeId) throws ServerError

Calculate the points contained within a given shape

IROI is deprecated.

RoiStats getRoiStats(long roiId) throws ServerError

Calculate stats for all the shapes within the given Roi.

IROI is deprecated.

ShapeStats getShapeStats(long shapeId) throws ServerError

Calculate the stats for the points within the given Shape.

IROI is deprecated.

ShapeStatsList getShapeStatsList(LongList shapeIdList) throws ServerError

Calculate the stats for the points within the given Shapes.

IROI is deprecated.

ShapeStatsList getShapeStatsRestricted(LongList shapeIdList, int zForUnattached, int tForUnattached, IntegerArray channels) throws ServerError

Calculate the stats for the points within the given Shapes. Varies to the above in the following ways: - does not allow tiled images - shapes have to be all belonging to the same image - unattached z/t use the fallback parameters zForUnattached/tForUnattached that is to say there is never more than 1 z/t combination queried - if channel list is given, only the channels in that list are iterated over - does not request data from reader on each iteration

IROI is deprecated.

AnnotationList getRoiMeasurements(long imageId, RoiOptions opts) throws ServerError

Returns a list of model::FileAnnotation instances with the namespace openmicroscopy.org/measurements which are attached to the model::Plate containing the given image AND which are attached to at least one model::Roi

IROI is deprecated.

RoiResult getMeasuredRois(long imageId, long annotationId, RoiOptions opts) throws ServerError

Loads the ROIs which are linked to by the given model::FileAnnotation id for the given image.

IROI is deprecated.

Parameters

annotationId

if -1, logic is identical to findByImage(imageId, opts)

LongRoiResultMap getMeasuredRoisMap(long imageId, LongList annotationIds, RoiOptions opts) throws ServerError

Returns a map from model::FileAnnotation ids to RoiResult instances. Logic is identical to getMeasuredRois, but Roi data will not be duplicated. (i.e. the objects are referentially identical)

IROI is deprecated.

grid::Table* getTable(long annotationId) throws ServerError

Returns the OMERO.tables service via the model::FileAnnotation id returned by {@code getImageMeasurements}.

IROI is deprecated.

void uploadMask(long roiId, int z, int t, ::Ice::ByteSeq bytes) throws ServerError

IROI is deprecated.