Table Of Contents

Previous topic

omero package

Next topic

omero.cmd package

This Page

omero.api package

Module contents

The omero::api module defines all the central verbs for working with OMERO.blitz.

Arguments and return values consist of those

types defined in the other ice files available here. With no further custom code, it is possible to interoperate with OMERO.blitz simply via the definitions here. Start with the ServiceFactory definition at the end of this file.

Note: Using these types is significantly easier in combination with

the JavaDocs of the OMERO.server, specifically the ome.api package. Where not further noted below, the follow mappings between ome.api argument types and omero::api argument types hold:

ome.api omero::api
java.lang.Class string
java.util.Set java.util.List/vector
IPojo options (Map) omero::sys::ParamMap
If null needed omero::RType subclass
... ...
class omero.api.ClientCallback

Bases: Ice.Object

Primary callback interface for interaction between client and server session (“ServiceFactory”). Where possible these methods will be called one-way to prevent clients from hanging the server.

_ice_type = <IcePy.TypeInfo object at 0x11b0f600>
_op_requestHeartbeat = <IcePy.Operation object at 0x11b0f618>
_op_sessionClosed = <IcePy.Operation object at 0x11b0f630>
_op_shutdownIn = <IcePy.Operation object at 0x11b0f648>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
requestHeartbeat(current=None)

Heartbeat-request made by the server to guarantee that the client is alive. If the client is still active, then some method should be made on the server to update the last idle time.

sessionClosed(current=None)

The session to which this ServiceFactory is connected has been closed. Almost no further method calls (if any) are possible. Create a new session via omero.client.createSession()

shutdownIn(milliseconds, current=None)

Message that the server will be shutting down in the given number of milliseconds, after which all new and running method invocations will receive a CancelledException.

class omero.api.ClientCallbackPrx

Bases: IcePy.ObjectPrx

Heartbeat-request made by the server to guarantee that the client is alive. If the client is still active, then some method should be made on the server to update the last idle time.

begin_requestHeartbeat(_response=None, _ex=None, _sent=None, _ctx=None)
begin_sessionClosed(_response=None, _ex=None, _sent=None, _ctx=None)
begin_shutdownIn(milliseconds, _response=None, _ex=None, _sent=None, _ctx=None)
static checkedCast(proxy, facetOrCtx=None, _ctx=None)
end_requestHeartbeat(_r)
end_sessionClosed(_r)
end_shutdownIn(_r)
requestHeartbeat(_ctx=None)
requestHeartbeat_async(_cb, _ctx=None)
sessionClosed(_ctx=None)
sessionClosed_async(_cb, _ctx=None)
shutdownIn(milliseconds, _ctx=None)
shutdownIn_async(_cb, milliseconds, _ctx=None)
static uncheckedCast(proxy, facet=None)
class omero.api.Exporter

Bases: omero.api.StatefulServiceInterface

Stateful service for generating OME-XML or OME-TIFF from data stored in OMERO. Intended usage:

ExporterPrx e = sf.createExporter();

// Exporter is currently in the “configuration” state // Objects can be added by id which should be present // in the output.

e.addImage(1);

// As soon as a generate method is called, the objects // added to the Exporter are converted to the specified // format. The length of the file produced is returned. // No more objects can be added to the Exporter, nor can // another generate method be called.

long length = e.generateTiff();

// As soon as the server-side file is generated, read() // can be called to get file segments. To create another // file, create a second Exporter. Be sure to close all // Exporter instances.

