Glossary of all OMERO Model Objects¶
Overview¶
In navigating the model objects used by the OMERO API and in omero hql it is often useful to look up the names of the object properties and the types of their values. This reference document lists every OMERO model object and their more useful properties, with an emphasis on enumerating every direct relationship among the objects.
Reference¶
AcquisitionMode¶
Used by: LogicalChannel.mode
- Properties:
- details.externalInfo: ExternalInfo (optional)value:
string
, see IEnum
AdminPrivilege¶
- Properties:
- details.externalInfo: ExternalInfo (optional)value:
string
, see IEnum
AffineTransform¶
Used by: Shape.transform
- Properties:
- a00:
double
a01:double
a02:double
a10:double
a11:double
a12:double
details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:integer
(optional), see IMutable
Annotation¶
Subclasses: BasicAnnotation, ListAnnotation, MapAnnotation, TextAnnotation, TypeAnnotation
Used by: AnnotationAnnotationLink.child, AnnotationAnnotationLink.parent, ChannelAnnotationLink.child, DatasetAnnotationLink.child, DetectorAnnotationLink.child, DichroicAnnotationLink.child, ExperimenterAnnotationLink.child, ExperimenterGroupAnnotationLink.child, FilesetAnnotationLink.child, FilterAnnotationLink.child, FolderAnnotationLink.child, ImageAnnotationLink.child, InstrumentAnnotationLink.child, LightPathAnnotationLink.child, LightSourceAnnotationLink.child, NamespaceAnnotationLink.child, NodeAnnotationLink.child, ObjectiveAnnotationLink.child, OriginalFileAnnotationLink.child, PlaneInfoAnnotationLink.child, PlateAcquisitionAnnotationLink.child, PlateAnnotationLink.child, ProjectAnnotationLink.child, ReagentAnnotationLink.child, RoiAnnotationLink.child, ScreenAnnotationLink.child, SessionAnnotationLink.child, ShapeAnnotationLink.child, WellAnnotationLink.child
- Properties:
- annotationLinks: AnnotationAnnotationLink (multiple)description:
text
(optional)details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventname:text
(optional)ns:text
(optional)version:integer
(optional), see IMutable
AnnotationAnnotationLink¶
Used by: Annotation.annotationLinks
- Properties:
- child: Annotation, see ILinkdetails.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventparent: Annotation, see ILinkversion:
integer
(optional), see IMutable
Arc¶
- Properties:
- annotationLinks: LightSourceAnnotationLink (multiple) from LightSourcedetails.creationEvent: Event from LightSourcedetails.externalInfo: ExternalInfo (optional) from LightSourcedetails.group: ExperimenterGroup from LightSourcedetails.owner: Experimenter from LightSourcedetails.updateEvent: Event from LightSourceinstrument: Instrument from LightSourcelotNumber:
string
(optional) from LightSourcemanufacturer:string
(optional) from LightSourcemodel:string
(optional) from LightSourcepower.unit: enumeration of Power (optional) from LightSourcepower.value:double
(optional) from LightSourceserialNumber:string
(optional) from LightSourcetype: ArcTypeversion:integer
(optional) from LightSource
ArcType¶
Used by: Arc.type
- Properties:
- details.externalInfo: ExternalInfo (optional)value:
string
, see IEnum
BasicAnnotation¶
Subclasses: BooleanAnnotation, NumericAnnotation, TermAnnotation, TimestampAnnotation
- Properties:
- annotationLinks: AnnotationAnnotationLink (multiple) from Annotationdescription:
text
(optional) from Annotationdetails.creationEvent: Event from Annotationdetails.externalInfo: ExternalInfo (optional) from Annotationdetails.group: ExperimenterGroup from Annotationdetails.owner: Experimenter from Annotationdetails.updateEvent: Event from Annotationname:text
(optional) from Annotationns:text
(optional) from Annotationversion:integer
(optional) from Annotation
Binning¶
Used by: DetectorSettings.binning
- Properties:
- details.externalInfo: ExternalInfo (optional)value:
string
, see IEnum
BooleanAnnotation¶
- Properties:
- annotationLinks: AnnotationAnnotationLink (multiple) from AnnotationboolValue:
boolean
(optional)description:text
(optional) from Annotationdetails.creationEvent: Event from Annotationdetails.externalInfo: ExternalInfo (optional) from Annotationdetails.group: ExperimenterGroup from Annotationdetails.owner: Experimenter from Annotationdetails.updateEvent: Event from Annotationname:text
(optional) from Annotationns:text
(optional) from Annotationversion:integer
(optional) from Annotation
Channel¶
Used by: ChannelAnnotationLink.parent, LogicalChannel.channels, Pixels.channels
- Properties:
- alpha:
integer
(optional)annotationLinks: ChannelAnnotationLink (multiple)blue:integer
(optional)details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventgreen:integer
(optional)logicalChannel: LogicalChannellookupTable:text
(optional)pixels: Pixelsred:integer
(optional)statsInfo: StatsInfo (optional)version:integer
(optional), see IMutable
ChannelAnnotationLink¶
Used by: Channel.annotationLinks
- Properties:
- child: Annotation, see ILinkdetails.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
ChannelBinding¶
Used by: CodomainMapContext.channelBinding, RenderingDef.waveRendering
- Properties:
- active:
boolean
alpha:integer
blue:integer
coefficient:double
details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventfamily: Familygreen:integer
inputEnd:double
inputStart:double
lookupTable:string
(optional)noiseReduction:boolean
red:integer
renderingDef: RenderingDefspatialDomainEnhancement: CodomainMapContext (multiple)version:integer
(optional), see IMutable
ChecksumAlgorithm¶
Used by: OriginalFile.hasher
- Properties:
- details.externalInfo: ExternalInfo (optional)value:
string
, see IEnum
CodomainMapContext¶
Subclasses: ContrastStretchingContext, PlaneSlicingContext, ReverseIntensityContext
Used by: ChannelBinding.spatialDomainEnhancement
- Properties:
- channelBinding: ChannelBindingdetails.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
CommentAnnotation¶
- Properties:
- annotationLinks: AnnotationAnnotationLink (multiple) from Annotationdescription:
text
(optional) from Annotationdetails.creationEvent: Event from Annotationdetails.externalInfo: ExternalInfo (optional) from Annotationdetails.group: ExperimenterGroup from Annotationdetails.owner: Experimenter from Annotationdetails.updateEvent: Event from Annotationname:text
(optional) from Annotationns:text
(optional) from AnnotationtextValue:text
(optional) from TextAnnotationversion:integer
(optional) from Annotation
ContrastMethod¶
Used by: LogicalChannel.contrastMethod
- Properties:
- details.externalInfo: ExternalInfo (optional)value:
string
, see IEnum
ContrastStretchingContext¶
- Properties:
- channelBinding: ChannelBinding from CodomainMapContextdetails.creationEvent: Event from CodomainMapContextdetails.externalInfo: ExternalInfo (optional) from CodomainMapContextdetails.group: ExperimenterGroup from CodomainMapContextdetails.owner: Experimenter from CodomainMapContextdetails.updateEvent: Event from CodomainMapContextversion:
integer
(optional) from CodomainMapContextxend:integer
xstart:integer
yend:integer
ystart:integer
Correction¶
Used by: Objective.correction
- Properties:
- details.externalInfo: ExternalInfo (optional)value:
string
, see IEnum
DBPatch¶
- Properties:
- currentPatch:
integer
currentVersion:string
details.externalInfo: ExternalInfo (optional)finished:timestamp
(optional)message:string
(optional)previousPatch:integer
previousVersion:string
Dataset¶
Used by: DatasetAnnotationLink.parent, DatasetImageLink.parent, ProjectDatasetLink.child
- Properties:
- annotationLinks: DatasetAnnotationLink (multiple)description:
text
(optional)details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: EventimageLinks: DatasetImageLink (multiple)name:text
projectLinks: ProjectDatasetLink (multiple)version:integer
(optional), see IMutable
DatasetAnnotationLink¶
Used by: Dataset.annotationLinks
- Properties:
- child: Annotation, see ILinkdetails.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
DatasetImageLink¶
Used by: Dataset.imageLinks, Image.datasetLinks
- Properties:
- details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
Detector¶
Used by: DetectorAnnotationLink.parent, DetectorSettings.detector, Instrument.detector
- Properties:
- amplificationGain:
double
(optional)annotationLinks: DetectorAnnotationLink (multiple)details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventgain:double
(optional)instrument: InstrumentlotNumber:string
(optional)manufacturer:string
(optional)model:string
(optional)offsetValue:double
(optional)serialNumber:string
(optional)type: DetectorTypeversion:integer
(optional), see IMutablevoltage.unit: enumeration of ElectricPotential (optional)voltage.value:double
(optional)zoom:double
(optional)
DetectorAnnotationLink¶
Used by: Detector.annotationLinks
- Properties:
- child: Annotation, see ILinkdetails.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
DetectorSettings¶
Used by: LogicalChannel.detectorSettings
- Properties:
- binning: Binning (optional)details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventdetector: Detectorgain:
double
(optional)integration:integer
(optional)offsetValue:double
(optional)readOutRate.unit: enumeration of Frequency (optional)readOutRate.value:double
(optional)version:integer
(optional), see IMutablevoltage.unit: enumeration of ElectricPotential (optional)voltage.value:double
(optional)zoom:double
(optional)
DetectorType¶
Used by: Detector.type
- Properties:
- details.externalInfo: ExternalInfo (optional)value:
string
, see IEnum
Dichroic¶
Used by: DichroicAnnotationLink.parent, FilterSet.dichroic, Instrument.dichroic, LightPath.dichroic
- Properties:
- annotationLinks: DichroicAnnotationLink (multiple)details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventinstrument: InstrumentlotNumber:
string
(optional)manufacturer:string
(optional)model:string
(optional)serialNumber:string
(optional)version:integer
(optional), see IMutable
DichroicAnnotationLink¶
Used by: Dichroic.annotationLinks
- Properties:
- child: Annotation, see ILinkdetails.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
DimensionOrder¶
Used by: Pixels.dimensionOrder
- Properties:
- details.externalInfo: ExternalInfo (optional)value:
string
, see IEnum
DoubleAnnotation¶
- Properties:
- annotationLinks: AnnotationAnnotationLink (multiple) from Annotationdescription:
text
(optional) from Annotationdetails.creationEvent: Event from Annotationdetails.externalInfo: ExternalInfo (optional) from Annotationdetails.group: ExperimenterGroup from Annotationdetails.owner: Experimenter from Annotationdetails.updateEvent: Event from AnnotationdoubleValue:double
(optional)name:text
(optional) from Annotationns:text
(optional) from Annotationversion:integer
(optional) from Annotation
Ellipse¶
- Properties:
- annotationLinks: ShapeAnnotationLink (multiple) from Shapedetails.externalInfo: ExternalInfo (optional) from Shapedetails.group: ExperimenterGroup from Shapedetails.owner: Experimenter from ShapefillColor:
integer
(optional) from ShapefillRule:string
(optional) from ShapefontFamily:string
(optional) from ShapefontSize.value:double
(optional) from ShapefontStyle:string
(optional) from Shapelocked:boolean
(optional) from ShaperadiusX:double
(optional)radiusY:double
(optional)strokeColor:integer
(optional) from ShapestrokeDashArray:string
(optional) from ShapestrokeWidth.value:double
(optional) from ShapetextValue:text
(optional)theC:integer
(optional) from ShapetheT:integer
(optional) from ShapetheZ:integer
(optional) from Shapetransform: AffineTransform (optional) from Shapeversion:integer
(optional) from Shapex:double
(optional)y:double
(optional)
Event¶
Used by: AffineTransform.details.creationEvent, AffineTransform.details.updateEvent, Annotation.details.creationEvent, Annotation.details.updateEvent, AnnotationAnnotationLink.details.creationEvent, AnnotationAnnotationLink.details.updateEvent, Channel.details.creationEvent, Channel.details.updateEvent, ChannelAnnotationLink.details.creationEvent, ChannelAnnotationLink.details.updateEvent, ChannelBinding.details.creationEvent, ChannelBinding.details.updateEvent, CodomainMapContext.details.creationEvent, CodomainMapContext.details.updateEvent, Dataset.details.creationEvent, Dataset.details.updateEvent, DatasetAnnotationLink.details.creationEvent, DatasetAnnotationLink.details.updateEvent, DatasetImageLink.details.creationEvent, DatasetImageLink.details.updateEvent, Detector.details.creationEvent, Detector.details.updateEvent, DetectorAnnotationLink.details.creationEvent, DetectorAnnotationLink.details.updateEvent, DetectorSettings.details.creationEvent, DetectorSettings.details.updateEvent, Dichroic.details.creationEvent, Dichroic.details.updateEvent, DichroicAnnotationLink.details.creationEvent, DichroicAnnotationLink.details.updateEvent, Event.containingEvent, EventLog.event, Experiment.details.creationEvent, Experiment.details.updateEvent, ExperimenterAnnotationLink.details.creationEvent, ExperimenterAnnotationLink.details.updateEvent, ExperimenterGroupAnnotationLink.details.creationEvent, ExperimenterGroupAnnotationLink.details.updateEvent, ExternalInfo.details.creationEvent, Fileset.details.creationEvent, Fileset.details.updateEvent, FilesetAnnotationLink.details.creationEvent, FilesetAnnotationLink.details.updateEvent, FilesetEntry.details.creationEvent, FilesetEntry.details.updateEvent, FilesetJobLink.details.creationEvent, FilesetJobLink.details.updateEvent, Filter.details.creationEvent, Filter.details.updateEvent, FilterAnnotationLink.details.creationEvent, FilterAnnotationLink.details.updateEvent, FilterSet.details.creationEvent, FilterSet.details.updateEvent, FilterSetEmissionFilterLink.details.creationEvent, FilterSetEmissionFilterLink.details.updateEvent, FilterSetExcitationFilterLink.details.creationEvent, FilterSetExcitationFilterLink.details.updateEvent, Folder.details.creationEvent, Folder.details.updateEvent, FolderAnnotationLink.details.creationEvent, FolderAnnotationLink.details.updateEvent, FolderImageLink.details.creationEvent, FolderImageLink.details.updateEvent, FolderRoiLink.details.creationEvent, FolderRoiLink.details.updateEvent, Image.details.creationEvent, Image.details.updateEvent, ImageAnnotationLink.details.creationEvent, ImageAnnotationLink.details.updateEvent, ImagingEnvironment.details.creationEvent, ImagingEnvironment.details.updateEvent, Instrument.details.creationEvent, Instrument.details.updateEvent, InstrumentAnnotationLink.details.creationEvent, InstrumentAnnotationLink.details.updateEvent, Job.details.creationEvent, Job.details.updateEvent, JobOriginalFileLink.details.creationEvent, JobOriginalFileLink.details.updateEvent, LightPath.details.creationEvent, LightPath.details.updateEvent, LightPathAnnotationLink.details.creationEvent, LightPathAnnotationLink.details.updateEvent, LightPathEmissionFilterLink.details.creationEvent, LightPathEmissionFilterLink.details.updateEvent, LightPathExcitationFilterLink.details.creationEvent, LightPathExcitationFilterLink.details.updateEvent, LightSettings.details.creationEvent, LightSettings.details.updateEvent, LightSource.details.creationEvent, LightSource.details.updateEvent, LightSourceAnnotationLink.details.creationEvent, LightSourceAnnotationLink.details.updateEvent, Link.details.creationEvent, Link.details.updateEvent, LogicalChannel.details.creationEvent, LogicalChannel.details.updateEvent, MicrobeamManipulation.details.creationEvent, MicrobeamManipulation.details.updateEvent, Microscope.details.creationEvent, Microscope.details.updateEvent, NamespaceAnnotationLink.details.creationEvent, NamespaceAnnotationLink.details.updateEvent, NodeAnnotationLink.details.creationEvent, NodeAnnotationLink.details.updateEvent, OTF.details.creationEvent, OTF.details.updateEvent, Objective.details.creationEvent, Objective.details.updateEvent, ObjectiveAnnotationLink.details.creationEvent, ObjectiveAnnotationLink.details.updateEvent, ObjectiveSettings.details.creationEvent, ObjectiveSettings.details.updateEvent, OriginalFile.details.creationEvent, OriginalFile.details.updateEvent, OriginalFileAnnotationLink.details.creationEvent, OriginalFileAnnotationLink.details.updateEvent, Pixels.details.creationEvent, Pixels.details.updateEvent, PixelsOriginalFileMap.details.creationEvent, PixelsOriginalFileMap.details.updateEvent, PlaneInfo.details.creationEvent, PlaneInfo.details.updateEvent, PlaneInfoAnnotationLink.details.creationEvent, PlaneInfoAnnotationLink.details.updateEvent, Plate.details.creationEvent, Plate.details.updateEvent, PlateAcquisition.details.creationEvent, PlateAcquisition.details.updateEvent, PlateAcquisitionAnnotationLink.details.creationEvent, PlateAcquisitionAnnotationLink.details.updateEvent, PlateAnnotationLink.details.creationEvent, PlateAnnotationLink.details.updateEvent, Project.details.creationEvent, Project.details.updateEvent, ProjectAnnotationLink.details.creationEvent, ProjectAnnotationLink.details.updateEvent, ProjectDatasetLink.details.creationEvent, ProjectDatasetLink.details.updateEvent, ProjectionDef.details.creationEvent, ProjectionDef.details.updateEvent, QuantumDef.details.creationEvent, QuantumDef.details.updateEvent, Reagent.details.creationEvent, Reagent.details.updateEvent, ReagentAnnotationLink.details.creationEvent, ReagentAnnotationLink.details.updateEvent, RenderingDef.details.creationEvent, RenderingDef.details.updateEvent, Roi.details.creationEvent, Roi.details.updateEvent, RoiAnnotationLink.details.creationEvent, RoiAnnotationLink.details.updateEvent, Screen.details.creationEvent, Screen.details.updateEvent, ScreenAnnotationLink.details.creationEvent, ScreenAnnotationLink.details.updateEvent, ScreenPlateLink.details.creationEvent, ScreenPlateLink.details.updateEvent, Session.events, SessionAnnotationLink.details.creationEvent, SessionAnnotationLink.details.updateEvent, Shape.details.creationEvent, Shape.details.updateEvent, ShapeAnnotationLink.details.creationEvent, ShapeAnnotationLink.details.updateEvent, StageLabel.details.creationEvent, StageLabel.details.updateEvent, StatsInfo.details.creationEvent, StatsInfo.details.updateEvent, Thumbnail.details.creationEvent, Thumbnail.details.updateEvent, TransmittanceRange.details.creationEvent, TransmittanceRange.details.updateEvent, Well.details.creationEvent, Well.details.updateEvent, WellAnnotationLink.details.creationEvent, WellAnnotationLink.details.updateEvent, WellReagentLink.details.creationEvent, WellReagentLink.details.updateEvent, WellSample.details.creationEvent, WellSample.details.updateEvent
- Properties:
- containingEvent: Event (optional)details.externalInfo: ExternalInfo (optional)experimenter: ExperimenterexperimenterGroup: ExperimenterGrouplogs: EventLog (multiple)session: Sessionstatus:
string
(optional)time:timestamp
type: EventType
EventLog¶
Used by: Event.logs
- Properties:
- action:
string
details.externalInfo: ExternalInfo (optional)entityId:long
entityType:string
event: Event
EventType¶
Used by: Event.type
- Properties:
- details.externalInfo: ExternalInfo (optional)value:
string
, see IEnum
Experiment¶
Used by: Image.experiment, MicrobeamManipulation.experiment
- Properties:
- description:
text
(optional)details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: EventmicrobeamManipulation: MicrobeamManipulation (multiple)type: ExperimentTypeversion:integer
(optional), see IMutable
ExperimentType¶
Used by: Experiment.type
- Properties:
- details.externalInfo: ExternalInfo (optional)value:
string
, see IEnum
Experimenter¶
Used by: AffineTransform.details.owner, Annotation.details.owner, AnnotationAnnotationLink.details.owner, Channel.details.owner, ChannelAnnotationLink.details.owner, ChannelBinding.details.owner, CodomainMapContext.details.owner, Dataset.details.owner, DatasetAnnotationLink.details.owner, DatasetImageLink.details.owner, Detector.details.owner, DetectorAnnotationLink.details.owner, DetectorSettings.details.owner, Dichroic.details.owner, DichroicAnnotationLink.details.owner, Event.experimenter, Experiment.details.owner, ExperimenterAnnotationLink.details.owner, ExperimenterAnnotationLink.parent, ExperimenterGroupAnnotationLink.details.owner, ExternalInfo.details.owner, Fileset.details.owner, FilesetAnnotationLink.details.owner, FilesetEntry.details.owner, FilesetJobLink.details.owner, Filter.details.owner, FilterAnnotationLink.details.owner, FilterSet.details.owner, FilterSetEmissionFilterLink.details.owner, FilterSetExcitationFilterLink.details.owner, Folder.details.owner, FolderAnnotationLink.details.owner, FolderImageLink.details.owner, FolderRoiLink.details.owner, GroupExperimenterMap.child, Image.details.owner, ImageAnnotationLink.details.owner, ImagingEnvironment.details.owner, Instrument.details.owner, InstrumentAnnotationLink.details.owner, Job.details.owner, JobOriginalFileLink.details.owner, LightPath.details.owner, LightPathAnnotationLink.details.owner, LightPathEmissionFilterLink.details.owner, LightPathExcitationFilterLink.details.owner, LightSettings.details.owner, LightSource.details.owner, LightSourceAnnotationLink.details.owner, Link.details.owner, LogicalChannel.details.owner, MicrobeamManipulation.details.owner, Microscope.details.owner, NamespaceAnnotationLink.details.owner, NodeAnnotationLink.details.owner, OTF.details.owner, Objective.details.owner, ObjectiveAnnotationLink.details.owner, ObjectiveSettings.details.owner, OriginalFile.details.owner, OriginalFileAnnotationLink.details.owner, Pixels.details.owner, PixelsOriginalFileMap.details.owner, PlaneInfo.details.owner, PlaneInfoAnnotationLink.details.owner, Plate.details.owner, PlateAcquisition.details.owner, PlateAcquisitionAnnotationLink.details.owner, PlateAnnotationLink.details.owner, Project.details.owner, ProjectAnnotationLink.details.owner, ProjectDatasetLink.details.owner, ProjectionDef.details.owner, QuantumDef.details.owner, Reagent.details.owner, ReagentAnnotationLink.details.owner, RenderingDef.details.owner, Roi.details.owner, RoiAnnotationLink.details.owner, Screen.details.owner, ScreenAnnotationLink.details.owner, ScreenPlateLink.details.owner, Session.owner, Session.sudoer, SessionAnnotationLink.details.owner, Shape.details.owner, ShapeAnnotationLink.details.owner, ShareMember.child, StageLabel.details.owner, StatsInfo.details.owner, Thumbnail.details.owner, TransmittanceRange.details.owner, Well.details.owner, WellAnnotationLink.details.owner, WellReagentLink.details.owner, WellSample.details.owner
- Properties:
- annotationLinks: ExperimenterAnnotationLink (multiple)config: list (multiple)details.externalInfo: ExternalInfo (optional)email:
string
(optional)firstName:string
groupExperimenterMap: GroupExperimenterMap (multiple)institution:string
(optional)lastName:string
ldap:boolean
middleName:string
(optional)omeName:string
version:integer
(optional), see IMutable
ExperimenterAnnotationLink¶
Used by: Experimenter.annotationLinks
- Properties:
- child: Annotation, see ILinkdetails.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventparent: Experimenter, see ILinkversion:
integer
(optional), see IMutable
ExperimenterGroup¶
Used by: AffineTransform.details.group, Annotation.details.group, AnnotationAnnotationLink.details.group, Channel.details.group, ChannelAnnotationLink.details.group, ChannelBinding.details.group, CodomainMapContext.details.group, Dataset.details.group, DatasetAnnotationLink.details.group, DatasetImageLink.details.group, Detector.details.group, DetectorAnnotationLink.details.group, DetectorSettings.details.group, Dichroic.details.group, DichroicAnnotationLink.details.group, Event.experimenterGroup, Experiment.details.group, ExperimenterAnnotationLink.details.group, ExperimenterGroupAnnotationLink.details.group, ExperimenterGroupAnnotationLink.parent, ExternalInfo.details.group, Fileset.details.group, FilesetAnnotationLink.details.group, FilesetEntry.details.group, FilesetJobLink.details.group, Filter.details.group, FilterAnnotationLink.details.group, FilterSet.details.group, FilterSetEmissionFilterLink.details.group, FilterSetExcitationFilterLink.details.group, Folder.details.group, FolderAnnotationLink.details.group, FolderImageLink.details.group, FolderRoiLink.details.group, GroupExperimenterMap.parent, Image.details.group, ImageAnnotationLink.details.group, ImagingEnvironment.details.group, Instrument.details.group, InstrumentAnnotationLink.details.group, Job.details.group, JobOriginalFileLink.details.group, LightPath.details.group, LightPathAnnotationLink.details.group, LightPathEmissionFilterLink.details.group, LightPathExcitationFilterLink.details.group, LightSettings.details.group, LightSource.details.group, LightSourceAnnotationLink.details.group, Link.details.group, LogicalChannel.details.group, MicrobeamManipulation.details.group, Microscope.details.group, NamespaceAnnotationLink.details.group, NodeAnnotationLink.details.group, OTF.details.group, Objective.details.group, ObjectiveAnnotationLink.details.group, ObjectiveSettings.details.group, OriginalFile.details.group, OriginalFileAnnotationLink.details.group, Pixels.details.group, PixelsOriginalFileMap.details.group, PlaneInfo.details.group, PlaneInfoAnnotationLink.details.group, Plate.details.group, PlateAcquisition.details.group, PlateAcquisitionAnnotationLink.details.group, PlateAnnotationLink.details.group, Project.details.group, ProjectAnnotationLink.details.group, ProjectDatasetLink.details.group, ProjectionDef.details.group, QuantumDef.details.group, Reagent.details.group, ReagentAnnotationLink.details.group, RenderingDef.details.group, Roi.details.group, RoiAnnotationLink.details.group, Screen.details.group, ScreenAnnotationLink.details.group, ScreenPlateLink.details.group, SessionAnnotationLink.details.group, Shape.details.group, ShapeAnnotationLink.details.group, Share.group, StageLabel.details.group, StatsInfo.details.group, Thumbnail.details.group, TransmittanceRange.details.group, Well.details.group, WellAnnotationLink.details.group, WellReagentLink.details.group, WellSample.details.group
- Properties:
- annotationLinks: ExperimenterGroupAnnotationLink (multiple)config: list (multiple)description:
text
(optional)details.externalInfo: ExternalInfo (optional)groupExperimenterMap: GroupExperimenterMap (multiple)ldap:boolean
name:string
version:integer
(optional), see IMutable
ExperimenterGroupAnnotationLink¶
Used by: ExperimenterGroup.annotationLinks
- Properties:
- child: Annotation, see ILinkdetails.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventparent: ExperimenterGroup, see ILinkversion:
integer
(optional), see IMutable
ExternalInfo¶
Used by: AcquisitionMode.details.externalInfo, AdminPrivilege.details.externalInfo, AffineTransform.details.externalInfo, Annotation.details.externalInfo, AnnotationAnnotationLink.details.externalInfo, ArcType.details.externalInfo, Binning.details.externalInfo, Channel.details.externalInfo, ChannelAnnotationLink.details.externalInfo, ChannelBinding.details.externalInfo, ChecksumAlgorithm.details.externalInfo, CodomainMapContext.details.externalInfo, ContrastMethod.details.externalInfo, Correction.details.externalInfo, DBPatch.details.externalInfo, Dataset.details.externalInfo, DatasetAnnotationLink.details.externalInfo, DatasetImageLink.details.externalInfo, Detector.details.externalInfo, DetectorAnnotationLink.details.externalInfo, DetectorSettings.details.externalInfo, DetectorType.details.externalInfo, Dichroic.details.externalInfo, DichroicAnnotationLink.details.externalInfo, DimensionOrder.details.externalInfo, Event.details.externalInfo, EventLog.details.externalInfo, EventType.details.externalInfo, Experiment.details.externalInfo, ExperimentType.details.externalInfo, Experimenter.details.externalInfo, ExperimenterAnnotationLink.details.externalInfo, ExperimenterGroup.details.externalInfo, ExperimenterGroupAnnotationLink.details.externalInfo, ExternalInfo.details.externalInfo, Family.details.externalInfo, FilamentType.details.externalInfo, Fileset.details.externalInfo, FilesetAnnotationLink.details.externalInfo, FilesetEntry.details.externalInfo, FilesetJobLink.details.externalInfo, Filter.details.externalInfo, FilterAnnotationLink.details.externalInfo, FilterSet.details.externalInfo, FilterSetEmissionFilterLink.details.externalInfo, FilterSetExcitationFilterLink.details.externalInfo, FilterType.details.externalInfo, Folder.details.externalInfo, FolderAnnotationLink.details.externalInfo, FolderImageLink.details.externalInfo, FolderRoiLink.details.externalInfo, Format.details.externalInfo, GroupExperimenterMap.details.externalInfo, Illumination.details.externalInfo, Image.details.externalInfo, ImageAnnotationLink.details.externalInfo, ImagingEnvironment.details.externalInfo, Immersion.details.externalInfo, Instrument.details.externalInfo, InstrumentAnnotationLink.details.externalInfo, Job.details.externalInfo, JobOriginalFileLink.details.externalInfo, JobStatus.details.externalInfo, LaserMedium.details.externalInfo, LaserType.details.externalInfo, LightPath.details.externalInfo, LightPathAnnotationLink.details.externalInfo, LightPathEmissionFilterLink.details.externalInfo, LightPathExcitationFilterLink.details.externalInfo, LightSettings.details.externalInfo, LightSource.details.externalInfo, LightSourceAnnotationLink.details.externalInfo, Link.details.externalInfo, LogicalChannel.details.externalInfo, Medium.details.externalInfo, MicrobeamManipulation.details.externalInfo, MicrobeamManipulationType.details.externalInfo, Microscope.details.externalInfo, MicroscopeType.details.externalInfo, Namespace.details.externalInfo, NamespaceAnnotationLink.details.externalInfo, Node.details.externalInfo, NodeAnnotationLink.details.externalInfo, OTF.details.externalInfo, Objective.details.externalInfo, ObjectiveAnnotationLink.details.externalInfo, ObjectiveSettings.details.externalInfo, OriginalFile.details.externalInfo, OriginalFileAnnotationLink.details.externalInfo, PhotometricInterpretation.details.externalInfo, Pixels.details.externalInfo, PixelsOriginalFileMap.details.externalInfo, PixelsType.details.externalInfo, PlaneInfo.details.externalInfo, PlaneInfoAnnotationLink.details.externalInfo, Plate.details.externalInfo, PlateAcquisition.details.externalInfo, PlateAcquisitionAnnotationLink.details.externalInfo, PlateAnnotationLink.details.externalInfo, Project.details.externalInfo, ProjectAnnotationLink.details.externalInfo, ProjectDatasetLink.details.externalInfo, ProjectionAxis.details.externalInfo, ProjectionDef.details.externalInfo, ProjectionType.details.externalInfo, Pulse.details.externalInfo, QuantumDef.details.externalInfo, Reagent.details.externalInfo, ReagentAnnotationLink.details.externalInfo, RenderingDef.details.externalInfo, RenderingModel.details.externalInfo, Roi.details.externalInfo, RoiAnnotationLink.details.externalInfo, Screen.details.externalInfo, ScreenAnnotationLink.details.externalInfo, ScreenPlateLink.details.externalInfo, Session.details.externalInfo, SessionAnnotationLink.details.externalInfo, Shape.details.externalInfo, ShapeAnnotationLink.details.externalInfo, ShareMember.details.externalInfo, StageLabel.details.externalInfo, StatsInfo.details.externalInfo, Thumbnail.details.externalInfo, TransmittanceRange.details.externalInfo, Well.details.externalInfo, WellAnnotationLink.details.externalInfo, WellReagentLink.details.externalInfo, WellSample.details.externalInfo
- Properties:
- details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: ExperimenterentityId:
long
entityType:string
lsid:string
(optional)uuid:string
(optional)
Family¶
Used by: ChannelBinding.family
- Properties:
- details.externalInfo: ExternalInfo (optional)value:
string
, see IEnum
Filament¶
- Properties:
- annotationLinks: LightSourceAnnotationLink (multiple) from LightSourcedetails.creationEvent: Event from LightSourcedetails.externalInfo: ExternalInfo (optional) from LightSourcedetails.group: ExperimenterGroup from LightSourcedetails.owner: Experimenter from LightSourcedetails.updateEvent: Event from LightSourceinstrument: Instrument from LightSourcelotNumber:
string
(optional) from LightSourcemanufacturer:string
(optional) from LightSourcemodel:string
(optional) from LightSourcepower.unit: enumeration of Power (optional) from LightSourcepower.value:double
(optional) from LightSourceserialNumber:string
(optional) from LightSourcetype: FilamentTypeversion:integer
(optional) from LightSource
FilamentType¶
Used by: Filament.type
- Properties:
- details.externalInfo: ExternalInfo (optional)value:
string
, see IEnum
FileAnnotation¶
- Properties:
- annotationLinks: AnnotationAnnotationLink (multiple) from Annotationdescription:
text
(optional) from Annotationdetails.creationEvent: Event from Annotationdetails.externalInfo: ExternalInfo (optional) from Annotationdetails.group: ExperimenterGroup from Annotationdetails.owner: Experimenter from Annotationdetails.updateEvent: Event from Annotationfile: OriginalFile (optional)name:text
(optional) from Annotationns:text
(optional) from Annotationversion:integer
(optional) from Annotation
Fileset¶
Used by: FilesetAnnotationLink.parent, FilesetEntry.fileset, FilesetJobLink.parent, Image.fileset
- Properties:
- annotationLinks: FilesetAnnotationLink (multiple)details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventimages: Image (multiple)jobLinks: FilesetJobLink (multiple)templatePrefix:
text
usedFiles: FilesetEntry (multiple)version:integer
(optional), see IMutable
FilesetAnnotationLink¶
Used by: Fileset.annotationLinks
- Properties:
- child: Annotation, see ILinkdetails.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
FilesetEntry¶
Used by: Fileset.usedFiles, OriginalFile.filesetEntries
- Properties:
- clientPath:
text
details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventfileset: FilesetoriginalFile: OriginalFileversion:integer
(optional), see IMutable
FilesetJobLink¶
Used by: Fileset.jobLinks
- Properties:
- details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
Filter¶
Used by: FilterAnnotationLink.parent, FilterSetEmissionFilterLink.child, FilterSetExcitationFilterLink.child, Instrument.filter, LightPathEmissionFilterLink.child, LightPathExcitationFilterLink.child
- Properties:
- annotationLinks: FilterAnnotationLink (multiple)details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: EventemissionFilterLink: FilterSetEmissionFilterLink (multiple)excitationFilterLink: FilterSetExcitationFilterLink (multiple)filterWheel:
string
(optional)instrument: InstrumentlotNumber:string
(optional)manufacturer:string
(optional)model:string
(optional)serialNumber:string
(optional)transmittanceRange: TransmittanceRange (optional)type: FilterType (optional)version:integer
(optional), see IMutable
FilterAnnotationLink¶
Used by: Filter.annotationLinks
- Properties:
- child: Annotation, see ILinkdetails.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
FilterSet¶
Used by: FilterSetEmissionFilterLink.parent, FilterSetExcitationFilterLink.parent, Instrument.filterSet, LogicalChannel.filterSet, OTF.filterSet
- Properties:
- details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventdichroic: Dichroic (optional)emissionFilterLink: FilterSetEmissionFilterLink (multiple)excitationFilterLink: FilterSetExcitationFilterLink (multiple)instrument: InstrumentlotNumber:
string
(optional)manufacturer:string
(optional)model:string
(optional)serialNumber:string
(optional)version:integer
(optional), see IMutable
FilterSetEmissionFilterLink¶
Used by: Filter.emissionFilterLink, FilterSet.emissionFilterLink
- Properties:
- details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
FilterSetExcitationFilterLink¶
Used by: Filter.excitationFilterLink, FilterSet.excitationFilterLink
- Properties:
- details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
FilterType¶
Used by: Filter.type
- Properties:
- details.externalInfo: ExternalInfo (optional)value:
string
, see IEnum
Folder¶
Used by: Folder.childFolders, Folder.parentFolder, FolderAnnotationLink.parent, FolderImageLink.parent, FolderRoiLink.parent
- Properties:
- annotationLinks: FolderAnnotationLink (multiple)childFolders: Folder (multiple)description:
text
(optional)details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: EventimageLinks: FolderImageLink (multiple)name:text
parentFolder: Folder (optional)roiLinks: FolderRoiLink (multiple)version:integer
(optional), see IMutable
FolderAnnotationLink¶
Used by: Folder.annotationLinks
- Properties:
- child: Annotation, see ILinkdetails.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
FolderImageLink¶
Used by: Folder.imageLinks, Image.folderLinks
- Properties:
- details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
FolderRoiLink¶
Used by: Folder.roiLinks, Roi.folderLinks
- Properties:
- details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
Format¶
Used by: Image.format
- Properties:
- details.externalInfo: ExternalInfo (optional)value:
string
, see IEnum
GenericExcitationSource¶
- Properties:
- annotationLinks: LightSourceAnnotationLink (multiple) from LightSourcedetails.creationEvent: Event from LightSourcedetails.externalInfo: ExternalInfo (optional) from LightSourcedetails.group: ExperimenterGroup from LightSourcedetails.owner: Experimenter from LightSourcedetails.updateEvent: Event from LightSourceinstrument: Instrument from LightSourcelotNumber:
string
(optional) from LightSourcemanufacturer:string
(optional) from LightSourcemap: list (multiple)model:string
(optional) from LightSourcepower.unit: enumeration of Power (optional) from LightSourcepower.value:double
(optional) from LightSourceserialNumber:string
(optional) from LightSourceversion:integer
(optional) from LightSource
GroupExperimenterMap¶
Used by: Experimenter.groupExperimenterMap, ExperimenterGroup.groupExperimenterMap
- Properties:
- child: Experimenter, see ILinkdetails.externalInfo: ExternalInfo (optional)owner:
boolean
parent: ExperimenterGroup, see ILinkversion:integer
(optional), see IMutable
Illumination¶
Used by: LogicalChannel.illumination
- Properties:
- details.externalInfo: ExternalInfo (optional)value:
string
, see IEnum
Image¶
Used by: DatasetImageLink.child, Fileset.images, FolderImageLink.child, ImageAnnotationLink.parent, Pixels.image, Roi.image, WellSample.image
- Properties:
- acquisitionDate:
timestamp
(optional)annotationLinks: ImageAnnotationLink (multiple)archived:boolean
(optional)datasetLinks: DatasetImageLink (multiple)description:text
(optional)details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventexperiment: Experiment (optional)fileset: Fileset (optional)folderLinks: FolderImageLink (multiple)format: Format (optional)imagingEnvironment: ImagingEnvironment (optional)instrument: Instrument (optional)name:text
objectiveSettings: ObjectiveSettings (optional)partial:boolean
(optional)pixels: Pixels (multiple)rois: Roi (multiple)series:integer
(optional)stageLabel: StageLabel (optional)version:integer
(optional), see IMutablewellSamples: WellSample (multiple)
ImageAnnotationLink¶
Used by: Image.annotationLinks
- Properties:
- child: Annotation, see ILinkdetails.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
ImagingEnvironment¶
Used by: Image.imagingEnvironment
- Properties:
- airPressure.unit: enumeration of Pressure (optional)airPressure.value:
double
(optional)co2percent:double
(optional)details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventhumidity:double
(optional)map: list (multiple)temperature.unit: enumeration of Temperature (optional)temperature.value:double
(optional)version:integer
(optional), see IMutable
Immersion¶
Used by: Objective.immersion
- Properties:
- details.externalInfo: ExternalInfo (optional)value:
string
, see IEnum
ImportJob¶
- Properties:
- details.externalInfo: ExternalInfo (optional) from Jobdetails.group: ExperimenterGroup from Jobdetails.owner: Experimenter from Jobfinished:
timestamp
(optional) from Jobgroupname:string
from JobimageDescription:text
imageName:text
message:string
from JoboriginalFileLinks: JobOriginalFileLink (multiple) from JobscheduledFor:timestamp
from Jobstarted:timestamp
(optional) from Jobsubmitted:timestamp
from Jobtype:string
from Jobusername:string
from Jobversion:integer
(optional) from Job
Warning
This model object is deprecated.
IndexingJob¶
- Properties:
- details.externalInfo: ExternalInfo (optional) from Jobdetails.group: ExperimenterGroup from Jobdetails.owner: Experimenter from Jobfinished:
timestamp
(optional) from Jobgroupname:string
from Jobmessage:string
from JoboriginalFileLinks: JobOriginalFileLink (multiple) from JobscheduledFor:timestamp
from Jobstarted:timestamp
(optional) from Jobsubmitted:timestamp
from Jobtype:string
from Jobusername:string
from Jobversion:integer
(optional) from Job
Instrument¶
Used by: Detector.instrument, Dichroic.instrument, Filter.instrument, FilterSet.instrument, Image.instrument, InstrumentAnnotationLink.parent, LightSource.instrument, OTF.instrument, Objective.instrument
- Properties:
- annotationLinks: InstrumentAnnotationLink (multiple)details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventdetector: Detector (multiple)dichroic: Dichroic (multiple)filter: Filter (multiple)filterSet: FilterSet (multiple)lightSource: LightSource (multiple)microscope: Microscope (optional)objective: Objective (multiple)otf: OTF (multiple)version:
integer
(optional), see IMutable
InstrumentAnnotationLink¶
Used by: Instrument.annotationLinks
- Properties:
- child: Annotation, see ILinkdetails.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventparent: Instrument, see ILinkversion:
integer
(optional), see IMutable
IntegrityCheckJob¶
- Properties:
- details.externalInfo: ExternalInfo (optional) from Jobdetails.group: ExperimenterGroup from Jobdetails.owner: Experimenter from Jobfinished:
timestamp
(optional) from Jobgroupname:string
from Jobmessage:string
from JoboriginalFileLinks: JobOriginalFileLink (multiple) from JobscheduledFor:timestamp
from Jobstarted:timestamp
(optional) from Jobsubmitted:timestamp
from Jobtype:string
from Jobusername:string
from Jobversion:integer
(optional) from Job
Job¶
Subclasses: ImportJob, IndexingJob, IntegrityCheckJob, MetadataImportJob, ParseJob, PixelDataJob, ScriptJob, ThumbnailGenerationJob, UploadJob
Used by: FilesetJobLink.child, JobOriginalFileLink.parent
- Properties:
- details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventfinished:
timestamp
(optional)groupname:string
message:string
originalFileLinks: JobOriginalFileLink (multiple)scheduledFor:timestamp
started:timestamp
(optional)status: JobStatussubmitted:timestamp
type:string
username:string
version:integer
(optional), see IMutable
JobOriginalFileLink¶
Used by: Job.originalFileLinks
- Properties:
- child: OriginalFile, see ILinkdetails.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
JobStatus¶
Used by: Job.status
- Properties:
- details.externalInfo: ExternalInfo (optional)value:
string
, see IEnum
Label¶
- Properties:
- annotationLinks: ShapeAnnotationLink (multiple) from Shapedetails.externalInfo: ExternalInfo (optional) from Shapedetails.group: ExperimenterGroup from Shapedetails.owner: Experimenter from ShapefillColor:
integer
(optional) from ShapefillRule:string
(optional) from ShapefontFamily:string
(optional) from ShapefontSize.value:double
(optional) from ShapefontStyle:string
(optional) from Shapelocked:boolean
(optional) from ShapestrokeColor:integer
(optional) from ShapestrokeDashArray:string
(optional) from ShapestrokeWidth.value:double
(optional) from ShapetextValue:text
(optional)theC:integer
(optional) from ShapetheT:integer
(optional) from ShapetheZ:integer
(optional) from Shapetransform: AffineTransform (optional) from Shapeversion:integer
(optional) from Shapex:double
(optional)y:double
(optional)
Laser¶
- Properties:
- annotationLinks: LightSourceAnnotationLink (multiple) from LightSourcedetails.creationEvent: Event from LightSourcedetails.externalInfo: ExternalInfo (optional) from LightSourcedetails.group: ExperimenterGroup from LightSourcedetails.owner: Experimenter from LightSourcedetails.updateEvent: Event from LightSourcefrequencyMultiplication:
integer
(optional)instrument: Instrument from LightSourcelaserMedium: LaserMediumlotNumber:string
(optional) from LightSourcemanufacturer:string
(optional) from LightSourcemodel:string
(optional) from LightSourcepockelCell:boolean
(optional)power.unit: enumeration of Power (optional) from LightSourcepower.value:double
(optional) from LightSourcepulse: Pulse (optional)pump: LightSource (optional)repetitionRate.unit: enumeration of Frequency (optional)repetitionRate.value:double
(optional)serialNumber:string
(optional) from LightSourcetuneable:boolean
(optional)type: LaserTypeversion:integer
(optional) from LightSourcewavelength.unit: enumeration of Length (optional)wavelength.value:double
(optional)
LaserMedium¶
Used by: Laser.laserMedium
- Properties:
- details.externalInfo: ExternalInfo (optional)value:
string
, see IEnum
LaserType¶
Used by: Laser.type
- Properties:
- details.externalInfo: ExternalInfo (optional)value:
string
, see IEnum
LightEmittingDiode¶
- Properties:
- annotationLinks: LightSourceAnnotationLink (multiple) from LightSourcedetails.creationEvent: Event from LightSourcedetails.externalInfo: ExternalInfo (optional) from LightSourcedetails.group: ExperimenterGroup from LightSourcedetails.owner: Experimenter from LightSourcedetails.updateEvent: Event from LightSourceinstrument: Instrument from LightSourcelotNumber:
string
(optional) from LightSourcemanufacturer:string
(optional) from LightSourcemodel:string
(optional) from LightSourcepower.unit: enumeration of Power (optional) from LightSourcepower.value:double
(optional) from LightSourceserialNumber:string
(optional) from LightSourceversion:integer
(optional) from LightSource
LightPath¶
Used by: LightPathAnnotationLink.parent, LightPathEmissionFilterLink.parent, LightPathExcitationFilterLink.parent, LogicalChannel.lightPath
- Properties:
- annotationLinks: LightPathAnnotationLink (multiple)details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventdichroic: Dichroic (optional)emissionFilterLink: LightPathEmissionFilterLink (multiple)excitationFilterLink: LightPathExcitationFilterLink (multiple)version:
integer
(optional), see IMutable
LightPathAnnotationLink¶
Used by: LightPath.annotationLinks
- Properties:
- child: Annotation, see ILinkdetails.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
LightPathEmissionFilterLink¶
Used by: LightPath.emissionFilterLink
- Properties:
- details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
LightPathExcitationFilterLink¶
Used by: LightPath.excitationFilterLink
- Properties:
- details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
LightSettings¶
Used by: LogicalChannel.lightSourceSettings, MicrobeamManipulation.lightSourceSettings
- Properties:
- attenuation:
double
(optional)details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: EventlightSource: LightSourcemicrobeamManipulation: MicrobeamManipulation (optional)version:integer
(optional), see IMutablewavelength.unit: enumeration of Length (optional)wavelength.value:double
(optional)
LightSource¶
Subclasses: Arc, Filament, GenericExcitationSource, Laser, LightEmittingDiode
Used by: Instrument.lightSource, Laser.pump, LightSettings.lightSource, LightSourceAnnotationLink.parent
- Properties:
- annotationLinks: LightSourceAnnotationLink (multiple)details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventinstrument: InstrumentlotNumber:
string
(optional)manufacturer:string
(optional)model:string
(optional)power.unit: enumeration of Power (optional)power.value:double
(optional)serialNumber:string
(optional)version:integer
(optional), see IMutable
LightSourceAnnotationLink¶
Used by: LightSource.annotationLinks
- Properties:
- child: Annotation, see ILinkdetails.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventparent: LightSource, see ILinkversion:
integer
(optional), see IMutable
Line¶
- Properties:
- annotationLinks: ShapeAnnotationLink (multiple) from Shapedetails.externalInfo: ExternalInfo (optional) from Shapedetails.group: ExperimenterGroup from Shapedetails.owner: Experimenter from ShapefillColor:
integer
(optional) from ShapefillRule:string
(optional) from ShapefontFamily:string
(optional) from ShapefontSize.value:double
(optional) from ShapefontStyle:string
(optional) from Shapelocked:boolean
(optional) from ShapemarkerEnd:string
(optional)markerStart:string
(optional)strokeColor:integer
(optional) from ShapestrokeDashArray:string
(optional) from ShapestrokeWidth.value:double
(optional) from ShapetextValue:text
(optional)theC:integer
(optional) from ShapetheT:integer
(optional) from ShapetheZ:integer
(optional) from Shapetransform: AffineTransform (optional) from Shapeversion:integer
(optional) from Shapex1:double
(optional)x2:double
(optional)y1:double
(optional)y2:double
(optional)
Link¶
- Properties:
- details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
ListAnnotation¶
- Properties:
- annotationLinks: AnnotationAnnotationLink (multiple) from Annotationdescription:
text
(optional) from Annotationdetails.creationEvent: Event from Annotationdetails.externalInfo: ExternalInfo (optional) from Annotationdetails.group: ExperimenterGroup from Annotationdetails.owner: Experimenter from Annotationdetails.updateEvent: Event from Annotationname:text
(optional) from Annotationns:text
(optional) from Annotationversion:integer
(optional) from Annotation
LogicalChannel¶
Used by: Channel.logicalChannel
- Properties:
- channels: Channel (multiple)contrastMethod: ContrastMethod (optional)details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: EventdetectorSettings: DetectorSettings (optional)emissionWave.unit: enumeration of Length (optional)emissionWave.value:
double
(optional)excitationWave.unit: enumeration of Length (optional)excitationWave.value:double
(optional)filterSet: FilterSet (optional)fluor:string
(optional)illumination: Illumination (optional)lightPath: LightPath (optional)lightSourceSettings: LightSettings (optional)mode: AcquisitionMode (optional)name:text
(optional)ndFilter:double
(optional)otf: OTF (optional)photometricInterpretation: PhotometricInterpretation (optional)pinHoleSize.unit: enumeration of Length (optional)pinHoleSize.value:double
(optional)pockelCellSetting:integer
(optional)samplesPerPixel:integer
(optional)version:integer
(optional), see IMutable
LongAnnotation¶
- Properties:
- annotationLinks: AnnotationAnnotationLink (multiple) from Annotationdescription:
text
(optional) from Annotationdetails.creationEvent: Event from Annotationdetails.externalInfo: ExternalInfo (optional) from Annotationdetails.group: ExperimenterGroup from Annotationdetails.owner: Experimenter from Annotationdetails.updateEvent: Event from AnnotationlongValue:long
(optional)name:text
(optional) from Annotationns:text
(optional) from Annotationversion:integer
(optional) from Annotation
MapAnnotation¶
- Properties:
- annotationLinks: AnnotationAnnotationLink (multiple) from Annotationdescription:
text
(optional) from Annotationdetails.creationEvent: Event from Annotationdetails.externalInfo: ExternalInfo (optional) from Annotationdetails.group: ExperimenterGroup from Annotationdetails.owner: Experimenter from Annotationdetails.updateEvent: Event from AnnotationmapValue: list (multiple)name:text
(optional) from Annotationns:text
(optional) from Annotationversion:integer
(optional) from Annotation
Mask¶
- Properties:
- annotationLinks: ShapeAnnotationLink (multiple) from Shapebytes:
binary
(optional)details.externalInfo: ExternalInfo (optional) from Shapedetails.group: ExperimenterGroup from Shapedetails.owner: Experimenter from ShapefillColor:integer
(optional) from ShapefillRule:string
(optional) from ShapefontFamily:string
(optional) from ShapefontSize.value:double
(optional) from ShapefontStyle:string
(optional) from Shapeheight:double
(optional)locked:boolean
(optional) from Shapepixels: Pixels (optional)strokeColor:integer
(optional) from ShapestrokeDashArray:string
(optional) from ShapestrokeWidth.value:double
(optional) from ShapetextValue:text
(optional)theC:integer
(optional) from ShapetheT:integer
(optional) from ShapetheZ:integer
(optional) from Shapetransform: AffineTransform (optional) from Shapeversion:integer
(optional) from Shapewidth:double
(optional)x:double
(optional)y:double
(optional)
Medium¶
Used by: ObjectiveSettings.medium
- Properties:
- details.externalInfo: ExternalInfo (optional)value:
string
, see IEnum
MetadataImportJob¶
- Properties:
- details.externalInfo: ExternalInfo (optional) from Jobdetails.group: ExperimenterGroup from Jobdetails.owner: Experimenter from Jobfinished:
timestamp
(optional) from Jobgroupname:string
from Jobmessage:string
from JoboriginalFileLinks: JobOriginalFileLink (multiple) from JobscheduledFor:timestamp
from Jobstarted:timestamp
(optional) from Jobsubmitted:timestamp
from Jobtype:string
from Jobusername:string
from Jobversion:integer
(optional) from JobversionInfo: list (multiple)
MicrobeamManipulation¶
Used by: Experiment.microbeamManipulation, LightSettings.microbeamManipulation
- Properties:
- description:
text
(optional)details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventexperiment: ExperimentlightSourceSettings: LightSettings (multiple)version:integer
(optional), see IMutable
MicrobeamManipulationType¶
Used by: MicrobeamManipulation.type
- Properties:
- details.externalInfo: ExternalInfo (optional)value:
string
, see IEnum
Microscope¶
Used by: Instrument.microscope
- Properties:
- details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: EventlotNumber:
string
(optional)manufacturer:string
(optional)model:string
(optional)serialNumber:string
(optional)type: MicroscopeTypeversion:integer
(optional), see IMutable
MicroscopeType¶
Used by: Microscope.type
- Properties:
- details.externalInfo: ExternalInfo (optional)value:
string
, see IEnum
Namespace¶
Used by: NamespaceAnnotationLink.parent
- Properties:
- annotationLinks: NamespaceAnnotationLink (multiple)description:
text
(optional)details.externalInfo: ExternalInfo (optional)display:boolean
(optional)displayName:text
(optional)keywords: list (optional)multivalued:boolean
(optional)name:text
version:integer
(optional), see IMutable
NamespaceAnnotationLink¶
Used by: Namespace.annotationLinks
- Properties:
- child: Annotation, see ILinkdetails.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
Node¶
Used by: NodeAnnotationLink.parent, Session.node
- Properties:
- annotationLinks: NodeAnnotationLink (multiple)conn:
text
details.externalInfo: ExternalInfo (optional)down:timestamp
(optional)scale:integer
(optional)sessions: Session (multiple)up:timestamp
uuid:string
version:integer
(optional), see IMutable
NodeAnnotationLink¶
Used by: Node.annotationLinks
- Properties:
- child: Annotation, see ILinkdetails.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
NumericAnnotation¶
Subclasses: DoubleAnnotation, LongAnnotation
- Properties:
- annotationLinks: AnnotationAnnotationLink (multiple) from Annotationdescription:
text
(optional) from Annotationdetails.creationEvent: Event from Annotationdetails.externalInfo: ExternalInfo (optional) from Annotationdetails.group: ExperimenterGroup from Annotationdetails.owner: Experimenter from Annotationdetails.updateEvent: Event from Annotationname:text
(optional) from Annotationns:text
(optional) from Annotationversion:integer
(optional) from Annotation
OTF¶
Used by: Instrument.otf, LogicalChannel.otf
- Properties:
- details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: EventfilterSet: FilterSet (optional)instrument: Instrumentobjective: ObjectiveopticalAxisAveraged:
boolean
path:string
pixelsType: PixelsTypesizeX:integer
sizeY:integer
version:integer
(optional), see IMutable
Objective¶
Used by: Instrument.objective, OTF.objective, ObjectiveAnnotationLink.parent, ObjectiveSettings.objective
- Properties:
- annotationLinks: ObjectiveAnnotationLink (multiple)calibratedMagnification:
double
(optional)correction: Correctiondetails.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventimmersion: Immersioninstrument: Instrumentiris:boolean
(optional)lensNA:double
(optional)lotNumber:string
(optional)manufacturer:string
(optional)model:string
(optional)nominalMagnification:double
(optional)serialNumber:string
(optional)version:integer
(optional), see IMutableworkingDistance.unit: enumeration of Length (optional)workingDistance.value:double
(optional)
ObjectiveAnnotationLink¶
Used by: Objective.annotationLinks
- Properties:
- child: Annotation, see ILinkdetails.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
ObjectiveSettings¶
Used by: Image.objectiveSettings
- Properties:
- correctionCollar:
double
(optional)details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventmedium: Medium (optional)objective: ObjectiverefractiveIndex:double
(optional)version:integer
(optional), see IMutable
OriginalFile¶
Used by: FileAnnotation.file, FilesetEntry.originalFile, JobOriginalFileLink.child, OriginalFileAnnotationLink.parent, PixelsOriginalFileMap.parent, Roi.source
- Properties:
- annotationLinks: OriginalFileAnnotationLink (multiple)atime:
timestamp
(optional)ctime:timestamp
(optional)details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: EventfilesetEntries: FilesetEntry (multiple)hash:text
(optional)hasher: ChecksumAlgorithm (optional)mimetype:string
(optional)mtime:timestamp
(optional)name:text
path:text
pixelsFileMaps: PixelsOriginalFileMap (multiple)repo:string
(optional)size:long
(optional)version:integer
(optional), see IMutable
OriginalFileAnnotationLink¶
Used by: OriginalFile.annotationLinks
- Properties:
- child: Annotation, see ILinkdetails.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventparent: OriginalFile, see ILinkversion:
integer
(optional), see IMutable
ParseJob¶
- Properties:
- details.externalInfo: ExternalInfo (optional) from Jobdetails.group: ExperimenterGroup from Jobdetails.owner: Experimenter from Jobfinished:
timestamp
(optional) from Jobgroupname:string
from Jobmessage:string
from JoboriginalFileLinks: JobOriginalFileLink (multiple) from Jobparams:binary
(optional)scheduledFor:timestamp
from Jobstarted:timestamp
(optional) from Jobsubmitted:timestamp
from Jobtype:string
from Jobusername:string
from Jobversion:integer
(optional) from Job
Path¶
- Properties:
- annotationLinks: ShapeAnnotationLink (multiple) from Shaped:
text
(optional)details.externalInfo: ExternalInfo (optional) from Shapedetails.group: ExperimenterGroup from Shapedetails.owner: Experimenter from ShapefillColor:integer
(optional) from ShapefillRule:string
(optional) from ShapefontFamily:string
(optional) from ShapefontSize.value:double
(optional) from ShapefontStyle:string
(optional) from Shapelocked:boolean
(optional) from ShapestrokeColor:integer
(optional) from ShapestrokeDashArray:string
(optional) from ShapestrokeWidth.value:double
(optional) from ShapetextValue:text
(optional)theC:integer
(optional) from ShapetheT:integer
(optional) from ShapetheZ:integer
(optional) from Shapetransform: AffineTransform (optional) from Shapeversion:integer
(optional) from Shape
Warning
This model object is deprecated.
PhotometricInterpretation¶
Used by: LogicalChannel.photometricInterpretation
- Properties:
- details.externalInfo: ExternalInfo (optional)value:
string
, see IEnum
PixelDataJob¶
- Properties:
- details.externalInfo: ExternalInfo (optional) from Jobdetails.group: ExperimenterGroup from Jobdetails.owner: Experimenter from Jobfinished:
timestamp
(optional) from Jobgroupname:string
from Jobmessage:string
from JoboriginalFileLinks: JobOriginalFileLink (multiple) from JobscheduledFor:timestamp
from Jobstarted:timestamp
(optional) from Jobsubmitted:timestamp
from Jobtype:string
from Jobusername:string
from Jobversion:integer
(optional) from Job
Pixels¶
Used by: Channel.pixels, Image.pixels, Mask.pixels, Pixels.relatedTo, PixelsOriginalFileMap.child, PlaneInfo.pixels, RenderingDef.pixels, Thumbnail.pixels
- Properties:
- channels: Channel (multiple)details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: EventdimensionOrder: DimensionOrderimage: Imagemethodology:
string
(optional)physicalSizeX.unit: enumeration of Length (optional)physicalSizeX.value:double
(optional)physicalSizeY.unit: enumeration of Length (optional)physicalSizeY.value:double
(optional)physicalSizeZ.unit: enumeration of Length (optional)physicalSizeZ.value:double
(optional)pixelsFileMaps: PixelsOriginalFileMap (multiple)pixelsType: PixelsTypeplaneInfo: PlaneInfo (multiple)relatedTo: Pixels (optional) (deprecated)settings: RenderingDef (multiple)sha1:string
significantBits:integer
(optional)sizeC:integer
sizeT:integer
sizeX:integer
sizeY:integer
sizeZ:integer
thumbnails: Thumbnail (multiple)timeIncrement.unit: enumeration of Time (optional)timeIncrement.value:double
(optional)version:integer
(optional), see IMutablewaveIncrement:integer
(optional)waveStart:integer
(optional)
Warning
This model object has a deprecated property.
PixelsOriginalFileMap¶
Used by: OriginalFile.pixelsFileMaps, Pixels.pixelsFileMaps
- Properties:
- details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventparent: OriginalFile, see ILinkversion:
integer
(optional), see IMutable
PlaneInfo¶
Used by: Pixels.planeInfo, PlaneInfoAnnotationLink.parent
- Properties:
- annotationLinks: PlaneInfoAnnotationLink (multiple)deltaT.unit: enumeration of Time (optional)deltaT.value:
double
(optional)details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: EventexposureTime.unit: enumeration of Time (optional)exposureTime.value:double
(optional)pixels: PixelspositionX.unit: enumeration of Length (optional)positionX.value:double
(optional)positionY.unit: enumeration of Length (optional)positionY.value:double
(optional)positionZ.unit: enumeration of Length (optional)positionZ.value:double
(optional)theC:integer
theT:integer
theZ:integer
version:integer
(optional), see IMutable
PlaneInfoAnnotationLink¶
Used by: PlaneInfo.annotationLinks
- Properties:
- child: Annotation, see ILinkdetails.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
PlaneSlicingContext¶
- Properties:
- channelBinding: ChannelBinding from CodomainMapContextconstant:
boolean
details.creationEvent: Event from CodomainMapContextdetails.externalInfo: ExternalInfo (optional) from CodomainMapContextdetails.group: ExperimenterGroup from CodomainMapContextdetails.owner: Experimenter from CodomainMapContextdetails.updateEvent: Event from CodomainMapContextlowerLimit:integer
planePrevious:integer
planeSelected:integer
upperLimit:integer
version:integer
(optional) from CodomainMapContext
Plate¶
Used by: PlateAcquisition.plate, PlateAnnotationLink.parent, ScreenPlateLink.child, Well.plate
- Properties:
- annotationLinks: PlateAnnotationLink (multiple)columnNamingConvention:
string
(optional)columns:integer
(optional)defaultSample:integer
(optional)description:text
(optional)details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: EventexternalIdentifier:string
(optional)name:text
plateAcquisitions: PlateAcquisition (multiple)rowNamingConvention:string
(optional)rows:integer
(optional)screenLinks: ScreenPlateLink (multiple)status:text
(optional)version:integer
(optional), see IMutablewellOriginX.unit: enumeration of Length (optional)wellOriginX.value:double
(optional)wellOriginY.unit: enumeration of Length (optional)wellOriginY.value:double
(optional)wells: Well (multiple)
PlateAcquisition¶
Used by: Plate.plateAcquisitions, PlateAcquisitionAnnotationLink.parent, WellSample.plateAcquisition
- Properties:
- annotationLinks: PlateAcquisitionAnnotationLink (multiple)description:
text
(optional)details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: EventendTime:timestamp
(optional)maximumFieldCount:integer
(optional)name:text
(optional)plate: PlatestartTime:timestamp
(optional)version:integer
(optional), see IMutablewellSample: WellSample (multiple)
PlateAcquisitionAnnotationLink¶
Used by: PlateAcquisition.annotationLinks
- Properties:
- child: Annotation, see ILinkdetails.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventparent: PlateAcquisition, see ILinkversion:
integer
(optional), see IMutable
PlateAnnotationLink¶
Used by: Plate.annotationLinks
- Properties:
- child: Annotation, see ILinkdetails.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
Point¶
- Properties:
- annotationLinks: ShapeAnnotationLink (multiple) from Shapedetails.externalInfo: ExternalInfo (optional) from Shapedetails.group: ExperimenterGroup from Shapedetails.owner: Experimenter from ShapefillColor:
integer
(optional) from ShapefillRule:string
(optional) from ShapefontFamily:string
(optional) from ShapefontSize.value:double
(optional) from ShapefontStyle:string
(optional) from Shapelocked:boolean
(optional) from ShapestrokeColor:integer
(optional) from ShapestrokeDashArray:string
(optional) from ShapestrokeWidth.value:double
(optional) from ShapetextValue:text
(optional)theC:integer
(optional) from ShapetheT:integer
(optional) from ShapetheZ:integer
(optional) from Shapetransform: AffineTransform (optional) from Shapeversion:integer
(optional) from Shapex:double
(optional)y:double
(optional)
Polygon¶
- Properties:
- annotationLinks: ShapeAnnotationLink (multiple) from Shapedetails.externalInfo: ExternalInfo (optional) from Shapedetails.group: ExperimenterGroup from Shapedetails.owner: Experimenter from ShapefillColor:
integer
(optional) from ShapefillRule:string
(optional) from ShapefontFamily:string
(optional) from ShapefontSize.value:double
(optional) from ShapefontStyle:string
(optional) from Shapelocked:boolean
(optional) from Shapepoints:text
(optional)strokeColor:integer
(optional) from ShapestrokeDashArray:string
(optional) from ShapestrokeWidth.value:double
(optional) from ShapetextValue:text
(optional)theC:integer
(optional) from ShapetheT:integer
(optional) from ShapetheZ:integer
(optional) from Shapetransform: AffineTransform (optional) from Shapeversion:integer
(optional) from Shape
Polyline¶
- Properties:
- annotationLinks: ShapeAnnotationLink (multiple) from Shapedetails.externalInfo: ExternalInfo (optional) from Shapedetails.group: ExperimenterGroup from Shapedetails.owner: Experimenter from ShapefillColor:
integer
(optional) from ShapefillRule:string
(optional) from ShapefontFamily:string
(optional) from ShapefontSize.value:double
(optional) from ShapefontStyle:string
(optional) from Shapelocked:boolean
(optional) from ShapemarkerEnd:string
(optional)markerStart:string
(optional)points:text
(optional)strokeColor:integer
(optional) from ShapestrokeDashArray:string
(optional) from ShapestrokeWidth.value:double
(optional) from ShapetextValue:text
(optional)theC:integer
(optional) from ShapetheT:integer
(optional) from ShapetheZ:integer
(optional) from Shapetransform: AffineTransform (optional) from Shapeversion:integer
(optional) from Shape
Project¶
Used by: ProjectAnnotationLink.parent, ProjectDatasetLink.parent
- Properties:
- annotationLinks: ProjectAnnotationLink (multiple)datasetLinks: ProjectDatasetLink (multiple)description:
text
(optional)details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventname:text
version:integer
(optional), see IMutable
ProjectAnnotationLink¶
Used by: Project.annotationLinks
- Properties:
- child: Annotation, see ILinkdetails.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
ProjectDatasetLink¶
Used by: Dataset.projectLinks, Project.datasetLinks
- Properties:
- details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
ProjectionAxis¶
Used by: ProjectionDef.axis
- Properties:
- details.externalInfo: ExternalInfo (optional)value:
string
, see IEnum
ProjectionDef¶
Used by: RenderingDef.projections
- Properties:
- active:
boolean
axis: ProjectionAxisdetails.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: EventendPlane:integer
(optional)renderingDef: RenderingDefstartPlane:integer
(optional)stepping:integer
(optional)type: ProjectionTypeversion:integer
(optional), see IMutable
ProjectionType¶
Used by: ProjectionDef.type
- Properties:
- details.externalInfo: ExternalInfo (optional)value:
string
, see IEnum
Pulse¶
Used by: Laser.pulse
- Properties:
- details.externalInfo: ExternalInfo (optional)value:
string
, see IEnum
QuantumDef¶
Used by: RenderingDef.quantization
- Properties:
- bitResolution:
integer
cdEnd:integer
cdStart:integer
details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:integer
(optional), see IMutable
Reagent¶
Used by: ReagentAnnotationLink.parent, Screen.reagents, WellReagentLink.child
- Properties:
- annotationLinks: ReagentAnnotationLink (multiple)description:
text
(optional)details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventname:text
(optional)reagentIdentifier:string
(optional)screen: Screenversion:integer
(optional), see IMutablewellLinks: WellReagentLink (multiple)
ReagentAnnotationLink¶
Used by: Reagent.annotationLinks
- Properties:
- child: Annotation, see ILinkdetails.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
Rectangle¶
- Properties:
- annotationLinks: ShapeAnnotationLink (multiple) from Shapedetails.externalInfo: ExternalInfo (optional) from Shapedetails.group: ExperimenterGroup from Shapedetails.owner: Experimenter from ShapefillColor:
integer
(optional) from ShapefillRule:string
(optional) from ShapefontFamily:string
(optional) from ShapefontSize.value:double
(optional) from ShapefontStyle:string
(optional) from Shapeheight:double
(optional)locked:boolean
(optional) from ShapestrokeColor:integer
(optional) from ShapestrokeDashArray:string
(optional) from ShapestrokeWidth.value:double
(optional) from ShapetextValue:text
(optional)theC:integer
(optional) from ShapetheT:integer
(optional) from ShapetheZ:integer
(optional) from Shapetransform: AffineTransform (optional) from Shapeversion:integer
(optional) from Shapewidth:double
(optional)x:double
(optional)y:double
(optional)
RenderingDef¶
Used by: ChannelBinding.renderingDef, Pixels.settings, ProjectionDef.renderingDef
- Properties:
- compression:
double
(optional)defaultT:integer
defaultZ:integer
details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventmodel: RenderingModelname:text
(optional)pixels: Pixelsprojections: ProjectionDef (multiple)quantization: QuantumDefversion:integer
(optional), see IMutablewaveRendering: ChannelBinding (multiple)
RenderingModel¶
Used by: RenderingDef.model
- Properties:
- details.externalInfo: ExternalInfo (optional)value:
string
, see IEnum
ReverseIntensityContext¶
- Properties:
- channelBinding: ChannelBinding from CodomainMapContextdetails.creationEvent: Event from CodomainMapContextdetails.externalInfo: ExternalInfo (optional) from CodomainMapContextdetails.group: ExperimenterGroup from CodomainMapContextdetails.owner: Experimenter from CodomainMapContextdetails.updateEvent: Event from CodomainMapContextreverse:
boolean
version:integer
(optional) from CodomainMapContext
Roi¶
Used by: FolderRoiLink.child, Image.rois, RoiAnnotationLink.parent, Shape.roi
- Properties:
- annotationLinks: RoiAnnotationLink (multiple)description:
text
(optional)details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: EventfolderLinks: FolderRoiLink (multiple)image: Image (optional)name:text
(optional)shapes: Shape (multiple)source: OriginalFile (optional)version:integer
(optional), see IMutable
RoiAnnotationLink¶
Used by: Roi.annotationLinks
- Properties:
- child: Annotation, see ILinkdetails.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
Screen¶
Used by: Reagent.screen, ScreenAnnotationLink.parent, ScreenPlateLink.parent
- Properties:
- annotationLinks: ScreenAnnotationLink (multiple)description:
text
(optional)details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventname:text
plateLinks: ScreenPlateLink (multiple)protocolDescription:text
(optional)protocolIdentifier:string
(optional)reagentSetDescription:text
(optional)reagentSetIdentifier:string
(optional)reagents: Reagent (multiple)type:string
(optional)version:integer
(optional), see IMutable
ScreenAnnotationLink¶
Used by: Screen.annotationLinks
- Properties:
- child: Annotation, see ILinkdetails.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
ScreenPlateLink¶
Used by: Plate.screenLinks, Screen.plateLinks
- Properties:
- details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
ScriptJob¶
- Properties:
- description:
string
(optional)details.externalInfo: ExternalInfo (optional) from Jobdetails.group: ExperimenterGroup from Jobdetails.owner: Experimenter from Jobfinished:timestamp
(optional) from Jobgroupname:string
from Jobmessage:string
from JoboriginalFileLinks: JobOriginalFileLink (multiple) from JobscheduledFor:timestamp
from Jobstarted:timestamp
(optional) from Jobsubmitted:timestamp
from Jobtype:string
from Jobusername:string
from Jobversion:integer
(optional) from Job
Session¶
Subclasses: Share
Used by: Event.session, Node.sessions, SessionAnnotationLink.parent
- Properties:
- annotationLinks: SessionAnnotationLink (multiple)closed:
timestamp
(optional)defaultEventType:string
details.externalInfo: ExternalInfo (optional)events: Event (multiple)message:text
(optional)node: Nodeowner: Experimenterstarted:timestamp
sudoer: Experimenter (optional)timeToIdle:long
timeToLive:long
userAgent:string
(optional)userIP:string
(optional)uuid:string
version:integer
(optional), see IMutable
SessionAnnotationLink¶
Used by: Session.annotationLinks
- Properties:
- child: Annotation, see ILinkdetails.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
Shape¶
Subclasses: Ellipse, Label, Line, Mask, Path, Point, Polygon, Polyline, Rectangle
Used by: Roi.shapes, ShapeAnnotationLink.parent
- Properties:
- annotationLinks: ShapeAnnotationLink (multiple)details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: EventfillColor:
integer
(optional)fillRule:string
(optional)fontFamily:string
(optional)fontSize.unit: enumeration of Length (optional)fontSize.value:double
(optional)fontStyle:string
(optional)locked:boolean
(optional)roi: RoistrokeColor:integer
(optional)strokeDashArray:string
(optional)strokeWidth.unit: enumeration of Length (optional)strokeWidth.value:double
(optional)theC:integer
(optional)theT:integer
(optional)theZ:integer
(optional)transform: AffineTransform (optional)version:integer
(optional), see IMutable
ShapeAnnotationLink¶
Used by: Shape.annotationLinks
- Properties:
- child: Annotation, see ILinkdetails.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
StageLabel¶
Used by: Image.stageLabel
- Properties:
- details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventname:
text
positionX.unit: enumeration of Length (optional)positionX.value:double
(optional)positionY.unit: enumeration of Length (optional)positionY.value:double
(optional)positionZ.unit: enumeration of Length (optional)positionZ.value:double
(optional)version:integer
(optional), see IMutable
StatsInfo¶
Used by: Channel.statsInfo
- Properties:
- details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: EventglobalMax:
double
globalMin:double
version:integer
(optional), see IMutable
TagAnnotation¶
- Properties:
- annotationLinks: AnnotationAnnotationLink (multiple) from Annotationdescription:
text
(optional) from Annotationdetails.creationEvent: Event from Annotationdetails.externalInfo: ExternalInfo (optional) from Annotationdetails.group: ExperimenterGroup from Annotationdetails.owner: Experimenter from Annotationdetails.updateEvent: Event from Annotationname:text
(optional) from Annotationns:text
(optional) from AnnotationtextValue:text
(optional) from TextAnnotationversion:integer
(optional) from Annotation
TermAnnotation¶
- Properties:
- annotationLinks: AnnotationAnnotationLink (multiple) from Annotationdescription:
text
(optional) from Annotationdetails.creationEvent: Event from Annotationdetails.externalInfo: ExternalInfo (optional) from Annotationdetails.group: ExperimenterGroup from Annotationdetails.owner: Experimenter from Annotationdetails.updateEvent: Event from Annotationname:text
(optional) from Annotationns:text
(optional) from AnnotationtermValue:text
(optional)version:integer
(optional) from Annotation
TextAnnotation¶
Subclasses: CommentAnnotation, TagAnnotation, XmlAnnotation
- Properties:
- annotationLinks: AnnotationAnnotationLink (multiple) from Annotationdescription:
text
(optional) from Annotationdetails.creationEvent: Event from Annotationdetails.externalInfo: ExternalInfo (optional) from Annotationdetails.group: ExperimenterGroup from Annotationdetails.owner: Experimenter from Annotationdetails.updateEvent: Event from Annotationname:text
(optional) from Annotationns:text
(optional) from AnnotationtextValue:text
(optional)version:integer
(optional) from Annotation
Thumbnail¶
Used by: Pixels.thumbnails
- Properties:
- details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: EventmimeType:
string
pixels: Pixelsref:string
(optional)sizeX:integer
sizeY:integer
version:integer
(optional), see IMutable
ThumbnailGenerationJob¶
- Properties:
- details.externalInfo: ExternalInfo (optional) from Jobdetails.group: ExperimenterGroup from Jobdetails.owner: Experimenter from Jobfinished:
timestamp
(optional) from Jobgroupname:string
from Jobmessage:string
from JoboriginalFileLinks: JobOriginalFileLink (multiple) from JobscheduledFor:timestamp
from Jobstarted:timestamp
(optional) from Jobsubmitted:timestamp
from Jobtype:string
from Jobusername:string
from Jobversion:integer
(optional) from Job
TimestampAnnotation¶
- Properties:
- annotationLinks: AnnotationAnnotationLink (multiple) from Annotationdescription:
text
(optional) from Annotationdetails.creationEvent: Event from Annotationdetails.externalInfo: ExternalInfo (optional) from Annotationdetails.group: ExperimenterGroup from Annotationdetails.owner: Experimenter from Annotationdetails.updateEvent: Event from Annotationname:text
(optional) from Annotationns:text
(optional) from AnnotationtimeValue:timestamp
(optional)version:integer
(optional) from Annotation
TransmittanceRange¶
Used by: Filter.transmittanceRange
- Properties:
- cutIn.unit: enumeration of Length (optional)cutIn.value:
double
(optional)cutInTolerance.unit: enumeration of Length (optional)cutInTolerance.value:double
(optional)cutOut.unit: enumeration of Length (optional)cutOut.value:double
(optional)cutOutTolerance.unit: enumeration of Length (optional)cutOutTolerance.value:double
(optional)details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventtransmittance:double
(optional)version:integer
(optional), see IMutable
TypeAnnotation¶
Subclasses: FileAnnotation
- Properties:
- annotationLinks: AnnotationAnnotationLink (multiple) from Annotationdescription:
text
(optional) from Annotationdetails.creationEvent: Event from Annotationdetails.externalInfo: ExternalInfo (optional) from Annotationdetails.group: ExperimenterGroup from Annotationdetails.owner: Experimenter from Annotationdetails.updateEvent: Event from Annotationname:text
(optional) from Annotationns:text
(optional) from Annotationversion:integer
(optional) from Annotation
UploadJob¶
- Properties:
- details.externalInfo: ExternalInfo (optional) from Jobdetails.group: ExperimenterGroup from Jobdetails.owner: Experimenter from Jobfinished:
timestamp
(optional) from Jobgroupname:string
from Jobmessage:string
from JoboriginalFileLinks: JobOriginalFileLink (multiple) from JobscheduledFor:timestamp
from Jobstarted:timestamp
(optional) from Jobsubmitted:timestamp
from Jobtype:string
from Jobusername:string
from Jobversion:integer
(optional) from JobversionInfo: list (multiple)
Well¶
Used by: Plate.wells, WellAnnotationLink.parent, WellReagentLink.parent, WellSample.well
- Properties:
- alpha:
integer
(optional)annotationLinks: WellAnnotationLink (multiple)blue:integer
(optional)column:integer
(optional)details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: EventexternalDescription:text
(optional)externalIdentifier:string
(optional)green:integer
(optional)plate: PlatereagentLinks: WellReagentLink (multiple)red:integer
(optional)row:integer
(optional)status:string
(optional)type:string
(optional)version:integer
(optional), see IMutablewellSamples: WellSample (multiple)
WellAnnotationLink¶
Used by: Well.annotationLinks
- Properties:
- child: Annotation, see ILinkdetails.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
WellReagentLink¶
Used by: Reagent.wellLinks, Well.reagentLinks
- Properties:
- details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventversion:
integer
(optional), see IMutable
WellSample¶
Used by: Image.wellSamples, PlateAcquisition.wellSample, Well.wellSamples
- Properties:
- details.creationEvent: Eventdetails.externalInfo: ExternalInfo (optional)details.group: ExperimenterGroupdetails.owner: Experimenterdetails.updateEvent: Eventimage: ImageplateAcquisition: PlateAcquisition (optional)posX.unit: enumeration of Length (optional)posX.value:
double
(optional)posY.unit: enumeration of Length (optional)posY.value:double
(optional)timepoint:timestamp
(optional)version:integer
(optional), see IMutablewell: Well
XmlAnnotation¶
- Properties:
- annotationLinks: AnnotationAnnotationLink (multiple) from Annotationdescription:
text
(optional) from Annotationdetails.creationEvent: Event from Annotationdetails.externalInfo: ExternalInfo (optional) from Annotationdetails.group: ExperimenterGroup from Annotationdetails.owner: Experimenter from Annotationdetails.updateEvent: Event from Annotationname:text
(optional) from Annotationns:text
(optional) from AnnotationtextValue:text
(optional) from TextAnnotationversion:integer
(optional) from Annotation