long read = 0 byte[] buf; while (true) { buf = e.read(read, 1000000); // Store to file locally here if (buf.length

_ice_type = <IcePy.TypeInfo object at 0x3c29de0>
_op_addImage = <IcePy.Operation object at 0x11be35d0>
_op_generateTiff = <IcePy.Operation object at 0x11be3600>
_op_generateXml = <IcePy.Operation object at 0x11be35e8>
_op_read = <IcePy.Operation object at 0x11be3618>
addImage_async(_cb, id, current=None)

Adds a single image with basic metadata to the Exporter for inclusion on the next call to getBytes().

generateTiff_async(_cb, current=None)

Generates an OME-TIFF file. The return value is the length of the file produced. This method ends configuration.

generateXml_async(_cb, current=None)

Generates an OME-XML file. The return value is the length of the file produced.

ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
read_async(_cb, position, length, current=None)

Returns “length” bytes from the output file. The file can be safely read until reset() is called.

class omero.api.ExporterPrx

Bases: omero.api.StatefulServiceInterfacePrx

Adds a single image with basic metadata to the Exporter for inclusion on the next call to getBytes().

addImage(id, _ctx=None)
addImage_async(_cb, id, _ctx=None)
begin_addImage(id, _response=None, _ex=None, _sent=None, _ctx=None)
begin_generateTiff(_response=None, _ex=None, _sent=None, _ctx=None)
begin_generateXml(_response=None, _ex=None, _sent=None, _ctx=None)
begin_read(position, length, _response=None, _ex=None, _sent=None, _ctx=None)
static checkedCast(proxy, facetOrCtx=None, _ctx=None)
end_addImage(_r)
end_generateTiff(_r)
end_generateXml(_r)
end_read(_r)
generateTiff(_ctx=None)
generateTiff_async(_cb, _ctx=None)
generateXml(_ctx=None)
generateXml_async(_cb, _ctx=None)
read(position, length, _ctx=None)
read_async(_cb, position, length, _ctx=None)
static uncheckedCast(proxy, facet=None)
class omero.api.IAdmin

Bases: omero.api.ServiceInterface

See IAdmin.html

_ice_type = <IcePy.TypeInfo object at 0x3c29ab0>
_op_addGroupOwners = <IcePy.Operation object at 0x11b85d80>
_op_addGroups = <IcePy.Operation object at 0x11b85d08>
_op_canUpdate = <IcePy.Operation object at 0x11b85ab0>
_op_changeExpiredCredentials = <IcePy.Operation object at 0x11b85ea0>
_op_changeGroup = <IcePy.Operation object at 0x11b85df8>
_op_changeOwner = <IcePy.Operation object at 0x11b85de0>
_op_changePassword = <IcePy.Operation object at 0x11b85e40>
_op_changePasswordWithOldPassword = <IcePy.Operation object at 0x11b85e58>
_op_changePermissions = <IcePy.Operation object at 0x11b85e10>
_op_changeUserPassword = <IcePy.Operation object at 0x11b85e70>
_op_containedExperimenters = <IcePy.Operation object at 0x11b85b58>
_op_containedGroups = <IcePy.Operation object at 0x11b85b70>
_op_createExperimenter = <IcePy.Operation object at 0x11b85cc0>
_op_createExperimenterWithPassword = <IcePy.Operation object at 0x11b85cd8>
_op_createGroup = <IcePy.Operation object at 0x11b85cf0>
_op_createSystemUser = <IcePy.Operation object at 0x11b85ca8>
_op_createUser = <IcePy.Operation object at 0x11b85c90>
_op_deleteExperimenter = <IcePy.Operation object at 0x11b85db0>
_op_deleteGroup = <IcePy.Operation object at 0x11b85dc8>
_op_getDefaultGroup = <IcePy.Operation object at 0x11b85b88>
_op_getEventContext = <IcePy.Operation object at 0x11b85ee8>
_op_getExperimenter = <IcePy.Operation object at 0x11b85ac8>
_op_getGroup = <IcePy.Operation object at 0x11b85b10>
_op_getLeaderOfGroupIds = <IcePy.Operation object at 0x11b85be8>
_op_getMemberOfGroupIds = <IcePy.Operation object at 0x11b85bd0>
_op_getMyUserPhotos = <IcePy.Operation object at 0x11b85c30>
_op_getSecurityRoles = <IcePy.Operation object at 0x11b85ed0>
_op_lookupExperimenter = <IcePy.Operation object at 0x11b85ae0>
_op_lookupExperimenters = <IcePy.Operation object at 0x11b85af8>
_op_lookupGroup = <IcePy.Operation object at 0x11b85b28>
_op_lookupGroups = <IcePy.Operation object at 0x11b85b40>
_op_lookupLdapAuthExperimenter = <IcePy.Operation object at 0x11b85ba0>
_op_lookupLdapAuthExperimenters = <IcePy.Operation object at 0x11b85bb8>
_op_moveToCommonSpace = <IcePy.Operation object at 0x11b85e28>
_op_removeGroupOwners = <IcePy.Operation object at 0x11b85d98>
_op_removeGroups = <IcePy.Operation object at 0x11b85d20>
_op_reportForgottenPassword = <IcePy.Operation object at 0x11b85eb8>
_op_setDefaultGroup = <IcePy.Operation object at 0x11b85d38>
_op_setGroupOwner = <IcePy.Operation object at 0x11b85d50>
_op_synchronizeLoginCache = <IcePy.Operation object at 0x11b85e88>
_op_unsetGroupOwner = <IcePy.Operation object at 0x11b85d68>
_op_updateExperimenter = <IcePy.Operation object at 0x11b85c48>
_op_updateExperimenterWithPassword = <IcePy.Operation object at 0x11b85c60>
_op_updateGroup = <IcePy.Operation object at 0x11b85c78>
_op_updateSelf = <IcePy.Operation object at 0x11b85c00>
_op_uploadMyUserPhoto = <IcePy.Operation object at 0x11b85c18>
addGroupOwners_async(_cb, group, owners, current=None)
addGroups_async(_cb, user, groups, current=None)
canUpdate_async(_cb, obj, current=None)
changeExpiredCredentials_async(_cb, name, oldCred, newCred, current=None)
changeGroup_async(_cb, obj, omeName, current=None)
changeOwner_async(_cb, obj, omeName, current=None)
changePasswordWithOldPassword_async(_cb, oldPassword, newPassword, current=None)
changePassword_async(_cb, newPassword, current=None)

HasPassword: Requires the session to have been created with a password as opposed to with a session uuid (via joinSession). If that’s not the case, a SecurityViolation will be thrown, in which case ServiceFactory.setSecurityPassword can be used.

changePermissions_async(_cb, obj, perms, current=None)
changeUserPassword_async(_cb, omeName, newPassword, current=None)

HasPassword: Requires the session to have been created with a password as opposed to with a session uuid (via joinSession). If that’s not the case, a SecurityViolation will be thrown, in which case ServiceFactory.setSecurityPassword can be used.

containedExperimenters_async(_cb, groupId, current=None)
containedGroups_async(_cb, experimenterId, current=None)
createExperimenterWithPassword_async(_cb, user, password, defaultGroup, groups, current=None)
createExperimenter_async(_cb, user, defaultGroup, groups, current=None)
createGroup_async(_cb, group, current=None)
createSystemUser_async(_cb, experimenter, current=None)
createUser_async(_cb, experimenter, group, current=None)
deleteExperimenter_async(_cb, user, current=None)
deleteGroup_async(_cb, group, current=None)
getDefaultGroup_async(_cb, experimenterId, current=None)
getEventContext_async(_cb, current=None)
getExperimenter_async(_cb, id, current=None)
getGroup_async(_cb, id, current=None)
getLeaderOfGroupIds_async(_cb, exp, current=None)
getMemberOfGroupIds_async(_cb, exp, current=None)
getMyUserPhotos_async(_cb, current=None)
getSecurityRoles_async(_cb, current=None)
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
lookupExperimenter_async(_cb, name, current=None)
lookupExperimenters_async(_cb, current=None)
lookupGroup_async(_cb, name, current=None)
lookupGroups_async(_cb, current=None)
lookupLdapAuthExperimenter_async(_cb, id, current=None)
lookupLdapAuthExperimenters_async(_cb, current=None)
moveToCommonSpace_async(_cb, objects, current=None)
removeGroupOwners_async(_cb, group, owners, current=None)
removeGroups_async(_cb, user, groups, current=None)
reportForgottenPassword_async(_cb, name, email, current=None)
setDefaultGroup_async(_cb, user, group, current=None)
setGroupOwner_async(_cb, group, owner, current=None)
synchronizeLoginCache_async(_cb, current=None)
unsetGroupOwner_async(_cb, group, owner, current=None)
updateExperimenterWithPassword_async(_cb, experimenter, password, current=None)
updateExperimenter_async(_cb, experimenter, current=None)
updateGroup_async(_cb, group, current=None)
updateSelf_async(_cb, experimenter, current=None)
uploadMyUserPhoto_async(_cb, filename, format, data, current=None)
class omero.api.IAdminPrx

Bases: omero.api.ServiceInterfacePrx

addGroupOwners(group, owners, _ctx=None)
addGroupOwners_async(_cb, group, owners, _ctx=None)
addGroups(user, groups, _ctx=None)
addGroups_async(_cb, user, groups, _ctx=None)
begin_addGroupOwners(group, owners, _response=None, _ex=None, _sent=None, _ctx=None)
begin_addGroups(user, groups, _response=None, _ex=None, _sent=None, _ctx=None)
begin_canUpdate(obj, _response=None, _ex=None, _sent=None, _ctx=None)
begin_changeExpiredCredentials(name, oldCred, newCred, _response=None, _ex=None, _sent=None, _ctx=None)
begin_changeGroup(obj, omeName, _response=None, _ex=None, _sent=None, _ctx=None)
begin_changeOwner(obj, omeName, _response=None, _ex=None, _sent=None, _ctx=None)
begin_changePassword(newPassword, _response=None, _ex=None, _sent=None, _ctx=None)
begin_changePasswordWithOldPassword(oldPassword, newPassword, _response=None, _ex=None, _sent=None, _ctx=None)
begin_changePermissions(obj, perms, _response=None, _ex=None, _sent=None, _ctx=None)
begin_changeUserPassword(omeName, newPassword, _response=None, _ex=None, _sent=None, _ctx=None)
begin_containedExperimenters(groupId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_containedGroups(experimenterId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_createExperimenter(user, defaultGroup, groups, _response=None, _ex=None, _sent=None, _ctx=None)
begin_createExperimenterWithPassword(user, password, defaultGroup, groups, _response=None, _ex=None, _sent=None, _ctx=None)
begin_createGroup(group, _response=None, _ex=None, _sent=None, _ctx=None)
begin_createSystemUser(experimenter, _response=None, _ex=None, _sent=None, _ctx=None)
begin_createUser(experimenter, group, _response=None, _ex=None, _sent=None, _ctx=None)
begin_deleteExperimenter(user, _response=None, _ex=None, _sent=None, _ctx=None)
begin_deleteGroup(group, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getDefaultGroup(experimenterId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getEventContext(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getExperimenter(id, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getGroup(id, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getLeaderOfGroupIds(exp, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getMemberOfGroupIds(exp, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getMyUserPhotos(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getSecurityRoles(_response=None, _ex=None, _sent=None, _ctx=None)
begin_lookupExperimenter(name, _response=None, _ex=None, _sent=None, _ctx=None)
begin_lookupExperimenters(_response=None, _ex=None, _sent=None, _ctx=None)
begin_lookupGroup(name, _response=None, _ex=None, _sent=None, _ctx=None)
begin_lookupGroups(_response=None, _ex=None, _sent=None, _ctx=None)
begin_lookupLdapAuthExperimenter(id, _response=None, _ex=None, _sent=None, _ctx=None)
begin_lookupLdapAuthExperimenters(_response=None, _ex=None, _sent=None, _ctx=None)
begin_moveToCommonSpace(objects, _response=None, _ex=None, _sent=None, _ctx=None)
begin_removeGroupOwners(group, owners, _response=None, _ex=None, _sent=None, _ctx=None)
begin_removeGroups(user, groups, _response=None, _ex=None, _sent=None, _ctx=None)
begin_reportForgottenPassword(name, email, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setDefaultGroup(user, group, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setGroupOwner(group, owner, _response=None, _ex=None, _sent=None, _ctx=None)
begin_synchronizeLoginCache(_response=None, _ex=None, _sent=None, _ctx=None)
begin_unsetGroupOwner(group, owner, _response=None, _ex=None, _sent=None, _ctx=None)
begin_updateExperimenter(experimenter, _response=None, _ex=None, _sent=None, _ctx=None)
begin_updateExperimenterWithPassword(experimenter, password, _response=None, _ex=None, _sent=None, _ctx=None)
begin_updateGroup(group, _response=None, _ex=None, _sent=None, _ctx=None)
begin_updateSelf(experimenter, _response=None, _ex=None, _sent=None, _ctx=None)
begin_uploadMyUserPhoto(filename, format, data, _response=None, _ex=None, _sent=None, _ctx=None)
canUpdate(obj, _ctx=None)
canUpdate_async(_cb, obj, _ctx=None)
changeExpiredCredentials(name, oldCred, newCred, _ctx=None)
changeExpiredCredentials_async(_cb, name, oldCred, newCred, _ctx=None)
changeGroup(obj, omeName, _ctx=None)
changeGroup_async(_cb, obj, omeName, _ctx=None)
changeOwner(obj, omeName, _ctx=None)
changeOwner_async(_cb, obj, omeName, _ctx=None)
changePassword(newPassword, _ctx=None)
changePasswordWithOldPassword(oldPassword, newPassword, _ctx=None)
changePasswordWithOldPassword_async(_cb, oldPassword, newPassword, _ctx=None)
changePassword_async(_cb, newPassword, _ctx=None)
changePermissions(obj, perms, _ctx=None)
changePermissions_async(_cb, obj, perms, _ctx=None)
changeUserPassword(omeName, newPassword, _ctx=None)
changeUserPassword_async(_cb, omeName, newPassword, _ctx=None)
static checkedCast(proxy, facetOrCtx=None, _ctx=None)
containedExperimenters(groupId, _ctx=None)
containedExperimenters_async(_cb, groupId, _ctx=None)
containedGroups(experimenterId, _ctx=None)
containedGroups_async(_cb, experimenterId, _ctx=None)
createExperimenter(user, defaultGroup, groups, _ctx=None)
createExperimenterWithPassword(user, password, defaultGroup, groups, _ctx=None)
createExperimenterWithPassword_async(_cb, user, password, defaultGroup, groups, _ctx=None)
createExperimenter_async(_cb, user, defaultGroup, groups, _ctx=None)
createGroup(group, _ctx=None)
createGroup_async(_cb, group, _ctx=None)
createSystemUser(experimenter, _ctx=None)
createSystemUser_async(_cb, experimenter, _ctx=None)
createUser(experimenter, group, _ctx=None)
createUser_async(_cb, experimenter, group, _ctx=None)
deleteExperimenter(user, _ctx=None)
deleteExperimenter_async(_cb, user, _ctx=None)
deleteGroup(group, _ctx=None)
deleteGroup_async(_cb, group, _ctx=None)
end_addGroupOwners(_r)
end_addGroups(_r)
end_canUpdate(_r)
end_changeExpiredCredentials(_r)
end_changeGroup(_r)
end_changeOwner(_r)
end_changePassword(_r)
end_changePasswordWithOldPassword(_r)
end_changePermissions(_r)
end_changeUserPassword(_r)
end_containedExperimenters(_r)
end_containedGroups(_r)
end_createExperimenter(_r)
end_createExperimenterWithPassword(_r)
end_createGroup(_r)
end_createSystemUser(_r)
end_createUser(_r)
end_deleteExperimenter(_r)
end_deleteGroup(_r)
end_getDefaultGroup(_r)
end_getEventContext(_r)
end_getExperimenter(_r)
end_getGroup(_r)
end_getLeaderOfGroupIds(_r)
end_getMemberOfGroupIds(_r)
end_getMyUserPhotos(_r)
end_getSecurityRoles(_r)
end_lookupExperimenter(_r)
end_lookupExperimenters(_r)
end_lookupGroup(_r)
end_lookupGroups(_r)
end_lookupLdapAuthExperimenter(_r)
end_lookupLdapAuthExperimenters(_r)
end_moveToCommonSpace(_r)
end_removeGroupOwners(_r)
end_removeGroups(_r)
end_reportForgottenPassword(_r)
end_setDefaultGroup(_r)
end_setGroupOwner(_r)
end_synchronizeLoginCache(_r)
end_unsetGroupOwner(_r)
end_updateExperimenter(_r)
end_updateExperimenterWithPassword(_r)
end_updateGroup(_r)
end_updateSelf(_r)
end_uploadMyUserPhoto(_r)
getDefaultGroup(experimenterId, _ctx=None)
getDefaultGroup_async(_cb, experimenterId, _ctx=None)
getEventContext(_ctx=None)
getEventContext_async(_cb, _ctx=None)
getExperimenter(id, _ctx=None)
getExperimenter_async(_cb, id, _ctx=None)
getGroup(id, _ctx=None)
getGroup_async(_cb, id, _ctx=None)
getLeaderOfGroupIds(exp, _ctx=None)
getLeaderOfGroupIds_async(_cb, exp, _ctx=None)
getMemberOfGroupIds(exp, _ctx=None)
getMemberOfGroupIds_async(_cb, exp, _ctx=None)
getMyUserPhotos(_ctx=None)
getMyUserPhotos_async(_cb, _ctx=None)
getSecurityRoles(_ctx=None)
getSecurityRoles_async(_cb, _ctx=None)
lookupExperimenter(name, _ctx=None)
lookupExperimenter_async(_cb, name, _ctx=None)
lookupExperimenters(_ctx=None)
lookupExperimenters_async(_cb, _ctx=None)
lookupGroup(name, _ctx=None)
lookupGroup_async(_cb, name, _ctx=None)
lookupGroups(_ctx=None)
lookupGroups_async(_cb, _ctx=None)
lookupLdapAuthExperimenter(id, _ctx=None)
lookupLdapAuthExperimenter_async(_cb, id, _ctx=None)
lookupLdapAuthExperimenters(_ctx=None)
lookupLdapAuthExperimenters_async(_cb, _ctx=None)
moveToCommonSpace(objects, _ctx=None)
moveToCommonSpace_async(_cb, objects, _ctx=None)
removeGroupOwners(group, owners, _ctx=None)
removeGroupOwners_async(_cb, group, owners, _ctx=None)
removeGroups(user, groups, _ctx=None)
removeGroups_async(_cb, user, groups, _ctx=None)
reportForgottenPassword(name, email, _ctx=None)
reportForgottenPassword_async(_cb, name, email, _ctx=None)
setDefaultGroup(user, group, _ctx=None)
setDefaultGroup_async(_cb, user, group, _ctx=None)
setGroupOwner(group, owner, _ctx=None)
setGroupOwner_async(_cb, group, owner, _ctx=None)
synchronizeLoginCache(_ctx=None)
synchronizeLoginCache_async(_cb, _ctx=None)
static uncheckedCast(proxy, facet=None)
unsetGroupOwner(group, owner, _ctx=None)
unsetGroupOwner_async(_cb, group, owner, _ctx=None)
updateExperimenter(experimenter, _ctx=None)
updateExperimenterWithPassword(experimenter, password, _ctx=None)
updateExperimenterWithPassword_async(_cb, experimenter, password, _ctx=None)
updateExperimenter_async(_cb, experimenter, _ctx=None)
updateGroup(group, _ctx=None)
updateGroup_async(_cb, group, _ctx=None)
updateSelf(experimenter, _ctx=None)
updateSelf_async(_cb, experimenter, _ctx=None)
uploadMyUserPhoto(filename, format, data, _ctx=None)
uploadMyUserPhoto_async(_cb, filename, format, data, _ctx=None)
class omero.api.IConfig

Bases: omero.api.ServiceInterface

See IConfig.html

_ice_type = <IcePy.TypeInfo object at 0x3c29ae0>
_op_getClientConfigDefaults = <IcePy.Operation object at 0x11b85f90>
_op_getClientConfigValues = <IcePy.Operation object at 0x11b85f78>
_op_getConfigDefaults = <IcePy.Operation object at 0x11b85f60>
_op_getConfigValue = <IcePy.Operation object at 0x11b85f30>
_op_getConfigValues = <IcePy.Operation object at 0x11b85f48>
_op_getDatabaseTime = <IcePy.Operation object at 0x11cad030>
_op_getDatabaseUuid = <IcePy.Operation object at 0x11b85fd8>
_op_getServerTime = <IcePy.Operation object at 0x11cad048>
_op_getVersion = <IcePy.Operation object at 0x11b85f18>
_op_setConfigValue = <IcePy.Operation object at 0x11b85fa8>
_op_setConfigValueIfEquals = <IcePy.Operation object at 0x11b85fc0>
getClientConfigDefaults_async(_cb, current=None)
getClientConfigValues_async(_cb, current=None)
getConfigDefaults_async(_cb, current=None)
getConfigValue_async(_cb, key, current=None)
getConfigValues_async(_cb, keyRegex, current=None)
getDatabaseTime_async(_cb, current=None)
getDatabaseUuid_async(_cb, current=None)
getServerTime_async(_cb, current=None)
getVersion_async(_cb, current=None)
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
setConfigValueIfEquals_async(_cb, key, value, test, current=None)
setConfigValue_async(_cb, key, value, current=None)
class omero.api.IConfigPrx

Bases: omero.api.ServiceInterfacePrx

begin_getClientConfigDefaults(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getClientConfigValues(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getConfigDefaults(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getConfigValue(key, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getConfigValues(keyRegex, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getDatabaseTime(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getDatabaseUuid(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getServerTime(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getVersion(_response=None, _ex=None, _sent=None, _ctx=None)
begin_setConfigValue(key, value, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setConfigValueIfEquals(key, value, test, _response=None, _ex=None, _sent=None, _ctx=None)
static checkedCast(proxy, facetOrCtx=None, _ctx=None)
end_getClientConfigDefaults(_r)
end_getClientConfigValues(_r)
end_getConfigDefaults(_r)
end_getConfigValue(_r)
end_getConfigValues(_r)
end_getDatabaseTime(_r)
end_getDatabaseUuid(_r)
end_getServerTime(_r)
end_getVersion(_r)
end_setConfigValue(_r)
end_setConfigValueIfEquals(_r)
getClientConfigDefaults(_ctx=None)
getClientConfigDefaults_async(_cb, _ctx=None)
getClientConfigValues(_ctx=None)
getClientConfigValues_async(_cb, _ctx=None)
getConfigDefaults(_ctx=None)
getConfigDefaults_async(_cb, _ctx=None)
getConfigValue(key, _ctx=None)
getConfigValue_async(_cb, key, _ctx=None)
getConfigValues(keyRegex, _ctx=None)
getConfigValues_async(_cb, keyRegex, _ctx=None)
getDatabaseTime(_ctx=None)
getDatabaseTime_async(_cb, _ctx=None)
getDatabaseUuid(_ctx=None)
getDatabaseUuid_async(_cb, _ctx=None)
getServerTime(_ctx=None)
getServerTime_async(_cb, _ctx=None)
getVersion(_ctx=None)
getVersion_async(_cb, _ctx=None)
setConfigValue(key, value, _ctx=None)
setConfigValueIfEquals(key, value, test, _ctx=None)
setConfigValueIfEquals_async(_cb, key, value, test, _ctx=None)
setConfigValue_async(_cb, key, value, _ctx=None)
static uncheckedCast(proxy, facet=None)
class omero.api.IContainer

Bases: omero.api.ServiceInterface

See IContainer.html

_ice_type = <IcePy.TypeInfo object at 0x3c29b10>
_op_createDataObject = <IcePy.Operation object at 0x11cad138>
_op_createDataObjects = <IcePy.Operation object at 0x11cad150>
_op_findContainerHierarchies = <IcePy.Operation object at 0x11cad090>
_op_getCollectionCount = <IcePy.Operation object at 0x11cad108>
_op_getImages = <IcePy.Operation object at 0x11cad0a8>
_op_getImagesByOptions = <IcePy.Operation object at 0x11cad0d8>
_op_getImagesBySplitFilesets = <IcePy.Operation object at 0x11cad0f0>
_op_getUserImages = <IcePy.Operation object at 0x11cad0c0>
_op_loadContainerHierarchy = <IcePy.Operation object at 0x11cad078>
_op_retrieveCollection = <IcePy.Operation object at 0x11cad120>
_op_updateDataObject = <IcePy.Operation object at 0x11cad198>
_op_updateDataObjects = <IcePy.Operation object at 0x11cad1b0>
createDataObject_async(_cb, obj, options, current=None)
createDataObjects_async(_cb, dataObjects, options, current=None)
findContainerHierarchies_async(_cb, rootType, imageIds, options, current=None)
getCollectionCount_async(_cb, type, property, ids, options, current=None)
getImagesByOptions_async(_cb, options, current=None)
getImagesBySplitFilesets_async(_cb, included, options, current=None)
getImages_async(_cb, rootType, rootIds, options, current=None)
getUserImages_async(_cb, options, current=None)
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
loadContainerHierarchy_async(_cb, rootType, rootIds, options, current=None)
retrieveCollection_async(_cb, obj, collectionName, options, current=None)
updateDataObject_async(_cb, obj, options, current=None)
updateDataObjects_async(_cb, objs, options, current=None)
class omero.api.IContainerPrx

Bases: omero.api.ServiceInterfacePrx

begin_createDataObject(obj, options, _response=None, _ex=None, _sent=None, _ctx=None)
begin_createDataObjects(dataObjects, options, _response=None, _ex=None, _sent=None, _ctx=None)
begin_findContainerHierarchies(rootType, imageIds, options, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getCollectionCount(type, property, ids, options, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getImages(rootType, rootIds, options, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getImagesByOptions(options, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getImagesBySplitFilesets(included, options, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getUserImages(options, _response=None, _ex=None, _sent=None, _ctx=None)
begin_loadContainerHierarchy(rootType, rootIds, options, _response=None, _ex=None, _sent=None, _ctx=None)
begin_retrieveCollection(obj, collectionName, options, _response=None, _ex=None, _sent=None, _ctx=None)
begin_updateDataObject(obj, options, _response=None, _ex=None, _sent=None, _ctx=None)
begin_updateDataObjects(objs, options, _response=None, _ex=None, _sent=None, _ctx=None)
static checkedCast(proxy, facetOrCtx=None, _ctx=None)
createDataObject(obj, options, _ctx=None)
createDataObject_async(_cb, obj, options, _ctx=None)
createDataObjects(dataObjects, options, _ctx=None)
createDataObjects_async(_cb, dataObjects, options, _ctx=None)
end_createDataObject(_r)
end_createDataObjects(_r)
end_findContainerHierarchies(_r)
end_getCollectionCount(_r)
end_getImages(_r)
end_getImagesByOptions(_r)
end_getImagesBySplitFilesets(_r)
end_getUserImages(_r)
end_loadContainerHierarchy(_r)
end_retrieveCollection(_r)
end_updateDataObject(_r)
end_updateDataObjects(_r)
findContainerHierarchies(rootType, imageIds, options, _ctx=None)
findContainerHierarchies_async(_cb, rootType, imageIds, options, _ctx=None)
getCollectionCount(type, property, ids, options, _ctx=None)
getCollectionCount_async(_cb, type, property, ids, options, _ctx=None)
getImages(rootType, rootIds, options, _ctx=None)
getImagesByOptions(options, _ctx=None)
getImagesByOptions_async(_cb, options, _ctx=None)
getImagesBySplitFilesets(included, options, _ctx=None)
getImagesBySplitFilesets_async(_cb, included, options, _ctx=None)
getImages_async(_cb, rootType, rootIds, options, _ctx=None)
getUserImages(options, _ctx=None)
getUserImages_async(_cb, options, _ctx=None)
loadContainerHierarchy(rootType, rootIds, options, _ctx=None)
loadContainerHierarchy_async(_cb, rootType, rootIds, options, _ctx=None)
retrieveCollection(obj, collectionName, options, _ctx=None)
retrieveCollection_async(_cb, obj, collectionName, options, _ctx=None)
static uncheckedCast(proxy, facet=None)
updateDataObject(obj, options, _ctx=None)
updateDataObject_async(_cb, obj, options, _ctx=None)
updateDataObjects(objs, options, _ctx=None)
updateDataObjects_async(_cb, objs, options, _ctx=None)
class omero.api.ILdap

Bases: omero.api.ServiceInterface

See ILdap.html

_ice_type = <IcePy.TypeInfo object at 0x3c29b40>
_op_createUser = <IcePy.Operation object at 0x11cad300>
_op_discover = <IcePy.Operation object at 0x11cad2d0>
_op_discoverGroups = <IcePy.Operation object at 0x11cad2e8>
_op_findDN = <IcePy.Operation object at 0x11cad240>
_op_findExperimenter = <IcePy.Operation object at 0x11cad270>
_op_findGroup = <IcePy.Operation object at 0x11cad288>
_op_findGroupDN = <IcePy.Operation object at 0x11cad258>
_op_getSetting = <IcePy.Operation object at 0x11cad2b8>
_op_searchAll = <IcePy.Operation object at 0x11cad1c8>
_op_searchByAttribute = <IcePy.Operation object at 0x11cad1f8>
_op_searchByAttributes = <IcePy.Operation object at 0x11cad210>
_op_searchByDN = <IcePy.Operation object at 0x11cad228>
_op_searchDnInGroups = <IcePy.Operation object at 0x11cad1e0>
_op_setDN = <IcePy.Operation object at 0x11cad2a0>
createUser_async(_cb, username, current=None)
discoverGroups_async(_cb, current=None)
discover_async(_cb, current=None)
findDN_async(_cb, username, current=None)
findExperimenter_async(_cb, username, current=None)
findGroupDN_async(_cb, groupname, current=None)
findGroup_async(_cb, groupname, current=None)
getSetting_async(_cb, current=None)
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
searchAll_async(_cb, current=None)
searchByAttribute_async(_cb, dn, attribute, value, current=None)
searchByAttributes_async(_cb, dn, attributes, values, current=None)
searchByDN_async(_cb, userdn, current=None)
searchDnInGroups_async(_cb, attr, value, current=None)
setDN_async(_cb, experimenterID, dn, current=None)
class omero.api.ILdapPrx

Bases: omero.api.ServiceInterfacePrx

begin_createUser(username, _response=None, _ex=None, _sent=None, _ctx=None)
begin_discover(_response=None, _ex=None, _sent=None, _ctx=None)
begin_discoverGroups(_response=None, _ex=None, _sent=None, _ctx=None)
begin_findDN(username, _response=None, _ex=None, _sent=None, _ctx=None)
begin_findExperimenter(username, _response=None, _ex=None, _sent=None, _ctx=None)
begin_findGroup(groupname, _response=None, _ex=None, _sent=None, _ctx=None)
begin_findGroupDN(groupname, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getSetting(_response=None, _ex=None, _sent=None, _ctx=None)
begin_searchAll(_response=None, _ex=None, _sent=None, _ctx=None)
begin_searchByAttribute(dn, attribute, value, _response=None, _ex=None, _sent=None, _ctx=None)
begin_searchByAttributes(dn, attributes, values, _response=None, _ex=None, _sent=None, _ctx=None)
begin_searchByDN(userdn, _response=None, _ex=None, _sent=None, _ctx=None)
begin_searchDnInGroups(attr, value, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setDN(experimenterID, dn, _response=None, _ex=None, _sent=None, _ctx=None)
static checkedCast(proxy, facetOrCtx=None, _ctx=None)
createUser(username, _ctx=None)
createUser_async(_cb, username, _ctx=None)
discover(_ctx=None)
discoverGroups(_ctx=None)
discoverGroups_async(_cb, _ctx=None)
discover_async(_cb, _ctx=None)
end_createUser(_r)
end_discover(_r)
end_discoverGroups(_r)
end_findDN(_r)
end_findExperimenter(_r)
end_findGroup(_r)
end_findGroupDN(_r)
end_getSetting(_r)
end_searchAll(_r)
end_searchByAttribute(_r)
end_searchByAttributes(_r)
end_searchByDN(_r)
end_searchDnInGroups(_r)
end_setDN(_r)
findDN(username, _ctx=None)
findDN_async(_cb, username, _ctx=None)
findExperimenter(username, _ctx=None)
findExperimenter_async(_cb, username, _ctx=None)
findGroup(groupname, _ctx=None)
findGroupDN(groupname, _ctx=None)
findGroupDN_async(_cb, groupname, _ctx=None)
findGroup_async(_cb, groupname, _ctx=None)
getSetting(_ctx=None)
getSetting_async(_cb, _ctx=None)
searchAll(_ctx=None)
searchAll_async(_cb, _ctx=None)
searchByAttribute(dn, attribute, value, _ctx=None)
searchByAttribute_async(_cb, dn, attribute, value, _ctx=None)
searchByAttributes(dn, attributes, values, _ctx=None)
searchByAttributes_async(_cb, dn, attributes, values, _ctx=None)
searchByDN(userdn, _ctx=None)
searchByDN_async(_cb, userdn, _ctx=None)
searchDnInGroups(attr, value, _ctx=None)
searchDnInGroups_async(_cb, attr, value, _ctx=None)
setDN(experimenterID, dn, _ctx=None)
setDN_async(_cb, experimenterID, dn, _ctx=None)
static uncheckedCast(proxy, facet=None)
class omero.api.IMetadata

Bases: omero.api.ServiceInterface

See IMetadata.html

_ice_type = <IcePy.TypeInfo object at 0x3c29b70>
_op_countAnnotationsUsedNotOwned = <IcePy.Operation object at 0x11cad420>
_op_countSpecifiedAnnotations = <IcePy.Operation object at 0x11cad3c0>
_op_getTaggedObjectsCount = <IcePy.Operation object at 0x11cad3a8>
_op_loadAnnotation = <IcePy.Operation object at 0x11cad3d8>
_op_loadAnnotations = <IcePy.Operation object at 0x11cad348>
_op_loadAnnotationsUsedNotOwned = <IcePy.Operation object at 0x11cad408>
_op_loadChannelAcquisitionData = <IcePy.Operation object at 0x11cad330>
_op_loadInstrument = <IcePy.Operation object at 0x11cad3f0>
_op_loadLogFiles = <IcePy.Operation object at 0x11cad450>
_op_loadSpecifiedAnnotations = <IcePy.Operation object at 0x11cad360>
_op_loadSpecifiedAnnotationsLinkedTo = <IcePy.Operation object at 0x11cad438>
_op_loadTagContent = <IcePy.Operation object at 0x11cad378>
_op_loadTagSets = <IcePy.Operation object at 0x11cad390>
countAnnotationsUsedNotOwned_async(_cb, annotationType, userID, current=None)
countSpecifiedAnnotations_async(_cb, annotationType, include, exclude, options, current=None)
getTaggedObjectsCount_async(_cb, ids, options, current=None)
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
loadAnnotation_async(_cb, annotationIds, current=None)
loadAnnotationsUsedNotOwned_async(_cb, annotationType, userID, current=None)
loadAnnotations_async(_cb, rootType, rootIds, annotationTypes, annotatorIds, options, current=None)
loadChannelAcquisitionData_async(_cb, ids, current=None)
loadInstrument_async(_cb, id, current=None)
loadLogFiles_async(_cb, rootType, ids, current=None)
loadSpecifiedAnnotationsLinkedTo_async(_cb, annotationType, include, exclude, rootNodeType, rootNodeIds, options, current=None)
loadSpecifiedAnnotations_async(_cb, annotationType, include, exclude, options, current=None)
loadTagContent_async(_cb, ids, options, current=None)
loadTagSets_async(_cb, options, current=None)
class omero.api.IMetadataPrx

Bases: omero.api.ServiceInterfacePrx

begin_countAnnotationsUsedNotOwned(annotationType, userID, _response=None, _ex=None, _sent=None, _ctx=None)
begin_countSpecifiedAnnotations(annotationType, include, exclude, options, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getTaggedObjectsCount(ids, options, _response=None, _ex=None, _sent=None, _ctx=None)
begin_loadAnnotation(annotationIds, _response=None, _ex=None, _sent=None, _ctx=None)
begin_loadAnnotations(rootType, rootIds, annotationTypes, annotatorIds, options, _response=None, _ex=None, _sent=None, _ctx=None)
begin_loadAnnotationsUsedNotOwned(annotationType, userID, _response=None, _ex=None, _sent=None, _ctx=None)
begin_loadChannelAcquisitionData(ids, _response=None, _ex=None, _sent=None, _ctx=None)
begin_loadInstrument(id, _response=None, _ex=None, _sent=None, _ctx=None)
begin_loadLogFiles(rootType, ids, _response=None, _ex=None, _sent=None, _ctx=None)
begin_loadSpecifiedAnnotations(annotationType, include, exclude, options, _response=None, _ex=None, _sent=None, _ctx=None)
begin_loadSpecifiedAnnotationsLinkedTo(annotationType, include, exclude, rootNodeType, rootNodeIds, options, _response=None, _ex=None, _sent=None, _ctx=None)
begin_loadTagContent(ids, options, _response=None, _ex=None, _sent=None, _ctx=None)
begin_loadTagSets(options, _response=None, _ex=None, _sent=None, _ctx=None)
static checkedCast(proxy, facetOrCtx=None, _ctx=None)
countAnnotationsUsedNotOwned(annotationType, userID, _ctx=None)
countAnnotationsUsedNotOwned_async(_cb, annotationType, userID, _ctx=None)
countSpecifiedAnnotations(annotationType, include, exclude, options, _ctx=None)
countSpecifiedAnnotations_async(_cb, annotationType, include, exclude, options, _ctx=None)
end_countAnnotationsUsedNotOwned(_r)
end_countSpecifiedAnnotations(_r)
end_getTaggedObjectsCount(_r)
end_loadAnnotation(_r)
end_loadAnnotations(_r)
end_loadAnnotationsUsedNotOwned(_r)
end_loadChannelAcquisitionData(_r)
end_loadInstrument(_r)
end_loadLogFiles(_r)
end_loadSpecifiedAnnotations(_r)
end_loadSpecifiedAnnotationsLinkedTo(_r)
end_loadTagContent(_r)
end_loadTagSets(_r)
getTaggedObjectsCount(ids, options, _ctx=None)
getTaggedObjectsCount_async(_cb, ids, options, _ctx=None)
loadAnnotation(annotationIds, _ctx=None)
loadAnnotation_async(_cb, annotationIds, _ctx=None)
loadAnnotations(rootType, rootIds, annotationTypes, annotatorIds, options, _ctx=None)
loadAnnotationsUsedNotOwned(annotationType, userID, _ctx=None)
loadAnnotationsUsedNotOwned_async(_cb, annotationType, userID, _ctx=None)
loadAnnotations_async(_cb, rootType, rootIds, annotationTypes, annotatorIds, options, _ctx=None)
loadChannelAcquisitionData(ids, _ctx=None)
loadChannelAcquisitionData_async(_cb, ids, _ctx=None)
loadInstrument(id, _ctx=None)
loadInstrument_async(_cb, id, _ctx=None)
loadLogFiles(rootType, ids, _ctx=None)
loadLogFiles_async(_cb, rootType, ids, _ctx=None)
loadSpecifiedAnnotations(annotationType, include, exclude, options, _ctx=None)
loadSpecifiedAnnotationsLinkedTo(annotationType, include, exclude, rootNodeType, rootNodeIds, options, _ctx=None)
loadSpecifiedAnnotationsLinkedTo_async(_cb, annotationType, include, exclude, rootNodeType, rootNodeIds, options, _ctx=None)
loadSpecifiedAnnotations_async(_cb, annotationType, include, exclude, options, _ctx=None)
loadTagContent(ids, options, _ctx=None)
loadTagContent_async(_cb, ids, options, _ctx=None)
loadTagSets(options, _ctx=None)
loadTagSets_async(_cb, options, _ctx=None)
static uncheckedCast(proxy, facet=None)
class omero.api.IPixels

Bases: omero.api.ServiceInterface

See IPixels.html

_ice_type = <IcePy.TypeInfo object at 0x3c29ba0>
_op_copyAndResizeImage = <IcePy.Operation object at 0x11cad570>
_op_copyAndResizePixels = <IcePy.Operation object at 0x11cad558>
_op_createImage = <IcePy.Operation object at 0x11cad588>
_op_getAllEnumerations = <IcePy.Operation object at 0x11cad540>
_op_getBitDepth = <IcePy.Operation object at 0x11cad510>
_op_getEnumeration = <IcePy.Operation object at 0x11cad528>
_op_loadRndSettings = <IcePy.Operation object at 0x11cad4e0>
_op_retrieveAllRndSettings = <IcePy.Operation object at 0x11cad4c8>
_op_retrievePixDescription = <IcePy.Operation object at 0x11cad480>
_op_retrieveRndSettings = <IcePy.Operation object at 0x11cad498>
_op_retrieveRndSettingsFor = <IcePy.Operation object at 0x11cad4b0>
_op_saveRndSettings = <IcePy.Operation object at 0x11cad4f8>
_op_setChannelGlobalMinMax = <IcePy.Operation object at 0x11cad5a0>
copyAndResizeImage_async(_cb, imageId, sizeX, sizeY, sizeZ, sizeT, channelList, methodology, copyStats, current=None)
copyAndResizePixels_async(_cb, pixelsId, sizeX, sizeY, sizeZ, sizeT, channelList, methodology, copyStats, current=None)
createImage_async(_cb, sizeX, sizeY, sizeZ, sizeT, channelList, pixelsType, name, description, current=None)
getAllEnumerations_async(_cb, enumClass, current=None)
getBitDepth_async(_cb, type, current=None)
getEnumeration_async(_cb, enumClass, value, current=None)
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
loadRndSettings_async(_cb, renderingSettingsId, current=None)
retrieveAllRndSettings_async(_cb, pixId, userId, current=None)
retrievePixDescription_async(_cb, pixId, current=None)
retrieveRndSettingsFor_async(_cb, pixId, userId, current=None)
retrieveRndSettings_async(_cb, pixId, current=None)
saveRndSettings_async(_cb, rndSettings, current=None)
setChannelGlobalMinMax_async(_cb, pixelsId, channelIndex, min, max, current=None)
class omero.api.IPixelsPrx

Bases: omero.api.ServiceInterfacePrx

begin_copyAndResizeImage(imageId, sizeX, sizeY, sizeZ, sizeT, channelList, methodology, copyStats, _response=None, _ex=None, _sent=None, _ctx=None)
begin_copyAndResizePixels(pixelsId, sizeX, sizeY, sizeZ, sizeT, channelList, methodology, copyStats, _response=None, _ex=None, _sent=None, _ctx=None)
begin_createImage(sizeX, sizeY, sizeZ, sizeT, channelList, pixelsType, name, description, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getAllEnumerations(enumClass, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getBitDepth(type, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getEnumeration(enumClass, value, _response=None, _ex=None, _sent=None, _ctx=None)
begin_loadRndSettings(renderingSettingsId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_retrieveAllRndSettings(pixId, userId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_retrievePixDescription(pixId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_retrieveRndSettings(pixId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_retrieveRndSettingsFor(pixId, userId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_saveRndSettings(rndSettings, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setChannelGlobalMinMax(pixelsId, channelIndex, min, max, _response=None, _ex=None, _sent=None, _ctx=None)
static checkedCast(proxy, facetOrCtx=None, _ctx=None)
copyAndResizeImage(imageId, sizeX, sizeY, sizeZ, sizeT, channelList, methodology, copyStats, _ctx=None)
copyAndResizeImage_async(_cb, imageId, sizeX, sizeY, sizeZ, sizeT, channelList, methodology, copyStats, _ctx=None)
copyAndResizePixels(pixelsId, sizeX, sizeY, sizeZ, sizeT, channelList, methodology, copyStats, _ctx=None)
copyAndResizePixels_async(_cb, pixelsId, sizeX, sizeY, sizeZ, sizeT, channelList, methodology, copyStats, _ctx=None)
createImage(sizeX, sizeY, sizeZ, sizeT, channelList, pixelsType, name, description, _ctx=None)
createImage_async(_cb, sizeX, sizeY, sizeZ, sizeT, channelList, pixelsType, name, description, _ctx=None)
end_copyAndResizeImage(_r)
end_copyAndResizePixels(_r)
end_createImage(_r)
end_getAllEnumerations(_r)
end_getBitDepth(_r)
end_getEnumeration(_r)
end_loadRndSettings(_r)
end_retrieveAllRndSettings(_r)
end_retrievePixDescription(_r)
end_retrieveRndSettings(_r)
end_retrieveRndSettingsFor(_r)
end_saveRndSettings(_r)
end_setChannelGlobalMinMax(_r)
getAllEnumerations(enumClass, _ctx=None)
getAllEnumerations_async(_cb, enumClass, _ctx=None)
getBitDepth(type, _ctx=None)
getBitDepth_async(_cb, type, _ctx=None)
getEnumeration(enumClass, value, _ctx=None)
getEnumeration_async(_cb, enumClass, value, _ctx=None)
loadRndSettings(renderingSettingsId, _ctx=None)
loadRndSettings_async(_cb, renderingSettingsId, _ctx=None)
retrieveAllRndSettings(pixId, userId, _ctx=None)
retrieveAllRndSettings_async(_cb, pixId, userId, _ctx=None)
retrievePixDescription(pixId, _ctx=None)
retrievePixDescription_async(_cb, pixId, _ctx=None)
retrieveRndSettings(pixId, _ctx=None)
retrieveRndSettingsFor(pixId, userId, _ctx=None)
retrieveRndSettingsFor_async(_cb, pixId, userId, _ctx=None)
retrieveRndSettings_async(_cb, pixId, _ctx=None)
saveRndSettings(rndSettings, _ctx=None)
saveRndSettings_async(_cb, rndSettings, _ctx=None)
setChannelGlobalMinMax(pixelsId, channelIndex, min, max, _ctx=None)
setChannelGlobalMinMax_async(_cb, pixelsId, channelIndex, min, max, _ctx=None)
static uncheckedCast(proxy, facet=None)
class omero.api.IProjection

Bases: omero.api.ServiceInterface

See IProjection.html

_ice_type = <IcePy.TypeInfo object at 0x3c29bd0>
_op_projectPixels = <IcePy.Operation object at 0x11cad5e8>
_op_projectStack = <IcePy.Operation object at 0x11cad5d0>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
projectPixels_async(_cb, pixelsId, pixelsType, algorithm, tStart, tEnd, channelList, stepping, zStart, zEnd, name, current=None)
projectStack_async(_cb, pixelsId, pixelsType, algorithm, timepoint, channelIndex, stepping, start, end, current=None)
class omero.api.IProjectionPrx

Bases: omero.api.ServiceInterfacePrx

begin_projectPixels(pixelsId, pixelsType, algorithm, tStart, tEnd, channelList, stepping, zStart, zEnd, name, _response=None, _ex=None, _sent=None, _ctx=None)
begin_projectStack(pixelsId, pixelsType, algorithm, timepoint, channelIndex, stepping, start, end, _response=None, _ex=None, _sent=None, _ctx=None)
static checkedCast(proxy, facetOrCtx=None, _ctx=None)
end_projectPixels(_r)
end_projectStack(_r)
projectPixels(pixelsId, pixelsType, algorithm, tStart, tEnd, channelList, stepping, zStart, zEnd, name, _ctx=None)
projectPixels_async(_cb, pixelsId, pixelsType, algorithm, tStart, tEnd, channelList, stepping, zStart, zEnd, name, _ctx=None)
projectStack(pixelsId, pixelsType, algorithm, timepoint, channelIndex, stepping, start, end, _ctx=None)
projectStack_async(_cb, pixelsId, pixelsType, algorithm, timepoint, channelIndex, stepping, start, end, _ctx=None)
static uncheckedCast(proxy, facet=None)
class omero.api.IQuery

Bases: omero.api.ServiceInterface

See IQuery.html

_ice_type = <IcePy.TypeInfo object at 0x3c29c00>
_op_find = <IcePy.Operation object at 0x11cad618>
_op_findAll = <IcePy.Operation object at 0x11cad630>
_op_findAllByExample = <IcePy.Operation object at 0x11cad660>
_op_findAllByFullText = <IcePy.Operation object at 0x11cad6d8>
_op_findAllByQuery = <IcePy.Operation object at 0x11cad6c0>
_op_findAllByString = <IcePy.Operation object at 0x11cad690>
_op_findByExample = <IcePy.Operation object at 0x11cad648>
_op_findByQuery = <IcePy.Operation object at 0x11cad6a8>
_op_findByString = <IcePy.Operation object at 0x11cad678>
_op_get = <IcePy.Operation object at 0x11cad600>
_op_projection = <IcePy.Operation object at 0x11cad6f0>
_op_refresh = <IcePy.Operation object at 0x11cad708>
findAllByExample_async(_cb, example, filter, current=None)
findAllByFullText_async(_cb, klass, query, params, current=None)
findAllByQuery_async(_cb, query, params, current=None)
findAllByString_async(_cb, klass, field, value, caseSensitive, filter, current=None)
findAll_async(_cb, klass, filter, current=None)
findByExample_async(_cb, example, current=None)
findByQuery_async(_cb, query, params, current=None)
findByString_async(_cb, klass, field, value, current=None)
find_async(_cb, klass, id, current=None)
get_async(_cb, klass, id, current=None)
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
projection_async(_cb, query, params, current=None)

Return a sequence of omero.RType sequences.

Each element of the outer sequence is one row in the return value. Each element of the inner sequence is one column specified in the HQL.

omero.model.IObject instances are returned wrapped in an omero.rtype.RObject instance. Primitives are mapped to the expected omero.RType subclass. Types without an omero.RType mapper if returned will throw an exception if present in the select except where a manual conversion is present on the server. This includes:

omero.model.Permissions instances are serialized to an omero.RMap containing the keys: perms, canAnnotate, canEdit, canLink, canDelete

The quantity types like omero.model.Length are serialized to an omero.RMap containing the keys: value, unit, symbol

As with SQL, if an aggregation statement is used, a group by clause must be added.

Examples:

select i.name, i.description from Image i where i.name like ‘%.dv’

select tag.textValue, tagset.textValue from TagAnnotation tag join tag.annotationLinks l join l.child tagset

select p.pixelsType.value, count(p.id) from Pixel p group by p.pixelsType.value

refresh_async(_cb, iObject, current=None)
class omero.api.IQueryPrx

Bases: omero.api.ServiceInterfacePrx

begin_find(klass, id, _response=None, _ex=None, _sent=None, _ctx=None)
begin_findAll(klass, filter, _response=None, _ex=None, _sent=None, _ctx=None)
begin_findAllByExample(example, filter, _response=None, _ex=None, _sent=None, _ctx=None)
begin_findAllByFullText(klass, query, params, _response=None, _ex=None, _sent=None, _ctx=None)
begin_findAllByQuery(query, params, _response=None, _ex=None, _sent=None, _ctx=None)
begin_findAllByString(klass, field, value, caseSensitive, filter, _response=None, _ex=None, _sent=None, _ctx=None)
begin_findByExample(example, _response=None, _ex=None, _sent=None, _ctx=None)
begin_findByQuery(query, params, _response=None, _ex=None, _sent=None, _ctx=None)
begin_findByString(klass, field, value, _response=None, _ex=None, _sent=None, _ctx=None)
begin_get(klass, id, _response=None, _ex=None, _sent=None, _ctx=None)
begin_projection(query, params, _response=None, _ex=None, _sent=None, _ctx=None)
begin_refresh(iObject, _response=None, _ex=None, _sent=None, _ctx=None)
static checkedCast(proxy, facetOrCtx=None, _ctx=None)
end_find(_r)
end_findAll(_r)
end_findAllByExample(_r)
end_findAllByFullText(_r)
end_findAllByQuery(_r)
end_findAllByString(_r)
end_findByExample(_r)
end_findByQuery(_r)
end_findByString(_r)
end_get(_r)
end_projection(_r)
end_refresh(_r)
find(klass, id, _ctx=None)
findAll(klass, filter, _ctx=None)
findAllByExample(example, filter, _ctx=None)
findAllByExample_async(_cb, example, filter, _ctx=None)
findAllByFullText(klass, query, params, _ctx=None)
findAllByFullText_async(_cb, klass, query, params, _ctx=None)
findAllByQuery(query, params, _ctx=None)
findAllByQuery_async(_cb, query, params, _ctx=None)
findAllByString(klass, field, value, caseSensitive, filter, _ctx=None)
findAllByString_async(_cb, klass, field, value, caseSensitive, filter, _ctx=None)
findAll_async(_cb, klass, filter, _ctx=None)
findByExample(example, _ctx=None)
findByExample_async(_cb, example, _ctx=None)
findByQuery(query, params, _ctx=None)
findByQuery_async(_cb, query, params, _ctx=None)
findByString(klass, field, value, _ctx=None)
findByString_async(_cb, klass, field, value, _ctx=None)
find_async(_cb, klass, id, _ctx=None)
get(klass, id, _ctx=None)
get_async(_cb, klass, id, _ctx=None)
projection(query, params, _ctx=None)
projection_async(_cb, query, params, _ctx=None)
refresh(iObject, _ctx=None)
refresh_async(_cb, iObject, _ctx=None)
static uncheckedCast(proxy, facet=None)
class omero.api.IRenderingSettings

Bases: omero.api.ServiceInterface

See IRenderingSettings.html

_ice_type = <IcePy.TypeInfo object at 0x3c29d50>
_op_applySettingsToDataset = <IcePy.Operation object at 0x11cad858>
_op_applySettingsToImage = <IcePy.Operation object at 0x11cad888>
_op_applySettingsToImages = <IcePy.Operation object at 0x11cad870>
_op_applySettingsToPixels = <IcePy.Operation object at 0x11cad8a0>
_op_applySettingsToProject = <IcePy.Operation object at 0x11cad840>
_op_applySettingsToSet = <IcePy.Operation object at 0x11cad828>
_op_createNewRenderingDef = <IcePy.Operation object at 0x11cad750>
_op_getRenderingSettings = <IcePy.Operation object at 0x11cad738>
_op_resetDefaults = <IcePy.Operation object at 0x11cad768>
_op_resetDefaultsByOwnerInSet = <IcePy.Operation object at 0x11cad7f8>
_op_resetDefaultsForPixels = <IcePy.Operation object at 0x11cad7b0>
_op_resetDefaultsInDataset = <IcePy.Operation object at 0x11cad7c8>
_op_resetDefaultsInImage = <IcePy.Operation object at 0x11cad798>
_op_resetDefaultsInSet = <IcePy.Operation object at 0x11cad7e0>
_op_resetDefaultsNoSave = <IcePy.Operation object at 0x11cad780>
_op_resetMinMaxInSet = <IcePy.Operation object at 0x11cad810>
_op_sanityCheckPixels = <IcePy.Operation object at 0x11cad720>
_op_setOriginalSettingsForPixels = <IcePy.Operation object at 0x11cad8d0>
_op_setOriginalSettingsInDataset = <IcePy.Operation object at 0x11cad8e8>
_op_setOriginalSettingsInImage = <IcePy.Operation object at 0x11cad8b8>
_op_setOriginalSettingsInSet = <IcePy.Operation object at 0x11cad900>
applySettingsToDataset_async(_cb, _from, to, current=None)
applySettingsToImage_async(_cb, _from, to, current=None)
applySettingsToImages_async(_cb, _from, to, current=None)
applySettingsToPixels_async(_cb, _from, to, current=None)
applySettingsToProject_async(_cb, _from, to, current=None)
applySettingsToSet_async(_cb, _from, toType, to, current=None)
createNewRenderingDef_async(_cb, pixels, current=None)
getRenderingSettings_async(_cb, pixelsId, current=None)
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
resetDefaultsByOwnerInSet_async(_cb, type, nodeIds, current=None)
resetDefaultsForPixels_async(_cb, pixelsId, current=None)
resetDefaultsInDataset_async(_cb, dataSetId, current=None)
resetDefaultsInImage_async(_cb, imageId, current=None)
resetDefaultsInSet_async(_cb, type, nodeIds, current=None)
resetDefaultsNoSave_async(_cb, _def, pixels, current=None)
resetDefaults_async(_cb, _def, pixels, current=None)
resetMinMaxInSet_async(_cb, type, nodeIds, current=None)
sanityCheckPixels_async(_cb, pFrom, pTo, current=None)
setOriginalSettingsForPixels_async(_cb, pixelsId, current=None)
setOriginalSettingsInDataset_async(_cb, dataSetId, current=None)
setOriginalSettingsInImage_async(_cb, imageId, current=None)
setOriginalSettingsInSet_async(_cb, type, nodeIds, current=None)
class omero.api.IRenderingSettingsPrx

Bases: omero.api.ServiceInterfacePrx

applySettingsToDataset(_from, to, _ctx=None)
applySettingsToDataset_async(_cb, _from, to, _ctx=None)
applySettingsToImage(_from, to, _ctx=None)
applySettingsToImage_async(_cb, _from, to, _ctx=None)
applySettingsToImages(_from, to, _ctx=None)
applySettingsToImages_async(_cb, _from, to, _ctx=None)
applySettingsToPixels(_from, to, _ctx=None)
applySettingsToPixels_async(_cb, _from, to, _ctx=None)
applySettingsToProject(_from, to, _ctx=None)
applySettingsToProject_async(_cb, _from, to, _ctx=None)
applySettingsToSet(_from, toType, to, _ctx=None)
applySettingsToSet_async(_cb, _from, toType, to, _ctx=None)
begin_applySettingsToDataset(_from, to, _response=None, _ex=None, _sent=None, _ctx=None)
begin_applySettingsToImage(_from, to, _response=None, _ex=None, _sent=None, _ctx=None)
begin_applySettingsToImages(_from, to, _response=None, _ex=None, _sent=None, _ctx=None)
begin_applySettingsToPixels(_from, to, _response=None, _ex=None, _sent=None, _ctx=None)
begin_applySettingsToProject(_from, to, _response=None, _ex=None, _sent=None, _ctx=None)
begin_applySettingsToSet(_from, toType, to, _response=None, _ex=None, _sent=None, _ctx=None)
begin_createNewRenderingDef(pixels, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getRenderingSettings(pixelsId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_resetDefaults(_def, pixels, _response=None, _ex=None, _sent=None, _ctx=None)
begin_resetDefaultsByOwnerInSet(type, nodeIds, _response=None, _ex=None, _sent=None, _ctx=None)
begin_resetDefaultsForPixels(pixelsId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_resetDefaultsInDataset(dataSetId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_resetDefaultsInImage(imageId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_resetDefaultsInSet(type, nodeIds, _response=None, _ex=None, _sent=None, _ctx=None)
begin_resetDefaultsNoSave(_def, pixels, _response=None, _ex=None, _sent=None, _ctx=None)
begin_resetMinMaxInSet(type, nodeIds, _response=None, _ex=None, _sent=None, _ctx=None)
begin_sanityCheckPixels(pFrom, pTo, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setOriginalSettingsForPixels(pixelsId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setOriginalSettingsInDataset(dataSetId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setOriginalSettingsInImage(imageId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setOriginalSettingsInSet(type, nodeIds, _response=None, _ex=None, _sent=None, _ctx=None)
static checkedCast(proxy, facetOrCtx=None, _ctx=None)
createNewRenderingDef(pixels, _ctx=None)
createNewRenderingDef_async(_cb, pixels, _ctx=None)
end_applySettingsToDataset(_r)
end_applySettingsToImage(_r)
end_applySettingsToImages(_r)
end_applySettingsToPixels(_r)
end_applySettingsToProject(_r)
end_applySettingsToSet(_r)
end_createNewRenderingDef(_r)
end_getRenderingSettings(_r)
end_resetDefaults(_r)
end_resetDefaultsByOwnerInSet(_r)
end_resetDefaultsForPixels(_r)
end_resetDefaultsInDataset(_r)
end_resetDefaultsInImage(_r)
end_resetDefaultsInSet(_r)
end_resetDefaultsNoSave(_r)
end_resetMinMaxInSet(_r)
end_sanityCheckPixels(_r)
end_setOriginalSettingsForPixels(_r)
end_setOriginalSettingsInDataset(_r)
end_setOriginalSettingsInImage(_r)
end_setOriginalSettingsInSet(_r)
getRenderingSettings(pixelsId, _ctx=None)
getRenderingSettings_async(_cb, pixelsId, _ctx=None)
resetDefaults(_def, pixels, _ctx=None)
resetDefaultsByOwnerInSet(type, nodeIds, _ctx=None)
resetDefaultsByOwnerInSet_async(_cb, type, nodeIds, _ctx=None)
resetDefaultsForPixels(pixelsId, _ctx=None)
resetDefaultsForPixels_async(_cb, pixelsId, _ctx=None)
resetDefaultsInDataset(dataSetId, _ctx=None)
resetDefaultsInDataset_async(_cb, dataSetId, _ctx=None)
resetDefaultsInImage(imageId, _ctx=None)
resetDefaultsInImage_async(_cb, imageId, _ctx=None)
resetDefaultsInSet(type, nodeIds, _ctx=None)
resetDefaultsInSet_async(_cb, type, nodeIds, _ctx=None)
resetDefaultsNoSave(_def, pixels, _ctx=None)
resetDefaultsNoSave_async(_cb, _def, pixels, _ctx=None)
resetDefaults_async(_cb, _def, pixels, _ctx=None)
resetMinMaxInSet(type, nodeIds, _ctx=None)
resetMinMaxInSet_async(_cb, type, nodeIds, _ctx=None)
sanityCheckPixels(pFrom, pTo, _ctx=None)
sanityCheckPixels_async(_cb, pFrom, pTo, _ctx=None)
setOriginalSettingsForPixels(pixelsId, _ctx=None)
setOriginalSettingsForPixels_async(_cb, pixelsId, _ctx=None)
setOriginalSettingsInDataset(dataSetId, _ctx=None)
setOriginalSettingsInDataset_async(_cb, dataSetId, _ctx=None)
setOriginalSettingsInImage(imageId, _ctx=None)
setOriginalSettingsInImage_async(_cb, imageId, _ctx=None)
setOriginalSettingsInSet(type, nodeIds, _ctx=None)
setOriginalSettingsInSet_async(_cb, type, nodeIds, _ctx=None)
static uncheckedCast(proxy, facet=None)
class omero.api.IRepositoryInfo

Bases: omero.api.ServiceInterface

See IRepositoryInfo.html

_ice_type = <IcePy.TypeInfo object at 0x3c29d80>
_op_getFreeSpaceInKilobytes = <IcePy.Operation object at 0x11cad930>
_op_getUsageFraction = <IcePy.Operation object at 0x11cad948>
_op_getUsedSpaceInKilobytes = <IcePy.Operation object at 0x11cad918>
_op_removeUnusedFiles = <IcePy.Operation object at 0x11cad978>
_op_sanityCheckRepository = <IcePy.Operation object at 0x11cad960>
getFreeSpaceInKilobytes_async(_cb, current=None)
getUsageFraction_async(_cb, current=None)
getUsedSpaceInKilobytes_async(_cb, current=None)
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
removeUnusedFiles_async(_cb, current=None)
sanityCheckRepository_async(_cb, current=None)
class omero.api.IRepositoryInfoPrx

Bases: omero.api.ServiceInterfacePrx

begin_getFreeSpaceInKilobytes(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getUsageFraction(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getUsedSpaceInKilobytes(_response=None, _ex=None, _sent=None, _ctx=None)
begin_removeUnusedFiles(_response=None, _ex=None, _sent=None, _ctx=None)
begin_sanityCheckRepository(_response=None, _ex=None, _sent=None, _ctx=None)
static checkedCast(proxy, facetOrCtx=None, _ctx=None)
end_getFreeSpaceInKilobytes(_r)
end_getUsageFraction(_r)
end_getUsedSpaceInKilobytes(_r)
end_removeUnusedFiles(_r)
end_sanityCheckRepository(_r)
getFreeSpaceInKilobytes(_ctx=None)
getFreeSpaceInKilobytes_async(_cb, _ctx=None)
getUsageFraction(_ctx=None)
getUsageFraction_async(_cb, _ctx=None)
getUsedSpaceInKilobytes(_ctx=None)
getUsedSpaceInKilobytes_async(_cb, _ctx=None)
removeUnusedFiles(_ctx=None)
removeUnusedFiles_async(_cb, _ctx=None)
sanityCheckRepository(_ctx=None)
sanityCheckRepository_async(_cb, _ctx=None)
static uncheckedCast(proxy, facet=None)
class omero.api.IRoi

Bases: omero.api.ServiceInterface

Interface for working with regions of interest.

_ice_type = <IcePy.TypeInfo object at 0x3c29c30>
_op_findByImage = <IcePy.Operation object at 0x11cadac8>
_op_findByPlane = <IcePy.Operation object at 0x11cadae0>
_op_findByRoi = <IcePy.Operation object at 0x11cadab0>
_op_getMeasuredRois = <IcePy.Operation object at 0x11cadb70>
_op_getMeasuredRoisMap = <IcePy.Operation object at 0x11cadb88>
_op_getPoints = <IcePy.Operation object at 0x11cadaf8>
_op_getRoiMeasurements = <IcePy.Operation object at 0x11cadb58>
_op_getRoiStats = <IcePy.Operation object at 0x11cadb10>
_op_getShapeStats = <IcePy.Operation object at 0x11cadb28>
_op_getShapeStatsList = <IcePy.Operation object at 0x11cadb40>
_op_getTable = <IcePy.Operation object at 0x11cadba0>
_op_uploadMask = <IcePy.Operation object at 0x11cadbb8>
findByImage_async(_cb, imageId, opts, current=None)

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

Loads Rois as findByRoi.

findByPlane_async(_cb, imageId, z, t, opts, current=None)

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

Loads Rois as findByRoi.

findByRoi_async(_cb, roiId, opts, current=None)

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?

getMeasuredRoisMap_async(_cb, imageId, annotationIds, opts, current=None)

Returns a map from omero.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)

getMeasuredRois_async(_cb, imageId, annotationId, opts, current=None)

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

Arguments:
annotationId if -1, logic is identical to findByImage(imageId, opts)
getPoints_async(_cb, shapeId, current=None)

Calculate the points contained within a given shape

getRoiMeasurements_async(_cb, imageId, opts, current=None)

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

Arguments:
opts, userId and groupId are respected based on the

ownership of the annotation.

getRoiStats_async(_cb, roiId, current=None)

Calculate stats for all the shapes within the given Roi.

getShapeStatsList_async(_cb, shapeIdList, current=None)

Calculate the stats for the points within the given Shapes.

getShapeStats_async(_cb, shapeId, current=None)

Calculate the stats for the points within the given Shape.

getTable_async(_cb, annotationId, current=None)

Returns the OMERO.tables service via the omero.model.FileAnnotation id returned by getImageMeasurements.

ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
uploadMask_async(_cb, roiId, z, t, bytes, current=None)
class omero.api.IRoiPrx

Bases: omero.api.ServiceInterfacePrx

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?

begin_findByImage(imageId, opts, _response=None, _ex=None, _sent=None, _ctx=None)
begin_findByPlane(imageId, z, t, opts, _response=None, _ex=None, _sent=None, _ctx=None)
begin_findByRoi(roiId, opts, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getMeasuredRois(imageId, annotationId, opts, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getMeasuredRoisMap(imageId, annotationIds, opts, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getPoints(shapeId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getRoiMeasurements(imageId, opts, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getRoiStats(roiId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getShapeStats(shapeId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getShapeStatsList(shapeIdList, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getTable(annotationId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_uploadMask(roiId, z, t, bytes, _response=None, _ex=None, _sent=None, _ctx=None)
static checkedCast(proxy, facetOrCtx=None, _ctx=None)
end_findByImage(_r)
end_findByPlane(_r)
end_findByRoi(_r)
end_getMeasuredRois(_r)
end_getMeasuredRoisMap(_r)
end_getPoints(_r)
end_getRoiMeasurements(_r)
end_getRoiStats(_r)
end_getShapeStats(_r)
end_getShapeStatsList(_r)
end_getTable(_r)
end_uploadMask(_r)
findByImage(imageId, opts, _ctx=None)
findByImage_async(_cb, imageId, opts, _ctx=None)
findByPlane(imageId, z, t, opts, _ctx=None)
findByPlane_async(_cb, imageId, z, t, opts, _ctx=None)
findByRoi(roiId, opts, _ctx=None)
findByRoi_async(_cb, roiId, opts, _ctx=None)
getMeasuredRois(imageId, annotationId, opts, _ctx=None)
getMeasuredRoisMap(imageId, annotationIds, opts, _ctx=None)
getMeasuredRoisMap_async(_cb, imageId, annotationIds, opts, _ctx=None)
getMeasuredRois_async(_cb, imageId, annotationId, opts, _ctx=None)
getPoints(shapeId, _ctx=None)
getPoints_async(_cb, shapeId, _ctx=None)
getRoiMeasurements(imageId, opts, _ctx=None)
getRoiMeasurements_async(_cb, imageId, opts, _ctx=None)
getRoiStats(roiId, _ctx=None)
getRoiStats_async(_cb, roiId, _ctx=None)
getShapeStats(shapeId, _ctx=None)
getShapeStatsList(shapeIdList, _ctx=None)
getShapeStatsList_async(_cb, shapeIdList, _ctx=None)
getShapeStats_async(_cb, shapeId, _ctx=None)
getTable(annotationId, _ctx=None)
getTable_async(_cb, annotationId, _ctx=None)
static uncheckedCast(proxy, facet=None)
uploadMask(roiId, z, t, bytes, _ctx=None)
uploadMask_async(_cb, roiId, z, t, bytes, _ctx=None)
class omero.api.IScript

Bases: omero.api.ServiceInterface

Utility service for managing and launching scripts for execution by the Processor API.

Typical usage might include (PYTHON):

sf = client.createSession() svc = sf.getScriptService() scripts = svc.getScripts()

if len(scripts) >= 1: script_id = svc.keys()[-1] else: script_id = svc.uploadScript(‘/test/my_script.py’, SCRIPT_TEXT)

params = svc.getParams(script_id)

# You will need to parse the params to create the proper input inputs = {}

# The last parameter is how long to wait as an RInt proc = svc.runScript(script_id, inputs, None) try: cb = omero.scripts.ProcessCallbackI(client, proc) while not cb.block(1000): # ms. pass cb.close() rv = proc.getResults(0) finally: proc.close(False)

See OMERO.scripts for more information.

_ice_type = <IcePy.TypeInfo object at 0x3c29c60>
_op_canRunScript = <IcePy.Operation object at 0x11cadcd8>
_op_deleteScript = <IcePy.Operation object at 0x11cadca8>
_op_editScript = <IcePy.Operation object at 0x11cadc60>
_op_getParams = <IcePy.Operation object at 0x11cadc90>
_op_getScriptID = <IcePy.Operation object at 0x11cadc00>
_op_getScriptText = <IcePy.Operation object at 0x11cadc18>
_op_getScriptWithDetails = <IcePy.Operation object at 0x11cadc78>
_op_getScripts = <IcePy.Operation object at 0x11cadbd0>
_op_getUserScripts = <IcePy.Operation object at 0x11cadbe8>
_op_runScript = <IcePy.Operation object at 0x11cadcc0>
_op_uploadOfficialScript = <IcePy.Operation object at 0x11cadc48>
_op_uploadScript = <IcePy.Operation object at 0x11cadc30>
_op_validateScript = <IcePy.Operation object at 0x11cadcf0>
canRunScript_async(_cb, scriptID, current=None)

Returns true if there is a processor which will run the given script.

Either the script is an official script and this method will return true (though an individual invocation may fail with an omero.ResourceError for some reason) or this is a user script, and a usermode processor must be active which takes the scripts user or group.

deleteScript_async(_cb, scriptID, current=None)

Delete the script on the server with id. The file will also be removed from disk.

Arguments:
scriptID Id of the script to delete.
Exceptions:
ApiUsageException SecurityViolation
editScript_async(_cb, fileObject, scriptText, current=None)

Modify the text for the given script object.

Arguments:
script see above.
Exceptions:
ApiUsageException SecurityViolation
getParams_async(_cb, scriptID, current=None)

Get the parameters that the script takes and returns, along with other metadata available from the script.

Arguments:
scriptID see above.
Returns:
see above.
Exceptions:
ApiUsageException
getScriptID_async(_cb, path, current=None)

Get the id of an official script by the script path. The script service ensures that all script paths are unique.

Note: there is no similar method for user scripts (e.g. getUserScriptID) since the path is not guaranteed to be unique.

Arguments:
scriptName The name of the script.
Returns:
see above.
Exceptions:
ApiUsageException SecurityViolation
getScriptText_async(_cb, scriptID, current=None)

Get the text from the server for the script with given id.

Arguments:
scriptID see above.
Returns:
see above.
Exceptions:
ApiUsageException
getScriptWithDetails_async(_cb, scriptID, current=None)

Get the script from the server with details from OriginalFile Arguments:

scriptID see above
Returns:
see above
Exceptions:
ApiUsageException
getScripts_async(_cb, current=None)

This method returns official server scripts as a list of omero.model.OriginalFile objects. These scripts will be executed by the server if submitted via runScript. The input parameters necessary for proper functioning can be retrieved via getParams.

The omero.model.OriginalFile#path value can be used in other official scripts via the language specific import command, since the script directory will be placed on the appropriate environment path variable.

scripts = scriptService.getScripts() for script in scripts: text = scriptService.getScriptText(script.id.val) path = script.path.val[1:] # First symbol is a “/” path = path.replace(“/”,”.”) print “Possible import: %s” % path

Returns:
see above.
Exceptions:
ApiUsageException SecurityViolation
getUserScripts_async(_cb, acceptsList, current=None)

Returns non-official scripts which have been uploaded by individual users. These scripts will not be run by the server, though a user can start a personal “usermode processor” which will allow the scripts to be executed. This is particularly useful for testing new scripts.

ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
runScript_async(_cb, scriptID, inputs, waitSecs, current=None)

If ResourceError is thrown, then no Processor is available. Use scheduleJob to create a omero.model.ScriptJob in the “Waiting” state. A Processor may become available.

try: proc = scriptService.runScript(1, {}, None) except ResourceError: job = scriptService.scheduleScript(1, {}, None)

The ScriptProcess proxy MUST be closed before exiting. If you would like the script execution to continue in the background, pass “True” as the argument.

try: proc.poll() # See if process is finished finally: proc.close(True) # Detach and execution can continue # proc.close(False) # OR script is immediately stopped.

uploadOfficialScript_async(_cb, path, scriptText, current=None)

Like uploadScript but is only callable by administrators. The parameters for the script are also checked.

uploadScript_async(_cb, path, scriptText, current=None)

Upload a user script to the server and return the id. This method checks that a script with that names does not exist and that the script has parameters if possible, i.e. a usermode processor is running which for the current user.

Arguments:
script see above.
Returns:
The new id of the script.
Exceptions:
ApiUsageException SecurityViolation
validateScript_async(_cb, j, acceptsList, current=None)

Used internally by processor.py to check if the script attached to the omero.model.Job has a valid script attached, based on the acceptsList and the current security context.

An example of an acceptsList might be Experimenter(myUserId, False), meaning that only scripts belonging to me should be trusted. An empty list implies that the server should return what it would by default trust.

A valid script will be returned if it exists; otherwise null.

class omero.api.IScriptPrx

Bases: omero.api.ServiceInterfacePrx

This method returns official server scripts as a list of omero.model.OriginalFile objects. These scripts will be executed by the server if submitted via runScript. The input parameters necessary for proper functioning can be retrieved via getParams.

The omero.model.OriginalFile#path value can be used in other official scripts via the language specific import command, since the script directory will be placed on the appropriate environment path variable.

scripts = scriptService.getScripts() for script in scripts: text = scriptService.getScriptText(script.id.val) path = script.path.val[1:] # First symbol is a “/” path = path.replace(“/”,”.”) print “Possible import: %s” % path

Returns:
see above.
Exceptions:
ApiUsageException SecurityViolation
begin_canRunScript(scriptID, _response=None, _ex=None, _sent=None, _ctx=None)
begin_deleteScript(scriptID, _response=None, _ex=None, _sent=None, _ctx=None)
begin_editScript(fileObject, scriptText, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getParams(scriptID, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getScriptID(path, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getScriptText(scriptID, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getScriptWithDetails(scriptID, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getScripts(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getUserScripts(acceptsList, _response=None, _ex=None, _sent=None, _ctx=None)
begin_runScript(scriptID, inputs, waitSecs, _response=None, _ex=None, _sent=None, _ctx=None)
begin_uploadOfficialScript(path, scriptText, _response=None, _ex=None, _sent=None, _ctx=None)
begin_uploadScript(path, scriptText, _response=None, _ex=None, _sent=None, _ctx=None)
begin_validateScript(j, acceptsList, _response=None, _ex=None, _sent=None, _ctx=None)
canRunScript(scriptID, _ctx=None)
canRunScript_async(_cb, scriptID, _ctx=None)
static checkedCast(proxy, facetOrCtx=None, _ctx=None)
deleteScript(scriptID, _ctx=None)
deleteScript_async(_cb, scriptID, _ctx=None)
editScript(fileObject, scriptText, _ctx=None)
editScript_async(_cb, fileObject, scriptText, _ctx=None)
end_canRunScript(_r)
end_deleteScript(_r)
end_editScript(_r)
end_getParams(_r)
end_getScriptID(_r)
end_getScriptText(_r)
end_getScriptWithDetails(_r)
end_getScripts(_r)
end_getUserScripts(_r)
end_runScript(_r)
end_uploadOfficialScript(_r)
end_uploadScript(_r)
end_validateScript(_r)
getParams(scriptID, _ctx=None)
getParams_async(_cb, scriptID, _ctx=None)
getScriptID(path, _ctx=None)
getScriptID_async(_cb, path, _ctx=None)
getScriptText(scriptID, _ctx=None)
getScriptText_async(_cb, scriptID, _ctx=None)
getScriptWithDetails(scriptID, _ctx=None)
getScriptWithDetails_async(_cb, scriptID, _ctx=None)
getScripts(_ctx=None)
getScripts_async(_cb, _ctx=None)
getUserScripts(acceptsList, _ctx=None)
getUserScripts_async(_cb, acceptsList, _ctx=None)
runScript(scriptID, inputs, waitSecs, _ctx=None)
runScript_async(_cb, scriptID, inputs, waitSecs, _ctx=None)
static uncheckedCast(proxy, facet=None)
uploadOfficialScript(path, scriptText, _ctx=None)
uploadOfficialScript_async(_cb, path, scriptText, _ctx=None)
uploadScript(path, scriptText, _ctx=None)
uploadScript_async(_cb, path, scriptText, _ctx=None)
validateScript(j, acceptsList, _ctx=None)
validateScript_async(_cb, j, acceptsList, _ctx=None)
class omero.api.ISession

Bases: omero.api.ServiceInterface

See ISession.html

_ice_type = <IcePy.TypeInfo object at 0x3c29c90>
_op_closeSession = <IcePy.Operation object at 0x11caddb0>
_op_createSession = <IcePy.Operation object at 0x11cadd20>
_op_createSessionWithTimeout = <IcePy.Operation object at 0x11cadd50>
_op_createSessionWithTimeouts = <IcePy.Operation object at 0x11cadd68>
_op_createUserSession = <IcePy.Operation object at 0x11cadd38>
_op_getInput = <IcePy.Operation object at 0x11cade10>
_op_getInputKeys = <IcePy.Operation object at 0x11cade70>
_op_getInputs = <IcePy.Operation object at 0x11cadea0>
_op_getMyOpenAgentSessions = <IcePy.Operation object at 0x11cadde0>
_op_getMyOpenClientSessions = <IcePy.Operation object at 0x11caddf8>
_op_getMyOpenSessions = <IcePy.Operation object at 0x11caddc8>
_op_getOutput = <IcePy.Operation object at 0x11cade28>
_op_getOutputKeys = <IcePy.Operation object at 0x11cade88>
_op_getOutputs = <IcePy.Operation object at 0x11cadeb8>
_op_getReferenceCount = <IcePy.Operation object at 0x11cadd98>
_op_getSession = <IcePy.Operation object at 0x11cadd80>
_op_setInput = <IcePy.Operation object at 0x11cade40>
_op_setOutput = <IcePy.Operation object at 0x11cade58>
closeSession_async(_cb, sess, current=None)
createSessionWithTimeout_async(_cb, p, timeToLiveMilliseconds, current=None)
createSessionWithTimeouts_async(_cb, p, timeToLiveMilliseconds, timeToIdleMilliseconds, current=None)
createSession_async(_cb, p, credentials, current=None)
createUserSession_async(_cb, timeToLiveMilliseconds, timeToIdleMilliseconds, defaultGroup, current=None)

HasPassword: Requires the session to have been created with a password as opposed to with a session uuid (via joinSession). If that’s not the case, a SecurityViolation will be thrown, in which case ServiceFactory.setSecurityPassword can be used.

getInputKeys_async(_cb, sess, current=None)
getInput_async(_cb, sess, key, current=None)
getInputs_async(_cb, sess, current=None)
getMyOpenAgentSessions_async(_cb, agent, current=None)
getMyOpenClientSessions_async(_cb, current=None)
getMyOpenSessions_async(_cb, current=None)
getOutputKeys_async(_cb, sess, current=None)
getOutput_async(_cb, sess, key, current=None)
getOutputs_async(_cb, sess, current=None)
getReferenceCount_async(_cb, sessionUuid, current=None)
getSession_async(_cb, sessionUuid, current=None)
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
setInput_async(_cb, sess, key, value, current=None)
setOutput_async(_cb, sess, key, value, current=None)
class omero.api.ISessionPrx

Bases: omero.api.ServiceInterfacePrx

begin_closeSession(sess, _response=None, _ex=None, _sent=None, _ctx=None)
begin_createSession(p, credentials, _response=None, _ex=None, _sent=None, _ctx=None)
begin_createSessionWithTimeout(p, timeToLiveMilliseconds, _response=None, _ex=None, _sent=None, _ctx=None)
begin_createSessionWithTimeouts(p, timeToLiveMilliseconds, timeToIdleMilliseconds, _response=None, _ex=None, _sent=None, _ctx=None)
begin_createUserSession(timeToLiveMilliseconds, timeToIdleMilliseconds, defaultGroup, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getInput(sess, key, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getInputKeys(sess, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getInputs(sess, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getMyOpenAgentSessions(agent, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getMyOpenClientSessions(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getMyOpenSessions(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getOutput(sess, key, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getOutputKeys(sess, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getOutputs(sess, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getReferenceCount(sessionUuid, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getSession(sessionUuid, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setInput(sess, key, value, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setOutput(sess, key, value, _response=None, _ex=None, _sent=None, _ctx=None)
static checkedCast(proxy, facetOrCtx=None, _ctx=None)
closeSession(sess, _ctx=None)
closeSession_async(_cb, sess, _ctx=None)
createSession(p, credentials, _ctx=None)
createSessionWithTimeout(p, timeToLiveMilliseconds, _ctx=None)
createSessionWithTimeout_async(_cb, p, timeToLiveMilliseconds, _ctx=None)
createSessionWithTimeouts(p, timeToLiveMilliseconds, timeToIdleMilliseconds, _ctx=None)
createSessionWithTimeouts_async(_cb, p, timeToLiveMilliseconds, timeToIdleMilliseconds, _ctx=None)
createSession_async(_cb, p, credentials, _ctx=None)
createUserSession(timeToLiveMilliseconds, timeToIdleMilliseconds, defaultGroup, _ctx=None)
createUserSession_async(_cb, timeToLiveMilliseconds, timeToIdleMilliseconds, defaultGroup, _ctx=None)
end_closeSession(_r)
end_createSession(_r)
end_createSessionWithTimeout(_r)
end_createSessionWithTimeouts(_r)
end_createUserSession(_r)
end_getInput(_r)
end_getInputKeys(_r)
end_getInputs(_r)
end_getMyOpenAgentSessions(_r)
end_getMyOpenClientSessions(_r)
end_getMyOpenSessions(_r)
end_getOutput(_r)
end_getOutputKeys(_r)
end_getOutputs(_r)
end_getReferenceCount(_r)
end_getSession(_r)
end_setInput(_r)
end_setOutput(_r)
getInput(sess, key, _ctx=None)
getInputKeys(sess, _ctx=None)
getInputKeys_async(_cb, sess, _ctx=None)
getInput_async(_cb, sess, key, _ctx=None)
getInputs(sess, _ctx=None)
getInputs_async(_cb, sess, _ctx=None)
getMyOpenAgentSessions(agent, _ctx=None)
getMyOpenAgentSessions_async(_cb, agent, _ctx=None)
getMyOpenClientSessions(_ctx=None)
getMyOpenClientSessions_async(_cb, _ctx=None)
getMyOpenSessions(_ctx=None)
getMyOpenSessions_async(_cb, _ctx=None)
getOutput(sess, key, _ctx=None)
getOutputKeys(sess, _ctx=None)
getOutputKeys_async(_cb, sess, _ctx=None)
getOutput_async(_cb, sess, key, _ctx=None)
getOutputs(sess, _ctx=None)
getOutputs_async(_cb, sess, _ctx=None)
getReferenceCount(sessionUuid, _ctx=None)
getReferenceCount_async(_cb, sessionUuid, _ctx=None)
getSession(sessionUuid, _ctx=None)
getSession_async(_cb, sessionUuid, _ctx=None)
setInput(sess, key, value, _ctx=None)
setInput_async(_cb, sess, key, value, _ctx=None)
setOutput(sess, key, value, _ctx=None)
setOutput_async(_cb, sess, key, value, _ctx=None)
static uncheckedCast(proxy, facet=None)
class omero.api.IShare

Bases: omero.api.ServiceInterface

See IShare.html

_ice_type = <IcePy.TypeInfo object at 0x3c29cc0>
_op_activate = <IcePy.Operation object at 0x11caded0>
_op_addComment = <IcePy.Operation object at 0x11be3138>
_op_addGuest = <IcePy.Operation object at 0x11be3240>
_op_addGuests = <IcePy.Operation object at 0x11be31e0>
_op_addObject = <IcePy.Operation object at 0x11be30c0>
_op_addObjects = <IcePy.Operation object at 0x11be30a8>
_op_addReply = <IcePy.Operation object at 0x11be3150>
_op_addUser = <IcePy.Operation object at 0x11be3228>
_op_addUsers = <IcePy.Operation object at 0x11be31c8>
_op_closeShare = <IcePy.Operation object at 0x11be3090>
_op_createShare = <IcePy.Operation object at 0x11be3030>
_op_deactivate = <IcePy.Operation object at 0x11cadee8>
_op_deleteComment = <IcePy.Operation object at 0x11be3168>
_op_getActiveConnections = <IcePy.Operation object at 0x11be3288>
_op_getAllGuests = <IcePy.Operation object at 0x11be3198>
_op_getAllMembers = <IcePy.Operation object at 0x11be3180>
_op_getAllUsers = <IcePy.Operation object at 0x11be31b0>
_op_getCommentCount = <IcePy.Operation object at 0x11be3108>
_op_getComments = <IcePy.Operation object at 0x11be3120>
_op_getContentMap = <IcePy.Operation object at 0x11cadfd8>
_op_getContentSize = <IcePy.Operation object at 0x11cadfc0>
_op_getContentSubList = <IcePy.Operation object at 0x11cadfa8>
_op_getContents = <IcePy.Operation object at 0x11cadf90>
_op_getEvents = <IcePy.Operation object at 0x11be32d0>
_op_getMemberCount = <IcePy.Operation object at 0x11cadf18>
_op_getMemberShares = <IcePy.Operation object at 0x11cadf48>
_op_getMemberSharesFor = <IcePy.Operation object at 0x11cadf78>
_op_getOwnShares = <IcePy.Operation object at 0x11cadf30>
_op_getPastConnections = <IcePy.Operation object at 0x11be32a0>
_op_getShare = <IcePy.Operation object at 0x11cadf00>
_op_getSharesOwnedBy = <IcePy.Operation object at 0x11cadf60>
_op_invalidateConnection = <IcePy.Operation object at 0x11be32b8>
_op_notifyMembersOfShare = <IcePy.Operation object at 0x11be32e8>
_op_removeGuest = <IcePy.Operation object at 0x11be3270>
_op_removeGuests = <IcePy.Operation object at 0x11be3210>
_op_removeObject = <IcePy.Operation object at 0x11be30f0>
_op_removeObjects = <IcePy.Operation object at 0x11be30d8>
_op_removeUser = <IcePy.Operation object at 0x11be3258>
_op_removeUsers = <IcePy.Operation object at 0x11be31f8>
_op_setActive = <IcePy.Operation object at 0x11be3078>
_op_setDescription = <IcePy.Operation object at 0x11be3048>
_op_setExpiration = <IcePy.Operation object at 0x11be3060>
activate_async(_cb, shareId, current=None)
addComment_async(_cb, shareId, comment, current=None)
addGuest_async(_cb, shareId, emailAddress, current=None)
addGuests_async(_cb, shareId, emailAddresses, current=None)
addObject_async(_cb, shareId, iobject, current=None)
addObjects_async(_cb, shareId, iobjects, current=None)
addReply_async(_cb, shareId, comment, replyTo, current=None)
addUser_async(_cb, shareId, exp, current=None)
addUsers_async(_cb, shareId, exps, current=None)
closeShare_async(_cb, shareId, current=None)
createShare_async(_cb, description, expiration, items, exps, guests, enabled, current=None)
deactivate_async(_cb, current=None)
deleteComment_async(_cb, comment, current=None)
getActiveConnections_async(_cb, shareId, current=None)
getAllGuests_async(_cb, shareId, current=None)
getAllMembers_async(_cb, shareId, current=None)
getAllUsers_async(_cb, shareId, current=None)
getCommentCount_async(_cb, shareIds, current=None)
getComments_async(_cb, shareId, current=None)
getContentMap_async(_cb, shareId, current=None)
getContentSize_async(_cb, shareId, current=None)
getContentSubList_async(_cb, shareId, start, finish, current=None)
getContents_async(_cb, shareId, current=None)
getEvents_async(_cb, shareId, exp, _from, to, current=None)
getMemberCount_async(_cb, shareIds, current=None)
getMemberSharesFor_async(_cb, user, active, current=None)
getMemberShares_async(_cb, active, current=None)
getOwnShares_async(_cb, active, current=None)
getPastConnections_async(_cb, shareId, current=None)
getShare_async(_cb, shareId, current=None)
getSharesOwnedBy_async(_cb, user, active, current=None)
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
invalidateConnection_async(_cb, shareId, exp, current=None)
notifyMembersOfShare_async(_cb, shareId, subject, message, html, current=None)
removeGuest_async(_cb, shareId, emailAddress, current=None)
removeGuests_async(_cb, shareId, emailAddresses, current=None)
removeObject_async(_cb, shareId, iobject, current=None)
removeObjects_async(_cb, shareId, iobjects, current=None)
removeUser_async(_cb, shareId, exp, current=None)
removeUsers_async(_cb, shareId, exps, current=None)
setActive_async(_cb, shareId, active, current=None)
setDescription_async(_cb, shareId, description, current=None)
setExpiration_async(_cb, shareId, expiration, current=None)
class omero.api.ISharePrx

Bases: omero.api.ServiceInterfacePrx

activate(shareId, _ctx=None)
activate_async(_cb, shareId, _ctx=None)
addComment(shareId, comment, _ctx=None)
addComment_async(_cb, shareId, comment, _ctx=None)
addGuest(shareId, emailAddress, _ctx=None)
addGuest_async(_cb, shareId, emailAddress, _ctx=None)
addGuests(shareId, emailAddresses, _ctx=None)
addGuests_async(_cb, shareId, emailAddresses, _ctx=None)
addObject(shareId, iobject, _ctx=None)
addObject_async(_cb, shareId, iobject, _ctx=None)
addObjects(shareId, iobjects, _ctx=None)
addObjects_async(_cb, shareId, iobjects, _ctx=None)
addReply(shareId, comment, replyTo, _ctx=None)
addReply_async(_cb, shareId, comment, replyTo, _ctx=None)
addUser(shareId, exp, _ctx=None)
addUser_async(_cb, shareId, exp, _ctx=None)
addUsers(shareId, exps, _ctx=None)
addUsers_async(_cb, shareId, exps, _ctx=None)
begin_activate(shareId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_addComment(shareId, comment, _response=None, _ex=None, _sent=None, _ctx=None)
begin_addGuest(shareId, emailAddress, _response=None, _ex=None, _sent=None, _ctx=None)
begin_addGuests(shareId, emailAddresses, _response=None, _ex=None, _sent=None, _ctx=None)
begin_addObject(shareId, iobject, _response=None, _ex=None, _sent=None, _ctx=None)
begin_addObjects(shareId, iobjects, _response=None, _ex=None, _sent=None, _ctx=None)
begin_addReply(shareId, comment, replyTo, _response=None, _ex=None, _sent=None, _ctx=None)
begin_addUser(shareId, exp, _response=None, _ex=None, _sent=None, _ctx=None)
begin_addUsers(shareId, exps, _response=None, _ex=None, _sent=None, _ctx=None)
begin_closeShare(shareId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_createShare(description, expiration, items, exps, guests, enabled, _response=None, _ex=None, _sent=None, _ctx=None)
begin_deactivate(_response=None, _ex=None, _sent=None, _ctx=None)
begin_deleteComment(comment, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getActiveConnections(shareId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getAllGuests(shareId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getAllMembers(shareId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getAllUsers(shareId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getCommentCount(shareIds, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getComments(shareId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getContentMap(shareId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getContentSize(shareId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getContentSubList(shareId, start, finish, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getContents(shareId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getEvents(shareId, exp, _from, to, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getMemberCount(shareIds, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getMemberShares(active, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getMemberSharesFor(user, active, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getOwnShares(active, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getPastConnections(shareId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getShare(shareId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getSharesOwnedBy(user, active, _response=None, _ex=None, _sent=None, _ctx=None)
begin_invalidateConnection(shareId, exp, _response=None, _ex=None, _sent=None, _ctx=None)
begin_notifyMembersOfShare(shareId, subject, message, html, _response=None, _ex=None, _sent=None, _ctx=None)
begin_removeGuest(shareId, emailAddress, _response=None, _ex=None, _sent=None, _ctx=None)
begin_removeGuests(shareId, emailAddresses, _response=None, _ex=None, _sent=None, _ctx=None)
begin_removeObject(shareId, iobject, _response=None, _ex=None, _sent=None, _ctx=None)
begin_removeObjects(shareId, iobjects, _response=None, _ex=None, _sent=None, _ctx=None)
begin_removeUser(shareId, exp, _response=None, _ex=None, _sent=None, _ctx=None)
begin_removeUsers(shareId, exps, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setActive(shareId, active, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setDescription(shareId, description, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setExpiration(shareId, expiration, _response=None, _ex=None, _sent=None, _ctx=None)
static checkedCast(proxy, facetOrCtx=None, _ctx=None)
closeShare(shareId, _ctx=None)
closeShare_async(_cb, shareId, _ctx=None)
createShare(description, expiration, items, exps, guests, enabled, _ctx=None)
createShare_async(_cb, description, expiration, items, exps, guests, enabled, _ctx=None)
deactivate(_ctx=None)
deactivate_async(_cb, _ctx=None)
deleteComment(comment, _ctx=None)
deleteComment_async(_cb, comment, _ctx=None)
end_activate(_r)
end_addComment(_r)
end_addGuest(_r)
end_addGuests(_r)
end_addObject(_r)
end_addObjects(_r)
end_addReply(_r)
end_addUser(_r)
end_addUsers(_r)
end_closeShare(_r)
end_createShare(_r)
end_deactivate(_r)
end_deleteComment(_r)
end_getActiveConnections(_r)
end_getAllGuests(_r)
end_getAllMembers(_r)
end_getAllUsers(_r)
end_getCommentCount(_r)
end_getComments(_r)
end_getContentMap(_r)
end_getContentSize(_r)
end_getContentSubList(_r)
end_getContents(_r)
end_getEvents(_r)
end_getMemberCount(_r)
end_getMemberShares(_r)
end_getMemberSharesFor(_r)
end_getOwnShares(_r)
end_getPastConnections(_r)
end_getShare(_r)
end_getSharesOwnedBy(_r)
end_invalidateConnection(_r)
end_notifyMembersOfShare(_r)
end_removeGuest(_r)
end_removeGuests(_r)
end_removeObject(_r)
end_removeObjects(_r)
end_removeUser(_r)
end_removeUsers(_r)
end_setActive(_r)
end_setDescription(_r)
end_setExpiration(_r)
getActiveConnections(shareId, _ctx=None)
getActiveConnections_async(_cb, shareId, _ctx=None)
getAllGuests(shareId, _ctx=None)
getAllGuests_async(_cb, shareId, _ctx=None)
getAllMembers(shareId, _ctx=None)
getAllMembers_async(_cb, shareId, _ctx=None)
getAllUsers(shareId, _ctx=None)
getAllUsers_async(_cb, shareId, _ctx=None)
getCommentCount(shareIds, _ctx=None)
getCommentCount_async(_cb, shareIds, _ctx=None)
getComments(shareId, _ctx=None)
getComments_async(_cb, shareId, _ctx=None)
getContentMap(shareId, _ctx=None)
getContentMap_async(_cb, shareId, _ctx=None)
getContentSize(shareId, _ctx=None)
getContentSize_async(_cb, shareId, _ctx=None)
getContentSubList(shareId, start, finish, _ctx=None)
getContentSubList_async(_cb, shareId, start, finish, _ctx=None)
getContents(shareId, _ctx=None)
getContents_async(_cb, shareId, _ctx=None)
getEvents(shareId, exp, _from, to, _ctx=None)
getEvents_async(_cb, shareId, exp, _from, to, _ctx=None)
getMemberCount(shareIds, _ctx=None)
getMemberCount_async(_cb, shareIds, _ctx=None)
getMemberShares(active, _ctx=None)
getMemberSharesFor(user, active, _ctx=None)
getMemberSharesFor_async(_cb, user, active, _ctx=None)
getMemberShares_async(_cb, active, _ctx=None)
getOwnShares(active, _ctx=None)
getOwnShares_async(_cb, active, _ctx=None)
getPastConnections(shareId, _ctx=None)
getPastConnections_async(_cb, shareId, _ctx=None)
getShare(shareId, _ctx=None)
getShare_async(_cb, shareId, _ctx=None)
getSharesOwnedBy(user, active, _ctx=None)
getSharesOwnedBy_async(_cb, user, active, _ctx=None)
invalidateConnection(shareId, exp, _ctx=None)
invalidateConnection_async(_cb, shareId, exp, _ctx=None)
notifyMembersOfShare(shareId, subject, message, html, _ctx=None)
notifyMembersOfShare_async(_cb, shareId, subject, message, html, _ctx=None)
removeGuest(shareId, emailAddress, _ctx=None)
removeGuest_async(_cb, shareId, emailAddress, _ctx=None)
removeGuests(shareId, emailAddresses, _ctx=None)
removeGuests_async(_cb, shareId, emailAddresses, _ctx=None)
removeObject(shareId, iobject, _ctx=None)
removeObject_async(_cb, shareId, iobject, _ctx=None)
removeObjects(shareId, iobjects, _ctx=None)
removeObjects_async(_cb, shareId, iobjects, _ctx=None)
removeUser(shareId, exp, _ctx=None)
removeUser_async(_cb, shareId, exp, _ctx=None)
removeUsers(shareId, exps, _ctx=None)
removeUsers_async(_cb, shareId, exps, _ctx=None)
setActive(shareId, active, _ctx=None)
setActive_async(_cb, shareId, active, _ctx=None)
setDescription(shareId, description, _ctx=None)
setDescription_async(_cb, shareId, description, _ctx=None)
setExpiration(shareId, expiration, _ctx=None)
setExpiration_async(_cb, shareId, expiration, _ctx=None)
static uncheckedCast(proxy, facet=None)
class omero.api.ITimeline

Bases: omero.api.ServiceInterface

Service for the querying of OMERO metadata based on creation and modification time. Currently supported types for querying include:

  • “Annotation”
  • “Dataset”
  • “Image”
  • “Project”
  • “RenderingDef”

The map return values will be indexed by the short type name above: “Project”, “Image”, ... All keys which are passed in the StringSet argument will be included in the returned map, even if they have no values. A default value of 0 or the empty list [] will be used. The only exception to this rule is that the null or empty StringSet implies all valid keys.

All methods take a omero::sys::Parameters object and will apply the filter object for paging through the data in order to prevent loading too many objects. If the parameters argument is null or no paging is activated, then the default will be: OFFSET=0, LIMIT=50. Filter.ownerId and Filter.groupId will also be AND’ed to the query if either value is present. If both are null, then the current user id will be used. To retrieve for all users, use ownerId == rlong(-1) and groupId == null.

The methods which take a StringSet and a Parameters object, also have a “bool merge” argument. This argument defines whether or not the LIMIT applies to each object independently ([“a”,”b”] @ 100 == 200) or merges the lists together chronologically ([“a”,”b”] @ 100 merged == 100).

Except for Image, IObject.details.updateEvent is used in all cases for determining most recent events. Images are compared via Image.acquisitionDate which is unlike the other properties is modifiable by the user.

A typical invocation might look like (in Python):

timeline = sf.getTimelineService() params = ParametersI().page(0,100) types = [“Project”,”Dataset”]) map = timeline.getByPeriod(types, params, False)

At this point, map will not contain more than 200 objects.

This service is defined only in Blitz and so no javadoc is available in the ome.api package.

TODOS: binning, stateful caching, ...

_ice_type = <IcePy.TypeInfo object at 0x3c29db0>
_op_countByPeriod = <IcePy.Operation object at 0x11be3360>
_op_getByPeriod = <IcePy.Operation object at 0x11be3348>
_op_getEventLogsByPeriod = <IcePy.Operation object at 0x11be3378>
_op_getMostRecentObjects = <IcePy.Operation object at 0x11be3330>
countByPeriod_async(_cb, types, start, end, p, current=None)

Queries the same information as getByPeriod, but only returns the counts for the given objects.

getByPeriod_async(_cb, types, start, end, p, merge, current=None)

Returns the given LIMIT objects of TYPES as ordered by creation/modification times in the Event table, but within the given time window.

getEventLogsByPeriod_async(_cb, start, end, p, current=None)

Returns the EventLog table objects which are queried to produce the counts above. Note the concept of “period inclusion” mentioned above.

WORKAROUND WARNING: this method returns non-managed EventLogs (i.e. eventLog.getId() == null) for “Image acquisitions”.

Return the last LIMIT annotation __Links__ whose parent (IAnnotated) matches one of the parentTypes, whose child (Annotation) matches one of the childTypes (limit of one for the moment), and who namespace matches via ILIKE.

The parents and children will be unloaded. The link will have its creation/update events loaded.

If Parameters.theFilter.ownerId or groupId are set, they will be AND’ed to the query to filter results.

Merges by default based on parentType.

getMostRecentObjects_async(_cb, types, p, merge, current=None)

Returns the last LIMIT objects of TYPES as ordered by creation/modification times in the Event table.

Return the last LIMIT comment annotation links attached to a share by __others__.

Note: Currently the storage of these objects is not optimal and so this method may change.

ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.api.ITimelinePrx

Bases: omero.api.ServiceInterfacePrx

Return the last LIMIT annotation __Links__ whose parent (IAnnotated) matches one of the parentTypes, whose child (Annotation) matches one of the childTypes (limit of one for the moment), and who namespace matches via ILIKE.

The parents and children will be unloaded. The link will have its creation/update events loaded.

If Parameters.theFilter.ownerId or groupId are set, they will be AND’ed to the query to filter results.

Merges by default based on parentType.

begin_countByPeriod(types, start, end, p, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getByPeriod(types, start, end, p, merge, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getEventLogsByPeriod(start, end, p, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getMostRecentObjects(types, p, merge, _response=None, _ex=None, _sent=None, _ctx=None)
static checkedCast(proxy, facetOrCtx=None, _ctx=None)
countByPeriod(types, start, end, p, _ctx=None)
countByPeriod_async(_cb, types, start, end, p, _ctx=None)
end_countByPeriod(_r)
end_getByPeriod(_r)
end_getEventLogsByPeriod(_r)
end_getMostRecentObjects(_r)
getByPeriod(types, start, end, p, merge, _ctx=None)
getByPeriod_async(_cb, types, start, end, p, merge, _ctx=None)
getEventLogsByPeriod(start, end, p, _ctx=None)
getEventLogsByPeriod_async(_cb, start, end, p, _ctx=None)
getMostRecentObjects(types, p, merge, _ctx=None)
getMostRecentObjects_async(_cb, types, p, merge, _ctx=None)
static uncheckedCast(proxy, facet=None)
class omero.api.ITypes

Bases: omero.api.ServiceInterface

See ITypes.html

_ice_type = <IcePy.TypeInfo object at 0x3c29cf0>
_op_allEnumerations = <IcePy.Operation object at 0x11be33c0>
_op_createEnumeration = <IcePy.Operation object at 0x11be3390>
_op_deleteEnumeration = <IcePy.Operation object at 0x11be3408>
_op_getAnnotationTypes = <IcePy.Operation object at 0x11be3438>
_op_getEnumeration = <IcePy.Operation object at 0x11be33a8>
_op_getEnumerationTypes = <IcePy.Operation object at 0x11be3420>
_op_getEnumerationsWithEntries = <IcePy.Operation object at 0x11be3450>
_op_getOriginalEnumerations = <IcePy.Operation object at 0x11be3468>
_op_resetEnumerations = <IcePy.Operation object at 0x11be3480>
_op_updateEnumeration = <IcePy.Operation object at 0x11be33d8>
_op_updateEnumerations = <IcePy.Operation object at 0x11be33f0>
allEnumerations_async(_cb, type, current=None)
createEnumeration_async(_cb, newEnum, current=None)
deleteEnumeration_async(_cb, oldEnum, current=None)
getAnnotationTypes_async(_cb, current=None)
getEnumerationTypes_async(_cb, current=None)
getEnumeration_async(_cb, type, value, current=None)
getEnumerationsWithEntries_async(_cb, current=None)
getOriginalEnumerations_async(_cb, current=None)
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
resetEnumerations_async(_cb, enumClass, current=None)
updateEnumeration_async(_cb, oldEnum, current=None)
updateEnumerations_async(_cb, oldEnums, current=None)
class omero.api.ITypesPrx

Bases: omero.api.ServiceInterfacePrx

allEnumerations(type, _ctx=None)
allEnumerations_async(_cb, type, _ctx=None)
begin_allEnumerations(type, _response=None, _ex=None, _sent=None, _ctx=None)
begin_createEnumeration(newEnum, _response=None, _ex=None, _sent=None, _ctx=None)
begin_deleteEnumeration(oldEnum, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getAnnotationTypes(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getEnumeration(type, value, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getEnumerationTypes(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getEnumerationsWithEntries(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getOriginalEnumerations(_response=None, _ex=None, _sent=None, _ctx=None)
begin_resetEnumerations(enumClass, _response=None, _ex=None, _sent=None, _ctx=None)
begin_updateEnumeration(oldEnum, _response=None, _ex=None, _sent=None, _ctx=None)
begin_updateEnumerations(oldEnums, _response=None, _ex=None, _sent=None, _ctx=None)
static checkedCast(proxy, facetOrCtx=None, _ctx=None)
createEnumeration(newEnum, _ctx=None)
createEnumeration_async(_cb, newEnum, _ctx=None)
deleteEnumeration(oldEnum, _ctx=None)
deleteEnumeration_async(_cb, oldEnum, _ctx=None)
end_allEnumerations(_r)
end_createEnumeration(_r)
end_deleteEnumeration(_r)
end_getAnnotationTypes(_r)
end_getEnumeration(_r)
end_getEnumerationTypes(_r)
end_getEnumerationsWithEntries(_r)
end_getOriginalEnumerations(_r)
end_resetEnumerations(_r)
end_updateEnumeration(_r)
end_updateEnumerations(_r)
getAnnotationTypes(_ctx=None)
getAnnotationTypes_async(_cb, _ctx=None)
getEnumeration(type, value, _ctx=None)
getEnumerationTypes(_ctx=None)
getEnumerationTypes_async(_cb, _ctx=None)
getEnumeration_async(_cb, type, value, _ctx=None)
getEnumerationsWithEntries(_ctx=None)
getEnumerationsWithEntries_async(_cb, _ctx=None)
getOriginalEnumerations(_ctx=None)
getOriginalEnumerations_async(_cb, _ctx=None)
resetEnumerations(enumClass, _ctx=None)
resetEnumerations_async(_cb, enumClass, _ctx=None)
static uncheckedCast(proxy, facet=None)
updateEnumeration(oldEnum, _ctx=None)
updateEnumeration_async(_cb, oldEnum, _ctx=None)
updateEnumerations(oldEnums, _ctx=None)
updateEnumerations_async(_cb, oldEnums, _ctx=None)
class omero.api.IUpdate

Bases: omero.api.ServiceInterface

See IUpdate.html

_ice_type = <IcePy.TypeInfo object at 0x3c29d20>
_op_deleteObject = <IcePy.Operation object at 0x11be3540>
_op_indexObject = <IcePy.Operation object at 0x11be3558>
_op_saveAndReturnArray = <IcePy.Operation object at 0x11be3510>
_op_saveAndReturnIds = <IcePy.Operation object at 0x11be3528>
_op_saveAndReturnObject = <IcePy.Operation object at 0x11be34e0>
_op_saveArray = <IcePy.Operation object at 0x11be34f8>
_op_saveCollection = <IcePy.Operation object at 0x11be34c8>
_op_saveObject = <IcePy.Operation object at 0x11be34b0>
deleteObject_async(_cb, row, current=None)
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
indexObject_async(_cb, row, current=None)
saveAndReturnArray_async(_cb, graph, current=None)
saveAndReturnIds_async(_cb, graph, current=None)
saveAndReturnObject_async(_cb, obj, current=None)
saveArray_async(_cb, graph, current=None)
saveCollection_async(_cb, objs, current=None)
saveObject_async(_cb, obj, current=None)
class omero.api.IUpdatePrx

Bases: omero.api.ServiceInterfacePrx

begin_deleteObject(row, _response=None, _ex=None, _sent=None, _ctx=None)
begin_indexObject(row, _response=None, _ex=None, _sent=None, _ctx=None)
begin_saveAndReturnArray(graph, _response=None, _ex=None, _sent=None, _ctx=None)
begin_saveAndReturnIds(graph, _response=None, _ex=None, _sent=None, _ctx=None)
begin_saveAndReturnObject(obj, _response=None, _ex=None, _sent=None, _ctx=None)
begin_saveArray(graph, _response=None, _ex=None, _sent=None, _ctx=None)
begin_saveCollection(objs, _response=None, _ex=None, _sent=None, _ctx=None)
begin_saveObject(obj, _response=None, _ex=None, _sent=None, _ctx=None)
static checkedCast(proxy, facetOrCtx=None, _ctx=None)
deleteObject(row, _ctx=None)
deleteObject_async(_cb, row, _ctx=None)
end_deleteObject(_r)
end_indexObject(_r)
end_saveAndReturnArray(_r)
end_saveAndReturnIds(_r)
end_saveAndReturnObject(_r)
end_saveArray(_r)
end_saveCollection(_r)
end_saveObject(_r)
indexObject(row, _ctx=None)
indexObject_async(_cb, row, _ctx=None)
saveAndReturnArray(graph, _ctx=None)
saveAndReturnArray_async(_cb, graph, _ctx=None)
saveAndReturnIds(graph, _ctx=None)
saveAndReturnIds_async(_cb, graph, _ctx=None)
saveAndReturnObject(obj, _ctx=None)
saveAndReturnObject_async(_cb, obj, _ctx=None)
saveArray(graph, _ctx=None)
saveArray_async(_cb, graph, _ctx=None)
saveCollection(objs, _ctx=None)
saveCollection_async(_cb, objs, _ctx=None)
saveObject(obj, _ctx=None)
saveObject_async(_cb, obj, _ctx=None)
static uncheckedCast(proxy, facet=None)
class omero.api.JobHandle

Bases: omero.api.StatefulServiceInterface

See JobHandle.html

_ice_type = <IcePy.TypeInfo object at 0x3c29e10>
_op_attach = <IcePy.Operation object at 0x11be3660>
_op_cancelJob = <IcePy.Operation object at 0x11be3708>
_op_getJob = <IcePy.Operation object at 0x11be3678>
_op_jobError = <IcePy.Operation object at 0x11be36f0>
_op_jobFinished = <IcePy.Operation object at 0x11be36a8>
_op_jobMessage = <IcePy.Operation object at 0x11be36c0>
_op_jobRunning = <IcePy.Operation object at 0x11be36d8>
_op_jobStatus = <IcePy.Operation object at 0x11be3690>
_op_setMessage = <IcePy.Operation object at 0x11be3738>
_op_setStatus = <IcePy.Operation object at 0x11be3720>
_op_setStatusAndMessage = <IcePy.Operation object at 0x11be3750>
_op_submit = <IcePy.Operation object at 0x11be3648>
attach_async(_cb, jobId, current=None)
cancelJob_async(_cb, current=None)
getJob_async(_cb, current=None)
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
jobError_async(_cb, current=None)
jobFinished_async(_cb, current=None)
jobMessage_async(_cb, current=None)
jobRunning_async(_cb, current=None)
jobStatus_async(_cb, current=None)
setMessage_async(_cb, message, current=None)
setStatusAndMessage_async(_cb, status, message, current=None)
setStatus_async(_cb, status, current=None)
submit_async(_cb, j, current=None)
class omero.api.JobHandlePrx

Bases: omero.api.StatefulServiceInterfacePrx

attach(jobId, _ctx=None)
attach_async(_cb, jobId, _ctx=None)
begin_attach(jobId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_cancelJob(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getJob(_response=None, _ex=None, _sent=None, _ctx=None)
begin_jobError(_response=None, _ex=None, _sent=None, _ctx=None)
begin_jobFinished(_response=None, _ex=None, _sent=None, _ctx=None)
begin_jobMessage(_response=None, _ex=None, _sent=None, _ctx=None)
begin_jobRunning(_response=None, _ex=None, _sent=None, _ctx=None)
begin_jobStatus(_response=None, _ex=None, _sent=None, _ctx=None)
begin_setMessage(message, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setStatus(status, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setStatusAndMessage(status, message, _response=None, _ex=None, _sent=None, _ctx=None)
begin_submit(j, _response=None, _ex=None, _sent=None, _ctx=None)
cancelJob(_ctx=None)
cancelJob_async(_cb, _ctx=None)
static checkedCast(proxy, facetOrCtx=None, _ctx=None)
end_attach(_r)
end_cancelJob(_r)
end_getJob(_r)
end_jobError(_r)
end_jobFinished(_r)
end_jobMessage(_r)
end_jobRunning(_r)
end_jobStatus(_r)
end_setMessage(_r)
end_setStatus(_r)
end_setStatusAndMessage(_r)
end_submit(_r)
getJob(_ctx=None)
getJob_async(_cb, _ctx=None)
jobError(_ctx=None)
jobError_async(_cb, _ctx=None)
jobFinished(_ctx=None)
jobFinished_async(_cb, _ctx=None)
jobMessage(_ctx=None)
jobMessage_async(_cb, _ctx=None)
jobRunning(_ctx=None)
jobRunning_async(_cb, _ctx=None)
jobStatus(_ctx=None)
jobStatus_async(_cb, _ctx=None)
setMessage(message, _ctx=None)
setMessage_async(_cb, message, _ctx=None)
setStatus(status, _ctx=None)
setStatusAndMessage(status, message, _ctx=None)
setStatusAndMessage_async(_cb, status, message, _ctx=None)
setStatus_async(_cb, status, _ctx=None)
submit(j, _ctx=None)
submit_async(_cb, j, _ctx=None)
static uncheckedCast(proxy, facet=None)
class omero.api.LongPair(first=0, second=0)

Bases: object

_LongPair__compare(other)
class omero.api.MetadataStore

Bases: omero.api.StatefulServiceInterface

Server-side interface for import.

_ice_type = <IcePy.TypeInfo object at 0x3c91900>
_op_createRoot = <IcePy.Operation object at 0x3c91918>
_op_populateMinMax = <IcePy.Operation object at 0x3c91978>
_op_postProcess = <IcePy.Operation object at 0x3c919a8>
_op_saveToDB = <IcePy.Operation object at 0x3c91960>
_op_setPixelsFile = <IcePy.Operation object at 0x3c91990>
_op_updateObjects = <IcePy.Operation object at 0x3c91930>
_op_updateReferences = <IcePy.Operation object at 0x3c91948>
createRoot_async(_cb, current=None)
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
populateMinMax_async(_cb, imageChannelGlobalMinMax, current=None)
postProcess_async(_cb, current=None)
saveToDB_async(_cb, activity, current=None)
setPixelsFile_async(_cb, pixelsId, file, repo, current=None)
updateObjects_async(_cb, objects, current=None)
updateReferences_async(_cb, references, current=None)
class omero.api.MetadataStorePrx

Bases: omero.api.StatefulServiceInterfacePrx

begin_createRoot(_response=None, _ex=None, _sent=None, _ctx=None)
begin_populateMinMax(imageChannelGlobalMinMax, _response=None, _ex=None, _sent=None, _ctx=None)
begin_postProcess(_response=None, _ex=None, _sent=None, _ctx=None)
begin_saveToDB(activity, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setPixelsFile(pixelsId, file, repo, _response=None, _ex=None, _sent=None, _ctx=None)
begin_updateObjects(objects, _response=None, _ex=None, _sent=None, _ctx=None)
begin_updateReferences(references, _response=None, _ex=None, _sent=None, _ctx=None)
static checkedCast(proxy, facetOrCtx=None, _ctx=None)
createRoot(_ctx=None)
createRoot_async(_cb, _ctx=None)
end_createRoot(_r)
end_populateMinMax(_r)
end_postProcess(_r)
end_saveToDB(_r)
end_setPixelsFile(_r)
end_updateObjects(_r)
end_updateReferences(_r)
populateMinMax(imageChannelGlobalMinMax, _ctx=None)
populateMinMax_async(_cb, imageChannelGlobalMinMax, _ctx=None)
postProcess(_ctx=None)
postProcess_async(_cb, _ctx=None)
saveToDB(activity, _ctx=None)
saveToDB_async(_cb, activity, _ctx=None)
setPixelsFile(pixelsId, file, repo, _ctx=None)
setPixelsFile_async(_cb, pixelsId, file, repo, _ctx=None)
static uncheckedCast(proxy, facet=None)
updateObjects(objects, _ctx=None)
updateObjects_async(_cb, objects, _ctx=None)
updateReferences(references, _ctx=None)
updateReferences_async(_cb, references, _ctx=None)
class omero.api.PyramidService

Bases: omero.api.StatefulServiceInterface

_ice_type = <IcePy.TypeInfo object at 0x11be3888>
_op_getResolutionDescriptions = <IcePy.Operation object at 0x11be38d0>
_op_getResolutionLevel = <IcePy.Operation object at 0x11be38e8>
_op_getResolutionLevels = <IcePy.Operation object at 0x11be38b8>
_op_getTileSize = <IcePy.Operation object at 0x11be3918>
_op_requiresPixelsPyramid = <IcePy.Operation object at 0x11be38a0>
_op_setResolutionLevel = <IcePy.Operation object at 0x11be3900>
getResolutionDescriptions_async(_cb, current=None)

Retrieves a more complete definition of the resolution level in question. The size of this array will be of length getResolutionLevels.

getResolutionLevel_async(_cb, current=None)

Retrieves the active resolution level. Returns:

The active resolution level.
getResolutionLevels_async(_cb, current=None)

Retrieves the number of resolution levels that the backing pixels pyramid contains. Returns:

The number of resolution levels. This value does not

necessarily indicate either the presence or absence of a pixels pyramid.

getTileSize_async(_cb, current=None)

Retrieves the tile size for the pixel store. Returns:

An array of length = 2 where the first

value of the array is the tile width and the second value is the tile height.

ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
requiresPixelsPyramid_async(_cb, current=None)

Whether or not this raw pixels store requires a backing pixels pyramid to provide sub-resolutions of the data. Returns:

true if the pixels store requires a

pixels pyramid and false otherwise.

setResolutionLevel_async(_cb, resolutionLevel, current=None)

Sets the active resolution level. Arguments:

resolutionLevel The resolution level to be used by

the pixel buffer.

class omero.api.PyramidServicePrx

Bases: omero.api.StatefulServiceInterfacePrx

Whether or not this raw pixels store requires a backing pixels pyramid to provide sub-resolutions of the data. Returns:

true if the pixels store requires a

pixels pyramid and false otherwise.

begin_getResolutionDescriptions(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getResolutionLevel(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getResolutionLevels(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getTileSize(_response=None, _ex=None, _sent=None, _ctx=None)
begin_requiresPixelsPyramid(_response=None, _ex=None, _sent=None, _ctx=None)
begin_setResolutionLevel(resolutionLevel, _response=None, _ex=None, _sent=None, _ctx=None)
static checkedCast(proxy, facetOrCtx=None, _ctx=None)
end_getResolutionDescriptions(_r)
end_getResolutionLevel(_r)
end_getResolutionLevels(_r)
end_getTileSize(_r)
end_requiresPixelsPyramid(_r)
end_setResolutionLevel(_r)
getResolutionDescriptions(_ctx=None)
getResolutionDescriptions_async(_cb, _ctx=None)
getResolutionLevel(_ctx=None)
getResolutionLevel_async(_cb, _ctx=None)
getResolutionLevels(_ctx=None)
getResolutionLevels_async(_cb, _ctx=None)
getTileSize(_ctx=None)
getTileSize_async(_cb, _ctx=None)
requiresPixelsPyramid(_ctx=None)
requiresPixelsPyramid_async(_cb, _ctx=None)
setResolutionLevel(resolutionLevel, _ctx=None)
setResolutionLevel_async(_cb, resolutionLevel, _ctx=None)
static uncheckedCast(proxy, facet=None)
class omero.api.RawFileStore

Bases: omero.api.StatefulServiceInterface

Raw file gateway which provides access to the OMERO file repository.

Note: methods on this service are protected by a “DOWNLOAD” restriction.

See also RawFileStore.html

_ice_type = <IcePy.TypeInfo object at 0x3c29e40>
_op_exists = <IcePy.Operation object at 0x11be37f8>
_op_getFileId = <IcePy.Operation object at 0x11be3780>
_op_read = <IcePy.Operation object at 0x11be3798>
_op_save = <IcePy.Operation object at 0x11be3810>
_op_setFileId = <IcePy.Operation object at 0x11be3768>
_op_size = <IcePy.Operation object at 0x11be37b0>
_op_truncate = <IcePy.Operation object at 0x11be37c8>
_op_write = <IcePy.Operation object at 0x11be37e0>
exists_async(_cb, current=None)
getFileId_async(_cb, current=None)

Returns the current file id or null if none has been set.

ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
read_async(_cb, position, length, current=None)
save_async(_cb, current=None)
setFileId_async(_cb, fileId, current=None)

This method manages the state of the service. This method will throw a omero.SecurityViolation if for the current user context either the file is not readable or a omero.constants.permissions#DOWNLOAD restriction is in place.

size_async(_cb, current=None)
truncate_async(_cb, length, current=None)
write_async(_cb, buf, position, length, current=None)
class omero.api.RawFileStorePrx

Bases: omero.api.StatefulServiceInterfacePrx

This method manages the state of the service. This method will throw a omero.SecurityViolation if for the current user context either the file is not readable or a omero.constants.permissions#DOWNLOAD restriction is in place.

begin_exists(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getFileId(_response=None, _ex=None, _sent=None, _ctx=None)
begin_read(position, length, _response=None, _ex=None, _sent=None, _ctx=None)
begin_save(_response=None, _ex=None, _sent=None, _ctx=None)
begin_setFileId(fileId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_size(_response=None, _ex=None, _sent=None, _ctx=None)
begin_truncate(length, _response=None, _ex=None, _sent=None, _ctx=None)
begin_write(buf, position, length, _response=None, _ex=None, _sent=None, _ctx=None)
static checkedCast(proxy, facetOrCtx=None, _ctx=None)
end_exists(_r)
end_getFileId(_r)
end_read(_r)
end_save(_r)
end_setFileId(_r)
end_size(_r)
end_truncate(_r)
end_write(_r)
exists(_ctx=None)
exists_async(_cb, _ctx=None)
getFileId(_ctx=None)
getFileId_async(_cb, _ctx=None)
read(position, length, _ctx=None)
read_async(_cb, position, length, _ctx=None)
save(_ctx=None)
save_async(_cb, _ctx=None)
setFileId(fileId, _ctx=None)
setFileId_async(_cb, fileId, _ctx=None)
size(_ctx=None)
size_async(_cb, _ctx=None)
truncate(length, _ctx=None)
truncate_async(_cb, length, _ctx=None)
static uncheckedCast(proxy, facet=None)
write(buf, position, length, _ctx=None)
write_async(_cb, buf, position, length, _ctx=None)
class omero.api.RawPixelsStore

Bases: omero.api.PyramidService

Binary data provider. Initialized with the ID of a omero.model.Pixels instance, this service can provide various slices, stacks, regions of the 5-dimensional (X-Y planes with multiple Z-sections and Channels over Time). The byte array returned by the getter methods and passed to the setter methods can and will be interpreted according to results of getByteWidth(), isFloat(), and isSigned().

Read-only caveat:

Mutating methods (set*) are only available during the first access. Once the Pixels data has been successfully saved (via the save or close methods on this interface), then the data should be treated read-only. If Pixels data writing fails and the service is inadvertently closed, delete the Pixels object, and create a new one. Any partially written data will be removed.

_ice_type = <IcePy.TypeInfo object at 0x3c29e70>
_op_calculateMessageDigest = <IcePy.Operation object at 0x11be3c18>
_op_getByteWidth = <IcePy.Operation object at 0x11be3bd0>
_op_getCol = <IcePy.Operation object at 0x11be3ac8>
_op_getHypercube = <IcePy.Operation object at 0x11be3a80>
_op_getPixelsId = <IcePy.Operation object at 0x11be3948>
_op_getPixelsPath = <IcePy.Operation object at 0x11be3960>
_op_getPlane = <IcePy.Operation object at 0x11be3ae0>
_op_getPlaneOffset = <IcePy.Operation object at 0x11be3a20>
_op_getPlaneRegion = <IcePy.Operation object at 0x11be3af8>
_op_getPlaneSize = <IcePy.Operation object at 0x11be3990>
_op_getRegion = <IcePy.Operation object at 0x11be3a98>
_op_getRow = <IcePy.Operation object at 0x11be3ab0>
_op_getRowOffset = <IcePy.Operation object at 0x11be3a08>
_op_getRowSize = <IcePy.Operation object at 0x11be39a8>
_op_getStack = <IcePy.Operation object at 0x11be3b10>
_op_getStackOffset = <IcePy.Operation object at 0x11be3a38>
_op_getStackSize = <IcePy.Operation object at 0x11be39c0>
_op_getTile = <IcePy.Operation object at 0x11be3a68>
_op_getTimepoint = <IcePy.Operation object at 0x11be3b28>
_op_getTimepointOffset = <IcePy.Operation object at 0x11be3a50>
_op_getTimepointSize = <IcePy.Operation object at 0x11be39d8>
_op_getTotalSize = <IcePy.Operation object at 0x11be39f0>
_op_isFloat = <IcePy.Operation object at 0x11be3c00>
_op_isSigned = <IcePy.Operation object at 0x11be3be8>
_op_prepare = <IcePy.Operation object at 0x11be3978>
_op_save = <IcePy.Operation object at 0x11be3c30>
_op_setPixelsId = <IcePy.Operation object at 0x11be3930>
_op_setPlane = <IcePy.Operation object at 0x11be3b88>
_op_setRegion = <IcePy.Operation object at 0x11be3b58>
_op_setRow = <IcePy.Operation object at 0x11be3b70>
_op_setStack = <IcePy.Operation object at 0x11be3ba0>
_op_setTile = <IcePy.Operation object at 0x11be3b40>
_op_setTimepoint = <IcePy.Operation object at 0x11be3bb8>
calculateMessageDigest_async(_cb, current=None)

Calculates a SHA-1 message digest for the entire pixel store. Returns:

byte array containing the message digest.
getByteWidth_async(_cb, current=None)

Returns the byte width for the pixel store. Returns:

See above.
getCol_async(_cb, x, z, c, t, current=None)

Retrieves a particular column from this pixel store. Arguments:

x offset across the X-axis of the pixel store. z offset across the Z-axis of the pixel store. c offset across the C-axis of the pixel store. t offset across the T-axis of the pixel store.
Returns:
buffer containing the data which comprises this column.
getHypercube_async(_cb, offset, size, step, current=None)

Retrieves a n-dimensional block from this pixel store. Arguments:

start offset for each dimension within pixel store. size of each dimension (dependent on dimension). step needed of each dimension (dependent on dimension).
Returns:
buffer containing the data.
getPixelsId_async(_cb, current=None)

Returns the current Pixels set identifier. Returns:

See above.
getPixelsPath_async(_cb, current=None)

Returns the current Pixels path. Returns:

See above.
getPlaneOffset_async(_cb, z, c, t, current=None)

Retrieves the offset for a particular 2D image plane in this pixel store. Arguments:

z offset across the Z-axis of the pixel buffer. c offset across the C-axis of the pixel buffer. t offset across the T-axis of the pixel buffer.
Returns:
offset of the 2D image plane.
getPlaneRegion_async(_cb, z, c, t, size, offset, current=None)

Retrieves a region from a given plane from this pixel store. Arguments:

z offset across the Z-axis of the pixel store. c offset across the C-axis of the pixel store. t offset across the T-axis of the pixel store. count the number of pixels to retrieve. offset the offset at which to retrieve count pixels.
Returns:
buffer containing the data which comprises the region of the

given 2D image plane. It is guaranteed that this buffer will have been byte swapped.

getPlaneSize_async(_cb, current=None)

Retrieves the in memory size of a 2D image plane in this pixel store. Returns:

2D image plane size in bytes (sizeX*sizeY*ByteWidth).
getPlane_async(_cb, z, c, t, current=None)

Retrieves a particular 2D image plane from this pixel store. Arguments:

z offset across the Z-axis of the pixel store. c offset across the C-axis of the pixel store. t offset across the T-axis of the pixel store.
Returns:
buffer containing the data which comprises this 2D image plane.
getRegion_async(_cb, size, offset, current=None)

Retrieves a region from this pixel store. Arguments:

size byte width of the region to retrieve. offset offset within the pixel store.
Returns:
buffer containing the data.
getRowOffset_async(_cb, y, z, c, t, current=None)

Retrieves the offset for a particular row or scanline in this pixel store. Arguments:

y offset across the Y-axis of the pixel buffer. z offset across the Z-axis of the pixel buffer. c offset across the C-axis of the pixel buffer. t offset across the T-axis of the pixel buffer.
Returns:
offset of the row or scaline.
getRowSize_async(_cb, current=None)

Retrieves the in memory size of a row or scanline of pixels in this pixel store. Returns:

row or scanline size in bytes (sizeX*ByteWidth)
getRow_async(_cb, y, z, c, t, current=None)

Retrieves a particular row or scanline from this pixel store. Arguments:

y offset across the Y-axis of the pixel store. z offset across the Z-axis of the pixel store. c offset across the C-axis of the pixel store. t offset across the T-axis of the pixel store.
Returns:
buffer containing the data which comprises this row or scanline.
getStackOffset_async(_cb, c, t, current=None)

Retrieves the offset for the entire number of optical sections for a single wavelength or channel at a particular timepoint in this pixel store. Arguments:

c offset across the C-axis of the pixel buffer. t offset across the T-axis of the pixel buffer.
Returns:
offset of the stack.
getStackSize_async(_cb, current=None)

Retrieves the in memory size of the entire number of optical sections for a single wavelength or channel at a particular timepoint in this pixel store. Returns:

stack size in bytes (sizeX*sizeY*sizeZ*ByteWidth).
getStack_async(_cb, c, t, current=None)

Retrieves the the entire number of optical sections for a single wavelength or channel at a particular timepoint in this pixel store. Arguments:

c offset across the C-axis of the pixel store. t offset across the T-axis of the pixel store.
Returns:
buffer containing the data which comprises this stack.
getTile_async(_cb, z, c, t, x, y, w, h, current=None)

Retrieves a tile from this pixel buffer. Arguments:

z offset across the Z-axis of the pixel buffer. c offset across the C-axis of the pixel buffer. t offset across the T-axis of the pixel buffer. x Top left corner of the tile, X offset. y Top left corner of the tile, Y offset. w Width of the tile. h Height of the tile.
Returns:
buffer containing the data.
getTimepointOffset_async(_cb, t, current=None)

Retrieves the in memory size of the entire number of optical sections for all wavelengths or channels at a particular timepoint in this pixel store. Arguments:

t offset across the T-axis of the pixel buffer.
Returns:
offset of the timepoint.
getTimepointSize_async(_cb, current=None)

Retrieves the in memory size of the entire number of optical sections for all wavelengths or channels at a particular timepoint in this pixel store. Returns:

timepoint size in bytes (sizeX*sizeY*sizeZ*sizeC*ByteWidth).
getTimepoint_async(_cb, t, current=None)

Retrieves the entire number of optical sections for all wavelengths or channels at a particular timepoint in this pixel store. Arguments:

t offset across the T-axis of the pixel store.
getTotalSize_async(_cb, current=None)

Retrieves the in memory size of the entire pixel store. Returns:

total size of the pixel size in bytes

(sizeX*sizeY*sizeZ*sizeC*sizeT*ByteWidth).

ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
isFloat_async(_cb, current=None)

Returns whether or not the pixel buffer has floating point pixels. Returns:

isSigned_async(_cb, current=None)

Returns whether or not the pixel store has signed pixels. Returns:

See above.
prepare_async(_cb, pixelsIds, current=None)

Prepares the stateful service with a cache of loaded Pixels objects. This method is designed to combat query overhead, where many sets of Pixels are to be read from or written to, by loading all the Pixels sets at once. Multiple calls will result in the existing cache being overwritten. Arguments:

pixelsIds Pixels IDs to cache.
save_async(_cb, current=None)

Save the current state of the pixels, updating the SHA1. This should only be called AFTER all data is successfully set. Future invocations of set methods may be disallowed. This read-only status will allow background processing (generation of thumbnails, compression, etc) to begin. More information under RawPixelsStore.

A null instance will be returned if no save was performed.

setPixelsId_async(_cb, pixelsId, bypassOriginalFile, current=None)

Initializes the stateful service for a given Pixels set. Arguments:

pixelsId Pixels set identifier. bypassOriginalFile Whether or not to bypass checking for an

original file to back the pixel buffer used by this service. If requests are predominantly write-only or involve the population of a brand new pixel buffer using true here is a safe optimization otherwise false is expected.

See “read-only caveat” under RawPixelsStore

setPlane_async(_cb, buf, z, c, t, current=None)

Sets a particular 2D image plane in this pixel store. Arguments:

buf a byte array of the data comprising this 2D image plane. z offset across the Z-axis of the pixel store. c offset across the C-axis of the pixel store. t offset across the T-axis of the pixel store.

See “read-only caveat” under RawPixelsStore

setRegion_async(_cb, size, offset, buf, current=None)

Sets a region in this pixel buffer. Arguments:

size byte width of the region to set. offset offset within the pixel buffer. buf a byte array of the data.

See “read-only caveat” under RawPixelsStore

setRow_async(_cb, buf, y, z, c, t, current=None)

Sets a particular row or scanline in this pixel store. Arguments:

buf a byte array of the data comprising this row or scanline. y offset across the Y-axis of the pixel store. z offset across the Z-axis of the pixel store. c offset across the C-axis of the pixel store. t offset across the T-axis of the pixel store.

See “read-only caveat” under RawPixelsStore

setStack_async(_cb, buf, z, c, t, current=None)

Sets the entire number of optical sections for a single wavelength or channel at a particular timepoint in this pixel store. Arguments:

buf a byte array of the data comprising this stack. c offset across the C-axis of the pixel store. t offset across the T-axis of the pixel store.

See “read-only caveat” under RawPixelsStore

setTile_async(_cb, buf, z, c, t, x, y, w, h, current=None)

Sets a tile in this pixel buffer. Arguments:

buf A byte array of the data. z offset across the Z-axis of the pixel buffer. c offset across the C-axis of the pixel buffer. t offset across the T-axis of the pixel buffer. x Top left corner of the tile, X offset. y Top left corner of the tile, Y offset. w Width of the tile. h Height of the tile.
Exceptions:
IOException if there is a problem writing to the pixel buffer. BufferOverflowException if an attempt is made to write off the

end of the file.

See “read-only caveat” under RawPixelsStore

setTimepoint_async(_cb, buf, t, current=None)

Sets the entire number of optical sections for all wavelengths or channels at a particular timepoint in this pixel store. Arguments:

buf a byte array of the data comprising this timepoint. t offset across the T-axis of the pixel buffer.

See “read-only caveat” under RawPixelsStore

class omero.api.RawPixelsStorePrx

Bases: omero.api.PyramidServicePrx

Initializes the stateful service for a given Pixels set. Arguments:

pixelsId Pixels set identifier. bypassOriginalFile Whether or not to bypass checking for an

original file to back the pixel buffer used by this service. If requests are predominantly write-only or involve the population of a brand new pixel buffer using true here is a safe optimization otherwise false is expected.

See “read-only caveat” under RawPixelsStore

begin_calculateMessageDigest(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getByteWidth(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getCol(x, z, c, t, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getHypercube(offset, size, step, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getPixelsId(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getPixelsPath(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getPlane(z, c, t, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getPlaneOffset(z, c, t, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getPlaneRegion(z, c, t, size, offset, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getPlaneSize(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getRegion(size, offset, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getRow(y, z, c, t, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getRowOffset(y, z, c, t, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getRowSize(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getStack(c, t, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getStackOffset(c, t, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getStackSize(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getTile(z, c, t, x, y, w, h, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getTimepoint(t, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getTimepointOffset(t, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getTimepointSize(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getTotalSize(_response=None, _ex=None, _sent=None, _ctx=None)
begin_isFloat(_response=None, _ex=None, _sent=None, _ctx=None)
begin_isSigned(_response=None, _ex=None, _sent=None, _ctx=None)
begin_prepare(pixelsIds, _response=None, _ex=None, _sent=None, _ctx=None)
begin_save(_response=None, _ex=None, _sent=None, _ctx=None)
begin_setPixelsId(pixelsId, bypassOriginalFile, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setPlane(buf, z, c, t, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setRegion(size, offset, buf, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setRow(buf, y, z, c, t, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setStack(buf, z, c, t, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setTile(buf, z, c, t, x, y, w, h, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setTimepoint(buf, t, _response=None, _ex=None, _sent=None, _ctx=None)
calculateMessageDigest(_ctx=None)
calculateMessageDigest_async(_cb, _ctx=None)
static checkedCast(proxy, facetOrCtx=None, _ctx=None)
end_calculateMessageDigest(_r)
end_getByteWidth(_r)
end_getCol(_r)
end_getHypercube(_r)
end_getPixelsId(_r)
end_getPixelsPath(_r)
end_getPlane(_r)
end_getPlaneOffset(_r)
end_getPlaneRegion(_r)
end_getPlaneSize(_r)
end_getRegion(_r)
end_getRow(_r)
end_getRowOffset(_r)
end_getRowSize(_r)
end_getStack(_r)
end_getStackOffset(_r)
end_getStackSize(_r)
end_getTile(_r)
end_getTimepoint(_r)
end_getTimepointOffset(_r)
end_getTimepointSize(_r)
end_getTotalSize(_r)
end_isFloat(_r)
end_isSigned(_r)
end_prepare(_r)
end_save(_r)
end_setPixelsId(_r)
end_setPlane(_r)
end_setRegion(_r)
end_setRow(_r)
end_setStack(_r)
end_setTile(_r)
end_setTimepoint(_r)
getByteWidth(_ctx=None)
getByteWidth_async(_cb, _ctx=None)
getCol(x, z, c, t, _ctx=None)
getCol_async(_cb, x, z, c, t, _ctx=None)
getHypercube(offset, size, step, _ctx=None)
getHypercube_async(_cb, offset, size, step, _ctx=None)
getPixelsId(_ctx=None)
getPixelsId_async(_cb, _ctx=None)
getPixelsPath(_ctx=None)
getPixelsPath_async(_cb, _ctx=None)
getPlane(z, c, t, _ctx=None)
getPlaneOffset(z, c, t, _ctx=None)
getPlaneOffset_async(_cb, z, c, t, _ctx=None)
getPlaneRegion(z, c, t, size, offset, _ctx=None)
getPlaneRegion_async(_cb, z, c, t, size, offset, _ctx=None)
getPlaneSize(_ctx=None)
getPlaneSize_async(_cb, _ctx=None)
getPlane_async(_cb, z, c, t, _ctx=None)
getRegion(size, offset, _ctx=None)
getRegion_async(_cb, size, offset, _ctx=None)
getRow(y, z, c, t, _ctx=None)
getRowOffset(y, z, c, t, _ctx=None)
getRowOffset_async(_cb, y, z, c, t, _ctx=None)
getRowSize(_ctx=None)
getRowSize_async(_cb, _ctx=None)
getRow_async(_cb, y, z, c, t, _ctx=None)
getStack(c, t, _ctx=None)
getStackOffset(c, t, _ctx=None)
getStackOffset_async(_cb, c, t, _ctx=None)
getStackSize(_ctx=None)
getStackSize_async(_cb, _ctx=None)
getStack_async(_cb, c, t, _ctx=None)
getTile(z, c, t, x, y, w, h, _ctx=None)
getTile_async(_cb, z, c, t, x, y, w, h, _ctx=None)
getTimepoint(t, _ctx=None)
getTimepointOffset(t, _ctx=None)
getTimepointOffset_async(_cb, t, _ctx=None)
getTimepointSize(_ctx=None)
getTimepointSize_async(_cb, _ctx=None)
getTimepoint_async(_cb, t, _ctx=None)
getTotalSize(_ctx=None)
getTotalSize_async(_cb, _ctx=None)
isFloat(_ctx=None)
isFloat_async(_cb, _ctx=None)
isSigned(_ctx=None)
isSigned_async(_cb, _ctx=None)
prepare(pixelsIds, _ctx=None)
prepare_async(_cb, pixelsIds, _ctx=None)
save(_ctx=None)
save_async(_cb, _ctx=None)
setPixelsId(pixelsId, bypassOriginalFile, _ctx=None)
setPixelsId_async(_cb, pixelsId, bypassOriginalFile, _ctx=None)
setPlane(buf, z, c, t, _ctx=None)
setPlane_async(_cb, buf, z, c, t, _ctx=None)
setRegion(size, offset, buf, _ctx=None)
setRegion_async(_cb, size, offset, buf, _ctx=None)
setRow(buf, y, z, c, t, _ctx=None)
setRow_async(_cb, buf, y, z, c, t, _ctx=None)
setStack(buf, z, c, t, _ctx=None)
setStack_async(_cb, buf, z, c, t, _ctx=None)
setTile(buf, z, c, t, x, y, w, h, _ctx=None)
setTile_async(_cb, buf, z, c, t, x, y, w, h, _ctx=None)
setTimepoint(buf, t, _ctx=None)
setTimepoint_async(_cb, buf, t, _ctx=None)
static uncheckedCast(proxy, facet=None)
class omero.api.RenderingEngine

Bases: omero.api.PyramidService

See RenderingEngine.html

_ice_type = <IcePy.TypeInfo object at 0x3c29ea0>
_op_addCodomainMap = <IcePy.Operation object at 0x11c63108>
_op_getAvailableFamilies = <IcePy.Operation object at 0x11be3f18>
_op_getAvailableModels = <IcePy.Operation object at 0x11be3f00>
_op_getChannelCurveCoefficient = <IcePy.Operation object at 0x11be3fd8>
_op_getChannelFamily = <IcePy.Operation object at 0x11be3f90>
_op_getChannelLookupTable = <IcePy.Operation object at 0x11c630f0>
_op_getChannelNoiseReduction = <IcePy.Operation object at 0x11be3fa8>
_op_getChannelStats = <IcePy.Operation object at 0x11be3fc0>
_op_getChannelWindowEnd = <IcePy.Operation object at 0x11c63060>
_op_getChannelWindowStart = <IcePy.Operation object at 0x11c63048>
_op_getCompressionLevel = <IcePy.Operation object at 0x11c631b0>
_op_getDefaultT = <IcePy.Operation object at 0x11be3ea0>
_op_getDefaultZ = <IcePy.Operation object at 0x11be3e88>
_op_getModel = <IcePy.Operation object at 0x11be3e70>
_op_getPixels = <IcePy.Operation object at 0x11be3ee8>
_op_getPixelsTypeLowerBound = <IcePy.Operation object at 0x11c631f8>
_op_getPixelsTypeUpperBound = <IcePy.Operation object at 0x11c631e0>
_op_getQuantumDef = <IcePy.Operation object at 0x11be3f60>
_op_getRGBA = <IcePy.Operation object at 0x11c63090>
_op_getRenderingDefId = <IcePy.Operation object at 0x11be3dc8>
_op_isActive = <IcePy.Operation object at 0x11c630c0>
_op_isPixelsTypeSigned = <IcePy.Operation object at 0x11c631c8>
_op_load = <IcePy.Operation object at 0x11be3e40>
_op_loadRenderingDef = <IcePy.Operation object at 0x11be3e10>
_op_lookupPixels = <IcePy.Operation object at 0x11be3de0>
_op_lookupRenderingDef = <IcePy.Operation object at 0x11be3df8>
_op_removeCodomainMap = <IcePy.Operation object at 0x11c63138>
_op_render = <IcePy.Operation object at 0x11be3d50>
_op_renderAsPackedInt = <IcePy.Operation object at 0x11be3d68>
_op_renderCompressed = <IcePy.Operation object at 0x11be3d98>
_op_renderProjectedAsPackedInt = <IcePy.Operation object at 0x11be3d80>
_op_renderProjectedCompressed = <IcePy.Operation object at 0x11be3db0>
_op_resetDefaultSettings = <IcePy.Operation object at 0x11c63180>
_op_saveAsNewSettings = <IcePy.Operation object at 0x11c63168>
_op_saveCurrentSettings = <IcePy.Operation object at 0x11c63150>
_op_setActive = <IcePy.Operation object at 0x11c630a8>
_op_setChannelLookupTable = <IcePy.Operation object at 0x11c630d8>
_op_setChannelWindow = <IcePy.Operation object at 0x11c63030>
_op_setCodomainInterval = <IcePy.Operation object at 0x11be3f48>
_op_setCompressionLevel = <IcePy.Operation object at 0x11c63198>
_op_setDefaultT = <IcePy.Operation object at 0x11be3ed0>
_op_setDefaultZ = <IcePy.Operation object at 0x11be3eb8>
_op_setModel = <IcePy.Operation object at 0x11be3e58>
_op_setOverlays = <IcePy.Operation object at 0x11be3e28>
_op_setQuantizationMap = <IcePy.Operation object at 0x11be3f78>
_op_setQuantumStrategy = <IcePy.Operation object at 0x11be3f30>
_op_setRGBA = <IcePy.Operation object at 0x11c63078>
_op_updateCodomainMap = <IcePy.Operation object at 0x11c63120>
addCodomainMap_async(_cb, mapCtx, current=None)
getAvailableFamilies_async(_cb, current=None)
getAvailableModels_async(_cb, current=None)
getChannelCurveCoefficient_async(_cb, w, current=None)
getChannelFamily_async(_cb, w, current=None)
getChannelLookupTable_async(_cb, w, current=None)
getChannelNoiseReduction_async(_cb, w, current=None)
getChannelStats_async(_cb, w, current=None)
getChannelWindowEnd_async(_cb, w, current=None)
getChannelWindowStart_async(_cb, w, current=None)
getCompressionLevel_async(_cb, current=None)
getDefaultT_async(_cb, current=None)
getDefaultZ_async(_cb, current=None)
getModel_async(_cb, current=None)
getPixelsTypeLowerBound_async(_cb, w, current=None)
getPixelsTypeUpperBound_async(_cb, w, current=None)
getPixels_async(_cb, current=None)
getQuantumDef_async(_cb, current=None)
getRGBA_async(_cb, w, current=None)
getRenderingDefId_async(_cb, current=None)
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
isActive_async(_cb, w, current=None)
isPixelsTypeSigned_async(_cb, current=None)
loadRenderingDef_async(_cb, renderingDefId, current=None)
load_async(_cb, current=None)
lookupPixels_async(_cb, pixelsId, current=None)
lookupRenderingDef_async(_cb, pixelsId, current=None)
removeCodomainMap_async(_cb, mapCtx, current=None)
renderAsPackedInt_async(_cb, _def, current=None)
renderCompressed_async(_cb, _def, current=None)
renderProjectedAsPackedInt_async(_cb, algorithm, timepoint, stepping, start, end, current=None)
renderProjectedCompressed_async(_cb, algorithm, timepoint, stepping, start, end, current=None)
render_async(_cb, _def, current=None)
resetDefaultSettings_async(_cb, save, current=None)
saveAsNewSettings_async(_cb, current=None)
saveCurrentSettings_async(_cb, current=None)
setActive_async(_cb, w, active, current=None)
setChannelLookupTable_async(_cb, w, lookup, current=None)
setChannelWindow_async(_cb, w, start, end, current=None)
setCodomainInterval_async(_cb, start, end, current=None)
setCompressionLevel_async(_cb, percentage, current=None)
setDefaultT_async(_cb, t, current=None)
setDefaultZ_async(_cb, z, current=None)
setModel_async(_cb, model, current=None)
setOverlays_async(_cb, tablesId, imageId, rowColorMap, current=None)
setQuantizationMap_async(_cb, w, fam, coefficient, noiseReduction, current=None)
setQuantumStrategy_async(_cb, bitResolution, current=None)
setRGBA_async(_cb, w, red, green, blue, alpha, current=None)
updateCodomainMap_async(_cb, mapCtx, current=None)
class omero.api.RenderingEnginePrx

Bases: omero.api.PyramidServicePrx

addCodomainMap(mapCtx, _ctx=None)
addCodomainMap_async(_cb, mapCtx, _ctx=None)
begin_addCodomainMap(mapCtx, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getAvailableFamilies(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getAvailableModels(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getChannelCurveCoefficient(w, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getChannelFamily(w, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getChannelLookupTable(w, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getChannelNoiseReduction(w, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getChannelStats(w, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getChannelWindowEnd(w, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getChannelWindowStart(w, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getCompressionLevel(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getDefaultT(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getDefaultZ(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getModel(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getPixels(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getPixelsTypeLowerBound(w, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getPixelsTypeUpperBound(w, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getQuantumDef(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getRGBA(w, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getRenderingDefId(_response=None, _ex=None, _sent=None, _ctx=None)
begin_isActive(w, _response=None, _ex=None, _sent=None, _ctx=None)
begin_isPixelsTypeSigned(_response=None, _ex=None, _sent=None, _ctx=None)
begin_load(_response=None, _ex=None, _sent=None, _ctx=None)
begin_loadRenderingDef(renderingDefId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_lookupPixels(pixelsId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_lookupRenderingDef(pixelsId, _response=None, _ex=None, _sent=None, _ctx=None)
begin_removeCodomainMap(mapCtx, _response=None, _ex=None, _sent=None, _ctx=None)
begin_render(_def, _response=None, _ex=None, _sent=None, _ctx=None)
begin_renderAsPackedInt(_def, _response=None, _ex=None, _sent=None, _ctx=None)
begin_renderCompressed(_def, _response=None, _ex=None, _sent=None, _ctx=None)
begin_renderProjectedAsPackedInt(algorithm, timepoint, stepping, start, end, _response=None, _ex=None, _sent=None, _ctx=None)
begin_renderProjectedCompressed(algorithm, timepoint, stepping, start, end, _response=None, _ex=None, _sent=None, _ctx=None)
begin_resetDefaultSettings(save, _response=None, _ex=None, _sent=None, _ctx=None)
begin_saveAsNewSettings(_response=None, _ex=None, _sent=None, _ctx=None)
begin_saveCurrentSettings(_response=None, _ex=None, _sent=None, _ctx=None)
begin_setActive(w, active, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setChannelLookupTable(w, lookup, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setChannelWindow(w, start, end, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setCodomainInterval(start, end, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setCompressionLevel(percentage, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setDefaultT(t, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setDefaultZ(z, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setModel(model, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setOverlays(tablesId, imageId, rowColorMap, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setQuantizationMap(w, fam, coefficient, noiseReduction, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setQuantumStrategy(bitResolution, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setRGBA(w, red, green, blue, alpha, _response=None, _ex=None, _sent=None, _ctx=None)
begin_updateCodomainMap(mapCtx, _response=None, _ex=None, _sent=None, _ctx=None)
static checkedCast(proxy, facetOrCtx=None, _ctx=None)
end_addCodomainMap(_r)
end_getAvailableFamilies(_r)
end_getAvailableModels(_r)
end_getChannelCurveCoefficient(_r)
end_getChannelFamily(_r)
end_getChannelLookupTable(_r)
end_getChannelNoiseReduction(_r)
end_getChannelStats(_r)
end_getChannelWindowEnd(_r)
end_getChannelWindowStart(_r)
end_getCompressionLevel(_r)
end_getDefaultT(_r)
end_getDefaultZ(_r)
end_getModel(_r)
end_getPixels(_r)
end_getPixelsTypeLowerBound(_r)
end_getPixelsTypeUpperBound(_r)
end_getQuantumDef(_r)
end_getRGBA(_r)
end_getRenderingDefId(_r)
end_isActive(_r)
end_isPixelsTypeSigned(_r)
end_load(_r)
end_loadRenderingDef(_r)
end_lookupPixels(_r)
end_lookupRenderingDef(_r)
end_removeCodomainMap(_r)
end_render(_r)
end_renderAsPackedInt(_r)
end_renderCompressed(_r)
end_renderProjectedAsPackedInt(_r)
end_renderProjectedCompressed(_r)
end_resetDefaultSettings(_r)
end_saveAsNewSettings(_r)
end_saveCurrentSettings(_r)
end_setActive(_r)
end_setChannelLookupTable(_r)
end_setChannelWindow(_r)
end_setCodomainInterval(_r)
end_setCompressionLevel(_r)
end_setDefaultT(_r)
end_setDefaultZ(_r)
end_setModel(_r)
end_setOverlays(_r)
end_setQuantizationMap(_r)
end_setQuantumStrategy(_r)
end_setRGBA(_r)
end_updateCodomainMap(_r)
getAvailableFamilies(_ctx=None)
getAvailableFamilies_async(_cb, _ctx=None)
getAvailableModels(_ctx=None)
getAvailableModels_async(_cb, _ctx=None)
getChannelCurveCoefficient(w, _ctx=None)
getChannelCurveCoefficient_async(_cb, w, _ctx=None)
getChannelFamily(w, _ctx=None)
getChannelFamily_async(_cb, w, _ctx=None)
getChannelLookupTable(w, _ctx=None)
getChannelLookupTable_async(_cb, w, _ctx=None)
getChannelNoiseReduction(w, _ctx=None)
getChannelNoiseReduction_async(_cb, w, _ctx=None)
getChannelStats(w, _ctx=None)
getChannelStats_async(_cb, w, _ctx=None)
getChannelWindowEnd(w, _ctx=None)
getChannelWindowEnd_async(_cb, w, _ctx=None)
getChannelWindowStart(w, _ctx=None)
getChannelWindowStart_async(_cb, w, _ctx=None)
getCompressionLevel(_ctx=None)
getCompressionLevel_async(_cb, _ctx=None)
getDefaultT(_ctx=None)
getDefaultT_async(_cb, _ctx=None)
getDefaultZ(_ctx=None)
getDefaultZ_async(_cb, _ctx=None)
getModel(_ctx=None)
getModel_async(_cb, _ctx=None)
getPixels(_ctx=None)
getPixelsTypeLowerBound(w, _ctx=None)
getPixelsTypeLowerBound_async(_cb, w, _ctx=None)
getPixelsTypeUpperBound(w, _ctx=None)
getPixelsTypeUpperBound_async(_cb, w, _ctx=None)
getPixels_async(_cb, _ctx=None)
getQuantumDef(_ctx=None)
getQuantumDef_async(_cb, _ctx=None)
getRGBA(w, _ctx=None)
getRGBA_async(_cb, w, _ctx=None)
getRenderingDefId(_ctx=None)
getRenderingDefId_async(_cb, _ctx=None)
isActive(w, _ctx=None)
isActive_async(_cb, w, _ctx=None)
isPixelsTypeSigned(_ctx=None)
isPixelsTypeSigned_async(_cb, _ctx=None)
load(_ctx=None)
loadRenderingDef(renderingDefId, _ctx=None)
loadRenderingDef_async(_cb, renderingDefId, _ctx=None)
load_async(_cb, _ctx=None)
lookupPixels(pixelsId, _ctx=None)
lookupPixels_async(_cb, pixelsId, _ctx=None)
lookupRenderingDef(pixelsId, _ctx=None)
lookupRenderingDef_async(_cb, pixelsId, _ctx=None)
removeCodomainMap(mapCtx, _ctx=None)
removeCodomainMap_async(_cb, mapCtx, _ctx=None)
render(_def, _ctx=None)
renderAsPackedInt(_def, _ctx=None)
renderAsPackedInt_async(_cb, _def, _ctx=None)
renderCompressed(_def, _ctx=None)
renderCompressed_async(_cb, _def, _ctx=None)
renderProjectedAsPackedInt(algorithm, timepoint, stepping, start, end, _ctx=None)
renderProjectedAsPackedInt_async(_cb, algorithm, timepoint, stepping, start, end, _ctx=None)
renderProjectedCompressed(algorithm, timepoint, stepping, start, end, _ctx=None)
renderProjectedCompressed_async(_cb, algorithm, timepoint, stepping, start, end, _ctx=None)
render_async(_cb, _def, _ctx=None)
resetDefaultSettings(save, _ctx=None)
resetDefaultSettings_async(_cb, save, _ctx=None)
saveAsNewSettings(_ctx=None)
saveAsNewSettings_async(_cb, _ctx=None)
saveCurrentSettings(_ctx=None)
saveCurrentSettings_async(_cb, _ctx=None)
setActive(w, active, _ctx=None)
setActive_async(_cb, w, active, _ctx=None)
setChannelLookupTable(w, lookup, _ctx=None)
setChannelLookupTable_async(_cb, w, lookup, _ctx=None)
setChannelWindow(w, start, end, _ctx=None)
setChannelWindow_async(_cb, w, start, end, _ctx=None)
setCodomainInterval(start, end, _ctx=None)
setCodomainInterval_async(_cb, start, end, _ctx=None)
setCompressionLevel(percentage, _ctx=None)
setCompressionLevel_async(_cb, percentage, _ctx=None)
setDefaultT(t, _ctx=None)
setDefaultT_async(_cb, t, _ctx=None)
setDefaultZ(z, _ctx=None)
setDefaultZ_async(_cb, z, _ctx=None)
setModel(model, _ctx=None)
setModel_async(_cb, model, _ctx=None)
setOverlays(tablesId, imageId, rowColorMap, _ctx=None)
setOverlays_async(_cb, tablesId, imageId, rowColorMap, _ctx=None)
setQuantizationMap(w, fam, coefficient, noiseReduction, _ctx=None)
setQuantizationMap_async(_cb, w, fam, coefficient, noiseReduction, _ctx=None)
setQuantumStrategy(bitResolution, _ctx=None)
setQuantumStrategy_async(_cb, bitResolution, _ctx=None)
setRGBA(w, red, green, blue, alpha, _ctx=None)
setRGBA_async(_cb, w, red, green, blue, alpha, _ctx=None)
static uncheckedCast(proxy, facet=None)
updateCodomainMap(mapCtx, _ctx=None)
updateCodomainMap_async(_cb, mapCtx, _ctx=None)
class omero.api.ResolutionDescription(sizeX=0, sizeY=0)

Bases: Ice.Object

_ice_type = <IcePy.TypeInfo object at 0x11be3840>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.api.ResolutionDescriptionPrx

Bases: IcePy.ObjectPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static uncheckedCast(proxy, facet=None)
class omero.api.RoiOptions(shapes=None, limit=None, offset=None, userId=None, groupId=None, namespace=None)

Bases: Ice.Object

Specifies filters used when querying the ROIs.

_ice_type = <IcePy.TypeInfo object at 0x11cad9a8>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.api.RoiOptionsPrx

Bases: IcePy.ObjectPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static uncheckedCast(proxy, facet=None)
class omero.api.RoiResult(opts=None, rois=None, byZ=None, byT=None, byG=None, groups=None)

Bases: Ice.Object

Returned by most search methods. The RoiOptions is the options object passed into a method, possibly modified by the server if some value was out of range. The RoiList contains all the Rois which matched the given query.

The individual shapes of the Rois which matched can be found in the indexes. For example, all the shapes on z=1 can by found by:

ShapeList shapes = byZ.get(1);

Shapes which are found on all z, t, or do not belong to a group can be found with:

byZ.get(-1); byT.get(-1); byG.get(“”);

respectively. The groups string-string map provides the hierarchy of the group strings using unix-style filesystem paths. That is, if a returned shape is in the group “/a/b”, then there will be an entry in the groups map: ...TBD...

_ice_type = <IcePy.TypeInfo object at 0x11cad9d8>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.api.RoiResultPrx

Bases: IcePy.ObjectPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static uncheckedCast(proxy, facet=None)
class omero.api.RoiStats(roiId=0, imageId=0, pixelsId=0, combined=None, perShape=None)

Bases: Ice.Object

Container for ShapeStats, one with the combined values, and one per shape.

_ice_type = <IcePy.TypeInfo object at 0x11cada98>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.api.RoiStatsPrx

Bases: IcePy.ObjectPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static uncheckedCast(proxy, facet=None)
class omero.api.Save(obj=None)

Bases: omero.cmd.Request

_ice_type = <IcePy.TypeInfo object at 0x11be3588>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.api.SavePrx

Bases: omero.cmd.RequestPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static uncheckedCast(proxy, facet=None)
class omero.api.SaveRsp(obj=None)

Bases: omero.cmd.Response

_ice_type = <IcePy.TypeInfo object at 0x11be35b8>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.api.SaveRspPrx

Bases: omero.cmd.ResponsePrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static uncheckedCast(proxy, facet=None)
class omero.api.Search

Bases: omero.api.StatefulServiceInterface

See Search.html

_ice_type = <IcePy.TypeInfo object at 0x3c29ed0>
_op_activeQueries = <IcePy.Operation object at 0x11c63210>
_op_addOrderByAsc = <IcePy.Operation object at 0x11c63468>
_op_addOrderByDesc = <IcePy.Operation object at 0x11c63480>
_op_allTypes = <IcePy.Operation object at 0x11c63378>
_op_and = <IcePy.Operation object at 0x11c635d0>
_op_byAnnotatedWith = <IcePy.Operation object at 0x11c635a0>
_op_byFullText = <IcePy.Operation object at 0x11c63528>
_op_byGroupForTags = <IcePy.Operation object at 0x11c634f8>
_op_byHqlQuery = <IcePy.Operation object at 0x11c63570>
_op_byLuceneQueryBuilder = <IcePy.Operation object at 0x11c63540>
_op_bySimilarTerms = <IcePy.Operation object at 0x11c63558>
_op_bySomeMustNone = <IcePy.Operation object at 0x11c63588>
_op_byTagForGroups = <IcePy.Operation object at 0x11c63510>
_op_clearQueries = <IcePy.Operation object at 0x11c635b8>
_op_currentMetadata = <IcePy.Operation object at 0x11c63660>
_op_currentMetadataList = <IcePy.Operation object at 0x11c63678>
_op_fetchAlso = <IcePy.Operation object at 0x11c634c8>
_op_fetchAnnotations = <IcePy.Operation object at 0x11c634b0>
_op_getBatchSize = <IcePy.Operation object at 0x11c63240>
_op_hasNext = <IcePy.Operation object at 0x11c63618>
_op_isAllowLeadingWildcard = <IcePy.Operation object at 0x11c63330>
_op_isCaseSensitive = <IcePy.Operation object at 0x11c632a0>
_op_isMergedBatches = <IcePy.Operation object at 0x11c63270>
_op_isReturnUnloaded = <IcePy.Operation object at 0x11c63300>
_op_isUseProjections = <IcePy.Operation object at 0x11c632d0>
_op_next = <IcePy.Operation object at 0x11c63630>
_op_not = <IcePy.Operation object at 0x11c63600>
_op_notAnnotatedBy = <IcePy.Operation object at 0x11c63438>
_op_notOwnedBy = <IcePy.Operation object at 0x11c633c0>
_op_onlyAnnotatedBetween = <IcePy.Operation object at 0x11c63408>
_op_onlyAnnotatedBy = <IcePy.Operation object at 0x11c63420>
_op_onlyAnnotatedWith = <IcePy.Operation object at 0x11c63450>
_op_onlyCreatedBetween = <IcePy.Operation object at 0x11c633d8>
_op_onlyIds = <IcePy.Operation object at 0x11c63390>
_op_onlyModifiedBetween = <IcePy.Operation object at 0x11c633f0>
_op_onlyOwnedBy = <IcePy.Operation object at 0x11c633a8>
_op_onlyType = <IcePy.Operation object at 0x11c63348>
_op_onlyTypes = <IcePy.Operation object at 0x11c63360>
_op_or = <IcePy.Operation object at 0x11c635e8>
_op_remove = <IcePy.Operation object at 0x11c63690>
_op_resetDefaults = <IcePy.Operation object at 0x11c634e0>
_op_results = <IcePy.Operation object at 0x11c63648>
_op_setAllowLeadingWildcard = <IcePy.Operation object at 0x11c63318>
_op_setBatchSize = <IcePy.Operation object at 0x11c63228>
_op_setCaseSentivice = <IcePy.Operation object at 0x11c63288>
_op_setMergedBatches = <IcePy.Operation object at 0x11c63258>
_op_setReturnUnloaded = <IcePy.Operation object at 0x11c632e8>
_op_setUseProjections = <IcePy.Operation object at 0x11c632b8>
_op_unordered = <IcePy.Operation object at 0x11c63498>
activeQueries_async(_cb, current=None)
addOrderByAsc_async(_cb, path, current=None)
addOrderByDesc_async(_cb, path, current=None)
allTypes_async(_cb, current=None)
and_async(_cb, current=None)
byAnnotatedWith_async(_cb, examples, current=None)
byFullText_async(_cb, query, current=None)
byGroupForTags_async(_cb, group, current=None)
byHqlQuery_async(_cb, query, params, current=None)
byLuceneQueryBuilder_async(_cb, fields, _from, to, dateType, query, current=None)
bySimilarTerms_async(_cb, terms, current=None)
bySomeMustNone_async(_cb, some, must, none, current=None)
byTagForGroups_async(_cb, tag, current=None)
clearQueries_async(_cb, current=None)
currentMetadataList_async(_cb, current=None)
currentMetadata_async(_cb, current=None)
fetchAlso_async(_cb, fetches, current=None)
fetchAnnotations_async(_cb, classes, current=None)
getBatchSize_async(_cb, current=None)
hasNext_async(_cb, current=None)
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
isAllowLeadingWildcard_async(_cb, current=None)
isCaseSensitive_async(_cb, current=None)
isMergedBatches_async(_cb, current=None)
isReturnUnloaded_async(_cb, current=None)
isUseProjections_async(_cb, current=None)
next_async(_cb, current=None)
notAnnotatedBy_async(_cb, d, current=None)
notOwnedBy_async(_cb, d, current=None)
not_async(_cb, current=None)
onlyAnnotatedBetween_async(_cb, start, stop, current=None)
onlyAnnotatedBy_async(_cb, d, current=None)
onlyAnnotatedWith_async(_cb, classes, current=None)
onlyCreatedBetween_async(_cb, start, stop, current=None)
onlyIds_async(_cb, ids, current=None)
onlyModifiedBetween_async(_cb, start, stop, current=None)
onlyOwnedBy_async(_cb, d, current=None)
onlyType_async(_cb, klass, current=None)
onlyTypes_async(_cb, classes, current=None)
or_async(_cb, current=None)
remove_async(_cb, current=None)
resetDefaults_async(_cb, current=None)
results_async(_cb, current=None)
setAllowLeadingWildcard_async(_cb, allowLeadingWildcard, current=None)
setBatchSize_async(_cb, size, current=None)
setCaseSentivice_async(_cb, caseSensitive, current=None)
setMergedBatches_async(_cb, merge, current=None)
setReturnUnloaded_async(_cb, returnUnloaded, current=None)
setUseProjections_async(_cb, useProjections, current=None)
unordered_async(_cb, current=None)
class omero.api.SearchPrx

Bases: omero.api.StatefulServiceInterfacePrx

_and(_ctx=None)
_not(_ctx=None)
_or(_ctx=None)
activeQueries(_ctx=None)
activeQueries_async(_cb, _ctx=None)
addOrderByAsc(path, _ctx=None)
addOrderByAsc_async(_cb, path, _ctx=None)
addOrderByDesc(path, _ctx=None)
addOrderByDesc_async(_cb, path, _ctx=None)
allTypes(_ctx=None)
allTypes_async(_cb, _ctx=None)
and_async(_cb, _ctx=None)
begin_activeQueries(_response=None, _ex=None, _sent=None, _ctx=None)
begin_addOrderByAsc(path, _response=None, _ex=None, _sent=None, _ctx=None)
begin_addOrderByDesc(path, _response=None, _ex=None, _sent=None, _ctx=None)
begin_allTypes(_response=None, _ex=None, _sent=None, _ctx=None)
begin_and(_response=None, _ex=None, _sent=None, _ctx=None)
begin_byAnnotatedWith(examples, _response=None, _ex=None, _sent=None, _ctx=None)
begin_byFullText(query, _response=None, _ex=None, _sent=None, _ctx=None)
begin_byGroupForTags(group, _response=None, _ex=None, _sent=None, _ctx=None)
begin_byHqlQuery(query, params, _response=None, _ex=None, _sent=None, _ctx=None)
begin_byLuceneQueryBuilder(fields, _from, to, dateType, query, _response=None, _ex=None, _sent=None, _ctx=None)
begin_bySimilarTerms(terms, _response=None, _ex=None, _sent=None, _ctx=None)
begin_bySomeMustNone(some, must, none, _response=None, _ex=None, _sent=None, _ctx=None)
begin_byTagForGroups(tag, _response=None, _ex=None, _sent=None, _ctx=None)
begin_clearQueries(_response=None, _ex=None, _sent=None, _ctx=None)
begin_currentMetadata(_response=None, _ex=None, _sent=None, _ctx=None)
begin_currentMetadataList(_response=None, _ex=None, _sent=None, _ctx=None)
begin_fetchAlso(fetches, _response=None, _ex=None, _sent=None, _ctx=None)
begin_fetchAnnotations(classes, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getBatchSize(_response=None, _ex=None, _sent=None, _ctx=None)
begin_hasNext(_response=None, _ex=None, _sent=None, _ctx=None)
begin_isAllowLeadingWildcard(_response=None, _ex=None, _sent=None, _ctx=None)
begin_isCaseSensitive(_response=None, _ex=None, _sent=None, _ctx=None)
begin_isMergedBatches(_response=None, _ex=None, _sent=None, _ctx=None)
begin_isReturnUnloaded(_response=None, _ex=None, _sent=None, _ctx=None)
begin_isUseProjections(_response=None, _ex=None, _sent=None, _ctx=None)
begin_next(_response=None, _ex=None, _sent=None, _ctx=None)
begin_not(_response=None, _ex=None, _sent=None, _ctx=None)
begin_notAnnotatedBy(d, _response=None, _ex=None, _sent=None, _ctx=None)
begin_notOwnedBy(d, _response=None, _ex=None, _sent=None, _ctx=None)
begin_onlyAnnotatedBetween(start, stop, _response=None, _ex=None, _sent=None, _ctx=None)
begin_onlyAnnotatedBy(d, _response=None, _ex=None, _sent=None, _ctx=None)
begin_onlyAnnotatedWith(classes, _response=None, _ex=None, _sent=None, _ctx=None)
begin_onlyCreatedBetween(start, stop, _response=None, _ex=None, _sent=None, _ctx=None)
begin_onlyIds(ids, _response=None, _ex=None, _sent=None, _ctx=None)
begin_onlyModifiedBetween(start, stop, _response=None, _ex=None, _sent=None, _ctx=None)
begin_onlyOwnedBy(d, _response=None, _ex=None, _sent=None, _ctx=None)
begin_onlyType(klass, _response=None, _ex=None, _sent=None, _ctx=None)
begin_onlyTypes(classes, _response=None, _ex=None, _sent=None, _ctx=None)
begin_or(_response=None, _ex=None, _sent=None, _ctx=None)
begin_remove(_response=None, _ex=None, _sent=None, _ctx=None)
begin_resetDefaults(_response=None, _ex=None, _sent=None, _ctx=None)
begin_results(_response=None, _ex=None, _sent=None, _ctx=None)
begin_setAllowLeadingWildcard(allowLeadingWildcard, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setBatchSize(size, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setCaseSentivice(caseSensitive, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setMergedBatches(merge, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setReturnUnloaded(returnUnloaded, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setUseProjections(useProjections, _response=None, _ex=None, _sent=None, _ctx=None)
begin_unordered(_response=None, _ex=None, _sent=None, _ctx=None)
byAnnotatedWith(examples, _ctx=None)
byAnnotatedWith_async(_cb, examples, _ctx=None)
byFullText(query, _ctx=None)
byFullText_async(_cb, query, _ctx=None)
byGroupForTags(group, _ctx=None)
byGroupForTags_async(_cb, group, _ctx=None)
byHqlQuery(query, params, _ctx=None)
byHqlQuery_async(_cb, query, params, _ctx=None)
byLuceneQueryBuilder(fields, _from, to, dateType, query, _ctx=None)
byLuceneQueryBuilder_async(_cb, fields, _from, to, dateType, query, _ctx=None)
bySimilarTerms(terms, _ctx=None)
bySimilarTerms_async(_cb, terms, _ctx=None)
bySomeMustNone(some, must, none, _ctx=None)
bySomeMustNone_async(_cb, some, must, none, _ctx=None)
byTagForGroups(tag, _ctx=None)
byTagForGroups_async(_cb, tag, _ctx=None)
static checkedCast(proxy, facetOrCtx=None, _ctx=None)
clearQueries(_ctx=None)
clearQueries_async(_cb, _ctx=None)
currentMetadata(_ctx=None)
currentMetadataList(_ctx=None)
currentMetadataList_async(_cb, _ctx=None)
currentMetadata_async(_cb, _ctx=None)
end_activeQueries(_r)
end_addOrderByAsc(_r)
end_addOrderByDesc(_r)
end_allTypes(_r)
end_and(_r)
end_byAnnotatedWith(_r)
end_byFullText(_r)
end_byGroupForTags(_r)
end_byHqlQuery(_r)
end_byLuceneQueryBuilder(_r)
end_bySimilarTerms(_r)
end_bySomeMustNone(_r)
end_byTagForGroups(_r)
end_clearQueries(_r)
end_currentMetadata(_r)
end_currentMetadataList(_r)
end_fetchAlso(_r)
end_fetchAnnotations(_r)
end_getBatchSize(_r)
end_hasNext(_r)
end_isAllowLeadingWildcard(_r)
end_isCaseSensitive(_r)
end_isMergedBatches(_r)
end_isReturnUnloaded(_r)
end_isUseProjections(_r)
end_next(_r)
end_not(_r)
end_notAnnotatedBy(_r)
end_notOwnedBy(_r)
end_onlyAnnotatedBetween(_r)
end_onlyAnnotatedBy(_r)
end_onlyAnnotatedWith(_r)
end_onlyCreatedBetween(_r)
end_onlyIds(_r)
end_onlyModifiedBetween(_r)
end_onlyOwnedBy(_r)
end_onlyType(_r)
end_onlyTypes(_r)
end_or(_r)
end_remove(_r)
end_resetDefaults(_r)
end_results(_r)
end_setAllowLeadingWildcard(_r)
end_setBatchSize(_r)
end_setCaseSentivice(_r)
end_setMergedBatches(_r)
end_setReturnUnloaded(_r)
end_setUseProjections(_r)
end_unordered(_r)
fetchAlso(fetches, _ctx=None)
fetchAlso_async(_cb, fetches, _ctx=None)
fetchAnnotations(classes, _ctx=None)
fetchAnnotations_async(_cb, classes, _ctx=None)
getBatchSize(_ctx=None)
getBatchSize_async(_cb, _ctx=None)
hasNext(_ctx=None)
hasNext_async(_cb, _ctx=None)
isAllowLeadingWildcard(_ctx=None)
isAllowLeadingWildcard_async(_cb, _ctx=None)
isCaseSensitive(_ctx=None)
isCaseSensitive_async(_cb, _ctx=None)
isMergedBatches(_ctx=None)
isMergedBatches_async(_cb, _ctx=None)
isReturnUnloaded(_ctx=None)
isReturnUnloaded_async(_cb, _ctx=None)
isUseProjections(_ctx=None)
isUseProjections_async(_cb, _ctx=None)
next(_ctx=None)
next_async(_cb, _ctx=None)
notAnnotatedBy(d, _ctx=None)
notAnnotatedBy_async(_cb, d, _ctx=None)
notOwnedBy(d, _ctx=None)
notOwnedBy_async(_cb, d, _ctx=None)
not_async(_cb, _ctx=None)
onlyAnnotatedBetween(start, stop, _ctx=None)
onlyAnnotatedBetween_async(_cb, start, stop, _ctx=None)
onlyAnnotatedBy(d, _ctx=None)
onlyAnnotatedBy_async(_cb, d, _ctx=None)
onlyAnnotatedWith(classes, _ctx=None)
onlyAnnotatedWith_async(_cb, classes, _ctx=None)
onlyCreatedBetween(start, stop, _ctx=None)
onlyCreatedBetween_async(_cb, start, stop, _ctx=None)
onlyIds(ids, _ctx=None)
onlyIds_async(_cb, ids, _ctx=None)
onlyModifiedBetween(start, stop, _ctx=None)
onlyModifiedBetween_async(_cb, start, stop, _ctx=None)
onlyOwnedBy(d, _ctx=None)
onlyOwnedBy_async(_cb, d, _ctx=None)
onlyType(klass, _ctx=None)
onlyType_async(_cb, klass, _ctx=None)
onlyTypes(classes, _ctx=None)
onlyTypes_async(_cb, classes, _ctx=None)
or_async(_cb, _ctx=None)
remove(_ctx=None)
remove_async(_cb, _ctx=None)
resetDefaults(_ctx=None)
resetDefaults_async(_cb, _ctx=None)
results(_ctx=None)
results_async(_cb, _ctx=None)
setAllowLeadingWildcard(allowLeadingWildcard, _ctx=None)
setAllowLeadingWildcard_async(_cb, allowLeadingWildcard, _ctx=None)
setBatchSize(size, _ctx=None)
setBatchSize_async(_cb, size, _ctx=None)
setCaseSentivice(caseSensitive, _ctx=None)
setCaseSentivice_async(_cb, caseSensitive, _ctx=None)
setMergedBatches(merge, _ctx=None)
setMergedBatches_async(_cb, merge, _ctx=None)
setReturnUnloaded(returnUnloaded, _ctx=None)
setReturnUnloaded_async(_cb, returnUnloaded, _ctx=None)
setUseProjections(useProjections, _ctx=None)
setUseProjections_async(_cb, useProjections, _ctx=None)
static uncheckedCast(proxy, facet=None)
unordered(_ctx=None)
unordered_async(_cb, _ctx=None)
class omero.api.ServiceFactory

Bases: omero.cmd.Session

Starting point for all OMERO.blitz interaction.

A ServiceFactory once acquired can be used to create any number

of service proxies to the server. Most services implement ServiceInterface or its subinterface StatefulServiceInterface.

_ice_type = <IcePy.TypeInfo object at 0x11b0f678>
_op_activeServices = <IcePy.Operation object at 0x11b0f9c0>
_op_closeOnDestroy = <IcePy.Operation object at 0x11b0f990>
_op_createByName = <IcePy.Operation object at 0x11b0f948>
_op_createExporter = <IcePy.Operation object at 0x11b0f870>
_op_createJobHandle = <IcePy.Operation object at 0x11b0f888>
_op_createRawFileStore = <IcePy.Operation object at 0x11b0f8a0>
_op_createRawPixelsStore = <IcePy.Operation object at 0x11b0f8b8>
_op_createRenderingEngine = <IcePy.Operation object at 0x11b0f8d0>
_op_createSearchService = <IcePy.Operation object at 0x11b0f8e8>
_op_createThumbnailStore = <IcePy.Operation object at 0x11b0f900>
_op_detachOnDestroy = <IcePy.Operation object at 0x11b0f9a8>
_op_getAdminService = <IcePy.Operation object at 0x11b0f6d8>
_op_getByName = <IcePy.Operation object at 0x11b0f930>
_op_getConfigService = <IcePy.Operation object at 0x11b0f6f0>
_op_getContainerService = <IcePy.Operation object at 0x11b0f708>
_op_getLdapService = <IcePy.Operation object at 0x11b0f720>
_op_getMetadataService = <IcePy.Operation object at 0x11b0f858>
_op_getPixelsService = <IcePy.Operation object at 0x11b0f738>
_op_getProjectionService = <IcePy.Operation object at 0x11b0f750>
_op_getQueryService = <IcePy.Operation object at 0x11b0f768>
_op_getRenderingSettingsService = <IcePy.Operation object at 0x11b0f780>
_op_getRepositoryInfoService = <IcePy.Operation object at 0x11b0f798>
_op_getRoiService = <IcePy.Operation object at 0x11b0f7b0>
_op_getScriptService = <IcePy.Operation object at 0x11b0f7c8>
_op_getSecurityContexts = <IcePy.Operation object at 0x11b0f690>
_op_getSessionService = <IcePy.Operation object at 0x11b0f7e0>
_op_getShareService = <IcePy.Operation object at 0x11b0f7f8>
_op_getTimelineService = <IcePy.Operation object at 0x11b0f810>
_op_getTypesService = <IcePy.Operation object at 0x11b0f828>
_op_getUpdateService = <IcePy.Operation object at 0x11b0f840>
_op_keepAlive = <IcePy.Operation object at 0x11b0f9f0>
_op_keepAllAlive = <IcePy.Operation object at 0x11b0f9d8>
_op_setCallback = <IcePy.Operation object at 0x11b0f978>
_op_setSecurityContext = <IcePy.Operation object at 0x11b0f6a8>
_op_setSecurityPassword = <IcePy.Operation object at 0x11b0f6c0>
_op_sharedResources = <IcePy.Operation object at 0x11b0f918>
_op_subscribe = <IcePy.Operation object at 0x11b0f960>
activeServices(current=None)

Returns a list of string ids for currently active services. This will _not_ keep services alive, and in fact checks for all expired services and removes them.

closeOnDestroy(current=None)

Marks the session for closure rather than detachment, which will be triggered by the destruction of the Glacier2 connection via router.destroySession()

Closing the session rather the detaching is more secure, since all resources are removed from the server and can safely be set once it is clear that a client is finished with those resources.

createByName(name, current=None)

Allows looking up any stateful service by name.

See Constants.ice for examples of services. If a service has been added by third-parties, createByName can be used even though no concrete method is available.

createExporter(current=None)
createJobHandle(current=None)
createRawFileStore(current=None)
createRawPixelsStore(current=None)
createRenderingEngine(current=None)
createSearchService(current=None)
createThumbnailStore(current=None)
detachOnDestroy(current=None)

Marks the session for detachment rather than closure, which will be triggered by the destruction of the Glacier2 connection via router.destroySession()

This is the default and allows a lost session to be reconnected, at a slight security cost since the session will persist longer and can be used by others if the UUID is intercepted.

getAdminService(current=None)
getByName(name, current=None)

Allows looking up any stateless service by name.

See Constants.ice for examples of services. If a service has been added by third-parties, getByName can be used even though no concrete method is available.

getConfigService(current=None)
getContainerService(current=None)
getLdapService(current=None)
getMetadataService(current=None)
getPixelsService(current=None)
getProjectionService(current=None)
getQueryService(current=None)
getRenderingSettingsService(current=None)
getRepositoryInfoService(current=None)
getRoiService(current=None)
getScriptService(current=None)
getSecurityContexts(current=None)

Provides a list of all valid security contexts for this session. Each of the returned omero.model.IObject instances can be passed to setSecurityContext.

getSessionService(current=None)
getShareService(current=None)
getTimelineService(current=None)
getTypesService(current=None)
getUpdateService(current=None)
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
keepAlive(proxy, current=None)

Returns true if the given service is alive.

Except for fatal server or session errors, this method should never throw an exception.

keepAllAlive(proxies, current=None)

Requests that the given services be marked as alive. It is possible that one of the services has already timed out, in which case the returned long value will be non-zero.

Specifically, the bit representing the 0-based index will be 1:

if (retval & 1&lt;&lt;idx == 1&lt;&lt;idx) { // not alive }

Except for fatal server or session errors, this method should never throw an exception.

setCallback(callback, current=None)

Sets the single callback used by the ServiceFactory to communicate with the client application. A default callback is set by the omero::client object on session creation which should suffice for most usage.

See the client object’s documentation in each language mapping for ways to use the callback.

setSecurityContext(obj, current=None)

Changes the security context for the current session.

A security context limits the set of objects which will

be returned by all queries and restricts what updates can be made.

Current valid values for security context:

omero.model.ExperimenterGroup - logs into a specific group omero.model.Share - uses IShare to activate a share

Passing an unloaded version of either object type will change

the way the current session operates. Note: only objects which are returned by the getSecurityContexts method are considered valid. Any other instance will cause an exception to be thrown.

Example usage in Python:

sf = client.createSession() objs = sf.getSecurityContexts() old = sf.setSecurityContext(objs[-1])

setSecurityPassword(password, current=None)

Re-validates the password for the current session. This prevents

See methods that mention “HasPassword”.

sharedResources(current=None)

Returns a reference to a back-end manager. The omero.grid.SharedResources service provides look ups for various facilities offered by OMERO:

OMERO.scripts OMERO.tables

These facilities may or may not be available on first request.

subscribe(topicName, prx, current=None)

Subscribe to a given topic. The topic must exist and the user must have sufficient permissions for that topic. Further the proxy object must match the required type for the topic as encoded in the topic name.

class omero.api.ServiceFactoryPrx

Bases: omero.cmd.SessionPrx

Provides a list of all valid security contexts for this session. Each of the returned omero.model.IObject instances can be passed to setSecurityContext.

activeServices(_ctx=None)
begin_activeServices(_response=None, _ex=None, _sent=None, _ctx=None)
begin_closeOnDestroy(_response=None, _ex=None, _sent=None, _ctx=None)
begin_createByName(name, _response=None, _ex=None, _sent=None, _ctx=None)
begin_createExporter(_response=None, _ex=None, _sent=None, _ctx=None)
begin_createJobHandle(_response=None, _ex=None, _sent=None, _ctx=None)
begin_createRawFileStore(_response=None, _ex=None, _sent=None, _ctx=None)
begin_createRawPixelsStore(_response=None, _ex=None, _sent=None, _ctx=None)
begin_createRenderingEngine(_response=None, _ex=None, _sent=None, _ctx=None)
begin_createSearchService(_response=None, _ex=None, _sent=None, _ctx=None)
begin_createThumbnailStore(_response=None, _ex=None, _sent=None, _ctx=None)
begin_detachOnDestroy(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getAdminService(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getByName(name, _response=None, _ex=None, _sent=None, _ctx=None)
begin_getConfigService(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getContainerService(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getLdapService(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getMetadataService(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getPixelsService(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getProjectionService(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getQueryService(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getRenderingSettingsService(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getRepositoryInfoService(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getRoiService(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getScriptService(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getSecurityContexts(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getSessionService(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getShareService(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getTimelineService(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getTypesService(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getUpdateService(_response=None, _ex=None, _sent=None, _ctx=None)
begin_keepAlive(proxy, _response=None, _ex=None, _sent=None, _ctx=None)
begin_keepAllAlive(proxies, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setCallback(callback, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setSecurityContext(obj, _response=None, _ex=None, _sent=None, _ctx=None)
begin_setSecurityPassword(password, _response=None, _ex=None, _sent=None, _ctx=None)
begin_sharedResources(_response=None, _ex=None, _sent=None, _ctx=None)
begin_subscribe(topicName, prx, _response=None, _ex=None, _sent=None, _ctx=None)
static checkedCast(proxy, facetOrCtx=None, _ctx=None)
closeOnDestroy(_ctx=None)
createByName(name, _ctx=None)
createExporter(_ctx=None)
createJobHandle(_ctx=None)
createRawFileStore(_ctx=None)
createRawPixelsStore(_ctx=None)
createRenderingEngine(_ctx=None)
createSearchService(_ctx=None)
createThumbnailStore(_ctx=None)
detachOnDestroy(_ctx=None)
end_activeServices(_r)
end_closeOnDestroy(_r)
end_createByName(_r)
end_createExporter(_r)
end_createJobHandle(_r)
end_createRawFileStore(_r)
end_createRawPixelsStore(_r)
end_createRenderingEngine(_r)
end_createSearchService(_r)
end_createThumbnailStore(_r)
end_detachOnDestroy(_r)
end_getAdminService(_r)
end_getByName(_r)
end_getConfigService(_r)
end_getContainerService(_r)
end_getLdapService(_r)
end_getMetadataService(_r)
end_getPixelsService(_r)
end_getProjectionService(_r)
end_getQueryService(_r)
end_getRenderingSettingsService(_r)
end_getRepositoryInfoService(_r)
end_getRoiService(_r)
end_getScriptService(_r)
end_getSecurityContexts(_r)
end_getSessionService(_r)
end_getShareService(_r)
end_getTimelineService(_r)
end_getTypesService(_r)
end_getUpdateService(_r)
end_keepAlive(_r)
end_keepAllAlive(_r)
end_setCallback(_r)
end_setSecurityContext(_r)
end_setSecurityPassword(_r)
end_sharedResources(_r)
end_subscribe(_r)
getAdminService(_ctx=None)
getByName(name, _ctx=None)
getConfigService(_ctx=None)
getContainerService(_ctx=None)
<