Package ome.xml.meta

Interface MetadataRetrieve

  • All Superinterfaces:
    BaseMetadata
    All Known Subinterfaces:
    IMetadata, OMEXMLMetadata
    All Known Implementing Classes:
    AbstractOMEXMLMetadata, AggregateMetadata, DummyMetadata, OMEXMLMetadataImpl

    public interface MetadataRetrieve
    extends BaseMetadata
    A proxy whose responsibility it is to extract biological image data from a particular storage medium.

    The MetadataRetrieve interface encompasses the metadata that any specific storage medium (file, relational database, etc.) should be expected to access from its backing data model.

    The MetadataRetrieve interface goes hand in hand with the MetadataStore interface. Essentially, MetadataRetrieve provides the "getter" methods for a storage medium, and MetadataStore provides the "setter" methods.

    Since it often makes sense for a storage medium to implement both interfaces, there is also an IMetadata interface encompassing both MetadataStore and MetadataRetrieve, which reduces the need to cast between object types.

    See OMEXMLMetadata for an example implementation.

    Author:
    Melissa Linkert linkert at wisc.edu, Curtis Rueden ctrueden at wisc.edu
    • Method Detail

      • getBooleanAnnotationAnnotationCount

        int getBooleanAnnotationAnnotationCount​(int booleanAnnotationIndex)
        Get the number of links to a BooleanAnnotation. This method returns the number of references to the specified BooleanAnnotation held by all model objects.
        Parameters:
        booleanAnnotationIndex - the BooleanAnnotation index.
        Returns:
        the number of BooleanAnnotation links.
      • getCommentAnnotationAnnotationCount

        int getCommentAnnotationAnnotationCount​(int commentAnnotationIndex)
        Get the number of links to a CommentAnnotation. This method returns the number of references to the specified CommentAnnotation held by all model objects.
        Parameters:
        commentAnnotationIndex - the CommentAnnotation index.
        Returns:
        the number of CommentAnnotation links.
      • getDoubleAnnotationAnnotationCount

        int getDoubleAnnotationAnnotationCount​(int doubleAnnotationIndex)
        Get the number of links to a DoubleAnnotation. This method returns the number of references to the specified DoubleAnnotation held by all model objects.
        Parameters:
        doubleAnnotationIndex - the DoubleAnnotation index.
        Returns:
        the number of DoubleAnnotation links.
      • getFileAnnotationAnnotationCount

        int getFileAnnotationAnnotationCount​(int fileAnnotationIndex)
        Get the number of links to a FileAnnotation. This method returns the number of references to the specified FileAnnotation held by all model objects.
        Parameters:
        fileAnnotationIndex - the FileAnnotation index.
        Returns:
        the number of FileAnnotation links.
      • getListAnnotationAnnotationCount

        int getListAnnotationAnnotationCount​(int listAnnotationIndex)
        Get the number of links to a ListAnnotation. This method returns the number of references to the specified ListAnnotation held by all model objects.
        Parameters:
        listAnnotationIndex - the ListAnnotation index.
        Returns:
        the number of ListAnnotation links.
      • getLongAnnotationAnnotationCount

        int getLongAnnotationAnnotationCount​(int longAnnotationIndex)
        Get the number of links to a LongAnnotation. This method returns the number of references to the specified LongAnnotation held by all model objects.
        Parameters:
        longAnnotationIndex - the LongAnnotation index.
        Returns:
        the number of LongAnnotation links.
      • getMapAnnotationAnnotationCount

        int getMapAnnotationAnnotationCount​(int mapAnnotationIndex)
        Get the number of links to a MapAnnotation. This method returns the number of references to the specified MapAnnotation held by all model objects.
        Parameters:
        mapAnnotationIndex - the MapAnnotation index.
        Returns:
        the number of MapAnnotation links.
      • getTagAnnotationAnnotationCount

        int getTagAnnotationAnnotationCount​(int tagAnnotationIndex)
        Get the number of links to a TagAnnotation. This method returns the number of references to the specified TagAnnotation held by all model objects.
        Parameters:
        tagAnnotationIndex - the TagAnnotation index.
        Returns:
        the number of TagAnnotation links.
      • getTermAnnotationAnnotationCount

        int getTermAnnotationAnnotationCount​(int termAnnotationIndex)
        Get the number of links to a TermAnnotation. This method returns the number of references to the specified TermAnnotation held by all model objects.
        Parameters:
        termAnnotationIndex - the TermAnnotation index.
        Returns:
        the number of TermAnnotation links.
      • getTimestampAnnotationAnnotationCount

        int getTimestampAnnotationAnnotationCount​(int timestampAnnotationIndex)
        Get the number of links to a TimestampAnnotation. This method returns the number of references to the specified TimestampAnnotation held by all model objects.
        Parameters:
        timestampAnnotationIndex - the TimestampAnnotation index.
        Returns:
        the number of TimestampAnnotation links.
      • getXMLAnnotationAnnotationCount

        int getXMLAnnotationAnnotationCount​(int xmlAnnotationIndex)
        Get the number of links to an XMLAnnotation. This method returns the number of references to the specified XMLAnnotation held by all model objects.
        Parameters:
        xmlAnnotationIndex - the XMLAnnotation index.
        Returns:
        the number of XMLAnnotation links.
      • getLightSourceType

        String getLightSourceType​(int instrumentIndex,
                                  int lightSourceIndex)
        Get the type of a LightSource.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the LightSource type.
      • getLightSourceCount

        int getLightSourceCount​(int instrumentIndex)
        Get the number of LightSource elements.
        Parameters:
        instrumentIndex - the Instrument index.
        Returns:
        the number of LightSource elements.
      • getShapeType

        String getShapeType​(int ROIIndex,
                            int shapeIndex)
        Get the type of a Shape.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Shape type.
      • getShapeCount

        int getShapeCount​(int ROIIndex)
        Get the number of Shape elements.
        Parameters:
        ROIIndex - the ROI index.
        Returns:
        the number of Shape elements.
      • getChannelAnnotationRefCount

        int getChannelAnnotationRefCount​(int imageIndex,
                                         int channelIndex)
        Get the number of AnnotationRef elements in Channel.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        Returns:
        the number of AnnotationRef elements.
      • getDatasetAnnotationRefCount

        int getDatasetAnnotationRefCount​(int datasetIndex)
        Get the number of AnnotationRef elements in Dataset.
        Parameters:
        datasetIndex - the Dataset index.
        Returns:
        the number of AnnotationRef elements.
      • getDetectorAnnotationRefCount

        int getDetectorAnnotationRefCount​(int instrumentIndex,
                                          int detectorIndex)
        Get the number of AnnotationRef elements in Detector.
        Parameters:
        instrumentIndex - the Instrument index.
        detectorIndex - the Detector index.
        Returns:
        the number of AnnotationRef elements.
      • getDichroicAnnotationRefCount

        int getDichroicAnnotationRefCount​(int instrumentIndex,
                                          int dichroicIndex)
        Get the number of AnnotationRef elements in Dichroic.
        Parameters:
        instrumentIndex - the Instrument index.
        dichroicIndex - the Dichroic index.
        Returns:
        the number of AnnotationRef elements.
      • getExperimenterAnnotationRefCount

        int getExperimenterAnnotationRefCount​(int experimenterIndex)
        Get the number of AnnotationRef elements in Experimenter.
        Parameters:
        experimenterIndex - the Experimenter index.
        Returns:
        the number of AnnotationRef elements.
      • getExperimenterGroupAnnotationRefCount

        int getExperimenterGroupAnnotationRefCount​(int experimenterGroupIndex)
        Get the number of AnnotationRef elements in ExperimenterGroup.
        Parameters:
        experimenterGroupIndex - the ExperimenterGroup index.
        Returns:
        the number of AnnotationRef elements.
      • getFilterAnnotationRefCount

        int getFilterAnnotationRefCount​(int instrumentIndex,
                                        int filterIndex)
        Get the number of AnnotationRef elements in Filter.
        Parameters:
        instrumentIndex - the Instrument index.
        filterIndex - the Filter index.
        Returns:
        the number of AnnotationRef elements.
      • getFolderAnnotationRefCount

        int getFolderAnnotationRefCount​(int folderIndex)
        Get the number of AnnotationRef elements in Folder.
        Parameters:
        folderIndex - the Folder index.
        Returns:
        the number of AnnotationRef elements.
      • getImageAnnotationRefCount

        int getImageAnnotationRefCount​(int imageIndex)
        Get the number of AnnotationRef elements in Image.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the number of AnnotationRef elements.
      • getInstrumentAnnotationRefCount

        int getInstrumentAnnotationRefCount​(int instrumentIndex)
        Get the number of AnnotationRef elements in Instrument.
        Parameters:
        instrumentIndex - the Instrument index.
        Returns:
        the number of AnnotationRef elements.
      • getLightPathAnnotationRefCount

        int getLightPathAnnotationRefCount​(int imageIndex,
                                           int channelIndex)
        Get the number of AnnotationRef elements in LightPath.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        Returns:
        the number of AnnotationRef elements.
      • getLightSourceAnnotationRefCount

        int getLightSourceAnnotationRefCount​(int instrumentIndex,
                                             int lightSourceIndex)
        Get the number of AnnotationRef elements in LightSource.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the number of AnnotationRef elements.
      • getObjectiveAnnotationRefCount

        int getObjectiveAnnotationRefCount​(int instrumentIndex,
                                           int objectiveIndex)
        Get the number of AnnotationRef elements in Objective.
        Parameters:
        instrumentIndex - the Instrument index.
        objectiveIndex - the Objective index.
        Returns:
        the number of AnnotationRef elements.
      • getPlaneAnnotationRefCount

        int getPlaneAnnotationRefCount​(int imageIndex,
                                       int planeIndex)
        Get the number of AnnotationRef elements in Plane.
        Parameters:
        imageIndex - the Image index.
        planeIndex - the Plane index.
        Returns:
        the number of AnnotationRef elements.
      • getPlateAnnotationRefCount

        int getPlateAnnotationRefCount​(int plateIndex)
        Get the number of AnnotationRef elements in Plate.
        Parameters:
        plateIndex - the Plate index.
        Returns:
        the number of AnnotationRef elements.
      • getPlateAcquisitionAnnotationRefCount

        int getPlateAcquisitionAnnotationRefCount​(int plateIndex,
                                                  int plateAcquisitionIndex)
        Get the number of AnnotationRef elements in PlateAcquisition.
        Parameters:
        plateIndex - the Plate index.
        plateAcquisitionIndex - the PlateAcquisition index.
        Returns:
        the number of AnnotationRef elements.
      • getProjectAnnotationRefCount

        int getProjectAnnotationRefCount​(int projectIndex)
        Get the number of AnnotationRef elements in Project.
        Parameters:
        projectIndex - the Project index.
        Returns:
        the number of AnnotationRef elements.
      • getROIAnnotationRefCount

        int getROIAnnotationRefCount​(int ROIIndex)
        Get the number of AnnotationRef elements in ROI.
        Parameters:
        ROIIndex - the ROI index.
        Returns:
        the number of AnnotationRef elements.
      • getReagentAnnotationRefCount

        int getReagentAnnotationRefCount​(int screenIndex,
                                         int reagentIndex)
        Get the number of AnnotationRef elements in Reagent.
        Parameters:
        screenIndex - the Screen index.
        reagentIndex - the Reagent index.
        Returns:
        the number of AnnotationRef elements.
      • getScreenAnnotationRefCount

        int getScreenAnnotationRefCount​(int screenIndex)
        Get the number of AnnotationRef elements in Screen.
        Parameters:
        screenIndex - the Screen index.
        Returns:
        the number of AnnotationRef elements.
      • getShapeAnnotationRefCount

        int getShapeAnnotationRefCount​(int ROIIndex,
                                       int shapeIndex)
        Get the number of AnnotationRef elements in Shape.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the number of AnnotationRef elements.
      • getWellAnnotationRefCount

        int getWellAnnotationRefCount​(int plateIndex,
                                      int wellIndex)
        Get the number of AnnotationRef elements in Well.
        Parameters:
        plateIndex - the Plate index.
        wellIndex - the Well index.
        Returns:
        the number of AnnotationRef elements.
      • getPixelsBinDataCount

        int getPixelsBinDataCount​(int imageIndex)
        Get the number of BinData elements in Pixels.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the number of BinData elements.
      • getBooleanAnnotationCount

        int getBooleanAnnotationCount()
        Get the number of BooleanAnnotation elements.
        Returns:
        the number of BooleanAnnotation elements.
      • getChannelCount

        int getChannelCount​(int imageIndex)
        Get the number of Channel elements.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the number of Channel elements.
      • getCommentAnnotationCount

        int getCommentAnnotationCount()
        Get the number of CommentAnnotation elements.
        Returns:
        the number of CommentAnnotation elements.
      • getDatasetCount

        int getDatasetCount()
        Get the number of Dataset elements.
        Returns:
        the number of Dataset elements.
      • getDatasetRefCount

        int getDatasetRefCount​(int projectIndex)
        Get the number of DatasetRef elements.
        Parameters:
        projectIndex - the Project index.
        Returns:
        the number of DatasetRef elements.
      • getDetectorCount

        int getDetectorCount​(int instrumentIndex)
        Get the number of Detector elements.
        Parameters:
        instrumentIndex - the Instrument index.
        Returns:
        the number of Detector elements.
      • getDichroicCount

        int getDichroicCount​(int instrumentIndex)
        Get the number of Dichroic elements.
        Parameters:
        instrumentIndex - the Instrument index.
        Returns:
        the number of Dichroic elements.
      • getDoubleAnnotationCount

        int getDoubleAnnotationCount()
        Get the number of DoubleAnnotation elements.
        Returns:
        the number of DoubleAnnotation elements.
      • getFilterSetEmissionFilterRefCount

        int getFilterSetEmissionFilterRefCount​(int instrumentIndex,
                                               int filterSetIndex)
        Get the number of EmissionFilterRef elements in FilterSet.
        Parameters:
        instrumentIndex - the Instrument index.
        filterSetIndex - the FilterSet index.
        Returns:
        the number of EmissionFilterRef elements.
      • getLightPathEmissionFilterRefCount

        int getLightPathEmissionFilterRefCount​(int imageIndex,
                                               int channelIndex)
        Get the number of EmissionFilterRef elements in LightPath.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        Returns:
        the number of EmissionFilterRef elements.
      • getFilterSetExcitationFilterRefCount

        int getFilterSetExcitationFilterRefCount​(int instrumentIndex,
                                                 int filterSetIndex)
        Get the number of ExcitationFilterRef elements in FilterSet.
        Parameters:
        instrumentIndex - the Instrument index.
        filterSetIndex - the FilterSet index.
        Returns:
        the number of ExcitationFilterRef elements.
      • getLightPathExcitationFilterRefCount

        int getLightPathExcitationFilterRefCount​(int imageIndex,
                                                 int channelIndex)
        Get the number of ExcitationFilterRef elements in LightPath.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        Returns:
        the number of ExcitationFilterRef elements.
      • getExperimentCount

        int getExperimentCount()
        Get the number of Experiment elements.
        Returns:
        the number of Experiment elements.
      • getExperimenterCount

        int getExperimenterCount()
        Get the number of Experimenter elements.
        Returns:
        the number of Experimenter elements.
      • getExperimenterGroupCount

        int getExperimenterGroupCount()
        Get the number of ExperimenterGroup elements.
        Returns:
        the number of ExperimenterGroup elements.
      • getExperimenterGroupExperimenterRefCount

        int getExperimenterGroupExperimenterRefCount​(int experimenterGroupIndex)
        Get the number of ExperimenterRef elements in ExperimenterGroup.
        Parameters:
        experimenterGroupIndex - the ExperimenterGroup index.
        Returns:
        the number of ExperimenterRef elements.
      • getFileAnnotationCount

        int getFileAnnotationCount()
        Get the number of FileAnnotation elements.
        Returns:
        the number of FileAnnotation elements.
      • getFilterCount

        int getFilterCount​(int instrumentIndex)
        Get the number of Filter elements.
        Parameters:
        instrumentIndex - the Instrument index.
        Returns:
        the number of Filter elements.
      • getFilterSetCount

        int getFilterSetCount​(int instrumentIndex)
        Get the number of FilterSet elements.
        Parameters:
        instrumentIndex - the Instrument index.
        Returns:
        the number of FilterSet elements.
      • getFolderCount

        int getFolderCount()
        Get the number of Folder elements.
        Returns:
        the number of Folder elements.
      • getFolderRefCount

        int getFolderRefCount​(int folderIndex)
        Get the number of FolderRef elements.
        Parameters:
        folderIndex - the Folder index.
        Returns:
        the number of FolderRef elements.
      • getImageCount

        int getImageCount()
        Get the number of Image elements.
        Returns:
        the number of Image elements.
      • getDatasetImageRefCount

        int getDatasetImageRefCount​(int datasetIndex)
        Get the number of ImageRef elements in Dataset.
        Parameters:
        datasetIndex - the Dataset index.
        Returns:
        the number of ImageRef elements.
      • getFolderImageRefCount

        int getFolderImageRefCount​(int folderIndex)
        Get the number of ImageRef elements in Folder.
        Parameters:
        folderIndex - the Folder index.
        Returns:
        the number of ImageRef elements.
      • getInstrumentCount

        int getInstrumentCount()
        Get the number of Instrument elements.
        Returns:
        the number of Instrument elements.
      • getLeaderCount

        int getLeaderCount​(int experimenterGroupIndex)
        Get the number of Leader elements.
        Parameters:
        experimenterGroupIndex - the ExperimenterGroup index.
        Returns:
        the number of Leader elements.
      • getMicrobeamManipulationLightSourceSettingsCount

        int getMicrobeamManipulationLightSourceSettingsCount​(int experimentIndex,
                                                             int microbeamManipulationIndex)
        Get the number of LightSourceSettings elements in MicrobeamManipulation.
        Parameters:
        experimentIndex - the Experiment index.
        microbeamManipulationIndex - the MicrobeamManipulation index.
        Returns:
        the number of LightSourceSettings elements.
      • getListAnnotationCount

        int getListAnnotationCount()
        Get the number of ListAnnotation elements.
        Returns:
        the number of ListAnnotation elements.
      • getLongAnnotationCount

        int getLongAnnotationCount()
        Get the number of LongAnnotation elements.
        Returns:
        the number of LongAnnotation elements.
      • getMapAnnotationCount

        int getMapAnnotationCount()
        Get the number of MapAnnotation elements.
        Returns:
        the number of MapAnnotation elements.
      • getMicrobeamManipulationCount

        int getMicrobeamManipulationCount​(int experimentIndex)
        Get the number of MicrobeamManipulation elements.
        Parameters:
        experimentIndex - the Experiment index.
        Returns:
        the number of MicrobeamManipulation elements.
      • getMicrobeamManipulationRefCount

        int getMicrobeamManipulationRefCount​(int imageIndex)
        Get the number of MicrobeamManipulationRef elements.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the number of MicrobeamManipulationRef elements.
      • getObjectiveCount

        int getObjectiveCount​(int instrumentIndex)
        Get the number of Objective elements.
        Parameters:
        instrumentIndex - the Instrument index.
        Returns:
        the number of Objective elements.
      • getPlaneCount

        int getPlaneCount​(int imageIndex)
        Get the number of Plane elements.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the number of Plane elements.
      • getPlateCount

        int getPlateCount()
        Get the number of Plate elements.
        Returns:
        the number of Plate elements.
      • getPlateAcquisitionCount

        int getPlateAcquisitionCount​(int plateIndex)
        Get the number of PlateAcquisition elements.
        Parameters:
        plateIndex - the Plate index.
        Returns:
        the number of PlateAcquisition elements.
      • getPlateRefCount

        int getPlateRefCount​(int screenIndex)
        Get the number of PlateRef elements.
        Parameters:
        screenIndex - the Screen index.
        Returns:
        the number of PlateRef elements.
      • getProjectCount

        int getProjectCount()
        Get the number of Project elements.
        Returns:
        the number of Project elements.
      • getROICount

        int getROICount()
        Get the number of ROI elements.
        Returns:
        the number of ROI elements.
      • getFolderROIRefCount

        int getFolderROIRefCount​(int folderIndex)
        Get the number of ROIRef elements in Folder.
        Parameters:
        folderIndex - the Folder index.
        Returns:
        the number of ROIRef elements.
      • getImageROIRefCount

        int getImageROIRefCount​(int imageIndex)
        Get the number of ROIRef elements in Image.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the number of ROIRef elements.
      • getMicrobeamManipulationROIRefCount

        int getMicrobeamManipulationROIRefCount​(int experimentIndex,
                                                int microbeamManipulationIndex)
        Get the number of ROIRef elements in MicrobeamManipulation.
        Parameters:
        experimentIndex - the Experiment index.
        microbeamManipulationIndex - the MicrobeamManipulation index.
        Returns:
        the number of ROIRef elements.
      • getReagentCount

        int getReagentCount​(int screenIndex)
        Get the number of Reagent elements.
        Parameters:
        screenIndex - the Screen index.
        Returns:
        the number of Reagent elements.
      • getScreenCount

        int getScreenCount()
        Get the number of Screen elements.
        Returns:
        the number of Screen elements.
      • getTagAnnotationCount

        int getTagAnnotationCount()
        Get the number of TagAnnotation elements.
        Returns:
        the number of TagAnnotation elements.
      • getTermAnnotationCount

        int getTermAnnotationCount()
        Get the number of TermAnnotation elements.
        Returns:
        the number of TermAnnotation elements.
      • getTiffDataCount

        int getTiffDataCount​(int imageIndex)
        Get the number of TiffData elements.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the number of TiffData elements.
      • getTimestampAnnotationCount

        int getTimestampAnnotationCount()
        Get the number of TimestampAnnotation elements.
        Returns:
        the number of TimestampAnnotation elements.
      • getUUIDValue

        String getUUIDValue​(int imageIndex,
                            int tiffDataIndex)
        Get the text value of UUID.
        Parameters:
        imageIndex - the Image index.
        tiffDataIndex - the TiffData index.
        Returns:
        the text value.
      • getWellCount

        int getWellCount​(int plateIndex)
        Get the number of Well elements.
        Parameters:
        plateIndex - the Plate index.
        Returns:
        the number of Well elements.
      • getWellSampleCount

        int getWellSampleCount​(int plateIndex,
                               int wellIndex)
        Get the number of WellSample elements.
        Parameters:
        plateIndex - the Plate index.
        wellIndex - the Well index.
        Returns:
        the number of WellSample elements.
      • getWellSampleRefCount

        int getWellSampleRefCount​(int plateIndex,
                                  int plateAcquisitionIndex)
        Get the number of WellSampleRef elements.
        Parameters:
        plateIndex - the Plate index.
        plateAcquisitionIndex - the PlateAcquisition index.
        Returns:
        the number of WellSampleRef elements.
      • getXMLAnnotationCount

        int getXMLAnnotationCount()
        Get the number of XMLAnnotation elements.
        Returns:
        the number of XMLAnnotation elements.
      • getMapAnnotationValue

        List<MapPair> getMapAnnotationValue​(int mapAnnotationIndex)
        Get the values from a MapAnnotation.
        Parameters:
        mapAnnotationIndex - the MapAnnotation index.
        Returns:
        the MapAnnotation values.
      • getGenericExcitationSourceMap

        List<MapPair> getGenericExcitationSourceMap​(int instrumentIndex,
                                                    int lightSourceIndex)
        Get the MapAnnotation values from a GenericExcitationSource.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the MapAnnotation values.
      • getImagingEnvironmentMap

        List<MapPair> getImagingEnvironmentMap​(int imageIndex)
        Get the MapAnnotation values from a ImagingEnvironment.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the MapAnnotation values.
      • getUUID

        String getUUID()
        Get the UUID associated with this collection of metadata.
        Returns:
        the UUID.
      • getCreator

        default String getCreator()
        Gets the Creator associated with this collection of metadata.
      • getArcAnnotationRef

        String getArcAnnotationRef​(int instrumentIndex,
                                   int lightSourceIndex,
                                   int annotationRefIndex)
        Get the AnnotationRef property of Arc.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getArcID

        String getArcID​(int instrumentIndex,
                        int lightSourceIndex)
        Get the ID property of Arc.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the ID property.
      • getArcLotNumber

        String getArcLotNumber​(int instrumentIndex,
                               int lightSourceIndex)
        Get the LotNumber property of Arc.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the LotNumber property.
      • getArcManufacturer

        String getArcManufacturer​(int instrumentIndex,
                                  int lightSourceIndex)
        Get the Manufacturer property of Arc.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the Manufacturer property.
      • getArcModel

        String getArcModel​(int instrumentIndex,
                           int lightSourceIndex)
        Get the Model property of Arc.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the Model property.
      • getArcPower

        Power getArcPower​(int instrumentIndex,
                          int lightSourceIndex)
        Get the Power property of Arc.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the Power property.
      • getArcSerialNumber

        String getArcSerialNumber​(int instrumentIndex,
                                  int lightSourceIndex)
        Get the SerialNumber property of Arc.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the SerialNumber property.
      • getArcType

        ArcType getArcType​(int instrumentIndex,
                           int lightSourceIndex)
        Get the Type property of Arc.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the Type property.
      • getBinaryFileBinData

        byte[] getBinaryFileBinData​(int fileAnnotationIndex)
        Get the Base64Binary property of BinData.
        Parameters:
        fileAnnotationIndex - the FileAnnotation index.
        Returns:
        the Base64Binary property.
      • getMaskBinData

        byte[] getMaskBinData​(int ROIIndex,
                              int shapeIndex)
        Get the Base64Binary property of BinData.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Base64Binary property.
      • getPixelsBinData

        byte[] getPixelsBinData​(int imageIndex,
                                int binDataIndex)
        Get the Base64Binary property of BinData.
        Parameters:
        imageIndex - the Image index.
        binDataIndex - the BinData index.
        Returns:
        the Base64Binary property.
      • getBinaryFileBinDataBigEndian

        Boolean getBinaryFileBinDataBigEndian​(int fileAnnotationIndex)
        Get the BigEndian property of BinData.
        Parameters:
        fileAnnotationIndex - the FileAnnotation index.
        Returns:
        the BigEndian property.
      • getMaskBinDataBigEndian

        Boolean getMaskBinDataBigEndian​(int ROIIndex,
                                        int shapeIndex)
        Get the BigEndian property of BinData.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the BigEndian property.
      • getPixelsBinDataBigEndian

        Boolean getPixelsBinDataBigEndian​(int imageIndex,
                                          int binDataIndex)
        Get the BigEndian property of BinData.
        Parameters:
        imageIndex - the Image index.
        binDataIndex - the BinData index.
        Returns:
        the BigEndian property.
      • getBinaryFileBinDataCompression

        Compression getBinaryFileBinDataCompression​(int fileAnnotationIndex)
        Get the Compression property of BinData.
        Parameters:
        fileAnnotationIndex - the FileAnnotation index.
        Returns:
        the Compression property.
      • getMaskBinDataCompression

        Compression getMaskBinDataCompression​(int ROIIndex,
                                              int shapeIndex)
        Get the Compression property of BinData.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Compression property.
      • getPixelsBinDataCompression

        Compression getPixelsBinDataCompression​(int imageIndex,
                                                int binDataIndex)
        Get the Compression property of BinData.
        Parameters:
        imageIndex - the Image index.
        binDataIndex - the BinData index.
        Returns:
        the Compression property.
      • getBinaryFileBinDataLength

        NonNegativeLong getBinaryFileBinDataLength​(int fileAnnotationIndex)
        Get the Length property of BinData.
        Parameters:
        fileAnnotationIndex - the FileAnnotation index.
        Returns:
        the Length property.
      • getMaskBinDataLength

        NonNegativeLong getMaskBinDataLength​(int ROIIndex,
                                             int shapeIndex)
        Get the Length property of BinData.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Length property.
      • getPixelsBinDataLength

        NonNegativeLong getPixelsBinDataLength​(int imageIndex,
                                               int binDataIndex)
        Get the Length property of BinData.
        Parameters:
        imageIndex - the Image index.
        binDataIndex - the BinData index.
        Returns:
        the Length property.
      • getBinaryFileFileName

        String getBinaryFileFileName​(int fileAnnotationIndex)
        Get the FileName property of BinaryFile.
        Parameters:
        fileAnnotationIndex - the FileAnnotation index.
        Returns:
        the FileName property.
      • getBinaryFileMIMEType

        String getBinaryFileMIMEType​(int fileAnnotationIndex)
        Get the MIMEType property of BinaryFile.
        Parameters:
        fileAnnotationIndex - the FileAnnotation index.
        Returns:
        the MIMEType property.
      • getBinaryFileSize

        NonNegativeLong getBinaryFileSize​(int fileAnnotationIndex)
        Get the Size property of BinaryFile.
        Parameters:
        fileAnnotationIndex - the FileAnnotation index.
        Returns:
        the Size property.
      • getBinaryOnlyMetadataFile

        String getBinaryOnlyMetadataFile()
        Get the MetadataFile property of BinaryOnly.
        Returns:
        the MetadataFile property.
      • getBinaryOnlyUUID

        String getBinaryOnlyUUID()
        Get the UUID property of BinaryOnly.
        Returns:
        the UUID property.
      • getBooleanAnnotationAnnotationRef

        String getBooleanAnnotationAnnotationRef​(int booleanAnnotationIndex,
                                                 int annotationRefIndex)
        Get the AnnotationRef property of BooleanAnnotation.
        Parameters:
        booleanAnnotationIndex - the BooleanAnnotation index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getBooleanAnnotationAnnotator

        String getBooleanAnnotationAnnotator​(int booleanAnnotationIndex)
        Get the Annotator property of BooleanAnnotation.
        Parameters:
        booleanAnnotationIndex - the BooleanAnnotation index.
        Returns:
        the Annotator property.
      • getBooleanAnnotationDescription

        String getBooleanAnnotationDescription​(int booleanAnnotationIndex)
        Get the Description property of BooleanAnnotation.
        Parameters:
        booleanAnnotationIndex - the BooleanAnnotation index.
        Returns:
        the Description property.
      • getBooleanAnnotationID

        String getBooleanAnnotationID​(int booleanAnnotationIndex)
        Get the ID property of BooleanAnnotation.
        Parameters:
        booleanAnnotationIndex - the BooleanAnnotation index.
        Returns:
        the ID property.
      • getBooleanAnnotationNamespace

        String getBooleanAnnotationNamespace​(int booleanAnnotationIndex)
        Get the Namespace property of BooleanAnnotation.
        Parameters:
        booleanAnnotationIndex - the BooleanAnnotation index.
        Returns:
        the Namespace property.
      • getBooleanAnnotationValue

        Boolean getBooleanAnnotationValue​(int booleanAnnotationIndex)
        Get the Value property of BooleanAnnotation.
        Parameters:
        booleanAnnotationIndex - the BooleanAnnotation index.
        Returns:
        the Value property.
      • getChannelAcquisitionMode

        AcquisitionMode getChannelAcquisitionMode​(int imageIndex,
                                                  int channelIndex)
        Get the AcquisitionMode property of Channel.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        Returns:
        the AcquisitionMode property.
      • getChannelAnnotationRef

        String getChannelAnnotationRef​(int imageIndex,
                                       int channelIndex,
                                       int annotationRefIndex)
        Get the AnnotationRef property of Channel.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getChannelColor

        Color getChannelColor​(int imageIndex,
                              int channelIndex)
        Get the Color property of Channel.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        Returns:
        the Color property.
      • getChannelContrastMethod

        ContrastMethod getChannelContrastMethod​(int imageIndex,
                                                int channelIndex)
        Get the ContrastMethod property of Channel.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        Returns:
        the ContrastMethod property.
      • getChannelEmissionWavelength

        Length getChannelEmissionWavelength​(int imageIndex,
                                            int channelIndex)
        Get the EmissionWavelength property of Channel.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        Returns:
        the EmissionWavelength property.
      • getChannelExcitationWavelength

        Length getChannelExcitationWavelength​(int imageIndex,
                                              int channelIndex)
        Get the ExcitationWavelength property of Channel.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        Returns:
        the ExcitationWavelength property.
      • getChannelFilterSetRef

        String getChannelFilterSetRef​(int imageIndex,
                                      int channelIndex)
        Get the FilterSetRef property of Channel.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        Returns:
        the FilterSetRef property.
      • getChannelFluor

        String getChannelFluor​(int imageIndex,
                               int channelIndex)
        Get the Fluor property of Channel.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        Returns:
        the Fluor property.
      • getChannelID

        String getChannelID​(int imageIndex,
                            int channelIndex)
        Get the ID property of Channel.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        Returns:
        the ID property.
      • getChannelIlluminationType

        IlluminationType getChannelIlluminationType​(int imageIndex,
                                                    int channelIndex)
        Get the IlluminationType property of Channel.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        Returns:
        the IlluminationType property.
      • getChannelNDFilter

        Double getChannelNDFilter​(int imageIndex,
                                  int channelIndex)
        Get the NDFilter property of Channel.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        Returns:
        the NDFilter property.
      • getChannelName

        String getChannelName​(int imageIndex,
                              int channelIndex)
        Get the Name property of Channel.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        Returns:
        the Name property.
      • getChannelPinholeSize

        Length getChannelPinholeSize​(int imageIndex,
                                     int channelIndex)
        Get the PinholeSize property of Channel.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        Returns:
        the PinholeSize property.
      • getChannelPockelCellSetting

        Integer getChannelPockelCellSetting​(int imageIndex,
                                            int channelIndex)
        Get the PockelCellSetting property of Channel.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        Returns:
        the PockelCellSetting property.
      • getChannelSamplesPerPixel

        PositiveInteger getChannelSamplesPerPixel​(int imageIndex,
                                                  int channelIndex)
        Get the SamplesPerPixel property of Channel.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        Returns:
        the SamplesPerPixel property.
      • getCommentAnnotationAnnotationRef

        String getCommentAnnotationAnnotationRef​(int commentAnnotationIndex,
                                                 int annotationRefIndex)
        Get the AnnotationRef property of CommentAnnotation.
        Parameters:
        commentAnnotationIndex - the CommentAnnotation index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getCommentAnnotationAnnotator

        String getCommentAnnotationAnnotator​(int commentAnnotationIndex)
        Get the Annotator property of CommentAnnotation.
        Parameters:
        commentAnnotationIndex - the CommentAnnotation index.
        Returns:
        the Annotator property.
      • getCommentAnnotationDescription

        String getCommentAnnotationDescription​(int commentAnnotationIndex)
        Get the Description property of CommentAnnotation.
        Parameters:
        commentAnnotationIndex - the CommentAnnotation index.
        Returns:
        the Description property.
      • getCommentAnnotationID

        String getCommentAnnotationID​(int commentAnnotationIndex)
        Get the ID property of CommentAnnotation.
        Parameters:
        commentAnnotationIndex - the CommentAnnotation index.
        Returns:
        the ID property.
      • getCommentAnnotationNamespace

        String getCommentAnnotationNamespace​(int commentAnnotationIndex)
        Get the Namespace property of CommentAnnotation.
        Parameters:
        commentAnnotationIndex - the CommentAnnotation index.
        Returns:
        the Namespace property.
      • getCommentAnnotationValue

        String getCommentAnnotationValue​(int commentAnnotationIndex)
        Get the Value property of CommentAnnotation.
        Parameters:
        commentAnnotationIndex - the CommentAnnotation index.
        Returns:
        the Value property.
      • getDatasetAnnotationRef

        String getDatasetAnnotationRef​(int datasetIndex,
                                       int annotationRefIndex)
        Get the AnnotationRef property of Dataset.
        Parameters:
        datasetIndex - the Dataset index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getDatasetDescription

        String getDatasetDescription​(int datasetIndex)
        Get the Description property of Dataset.
        Parameters:
        datasetIndex - the Dataset index.
        Returns:
        the Description property.
      • getDatasetExperimenterGroupRef

        String getDatasetExperimenterGroupRef​(int datasetIndex)
        Get the ExperimenterGroupRef property of Dataset.
        Parameters:
        datasetIndex - the Dataset index.
        Returns:
        the ExperimenterGroupRef property.
      • getDatasetExperimenterRef

        String getDatasetExperimenterRef​(int datasetIndex)
        Get the ExperimenterRef property of Dataset.
        Parameters:
        datasetIndex - the Dataset index.
        Returns:
        the ExperimenterRef property.
      • getDatasetID

        String getDatasetID​(int datasetIndex)
        Get the ID property of Dataset.
        Parameters:
        datasetIndex - the Dataset index.
        Returns:
        the ID property.
      • getDatasetImageRef

        String getDatasetImageRef​(int datasetIndex,
                                  int imageRefIndex)
        Get the ImageRef property of Dataset.
        Parameters:
        datasetIndex - the Dataset index.
        imageRefIndex - ImageRef index.
        Returns:
        the ImageRef property.
      • getDatasetName

        String getDatasetName​(int datasetIndex)
        Get the Name property of Dataset.
        Parameters:
        datasetIndex - the Dataset index.
        Returns:
        the Name property.
      • getDetectorAmplificationGain

        Double getDetectorAmplificationGain​(int instrumentIndex,
                                            int detectorIndex)
        Get the AmplificationGain property of Detector.
        Parameters:
        instrumentIndex - the Instrument index.
        detectorIndex - the Detector index.
        Returns:
        the AmplificationGain property.
      • getDetectorAnnotationRef

        String getDetectorAnnotationRef​(int instrumentIndex,
                                        int detectorIndex,
                                        int annotationRefIndex)
        Get the AnnotationRef property of Detector.
        Parameters:
        instrumentIndex - the Instrument index.
        detectorIndex - the Detector index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getDetectorGain

        Double getDetectorGain​(int instrumentIndex,
                               int detectorIndex)
        Get the Gain property of Detector.
        Parameters:
        instrumentIndex - the Instrument index.
        detectorIndex - the Detector index.
        Returns:
        the Gain property.
      • getDetectorID

        String getDetectorID​(int instrumentIndex,
                             int detectorIndex)
        Get the ID property of Detector.
        Parameters:
        instrumentIndex - the Instrument index.
        detectorIndex - the Detector index.
        Returns:
        the ID property.
      • getDetectorLotNumber

        String getDetectorLotNumber​(int instrumentIndex,
                                    int detectorIndex)
        Get the LotNumber property of Detector.
        Parameters:
        instrumentIndex - the Instrument index.
        detectorIndex - the Detector index.
        Returns:
        the LotNumber property.
      • getDetectorManufacturer

        String getDetectorManufacturer​(int instrumentIndex,
                                       int detectorIndex)
        Get the Manufacturer property of Detector.
        Parameters:
        instrumentIndex - the Instrument index.
        detectorIndex - the Detector index.
        Returns:
        the Manufacturer property.
      • getDetectorModel

        String getDetectorModel​(int instrumentIndex,
                                int detectorIndex)
        Get the Model property of Detector.
        Parameters:
        instrumentIndex - the Instrument index.
        detectorIndex - the Detector index.
        Returns:
        the Model property.
      • getDetectorOffset

        Double getDetectorOffset​(int instrumentIndex,
                                 int detectorIndex)
        Get the Offset property of Detector.
        Parameters:
        instrumentIndex - the Instrument index.
        detectorIndex - the Detector index.
        Returns:
        the Offset property.
      • getDetectorSerialNumber

        String getDetectorSerialNumber​(int instrumentIndex,
                                       int detectorIndex)
        Get the SerialNumber property of Detector.
        Parameters:
        instrumentIndex - the Instrument index.
        detectorIndex - the Detector index.
        Returns:
        the SerialNumber property.
      • getDetectorType

        DetectorType getDetectorType​(int instrumentIndex,
                                     int detectorIndex)
        Get the Type property of Detector.
        Parameters:
        instrumentIndex - the Instrument index.
        detectorIndex - the Detector index.
        Returns:
        the Type property.
      • getDetectorVoltage

        ElectricPotential getDetectorVoltage​(int instrumentIndex,
                                             int detectorIndex)
        Get the Voltage property of Detector.
        Parameters:
        instrumentIndex - the Instrument index.
        detectorIndex - the Detector index.
        Returns:
        the Voltage property.
      • getDetectorZoom

        Double getDetectorZoom​(int instrumentIndex,
                               int detectorIndex)
        Get the Zoom property of Detector.
        Parameters:
        instrumentIndex - the Instrument index.
        detectorIndex - the Detector index.
        Returns:
        the Zoom property.
      • getDetectorSettingsBinning

        Binning getDetectorSettingsBinning​(int imageIndex,
                                           int channelIndex)
        Get the Binning property of DetectorSettings.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        Returns:
        the Binning property.
      • getDetectorSettingsGain

        Double getDetectorSettingsGain​(int imageIndex,
                                       int channelIndex)
        Get the Gain property of DetectorSettings.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        Returns:
        the Gain property.
      • getDetectorSettingsID

        String getDetectorSettingsID​(int imageIndex,
                                     int channelIndex)
        Get the ID property of DetectorSettings.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        Returns:
        the ID property.
      • getDetectorSettingsIntegration

        PositiveInteger getDetectorSettingsIntegration​(int imageIndex,
                                                       int channelIndex)
        Get the Integration property of DetectorSettings.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        Returns:
        the Integration property.
      • getDetectorSettingsOffset

        Double getDetectorSettingsOffset​(int imageIndex,
                                         int channelIndex)
        Get the Offset property of DetectorSettings.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        Returns:
        the Offset property.
      • getDetectorSettingsReadOutRate

        Frequency getDetectorSettingsReadOutRate​(int imageIndex,
                                                 int channelIndex)
        Get the ReadOutRate property of DetectorSettings.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        Returns:
        the ReadOutRate property.
      • getDetectorSettingsVoltage

        ElectricPotential getDetectorSettingsVoltage​(int imageIndex,
                                                     int channelIndex)
        Get the Voltage property of DetectorSettings.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        Returns:
        the Voltage property.
      • getDetectorSettingsZoom

        Double getDetectorSettingsZoom​(int imageIndex,
                                       int channelIndex)
        Get the Zoom property of DetectorSettings.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        Returns:
        the Zoom property.
      • getDichroicAnnotationRef

        String getDichroicAnnotationRef​(int instrumentIndex,
                                        int dichroicIndex,
                                        int annotationRefIndex)
        Get the AnnotationRef property of Dichroic.
        Parameters:
        instrumentIndex - the Instrument index.
        dichroicIndex - the Dichroic index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getDichroicID

        String getDichroicID​(int instrumentIndex,
                             int dichroicIndex)
        Get the ID property of Dichroic.
        Parameters:
        instrumentIndex - the Instrument index.
        dichroicIndex - the Dichroic index.
        Returns:
        the ID property.
      • getDichroicLotNumber

        String getDichroicLotNumber​(int instrumentIndex,
                                    int dichroicIndex)
        Get the LotNumber property of Dichroic.
        Parameters:
        instrumentIndex - the Instrument index.
        dichroicIndex - the Dichroic index.
        Returns:
        the LotNumber property.
      • getDichroicManufacturer

        String getDichroicManufacturer​(int instrumentIndex,
                                       int dichroicIndex)
        Get the Manufacturer property of Dichroic.
        Parameters:
        instrumentIndex - the Instrument index.
        dichroicIndex - the Dichroic index.
        Returns:
        the Manufacturer property.
      • getDichroicModel

        String getDichroicModel​(int instrumentIndex,
                                int dichroicIndex)
        Get the Model property of Dichroic.
        Parameters:
        instrumentIndex - the Instrument index.
        dichroicIndex - the Dichroic index.
        Returns:
        the Model property.
      • getDichroicSerialNumber

        String getDichroicSerialNumber​(int instrumentIndex,
                                       int dichroicIndex)
        Get the SerialNumber property of Dichroic.
        Parameters:
        instrumentIndex - the Instrument index.
        dichroicIndex - the Dichroic index.
        Returns:
        the SerialNumber property.
      • getDoubleAnnotationAnnotationRef

        String getDoubleAnnotationAnnotationRef​(int doubleAnnotationIndex,
                                                int annotationRefIndex)
        Get the AnnotationRef property of DoubleAnnotation.
        Parameters:
        doubleAnnotationIndex - the DoubleAnnotation index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getDoubleAnnotationAnnotator

        String getDoubleAnnotationAnnotator​(int doubleAnnotationIndex)
        Get the Annotator property of DoubleAnnotation.
        Parameters:
        doubleAnnotationIndex - the DoubleAnnotation index.
        Returns:
        the Annotator property.
      • getDoubleAnnotationDescription

        String getDoubleAnnotationDescription​(int doubleAnnotationIndex)
        Get the Description property of DoubleAnnotation.
        Parameters:
        doubleAnnotationIndex - the DoubleAnnotation index.
        Returns:
        the Description property.
      • getDoubleAnnotationID

        String getDoubleAnnotationID​(int doubleAnnotationIndex)
        Get the ID property of DoubleAnnotation.
        Parameters:
        doubleAnnotationIndex - the DoubleAnnotation index.
        Returns:
        the ID property.
      • getDoubleAnnotationNamespace

        String getDoubleAnnotationNamespace​(int doubleAnnotationIndex)
        Get the Namespace property of DoubleAnnotation.
        Parameters:
        doubleAnnotationIndex - the DoubleAnnotation index.
        Returns:
        the Namespace property.
      • getDoubleAnnotationValue

        Double getDoubleAnnotationValue​(int doubleAnnotationIndex)
        Get the Value property of DoubleAnnotation.
        Parameters:
        doubleAnnotationIndex - the DoubleAnnotation index.
        Returns:
        the Value property.
      • getEllipseAnnotationRef

        String getEllipseAnnotationRef​(int ROIIndex,
                                       int shapeIndex,
                                       int annotationRefIndex)
        Get the AnnotationRef property of Ellipse.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getEllipseFillColor

        Color getEllipseFillColor​(int ROIIndex,
                                  int shapeIndex)
        Get the FillColor property of Ellipse.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FillColor property.
      • getEllipseFillRule

        FillRule getEllipseFillRule​(int ROIIndex,
                                    int shapeIndex)
        Get the FillRule property of Ellipse.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FillRule property.
      • getEllipseFontFamily

        FontFamily getEllipseFontFamily​(int ROIIndex,
                                        int shapeIndex)
        Get the FontFamily property of Ellipse.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FontFamily property.
      • getEllipseFontSize

        Length getEllipseFontSize​(int ROIIndex,
                                  int shapeIndex)
        Get the FontSize property of Ellipse.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FontSize property.
      • getEllipseFontStyle

        FontStyle getEllipseFontStyle​(int ROIIndex,
                                      int shapeIndex)
        Get the FontStyle property of Ellipse.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FontStyle property.
      • getEllipseID

        String getEllipseID​(int ROIIndex,
                            int shapeIndex)
        Get the ID property of Ellipse.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the ID property.
      • getEllipseLocked

        Boolean getEllipseLocked​(int ROIIndex,
                                 int shapeIndex)
        Get the Locked property of Ellipse.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Locked property.
      • getEllipseRadiusX

        Double getEllipseRadiusX​(int ROIIndex,
                                 int shapeIndex)
        Get the RadiusX property of Ellipse.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the RadiusX property.
      • getEllipseRadiusY

        Double getEllipseRadiusY​(int ROIIndex,
                                 int shapeIndex)
        Get the RadiusY property of Ellipse.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the RadiusY property.
      • getEllipseStrokeColor

        Color getEllipseStrokeColor​(int ROIIndex,
                                    int shapeIndex)
        Get the StrokeColor property of Ellipse.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the StrokeColor property.
      • getEllipseStrokeDashArray

        String getEllipseStrokeDashArray​(int ROIIndex,
                                         int shapeIndex)
        Get the StrokeDashArray property of Ellipse.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the StrokeDashArray property.
      • getEllipseStrokeWidth

        Length getEllipseStrokeWidth​(int ROIIndex,
                                     int shapeIndex)
        Get the StrokeWidth property of Ellipse.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the StrokeWidth property.
      • getEllipseText

        String getEllipseText​(int ROIIndex,
                              int shapeIndex)
        Get the Text property of Ellipse.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Text property.
      • getEllipseTheC

        NonNegativeInteger getEllipseTheC​(int ROIIndex,
                                          int shapeIndex)
        Get the TheC property of Ellipse.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the TheC property.
      • getEllipseTheT

        NonNegativeInteger getEllipseTheT​(int ROIIndex,
                                          int shapeIndex)
        Get the TheT property of Ellipse.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the TheT property.
      • getEllipseTheZ

        NonNegativeInteger getEllipseTheZ​(int ROIIndex,
                                          int shapeIndex)
        Get the TheZ property of Ellipse.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the TheZ property.
      • getEllipseTransform

        AffineTransform getEllipseTransform​(int ROIIndex,
                                            int shapeIndex)
        Get the Transform property of Ellipse.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Transform property.
      • getEllipseX

        Double getEllipseX​(int ROIIndex,
                           int shapeIndex)
        Get the X property of Ellipse.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the X property.
      • getEllipseY

        Double getEllipseY​(int ROIIndex,
                           int shapeIndex)
        Get the Y property of Ellipse.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Y property.
      • getExperimentDescription

        String getExperimentDescription​(int experimentIndex)
        Get the Description property of Experiment.
        Parameters:
        experimentIndex - the Experiment index.
        Returns:
        the Description property.
      • getExperimentExperimenterRef

        String getExperimentExperimenterRef​(int experimentIndex)
        Get the ExperimenterRef property of Experiment.
        Parameters:
        experimentIndex - the Experiment index.
        Returns:
        the ExperimenterRef property.
      • getExperimentID

        String getExperimentID​(int experimentIndex)
        Get the ID property of Experiment.
        Parameters:
        experimentIndex - the Experiment index.
        Returns:
        the ID property.
      • getExperimentType

        ExperimentType getExperimentType​(int experimentIndex)
        Get the Type property of Experiment.
        Parameters:
        experimentIndex - the Experiment index.
        Returns:
        the Type property.
      • getExperimenterAnnotationRef

        String getExperimenterAnnotationRef​(int experimenterIndex,
                                            int annotationRefIndex)
        Get the AnnotationRef property of Experimenter.
        Parameters:
        experimenterIndex - the Experimenter index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getExperimenterEmail

        String getExperimenterEmail​(int experimenterIndex)
        Get the Email property of Experimenter.
        Parameters:
        experimenterIndex - the Experimenter index.
        Returns:
        the Email property.
      • getExperimenterFirstName

        String getExperimenterFirstName​(int experimenterIndex)
        Get the FirstName property of Experimenter.
        Parameters:
        experimenterIndex - the Experimenter index.
        Returns:
        the FirstName property.
      • getExperimenterID

        String getExperimenterID​(int experimenterIndex)
        Get the ID property of Experimenter.
        Parameters:
        experimenterIndex - the Experimenter index.
        Returns:
        the ID property.
      • getExperimenterInstitution

        String getExperimenterInstitution​(int experimenterIndex)
        Get the Institution property of Experimenter.
        Parameters:
        experimenterIndex - the Experimenter index.
        Returns:
        the Institution property.
      • getExperimenterLastName

        String getExperimenterLastName​(int experimenterIndex)
        Get the LastName property of Experimenter.
        Parameters:
        experimenterIndex - the Experimenter index.
        Returns:
        the LastName property.
      • getExperimenterMiddleName

        String getExperimenterMiddleName​(int experimenterIndex)
        Get the MiddleName property of Experimenter.
        Parameters:
        experimenterIndex - the Experimenter index.
        Returns:
        the MiddleName property.
      • getExperimenterUserName

        String getExperimenterUserName​(int experimenterIndex)
        Get the UserName property of Experimenter.
        Parameters:
        experimenterIndex - the Experimenter index.
        Returns:
        the UserName property.
      • getExperimenterGroupAnnotationRef

        String getExperimenterGroupAnnotationRef​(int experimenterGroupIndex,
                                                 int annotationRefIndex)
        Get the AnnotationRef property of ExperimenterGroup.
        Parameters:
        experimenterGroupIndex - the ExperimenterGroup index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getExperimenterGroupDescription

        String getExperimenterGroupDescription​(int experimenterGroupIndex)
        Get the Description property of ExperimenterGroup.
        Parameters:
        experimenterGroupIndex - the ExperimenterGroup index.
        Returns:
        the Description property.
      • getExperimenterGroupExperimenterRef

        String getExperimenterGroupExperimenterRef​(int experimenterGroupIndex,
                                                   int experimenterRefIndex)
        Get the ExperimenterRef property of ExperimenterGroup.
        Parameters:
        experimenterGroupIndex - the ExperimenterGroup index.
        experimenterRefIndex - ExperimenterRef index.
        Returns:
        the ExperimenterRef property.
      • getExperimenterGroupID

        String getExperimenterGroupID​(int experimenterGroupIndex)
        Get the ID property of ExperimenterGroup.
        Parameters:
        experimenterGroupIndex - the ExperimenterGroup index.
        Returns:
        the ID property.
      • getExperimenterGroupLeader

        String getExperimenterGroupLeader​(int experimenterGroupIndex,
                                          int leaderIndex)
        Get the Leader property of ExperimenterGroup.
        Parameters:
        experimenterGroupIndex - the ExperimenterGroup index.
        leaderIndex - Leader index.
        Returns:
        the Leader property.
      • getExperimenterGroupName

        String getExperimenterGroupName​(int experimenterGroupIndex)
        Get the Name property of ExperimenterGroup.
        Parameters:
        experimenterGroupIndex - the ExperimenterGroup index.
        Returns:
        the Name property.
      • getFilamentAnnotationRef

        String getFilamentAnnotationRef​(int instrumentIndex,
                                        int lightSourceIndex,
                                        int annotationRefIndex)
        Get the AnnotationRef property of Filament.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getFilamentID

        String getFilamentID​(int instrumentIndex,
                             int lightSourceIndex)
        Get the ID property of Filament.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the ID property.
      • getFilamentLotNumber

        String getFilamentLotNumber​(int instrumentIndex,
                                    int lightSourceIndex)
        Get the LotNumber property of Filament.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the LotNumber property.
      • getFilamentManufacturer

        String getFilamentManufacturer​(int instrumentIndex,
                                       int lightSourceIndex)
        Get the Manufacturer property of Filament.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the Manufacturer property.
      • getFilamentModel

        String getFilamentModel​(int instrumentIndex,
                                int lightSourceIndex)
        Get the Model property of Filament.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the Model property.
      • getFilamentPower

        Power getFilamentPower​(int instrumentIndex,
                               int lightSourceIndex)
        Get the Power property of Filament.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the Power property.
      • getFilamentSerialNumber

        String getFilamentSerialNumber​(int instrumentIndex,
                                       int lightSourceIndex)
        Get the SerialNumber property of Filament.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the SerialNumber property.
      • getFilamentType

        FilamentType getFilamentType​(int instrumentIndex,
                                     int lightSourceIndex)
        Get the Type property of Filament.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the Type property.
      • getFileAnnotationAnnotationRef

        String getFileAnnotationAnnotationRef​(int fileAnnotationIndex,
                                              int annotationRefIndex)
        Get the AnnotationRef property of FileAnnotation.
        Parameters:
        fileAnnotationIndex - the FileAnnotation index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getFileAnnotationAnnotator

        String getFileAnnotationAnnotator​(int fileAnnotationIndex)
        Get the Annotator property of FileAnnotation.
        Parameters:
        fileAnnotationIndex - the FileAnnotation index.
        Returns:
        the Annotator property.
      • getFileAnnotationDescription

        String getFileAnnotationDescription​(int fileAnnotationIndex)
        Get the Description property of FileAnnotation.
        Parameters:
        fileAnnotationIndex - the FileAnnotation index.
        Returns:
        the Description property.
      • getFileAnnotationID

        String getFileAnnotationID​(int fileAnnotationIndex)
        Get the ID property of FileAnnotation.
        Parameters:
        fileAnnotationIndex - the FileAnnotation index.
        Returns:
        the ID property.
      • getFileAnnotationNamespace

        String getFileAnnotationNamespace​(int fileAnnotationIndex)
        Get the Namespace property of FileAnnotation.
        Parameters:
        fileAnnotationIndex - the FileAnnotation index.
        Returns:
        the Namespace property.
      • getFilterAnnotationRef

        String getFilterAnnotationRef​(int instrumentIndex,
                                      int filterIndex,
                                      int annotationRefIndex)
        Get the AnnotationRef property of Filter.
        Parameters:
        instrumentIndex - the Instrument index.
        filterIndex - the Filter index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getFilterFilterWheel

        String getFilterFilterWheel​(int instrumentIndex,
                                    int filterIndex)
        Get the FilterWheel property of Filter.
        Parameters:
        instrumentIndex - the Instrument index.
        filterIndex - the Filter index.
        Returns:
        the FilterWheel property.
      • getFilterID

        String getFilterID​(int instrumentIndex,
                           int filterIndex)
        Get the ID property of Filter.
        Parameters:
        instrumentIndex - the Instrument index.
        filterIndex - the Filter index.
        Returns:
        the ID property.
      • getFilterLotNumber

        String getFilterLotNumber​(int instrumentIndex,
                                  int filterIndex)
        Get the LotNumber property of Filter.
        Parameters:
        instrumentIndex - the Instrument index.
        filterIndex - the Filter index.
        Returns:
        the LotNumber property.
      • getFilterManufacturer

        String getFilterManufacturer​(int instrumentIndex,
                                     int filterIndex)
        Get the Manufacturer property of Filter.
        Parameters:
        instrumentIndex - the Instrument index.
        filterIndex - the Filter index.
        Returns:
        the Manufacturer property.
      • getFilterModel

        String getFilterModel​(int instrumentIndex,
                              int filterIndex)
        Get the Model property of Filter.
        Parameters:
        instrumentIndex - the Instrument index.
        filterIndex - the Filter index.
        Returns:
        the Model property.
      • getFilterSerialNumber

        String getFilterSerialNumber​(int instrumentIndex,
                                     int filterIndex)
        Get the SerialNumber property of Filter.
        Parameters:
        instrumentIndex - the Instrument index.
        filterIndex - the Filter index.
        Returns:
        the SerialNumber property.
      • getFilterType

        FilterType getFilterType​(int instrumentIndex,
                                 int filterIndex)
        Get the Type property of Filter.
        Parameters:
        instrumentIndex - the Instrument index.
        filterIndex - the Filter index.
        Returns:
        the Type property.
      • getFilterSetDichroicRef

        String getFilterSetDichroicRef​(int instrumentIndex,
                                       int filterSetIndex)
        Get the DichroicRef property of FilterSet.
        Parameters:
        instrumentIndex - the Instrument index.
        filterSetIndex - the FilterSet index.
        Returns:
        the DichroicRef property.
      • getFilterSetEmissionFilterRef

        String getFilterSetEmissionFilterRef​(int instrumentIndex,
                                             int filterSetIndex,
                                             int emissionFilterRefIndex)
        Get the EmissionFilterRef property of FilterSet.
        Parameters:
        instrumentIndex - the Instrument index.
        filterSetIndex - the FilterSet index.
        emissionFilterRefIndex - EmissionFilterRef index.
        Returns:
        the EmissionFilterRef property.
      • getFilterSetExcitationFilterRef

        String getFilterSetExcitationFilterRef​(int instrumentIndex,
                                               int filterSetIndex,
                                               int excitationFilterRefIndex)
        Get the ExcitationFilterRef property of FilterSet.
        Parameters:
        instrumentIndex - the Instrument index.
        filterSetIndex - the FilterSet index.
        excitationFilterRefIndex - ExcitationFilterRef index.
        Returns:
        the ExcitationFilterRef property.
      • getFilterSetID

        String getFilterSetID​(int instrumentIndex,
                              int filterSetIndex)
        Get the ID property of FilterSet.
        Parameters:
        instrumentIndex - the Instrument index.
        filterSetIndex - the FilterSet index.
        Returns:
        the ID property.
      • getFilterSetLotNumber

        String getFilterSetLotNumber​(int instrumentIndex,
                                     int filterSetIndex)
        Get the LotNumber property of FilterSet.
        Parameters:
        instrumentIndex - the Instrument index.
        filterSetIndex - the FilterSet index.
        Returns:
        the LotNumber property.
      • getFilterSetManufacturer

        String getFilterSetManufacturer​(int instrumentIndex,
                                        int filterSetIndex)
        Get the Manufacturer property of FilterSet.
        Parameters:
        instrumentIndex - the Instrument index.
        filterSetIndex - the FilterSet index.
        Returns:
        the Manufacturer property.
      • getFilterSetModel

        String getFilterSetModel​(int instrumentIndex,
                                 int filterSetIndex)
        Get the Model property of FilterSet.
        Parameters:
        instrumentIndex - the Instrument index.
        filterSetIndex - the FilterSet index.
        Returns:
        the Model property.
      • getFilterSetSerialNumber

        String getFilterSetSerialNumber​(int instrumentIndex,
                                        int filterSetIndex)
        Get the SerialNumber property of FilterSet.
        Parameters:
        instrumentIndex - the Instrument index.
        filterSetIndex - the FilterSet index.
        Returns:
        the SerialNumber property.
      • getFolderAnnotationRef

        String getFolderAnnotationRef​(int folderIndex,
                                      int annotationRefIndex)
        Get the AnnotationRef property of Folder.
        Parameters:
        folderIndex - the Folder index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getFolderDescription

        String getFolderDescription​(int folderIndex)
        Get the Description property of Folder.
        Parameters:
        folderIndex - the Folder index.
        Returns:
        the Description property.
      • getFolderFolderRef

        String getFolderFolderRef​(int folderIndex,
                                  int folderRefIndex)
        Get the FolderRef property of Folder.
        Parameters:
        folderIndex - the Folder index.
        folderRefIndex - FolderRef index.
        Returns:
        the FolderRef property.
      • getFolderID

        String getFolderID​(int folderIndex)
        Get the ID property of Folder.
        Parameters:
        folderIndex - the Folder index.
        Returns:
        the ID property.
      • getFolderImageRef

        String getFolderImageRef​(int folderIndex,
                                 int imageRefIndex)
        Get the ImageRef property of Folder.
        Parameters:
        folderIndex - the Folder index.
        imageRefIndex - ImageRef index.
        Returns:
        the ImageRef property.
      • getFolderName

        String getFolderName​(int folderIndex)
        Get the Name property of Folder.
        Parameters:
        folderIndex - the Folder index.
        Returns:
        the Name property.
      • getFolderROIRef

        String getFolderROIRef​(int folderIndex,
                               int ROIRefIndex)
        Get the ROIRef property of Folder.
        Parameters:
        folderIndex - the Folder index.
        ROIRefIndex - ROIRef index.
        Returns:
        the ROIRef property.
      • getGenericExcitationSourceAnnotationRef

        String getGenericExcitationSourceAnnotationRef​(int instrumentIndex,
                                                       int lightSourceIndex,
                                                       int annotationRefIndex)
        Get the AnnotationRef property of GenericExcitationSource.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getGenericExcitationSourceID

        String getGenericExcitationSourceID​(int instrumentIndex,
                                            int lightSourceIndex)
        Get the ID property of GenericExcitationSource.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the ID property.
      • getGenericExcitationSourceLotNumber

        String getGenericExcitationSourceLotNumber​(int instrumentIndex,
                                                   int lightSourceIndex)
        Get the LotNumber property of GenericExcitationSource.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the LotNumber property.
      • getGenericExcitationSourceManufacturer

        String getGenericExcitationSourceManufacturer​(int instrumentIndex,
                                                      int lightSourceIndex)
        Get the Manufacturer property of GenericExcitationSource.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the Manufacturer property.
      • getGenericExcitationSourceModel

        String getGenericExcitationSourceModel​(int instrumentIndex,
                                               int lightSourceIndex)
        Get the Model property of GenericExcitationSource.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the Model property.
      • getGenericExcitationSourcePower

        Power getGenericExcitationSourcePower​(int instrumentIndex,
                                              int lightSourceIndex)
        Get the Power property of GenericExcitationSource.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the Power property.
      • getGenericExcitationSourceSerialNumber

        String getGenericExcitationSourceSerialNumber​(int instrumentIndex,
                                                      int lightSourceIndex)
        Get the SerialNumber property of GenericExcitationSource.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the SerialNumber property.
      • getImageAcquisitionDate

        Timestamp getImageAcquisitionDate​(int imageIndex)
        Get the AcquisitionDate property of Image.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the AcquisitionDate property.
      • getImageAnnotationRef

        String getImageAnnotationRef​(int imageIndex,
                                     int annotationRefIndex)
        Get the AnnotationRef property of Image.
        Parameters:
        imageIndex - the Image index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getImageDescription

        String getImageDescription​(int imageIndex)
        Get the Description property of Image.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the Description property.
      • getImageExperimentRef

        String getImageExperimentRef​(int imageIndex)
        Get the ExperimentRef property of Image.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the ExperimentRef property.
      • getImageExperimenterGroupRef

        String getImageExperimenterGroupRef​(int imageIndex)
        Get the ExperimenterGroupRef property of Image.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the ExperimenterGroupRef property.
      • getImageExperimenterRef

        String getImageExperimenterRef​(int imageIndex)
        Get the ExperimenterRef property of Image.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the ExperimenterRef property.
      • getImageID

        String getImageID​(int imageIndex)
        Get the ID property of Image.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the ID property.
      • getImageInstrumentRef

        String getImageInstrumentRef​(int imageIndex)
        Get the InstrumentRef property of Image.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the InstrumentRef property.
      • getImageMicrobeamManipulationRef

        String getImageMicrobeamManipulationRef​(int imageIndex,
                                                int microbeamManipulationRefIndex)
        Get the MicrobeamManipulationRef property of Image.
        Parameters:
        imageIndex - the Image index.
        microbeamManipulationRefIndex - MicrobeamManipulationRef index.
        Returns:
        the MicrobeamManipulationRef property.
      • getImageName

        String getImageName​(int imageIndex)
        Get the Name property of Image.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the Name property.
      • getImageROIRef

        String getImageROIRef​(int imageIndex,
                              int ROIRefIndex)
        Get the ROIRef property of Image.
        Parameters:
        imageIndex - the Image index.
        ROIRefIndex - ROIRef index.
        Returns:
        the ROIRef property.
      • getImagingEnvironmentAirPressure

        Pressure getImagingEnvironmentAirPressure​(int imageIndex)
        Get the AirPressure property of ImagingEnvironment.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the AirPressure property.
      • getImagingEnvironmentCO2Percent

        PercentFraction getImagingEnvironmentCO2Percent​(int imageIndex)
        Get the CO2Percent property of ImagingEnvironment.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the CO2Percent property.
      • getImagingEnvironmentHumidity

        PercentFraction getImagingEnvironmentHumidity​(int imageIndex)
        Get the Humidity property of ImagingEnvironment.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the Humidity property.
      • getImagingEnvironmentTemperature

        Temperature getImagingEnvironmentTemperature​(int imageIndex)
        Get the Temperature property of ImagingEnvironment.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the Temperature property.
      • getInstrumentAnnotationRef

        String getInstrumentAnnotationRef​(int instrumentIndex,
                                          int annotationRefIndex)
        Get the AnnotationRef property of Instrument.
        Parameters:
        instrumentIndex - the Instrument index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getInstrumentID

        String getInstrumentID​(int instrumentIndex)
        Get the ID property of Instrument.
        Parameters:
        instrumentIndex - the Instrument index.
        Returns:
        the ID property.
      • getLabelAnnotationRef

        String getLabelAnnotationRef​(int ROIIndex,
                                     int shapeIndex,
                                     int annotationRefIndex)
        Get the AnnotationRef property of Label.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getLabelFillColor

        Color getLabelFillColor​(int ROIIndex,
                                int shapeIndex)
        Get the FillColor property of Label.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FillColor property.
      • getLabelFillRule

        FillRule getLabelFillRule​(int ROIIndex,
                                  int shapeIndex)
        Get the FillRule property of Label.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FillRule property.
      • getLabelFontFamily

        FontFamily getLabelFontFamily​(int ROIIndex,
                                      int shapeIndex)
        Get the FontFamily property of Label.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FontFamily property.
      • getLabelFontSize

        Length getLabelFontSize​(int ROIIndex,
                                int shapeIndex)
        Get the FontSize property of Label.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FontSize property.
      • getLabelFontStyle

        FontStyle getLabelFontStyle​(int ROIIndex,
                                    int shapeIndex)
        Get the FontStyle property of Label.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FontStyle property.
      • getLabelID

        String getLabelID​(int ROIIndex,
                          int shapeIndex)
        Get the ID property of Label.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the ID property.
      • getLabelLocked

        Boolean getLabelLocked​(int ROIIndex,
                               int shapeIndex)
        Get the Locked property of Label.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Locked property.
      • getLabelStrokeColor

        Color getLabelStrokeColor​(int ROIIndex,
                                  int shapeIndex)
        Get the StrokeColor property of Label.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the StrokeColor property.
      • getLabelStrokeDashArray

        String getLabelStrokeDashArray​(int ROIIndex,
                                       int shapeIndex)
        Get the StrokeDashArray property of Label.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the StrokeDashArray property.
      • getLabelStrokeWidth

        Length getLabelStrokeWidth​(int ROIIndex,
                                   int shapeIndex)
        Get the StrokeWidth property of Label.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the StrokeWidth property.
      • getLabelText

        String getLabelText​(int ROIIndex,
                            int shapeIndex)
        Get the Text property of Label.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Text property.
      • getLabelTheC

        NonNegativeInteger getLabelTheC​(int ROIIndex,
                                        int shapeIndex)
        Get the TheC property of Label.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the TheC property.
      • getLabelTheT

        NonNegativeInteger getLabelTheT​(int ROIIndex,
                                        int shapeIndex)
        Get the TheT property of Label.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the TheT property.
      • getLabelTheZ

        NonNegativeInteger getLabelTheZ​(int ROIIndex,
                                        int shapeIndex)
        Get the TheZ property of Label.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the TheZ property.
      • getLabelTransform

        AffineTransform getLabelTransform​(int ROIIndex,
                                          int shapeIndex)
        Get the Transform property of Label.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Transform property.
      • getLabelX

        Double getLabelX​(int ROIIndex,
                         int shapeIndex)
        Get the X property of Label.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the X property.
      • getLabelY

        Double getLabelY​(int ROIIndex,
                         int shapeIndex)
        Get the Y property of Label.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Y property.
      • getLaserAnnotationRef

        String getLaserAnnotationRef​(int instrumentIndex,
                                     int lightSourceIndex,
                                     int annotationRefIndex)
        Get the AnnotationRef property of Laser.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getLaserFrequencyMultiplication

        PositiveInteger getLaserFrequencyMultiplication​(int instrumentIndex,
                                                        int lightSourceIndex)
        Get the FrequencyMultiplication property of Laser.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the FrequencyMultiplication property.
      • getLaserID

        String getLaserID​(int instrumentIndex,
                          int lightSourceIndex)
        Get the ID property of Laser.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the ID property.
      • getLaserLaserMedium

        LaserMedium getLaserLaserMedium​(int instrumentIndex,
                                        int lightSourceIndex)
        Get the LaserMedium property of Laser.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the LaserMedium property.
      • getLaserLotNumber

        String getLaserLotNumber​(int instrumentIndex,
                                 int lightSourceIndex)
        Get the LotNumber property of Laser.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the LotNumber property.
      • getLaserManufacturer

        String getLaserManufacturer​(int instrumentIndex,
                                    int lightSourceIndex)
        Get the Manufacturer property of Laser.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the Manufacturer property.
      • getLaserModel

        String getLaserModel​(int instrumentIndex,
                             int lightSourceIndex)
        Get the Model property of Laser.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the Model property.
      • getLaserPockelCell

        Boolean getLaserPockelCell​(int instrumentIndex,
                                   int lightSourceIndex)
        Get the PockelCell property of Laser.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the PockelCell property.
      • getLaserPower

        Power getLaserPower​(int instrumentIndex,
                            int lightSourceIndex)
        Get the Power property of Laser.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the Power property.
      • getLaserPulse

        Pulse getLaserPulse​(int instrumentIndex,
                            int lightSourceIndex)
        Get the Pulse property of Laser.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the Pulse property.
      • getLaserPump

        String getLaserPump​(int instrumentIndex,
                            int lightSourceIndex)
        Get the Pump property of Laser.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the Pump property.
      • getLaserRepetitionRate

        Frequency getLaserRepetitionRate​(int instrumentIndex,
                                         int lightSourceIndex)
        Get the RepetitionRate property of Laser.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the RepetitionRate property.
      • getLaserSerialNumber

        String getLaserSerialNumber​(int instrumentIndex,
                                    int lightSourceIndex)
        Get the SerialNumber property of Laser.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the SerialNumber property.
      • getLaserTuneable

        Boolean getLaserTuneable​(int instrumentIndex,
                                 int lightSourceIndex)
        Get the Tuneable property of Laser.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the Tuneable property.
      • getLaserType

        LaserType getLaserType​(int instrumentIndex,
                               int lightSourceIndex)
        Get the Type property of Laser.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the Type property.
      • getLaserWavelength

        Length getLaserWavelength​(int instrumentIndex,
                                  int lightSourceIndex)
        Get the Wavelength property of Laser.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the Wavelength property.
      • getLightEmittingDiodeAnnotationRef

        String getLightEmittingDiodeAnnotationRef​(int instrumentIndex,
                                                  int lightSourceIndex,
                                                  int annotationRefIndex)
        Get the AnnotationRef property of LightEmittingDiode.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getLightEmittingDiodeID

        String getLightEmittingDiodeID​(int instrumentIndex,
                                       int lightSourceIndex)
        Get the ID property of LightEmittingDiode.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the ID property.
      • getLightEmittingDiodeLotNumber

        String getLightEmittingDiodeLotNumber​(int instrumentIndex,
                                              int lightSourceIndex)
        Get the LotNumber property of LightEmittingDiode.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the LotNumber property.
      • getLightEmittingDiodeManufacturer

        String getLightEmittingDiodeManufacturer​(int instrumentIndex,
                                                 int lightSourceIndex)
        Get the Manufacturer property of LightEmittingDiode.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the Manufacturer property.
      • getLightEmittingDiodeModel

        String getLightEmittingDiodeModel​(int instrumentIndex,
                                          int lightSourceIndex)
        Get the Model property of LightEmittingDiode.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the Model property.
      • getLightEmittingDiodePower

        Power getLightEmittingDiodePower​(int instrumentIndex,
                                         int lightSourceIndex)
        Get the Power property of LightEmittingDiode.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the Power property.
      • getLightEmittingDiodeSerialNumber

        String getLightEmittingDiodeSerialNumber​(int instrumentIndex,
                                                 int lightSourceIndex)
        Get the SerialNumber property of LightEmittingDiode.
        Parameters:
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        Returns:
        the SerialNumber property.
      • getLightPathAnnotationRef

        String getLightPathAnnotationRef​(int imageIndex,
                                         int channelIndex,
                                         int annotationRefIndex)
        Get the AnnotationRef property of LightPath.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getLightPathDichroicRef

        String getLightPathDichroicRef​(int imageIndex,
                                       int channelIndex)
        Get the DichroicRef property of LightPath.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        Returns:
        the DichroicRef property.
      • getLightPathEmissionFilterRef

        String getLightPathEmissionFilterRef​(int imageIndex,
                                             int channelIndex,
                                             int emissionFilterRefIndex)
        Get the EmissionFilterRef property of LightPath.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        emissionFilterRefIndex - EmissionFilterRef index.
        Returns:
        the EmissionFilterRef property.
      • getLightPathExcitationFilterRef

        String getLightPathExcitationFilterRef​(int imageIndex,
                                               int channelIndex,
                                               int excitationFilterRefIndex)
        Get the ExcitationFilterRef property of LightPath.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        excitationFilterRefIndex - ExcitationFilterRef index.
        Returns:
        the ExcitationFilterRef property.
      • getChannelLightSourceSettingsAttenuation

        PercentFraction getChannelLightSourceSettingsAttenuation​(int imageIndex,
                                                                 int channelIndex)
        Get the Attenuation property of LightSourceSettings.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        Returns:
        the Attenuation property.
      • getMicrobeamManipulationLightSourceSettingsAttenuation

        PercentFraction getMicrobeamManipulationLightSourceSettingsAttenuation​(int experimentIndex,
                                                                               int microbeamManipulationIndex,
                                                                               int lightSourceSettingsIndex)
        Get the Attenuation property of LightSourceSettings.
        Parameters:
        experimentIndex - the Experiment index.
        microbeamManipulationIndex - the MicrobeamManipulation index.
        lightSourceSettingsIndex - the LightSourceSettings index.
        Returns:
        the Attenuation property.
      • getChannelLightSourceSettingsID

        String getChannelLightSourceSettingsID​(int imageIndex,
                                               int channelIndex)
        Get the ID property of LightSourceSettings.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        Returns:
        the ID property.
      • getMicrobeamManipulationLightSourceSettingsID

        String getMicrobeamManipulationLightSourceSettingsID​(int experimentIndex,
                                                             int microbeamManipulationIndex,
                                                             int lightSourceSettingsIndex)
        Get the ID property of LightSourceSettings.
        Parameters:
        experimentIndex - the Experiment index.
        microbeamManipulationIndex - the MicrobeamManipulation index.
        lightSourceSettingsIndex - the LightSourceSettings index.
        Returns:
        the ID property.
      • getChannelLightSourceSettingsWavelength

        Length getChannelLightSourceSettingsWavelength​(int imageIndex,
                                                       int channelIndex)
        Get the Wavelength property of LightSourceSettings.
        Parameters:
        imageIndex - the Image index.
        channelIndex - the Channel index.
        Returns:
        the Wavelength property.
      • getMicrobeamManipulationLightSourceSettingsWavelength

        Length getMicrobeamManipulationLightSourceSettingsWavelength​(int experimentIndex,
                                                                     int microbeamManipulationIndex,
                                                                     int lightSourceSettingsIndex)
        Get the Wavelength property of LightSourceSettings.
        Parameters:
        experimentIndex - the Experiment index.
        microbeamManipulationIndex - the MicrobeamManipulation index.
        lightSourceSettingsIndex - the LightSourceSettings index.
        Returns:
        the Wavelength property.
      • getLineAnnotationRef

        String getLineAnnotationRef​(int ROIIndex,
                                    int shapeIndex,
                                    int annotationRefIndex)
        Get the AnnotationRef property of Line.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getLineFillColor

        Color getLineFillColor​(int ROIIndex,
                               int shapeIndex)
        Get the FillColor property of Line.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FillColor property.
      • getLineFillRule

        FillRule getLineFillRule​(int ROIIndex,
                                 int shapeIndex)
        Get the FillRule property of Line.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FillRule property.
      • getLineFontFamily

        FontFamily getLineFontFamily​(int ROIIndex,
                                     int shapeIndex)
        Get the FontFamily property of Line.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FontFamily property.
      • getLineFontSize

        Length getLineFontSize​(int ROIIndex,
                               int shapeIndex)
        Get the FontSize property of Line.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FontSize property.
      • getLineFontStyle

        FontStyle getLineFontStyle​(int ROIIndex,
                                   int shapeIndex)
        Get the FontStyle property of Line.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FontStyle property.
      • getLineID

        String getLineID​(int ROIIndex,
                         int shapeIndex)
        Get the ID property of Line.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the ID property.
      • getLineLocked

        Boolean getLineLocked​(int ROIIndex,
                              int shapeIndex)
        Get the Locked property of Line.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Locked property.
      • getLineMarkerEnd

        Marker getLineMarkerEnd​(int ROIIndex,
                                int shapeIndex)
        Get the MarkerEnd property of Line.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the MarkerEnd property.
      • getLineMarkerStart

        Marker getLineMarkerStart​(int ROIIndex,
                                  int shapeIndex)
        Get the MarkerStart property of Line.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the MarkerStart property.
      • getLineStrokeColor

        Color getLineStrokeColor​(int ROIIndex,
                                 int shapeIndex)
        Get the StrokeColor property of Line.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the StrokeColor property.
      • getLineStrokeDashArray

        String getLineStrokeDashArray​(int ROIIndex,
                                      int shapeIndex)
        Get the StrokeDashArray property of Line.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the StrokeDashArray property.
      • getLineStrokeWidth

        Length getLineStrokeWidth​(int ROIIndex,
                                  int shapeIndex)
        Get the StrokeWidth property of Line.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the StrokeWidth property.
      • getLineText

        String getLineText​(int ROIIndex,
                           int shapeIndex)
        Get the Text property of Line.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Text property.
      • getLineTheC

        NonNegativeInteger getLineTheC​(int ROIIndex,
                                       int shapeIndex)
        Get the TheC property of Line.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the TheC property.
      • getLineTheT

        NonNegativeInteger getLineTheT​(int ROIIndex,
                                       int shapeIndex)
        Get the TheT property of Line.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the TheT property.
      • getLineTheZ

        NonNegativeInteger getLineTheZ​(int ROIIndex,
                                       int shapeIndex)
        Get the TheZ property of Line.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the TheZ property.
      • getLineTransform

        AffineTransform getLineTransform​(int ROIIndex,
                                         int shapeIndex)
        Get the Transform property of Line.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Transform property.
      • getLineX1

        Double getLineX1​(int ROIIndex,
                         int shapeIndex)
        Get the X1 property of Line.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the X1 property.
      • getLineX2

        Double getLineX2​(int ROIIndex,
                         int shapeIndex)
        Get the X2 property of Line.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the X2 property.
      • getLineY1

        Double getLineY1​(int ROIIndex,
                         int shapeIndex)
        Get the Y1 property of Line.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Y1 property.
      • getLineY2

        Double getLineY2​(int ROIIndex,
                         int shapeIndex)
        Get the Y2 property of Line.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Y2 property.
      • getListAnnotationAnnotationRef

        String getListAnnotationAnnotationRef​(int listAnnotationIndex,
                                              int annotationRefIndex)
        Get the AnnotationRef property of ListAnnotation.
        Parameters:
        listAnnotationIndex - the ListAnnotation index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getListAnnotationAnnotator

        String getListAnnotationAnnotator​(int listAnnotationIndex)
        Get the Annotator property of ListAnnotation.
        Parameters:
        listAnnotationIndex - the ListAnnotation index.
        Returns:
        the Annotator property.
      • getListAnnotationDescription

        String getListAnnotationDescription​(int listAnnotationIndex)
        Get the Description property of ListAnnotation.
        Parameters:
        listAnnotationIndex - the ListAnnotation index.
        Returns:
        the Description property.
      • getListAnnotationID

        String getListAnnotationID​(int listAnnotationIndex)
        Get the ID property of ListAnnotation.
        Parameters:
        listAnnotationIndex - the ListAnnotation index.
        Returns:
        the ID property.
      • getListAnnotationNamespace

        String getListAnnotationNamespace​(int listAnnotationIndex)
        Get the Namespace property of ListAnnotation.
        Parameters:
        listAnnotationIndex - the ListAnnotation index.
        Returns:
        the Namespace property.
      • getLongAnnotationAnnotationRef

        String getLongAnnotationAnnotationRef​(int longAnnotationIndex,
                                              int annotationRefIndex)
        Get the AnnotationRef property of LongAnnotation.
        Parameters:
        longAnnotationIndex - the LongAnnotation index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getLongAnnotationAnnotator

        String getLongAnnotationAnnotator​(int longAnnotationIndex)
        Get the Annotator property of LongAnnotation.
        Parameters:
        longAnnotationIndex - the LongAnnotation index.
        Returns:
        the Annotator property.
      • getLongAnnotationDescription

        String getLongAnnotationDescription​(int longAnnotationIndex)
        Get the Description property of LongAnnotation.
        Parameters:
        longAnnotationIndex - the LongAnnotation index.
        Returns:
        the Description property.
      • getLongAnnotationID

        String getLongAnnotationID​(int longAnnotationIndex)
        Get the ID property of LongAnnotation.
        Parameters:
        longAnnotationIndex - the LongAnnotation index.
        Returns:
        the ID property.
      • getLongAnnotationNamespace

        String getLongAnnotationNamespace​(int longAnnotationIndex)
        Get the Namespace property of LongAnnotation.
        Parameters:
        longAnnotationIndex - the LongAnnotation index.
        Returns:
        the Namespace property.
      • getLongAnnotationValue

        Long getLongAnnotationValue​(int longAnnotationIndex)
        Get the Value property of LongAnnotation.
        Parameters:
        longAnnotationIndex - the LongAnnotation index.
        Returns:
        the Value property.
      • getMapAnnotationAnnotationRef

        String getMapAnnotationAnnotationRef​(int mapAnnotationIndex,
                                             int annotationRefIndex)
        Get the AnnotationRef property of MapAnnotation.
        Parameters:
        mapAnnotationIndex - the MapAnnotation index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getMapAnnotationAnnotator

        String getMapAnnotationAnnotator​(int mapAnnotationIndex)
        Get the Annotator property of MapAnnotation.
        Parameters:
        mapAnnotationIndex - the MapAnnotation index.
        Returns:
        the Annotator property.
      • getMapAnnotationDescription

        String getMapAnnotationDescription​(int mapAnnotationIndex)
        Get the Description property of MapAnnotation.
        Parameters:
        mapAnnotationIndex - the MapAnnotation index.
        Returns:
        the Description property.
      • getMapAnnotationID

        String getMapAnnotationID​(int mapAnnotationIndex)
        Get the ID property of MapAnnotation.
        Parameters:
        mapAnnotationIndex - the MapAnnotation index.
        Returns:
        the ID property.
      • getMapAnnotationNamespace

        String getMapAnnotationNamespace​(int mapAnnotationIndex)
        Get the Namespace property of MapAnnotation.
        Parameters:
        mapAnnotationIndex - the MapAnnotation index.
        Returns:
        the Namespace property.
      • getMaskAnnotationRef

        String getMaskAnnotationRef​(int ROIIndex,
                                    int shapeIndex,
                                    int annotationRefIndex)
        Get the AnnotationRef property of Mask.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getMaskFillColor

        Color getMaskFillColor​(int ROIIndex,
                               int shapeIndex)
        Get the FillColor property of Mask.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FillColor property.
      • getMaskFillRule

        FillRule getMaskFillRule​(int ROIIndex,
                                 int shapeIndex)
        Get the FillRule property of Mask.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FillRule property.
      • getMaskFontFamily

        FontFamily getMaskFontFamily​(int ROIIndex,
                                     int shapeIndex)
        Get the FontFamily property of Mask.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FontFamily property.
      • getMaskFontSize

        Length getMaskFontSize​(int ROIIndex,
                               int shapeIndex)
        Get the FontSize property of Mask.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FontSize property.
      • getMaskFontStyle

        FontStyle getMaskFontStyle​(int ROIIndex,
                                   int shapeIndex)
        Get the FontStyle property of Mask.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FontStyle property.
      • getMaskHeight

        Double getMaskHeight​(int ROIIndex,
                             int shapeIndex)
        Get the Height property of Mask.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Height property.
      • getMaskID

        String getMaskID​(int ROIIndex,
                         int shapeIndex)
        Get the ID property of Mask.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the ID property.
      • getMaskLocked

        Boolean getMaskLocked​(int ROIIndex,
                              int shapeIndex)
        Get the Locked property of Mask.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Locked property.
      • getMaskStrokeColor

        Color getMaskStrokeColor​(int ROIIndex,
                                 int shapeIndex)
        Get the StrokeColor property of Mask.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the StrokeColor property.
      • getMaskStrokeDashArray

        String getMaskStrokeDashArray​(int ROIIndex,
                                      int shapeIndex)
        Get the StrokeDashArray property of Mask.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the StrokeDashArray property.
      • getMaskStrokeWidth

        Length getMaskStrokeWidth​(int ROIIndex,
                                  int shapeIndex)
        Get the StrokeWidth property of Mask.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the StrokeWidth property.
      • getMaskText

        String getMaskText​(int ROIIndex,
                           int shapeIndex)
        Get the Text property of Mask.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Text property.
      • getMaskTheC

        NonNegativeInteger getMaskTheC​(int ROIIndex,
                                       int shapeIndex)
        Get the TheC property of Mask.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the TheC property.
      • getMaskTheT

        NonNegativeInteger getMaskTheT​(int ROIIndex,
                                       int shapeIndex)
        Get the TheT property of Mask.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the TheT property.
      • getMaskTheZ

        NonNegativeInteger getMaskTheZ​(int ROIIndex,
                                       int shapeIndex)
        Get the TheZ property of Mask.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the TheZ property.
      • getMaskTransform

        AffineTransform getMaskTransform​(int ROIIndex,
                                         int shapeIndex)
        Get the Transform property of Mask.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Transform property.
      • getMaskWidth

        Double getMaskWidth​(int ROIIndex,
                            int shapeIndex)
        Get the Width property of Mask.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Width property.
      • getMaskX

        Double getMaskX​(int ROIIndex,
                        int shapeIndex)
        Get the X property of Mask.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the X property.
      • getMaskY

        Double getMaskY​(int ROIIndex,
                        int shapeIndex)
        Get the Y property of Mask.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Y property.
      • getMicrobeamManipulationDescription

        String getMicrobeamManipulationDescription​(int experimentIndex,
                                                   int microbeamManipulationIndex)
        Get the Description property of MicrobeamManipulation.
        Parameters:
        experimentIndex - the Experiment index.
        microbeamManipulationIndex - the MicrobeamManipulation index.
        Returns:
        the Description property.
      • getMicrobeamManipulationExperimenterRef

        String getMicrobeamManipulationExperimenterRef​(int experimentIndex,
                                                       int microbeamManipulationIndex)
        Get the ExperimenterRef property of MicrobeamManipulation.
        Parameters:
        experimentIndex - the Experiment index.
        microbeamManipulationIndex - the MicrobeamManipulation index.
        Returns:
        the ExperimenterRef property.
      • getMicrobeamManipulationID

        String getMicrobeamManipulationID​(int experimentIndex,
                                          int microbeamManipulationIndex)
        Get the ID property of MicrobeamManipulation.
        Parameters:
        experimentIndex - the Experiment index.
        microbeamManipulationIndex - the MicrobeamManipulation index.
        Returns:
        the ID property.
      • getMicrobeamManipulationROIRef

        String getMicrobeamManipulationROIRef​(int experimentIndex,
                                              int microbeamManipulationIndex,
                                              int ROIRefIndex)
        Get the ROIRef property of MicrobeamManipulation.
        Parameters:
        experimentIndex - the Experiment index.
        microbeamManipulationIndex - the MicrobeamManipulation index.
        ROIRefIndex - ROIRef index.
        Returns:
        the ROIRef property.
      • getMicrobeamManipulationType

        MicrobeamManipulationType getMicrobeamManipulationType​(int experimentIndex,
                                                               int microbeamManipulationIndex)
        Get the Type property of MicrobeamManipulation.
        Parameters:
        experimentIndex - the Experiment index.
        microbeamManipulationIndex - the MicrobeamManipulation index.
        Returns:
        the Type property.
      • getMicroscopeLotNumber

        String getMicroscopeLotNumber​(int instrumentIndex)
        Get the LotNumber property of Microscope.
        Parameters:
        instrumentIndex - the Instrument index.
        Returns:
        the LotNumber property.
      • getMicroscopeManufacturer

        String getMicroscopeManufacturer​(int instrumentIndex)
        Get the Manufacturer property of Microscope.
        Parameters:
        instrumentIndex - the Instrument index.
        Returns:
        the Manufacturer property.
      • getMicroscopeModel

        String getMicroscopeModel​(int instrumentIndex)
        Get the Model property of Microscope.
        Parameters:
        instrumentIndex - the Instrument index.
        Returns:
        the Model property.
      • getMicroscopeSerialNumber

        String getMicroscopeSerialNumber​(int instrumentIndex)
        Get the SerialNumber property of Microscope.
        Parameters:
        instrumentIndex - the Instrument index.
        Returns:
        the SerialNumber property.
      • getMicroscopeType

        MicroscopeType getMicroscopeType​(int instrumentIndex)
        Get the Type property of Microscope.
        Parameters:
        instrumentIndex - the Instrument index.
        Returns:
        the Type property.
      • getObjectiveAnnotationRef

        String getObjectiveAnnotationRef​(int instrumentIndex,
                                         int objectiveIndex,
                                         int annotationRefIndex)
        Get the AnnotationRef property of Objective.
        Parameters:
        instrumentIndex - the Instrument index.
        objectiveIndex - the Objective index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getObjectiveCalibratedMagnification

        Double getObjectiveCalibratedMagnification​(int instrumentIndex,
                                                   int objectiveIndex)
        Get the CalibratedMagnification property of Objective.
        Parameters:
        instrumentIndex - the Instrument index.
        objectiveIndex - the Objective index.
        Returns:
        the CalibratedMagnification property.
      • getObjectiveCorrection

        Correction getObjectiveCorrection​(int instrumentIndex,
                                          int objectiveIndex)
        Get the Correction property of Objective.
        Parameters:
        instrumentIndex - the Instrument index.
        objectiveIndex - the Objective index.
        Returns:
        the Correction property.
      • getObjectiveID

        String getObjectiveID​(int instrumentIndex,
                              int objectiveIndex)
        Get the ID property of Objective.
        Parameters:
        instrumentIndex - the Instrument index.
        objectiveIndex - the Objective index.
        Returns:
        the ID property.
      • getObjectiveImmersion

        Immersion getObjectiveImmersion​(int instrumentIndex,
                                        int objectiveIndex)
        Get the Immersion property of Objective.
        Parameters:
        instrumentIndex - the Instrument index.
        objectiveIndex - the Objective index.
        Returns:
        the Immersion property.
      • getObjectiveIris

        Boolean getObjectiveIris​(int instrumentIndex,
                                 int objectiveIndex)
        Get the Iris property of Objective.
        Parameters:
        instrumentIndex - the Instrument index.
        objectiveIndex - the Objective index.
        Returns:
        the Iris property.
      • getObjectiveLensNA

        Double getObjectiveLensNA​(int instrumentIndex,
                                  int objectiveIndex)
        Get the LensNA property of Objective.
        Parameters:
        instrumentIndex - the Instrument index.
        objectiveIndex - the Objective index.
        Returns:
        the LensNA property.
      • getObjectiveLotNumber

        String getObjectiveLotNumber​(int instrumentIndex,
                                     int objectiveIndex)
        Get the LotNumber property of Objective.
        Parameters:
        instrumentIndex - the Instrument index.
        objectiveIndex - the Objective index.
        Returns:
        the LotNumber property.
      • getObjectiveManufacturer

        String getObjectiveManufacturer​(int instrumentIndex,
                                        int objectiveIndex)
        Get the Manufacturer property of Objective.
        Parameters:
        instrumentIndex - the Instrument index.
        objectiveIndex - the Objective index.
        Returns:
        the Manufacturer property.
      • getObjectiveModel

        String getObjectiveModel​(int instrumentIndex,
                                 int objectiveIndex)
        Get the Model property of Objective.
        Parameters:
        instrumentIndex - the Instrument index.
        objectiveIndex - the Objective index.
        Returns:
        the Model property.
      • getObjectiveNominalMagnification

        Double getObjectiveNominalMagnification​(int instrumentIndex,
                                                int objectiveIndex)
        Get the NominalMagnification property of Objective.
        Parameters:
        instrumentIndex - the Instrument index.
        objectiveIndex - the Objective index.
        Returns:
        the NominalMagnification property.
      • getObjectiveSerialNumber

        String getObjectiveSerialNumber​(int instrumentIndex,
                                        int objectiveIndex)
        Get the SerialNumber property of Objective.
        Parameters:
        instrumentIndex - the Instrument index.
        objectiveIndex - the Objective index.
        Returns:
        the SerialNumber property.
      • getObjectiveWorkingDistance

        Length getObjectiveWorkingDistance​(int instrumentIndex,
                                           int objectiveIndex)
        Get the WorkingDistance property of Objective.
        Parameters:
        instrumentIndex - the Instrument index.
        objectiveIndex - the Objective index.
        Returns:
        the WorkingDistance property.
      • getObjectiveSettingsCorrectionCollar

        Double getObjectiveSettingsCorrectionCollar​(int imageIndex)
        Get the CorrectionCollar property of ObjectiveSettings.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the CorrectionCollar property.
      • getObjectiveSettingsID

        String getObjectiveSettingsID​(int imageIndex)
        Get the ID property of ObjectiveSettings.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the ID property.
      • getObjectiveSettingsMedium

        Medium getObjectiveSettingsMedium​(int imageIndex)
        Get the Medium property of ObjectiveSettings.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the Medium property.
      • getObjectiveSettingsRefractiveIndex

        Double getObjectiveSettingsRefractiveIndex​(int imageIndex)
        Get the RefractiveIndex property of ObjectiveSettings.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the RefractiveIndex property.
      • getPixelsBigEndian

        Boolean getPixelsBigEndian​(int imageIndex)
        Get the BigEndian property of Pixels.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the BigEndian property.
      • getPixelsDimensionOrder

        DimensionOrder getPixelsDimensionOrder​(int imageIndex)
        Get the DimensionOrder property of Pixels.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the DimensionOrder property.
      • getPixelsID

        String getPixelsID​(int imageIndex)
        Get the ID property of Pixels.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the ID property.
      • getPixelsInterleaved

        Boolean getPixelsInterleaved​(int imageIndex)
        Get the Interleaved property of Pixels.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the Interleaved property.
      • getPixelsPhysicalSizeX

        Length getPixelsPhysicalSizeX​(int imageIndex)
        Get the PhysicalSizeX property of Pixels.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the PhysicalSizeX property.
      • getPixelsPhysicalSizeY

        Length getPixelsPhysicalSizeY​(int imageIndex)
        Get the PhysicalSizeY property of Pixels.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the PhysicalSizeY property.
      • getPixelsPhysicalSizeZ

        Length getPixelsPhysicalSizeZ​(int imageIndex)
        Get the PhysicalSizeZ property of Pixels.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the PhysicalSizeZ property.
      • getPixelsSignificantBits

        PositiveInteger getPixelsSignificantBits​(int imageIndex)
        Get the SignificantBits property of Pixels.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the SignificantBits property.
      • getPixelsSizeC

        PositiveInteger getPixelsSizeC​(int imageIndex)
        Get the SizeC property of Pixels.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the SizeC property.
      • getPixelsSizeT

        PositiveInteger getPixelsSizeT​(int imageIndex)
        Get the SizeT property of Pixels.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the SizeT property.
      • getPixelsSizeX

        PositiveInteger getPixelsSizeX​(int imageIndex)
        Get the SizeX property of Pixels.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the SizeX property.
      • getPixelsSizeY

        PositiveInteger getPixelsSizeY​(int imageIndex)
        Get the SizeY property of Pixels.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the SizeY property.
      • getPixelsSizeZ

        PositiveInteger getPixelsSizeZ​(int imageIndex)
        Get the SizeZ property of Pixels.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the SizeZ property.
      • getPixelsTimeIncrement

        Time getPixelsTimeIncrement​(int imageIndex)
        Get the TimeIncrement property of Pixels.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the TimeIncrement property.
      • getPixelsType

        PixelType getPixelsType​(int imageIndex)
        Get the Type property of Pixels.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the Type property.
      • getPlaneAnnotationRef

        String getPlaneAnnotationRef​(int imageIndex,
                                     int planeIndex,
                                     int annotationRefIndex)
        Get the AnnotationRef property of Plane.
        Parameters:
        imageIndex - the Image index.
        planeIndex - the Plane index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getPlaneDeltaT

        Time getPlaneDeltaT​(int imageIndex,
                            int planeIndex)
        Get the DeltaT property of Plane.
        Parameters:
        imageIndex - the Image index.
        planeIndex - the Plane index.
        Returns:
        the DeltaT property.
      • getPlaneExposureTime

        Time getPlaneExposureTime​(int imageIndex,
                                  int planeIndex)
        Get the ExposureTime property of Plane.
        Parameters:
        imageIndex - the Image index.
        planeIndex - the Plane index.
        Returns:
        the ExposureTime property.
      • getPlaneHashSHA1

        String getPlaneHashSHA1​(int imageIndex,
                                int planeIndex)
        Get the HashSHA1 property of Plane.
        Parameters:
        imageIndex - the Image index.
        planeIndex - the Plane index.
        Returns:
        the HashSHA1 property.
      • getPlanePositionX

        Length getPlanePositionX​(int imageIndex,
                                 int planeIndex)
        Get the PositionX property of Plane.
        Parameters:
        imageIndex - the Image index.
        planeIndex - the Plane index.
        Returns:
        the PositionX property.
      • getPlanePositionY

        Length getPlanePositionY​(int imageIndex,
                                 int planeIndex)
        Get the PositionY property of Plane.
        Parameters:
        imageIndex - the Image index.
        planeIndex - the Plane index.
        Returns:
        the PositionY property.
      • getPlanePositionZ

        Length getPlanePositionZ​(int imageIndex,
                                 int planeIndex)
        Get the PositionZ property of Plane.
        Parameters:
        imageIndex - the Image index.
        planeIndex - the Plane index.
        Returns:
        the PositionZ property.
      • getPlaneTheC

        NonNegativeInteger getPlaneTheC​(int imageIndex,
                                        int planeIndex)
        Get the TheC property of Plane.
        Parameters:
        imageIndex - the Image index.
        planeIndex - the Plane index.
        Returns:
        the TheC property.
      • getPlaneTheT

        NonNegativeInteger getPlaneTheT​(int imageIndex,
                                        int planeIndex)
        Get the TheT property of Plane.
        Parameters:
        imageIndex - the Image index.
        planeIndex - the Plane index.
        Returns:
        the TheT property.
      • getPlaneTheZ

        NonNegativeInteger getPlaneTheZ​(int imageIndex,
                                        int planeIndex)
        Get the TheZ property of Plane.
        Parameters:
        imageIndex - the Image index.
        planeIndex - the Plane index.
        Returns:
        the TheZ property.
      • getPlateAnnotationRef

        String getPlateAnnotationRef​(int plateIndex,
                                     int annotationRefIndex)
        Get the AnnotationRef property of Plate.
        Parameters:
        plateIndex - the Plate index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getPlateColumnNamingConvention

        NamingConvention getPlateColumnNamingConvention​(int plateIndex)
        Get the ColumnNamingConvention property of Plate.
        Parameters:
        plateIndex - the Plate index.
        Returns:
        the ColumnNamingConvention property.
      • getPlateColumns

        PositiveInteger getPlateColumns​(int plateIndex)
        Get the Columns property of Plate.
        Parameters:
        plateIndex - the Plate index.
        Returns:
        the Columns property.
      • getPlateDescription

        String getPlateDescription​(int plateIndex)
        Get the Description property of Plate.
        Parameters:
        plateIndex - the Plate index.
        Returns:
        the Description property.
      • getPlateExternalIdentifier

        String getPlateExternalIdentifier​(int plateIndex)
        Get the ExternalIdentifier property of Plate.
        Parameters:
        plateIndex - the Plate index.
        Returns:
        the ExternalIdentifier property.
      • getPlateFieldIndex

        NonNegativeInteger getPlateFieldIndex​(int plateIndex)
        Get the FieldIndex property of Plate.
        Parameters:
        plateIndex - the Plate index.
        Returns:
        the FieldIndex property.
      • getPlateID

        String getPlateID​(int plateIndex)
        Get the ID property of Plate.
        Parameters:
        plateIndex - the Plate index.
        Returns:
        the ID property.
      • getPlateName

        String getPlateName​(int plateIndex)
        Get the Name property of Plate.
        Parameters:
        plateIndex - the Plate index.
        Returns:
        the Name property.
      • getPlateRowNamingConvention

        NamingConvention getPlateRowNamingConvention​(int plateIndex)
        Get the RowNamingConvention property of Plate.
        Parameters:
        plateIndex - the Plate index.
        Returns:
        the RowNamingConvention property.
      • getPlateRows

        PositiveInteger getPlateRows​(int plateIndex)
        Get the Rows property of Plate.
        Parameters:
        plateIndex - the Plate index.
        Returns:
        the Rows property.
      • getPlateStatus

        String getPlateStatus​(int plateIndex)
        Get the Status property of Plate.
        Parameters:
        plateIndex - the Plate index.
        Returns:
        the Status property.
      • getPlateWellOriginX

        Length getPlateWellOriginX​(int plateIndex)
        Get the WellOriginX property of Plate.
        Parameters:
        plateIndex - the Plate index.
        Returns:
        the WellOriginX property.
      • getPlateWellOriginY

        Length getPlateWellOriginY​(int plateIndex)
        Get the WellOriginY property of Plate.
        Parameters:
        plateIndex - the Plate index.
        Returns:
        the WellOriginY property.
      • getPlateAcquisitionAnnotationRef

        String getPlateAcquisitionAnnotationRef​(int plateIndex,
                                                int plateAcquisitionIndex,
                                                int annotationRefIndex)
        Get the AnnotationRef property of PlateAcquisition.
        Parameters:
        plateIndex - the Plate index.
        plateAcquisitionIndex - the PlateAcquisition index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getPlateAcquisitionDescription

        String getPlateAcquisitionDescription​(int plateIndex,
                                              int plateAcquisitionIndex)
        Get the Description property of PlateAcquisition.
        Parameters:
        plateIndex - the Plate index.
        plateAcquisitionIndex - the PlateAcquisition index.
        Returns:
        the Description property.
      • getPlateAcquisitionEndTime

        Timestamp getPlateAcquisitionEndTime​(int plateIndex,
                                             int plateAcquisitionIndex)
        Get the EndTime property of PlateAcquisition.
        Parameters:
        plateIndex - the Plate index.
        plateAcquisitionIndex - the PlateAcquisition index.
        Returns:
        the EndTime property.
      • getPlateAcquisitionID

        String getPlateAcquisitionID​(int plateIndex,
                                     int plateAcquisitionIndex)
        Get the ID property of PlateAcquisition.
        Parameters:
        plateIndex - the Plate index.
        plateAcquisitionIndex - the PlateAcquisition index.
        Returns:
        the ID property.
      • getPlateAcquisitionMaximumFieldCount

        PositiveInteger getPlateAcquisitionMaximumFieldCount​(int plateIndex,
                                                             int plateAcquisitionIndex)
        Get the MaximumFieldCount property of PlateAcquisition.
        Parameters:
        plateIndex - the Plate index.
        plateAcquisitionIndex - the PlateAcquisition index.
        Returns:
        the MaximumFieldCount property.
      • getPlateAcquisitionName

        String getPlateAcquisitionName​(int plateIndex,
                                       int plateAcquisitionIndex)
        Get the Name property of PlateAcquisition.
        Parameters:
        plateIndex - the Plate index.
        plateAcquisitionIndex - the PlateAcquisition index.
        Returns:
        the Name property.
      • getPlateAcquisitionStartTime

        Timestamp getPlateAcquisitionStartTime​(int plateIndex,
                                               int plateAcquisitionIndex)
        Get the StartTime property of PlateAcquisition.
        Parameters:
        plateIndex - the Plate index.
        plateAcquisitionIndex - the PlateAcquisition index.
        Returns:
        the StartTime property.
      • getPlateAcquisitionWellSampleRef

        String getPlateAcquisitionWellSampleRef​(int plateIndex,
                                                int plateAcquisitionIndex,
                                                int wellSampleRefIndex)
        Get the WellSampleRef property of PlateAcquisition.
        Parameters:
        plateIndex - the Plate index.
        plateAcquisitionIndex - the PlateAcquisition index.
        wellSampleRefIndex - WellSampleRef index.
        Returns:
        the WellSampleRef property.
      • getPointAnnotationRef

        String getPointAnnotationRef​(int ROIIndex,
                                     int shapeIndex,
                                     int annotationRefIndex)
        Get the AnnotationRef property of Point.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getPointFillColor

        Color getPointFillColor​(int ROIIndex,
                                int shapeIndex)
        Get the FillColor property of Point.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FillColor property.
      • getPointFillRule

        FillRule getPointFillRule​(int ROIIndex,
                                  int shapeIndex)
        Get the FillRule property of Point.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FillRule property.
      • getPointFontFamily

        FontFamily getPointFontFamily​(int ROIIndex,
                                      int shapeIndex)
        Get the FontFamily property of Point.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FontFamily property.
      • getPointFontSize

        Length getPointFontSize​(int ROIIndex,
                                int shapeIndex)
        Get the FontSize property of Point.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FontSize property.
      • getPointFontStyle

        FontStyle getPointFontStyle​(int ROIIndex,
                                    int shapeIndex)
        Get the FontStyle property of Point.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FontStyle property.
      • getPointID

        String getPointID​(int ROIIndex,
                          int shapeIndex)
        Get the ID property of Point.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the ID property.
      • getPointLocked

        Boolean getPointLocked​(int ROIIndex,
                               int shapeIndex)
        Get the Locked property of Point.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Locked property.
      • getPointStrokeColor

        Color getPointStrokeColor​(int ROIIndex,
                                  int shapeIndex)
        Get the StrokeColor property of Point.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the StrokeColor property.
      • getPointStrokeDashArray

        String getPointStrokeDashArray​(int ROIIndex,
                                       int shapeIndex)
        Get the StrokeDashArray property of Point.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the StrokeDashArray property.
      • getPointStrokeWidth

        Length getPointStrokeWidth​(int ROIIndex,
                                   int shapeIndex)
        Get the StrokeWidth property of Point.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the StrokeWidth property.
      • getPointText

        String getPointText​(int ROIIndex,
                            int shapeIndex)
        Get the Text property of Point.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Text property.
      • getPointTheC

        NonNegativeInteger getPointTheC​(int ROIIndex,
                                        int shapeIndex)
        Get the TheC property of Point.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the TheC property.
      • getPointTheT

        NonNegativeInteger getPointTheT​(int ROIIndex,
                                        int shapeIndex)
        Get the TheT property of Point.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the TheT property.
      • getPointTheZ

        NonNegativeInteger getPointTheZ​(int ROIIndex,
                                        int shapeIndex)
        Get the TheZ property of Point.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the TheZ property.
      • getPointTransform

        AffineTransform getPointTransform​(int ROIIndex,
                                          int shapeIndex)
        Get the Transform property of Point.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Transform property.
      • getPointX

        Double getPointX​(int ROIIndex,
                         int shapeIndex)
        Get the X property of Point.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the X property.
      • getPointY

        Double getPointY​(int ROIIndex,
                         int shapeIndex)
        Get the Y property of Point.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Y property.
      • getPolygonAnnotationRef

        String getPolygonAnnotationRef​(int ROIIndex,
                                       int shapeIndex,
                                       int annotationRefIndex)
        Get the AnnotationRef property of Polygon.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getPolygonFillColor

        Color getPolygonFillColor​(int ROIIndex,
                                  int shapeIndex)
        Get the FillColor property of Polygon.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FillColor property.
      • getPolygonFillRule

        FillRule getPolygonFillRule​(int ROIIndex,
                                    int shapeIndex)
        Get the FillRule property of Polygon.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FillRule property.
      • getPolygonFontFamily

        FontFamily getPolygonFontFamily​(int ROIIndex,
                                        int shapeIndex)
        Get the FontFamily property of Polygon.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FontFamily property.
      • getPolygonFontSize

        Length getPolygonFontSize​(int ROIIndex,
                                  int shapeIndex)
        Get the FontSize property of Polygon.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FontSize property.
      • getPolygonFontStyle

        FontStyle getPolygonFontStyle​(int ROIIndex,
                                      int shapeIndex)
        Get the FontStyle property of Polygon.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FontStyle property.
      • getPolygonID

        String getPolygonID​(int ROIIndex,
                            int shapeIndex)
        Get the ID property of Polygon.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the ID property.
      • getPolygonLocked

        Boolean getPolygonLocked​(int ROIIndex,
                                 int shapeIndex)
        Get the Locked property of Polygon.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Locked property.
      • getPolygonPoints

        String getPolygonPoints​(int ROIIndex,
                                int shapeIndex)
        Get the Points property of Polygon.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Points property.
      • getPolygonStrokeColor

        Color getPolygonStrokeColor​(int ROIIndex,
                                    int shapeIndex)
        Get the StrokeColor property of Polygon.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the StrokeColor property.
      • getPolygonStrokeDashArray

        String getPolygonStrokeDashArray​(int ROIIndex,
                                         int shapeIndex)
        Get the StrokeDashArray property of Polygon.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the StrokeDashArray property.
      • getPolygonStrokeWidth

        Length getPolygonStrokeWidth​(int ROIIndex,
                                     int shapeIndex)
        Get the StrokeWidth property of Polygon.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the StrokeWidth property.
      • getPolygonText

        String getPolygonText​(int ROIIndex,
                              int shapeIndex)
        Get the Text property of Polygon.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Text property.
      • getPolygonTheC

        NonNegativeInteger getPolygonTheC​(int ROIIndex,
                                          int shapeIndex)
        Get the TheC property of Polygon.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the TheC property.
      • getPolygonTheT

        NonNegativeInteger getPolygonTheT​(int ROIIndex,
                                          int shapeIndex)
        Get the TheT property of Polygon.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the TheT property.
      • getPolygonTheZ

        NonNegativeInteger getPolygonTheZ​(int ROIIndex,
                                          int shapeIndex)
        Get the TheZ property of Polygon.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the TheZ property.
      • getPolygonTransform

        AffineTransform getPolygonTransform​(int ROIIndex,
                                            int shapeIndex)
        Get the Transform property of Polygon.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Transform property.
      • getPolylineAnnotationRef

        String getPolylineAnnotationRef​(int ROIIndex,
                                        int shapeIndex,
                                        int annotationRefIndex)
        Get the AnnotationRef property of Polyline.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getPolylineFillColor

        Color getPolylineFillColor​(int ROIIndex,
                                   int shapeIndex)
        Get the FillColor property of Polyline.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FillColor property.
      • getPolylineFillRule

        FillRule getPolylineFillRule​(int ROIIndex,
                                     int shapeIndex)
        Get the FillRule property of Polyline.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FillRule property.
      • getPolylineFontFamily

        FontFamily getPolylineFontFamily​(int ROIIndex,
                                         int shapeIndex)
        Get the FontFamily property of Polyline.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FontFamily property.
      • getPolylineFontSize

        Length getPolylineFontSize​(int ROIIndex,
                                   int shapeIndex)
        Get the FontSize property of Polyline.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FontSize property.
      • getPolylineFontStyle

        FontStyle getPolylineFontStyle​(int ROIIndex,
                                       int shapeIndex)
        Get the FontStyle property of Polyline.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FontStyle property.
      • getPolylineID

        String getPolylineID​(int ROIIndex,
                             int shapeIndex)
        Get the ID property of Polyline.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the ID property.
      • getPolylineLocked

        Boolean getPolylineLocked​(int ROIIndex,
                                  int shapeIndex)
        Get the Locked property of Polyline.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Locked property.
      • getPolylineMarkerEnd

        Marker getPolylineMarkerEnd​(int ROIIndex,
                                    int shapeIndex)
        Get the MarkerEnd property of Polyline.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the MarkerEnd property.
      • getPolylineMarkerStart

        Marker getPolylineMarkerStart​(int ROIIndex,
                                      int shapeIndex)
        Get the MarkerStart property of Polyline.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the MarkerStart property.
      • getPolylinePoints

        String getPolylinePoints​(int ROIIndex,
                                 int shapeIndex)
        Get the Points property of Polyline.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Points property.
      • getPolylineStrokeColor

        Color getPolylineStrokeColor​(int ROIIndex,
                                     int shapeIndex)
        Get the StrokeColor property of Polyline.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the StrokeColor property.
      • getPolylineStrokeDashArray

        String getPolylineStrokeDashArray​(int ROIIndex,
                                          int shapeIndex)
        Get the StrokeDashArray property of Polyline.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the StrokeDashArray property.
      • getPolylineStrokeWidth

        Length getPolylineStrokeWidth​(int ROIIndex,
                                      int shapeIndex)
        Get the StrokeWidth property of Polyline.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the StrokeWidth property.
      • getPolylineText

        String getPolylineText​(int ROIIndex,
                               int shapeIndex)
        Get the Text property of Polyline.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Text property.
      • getPolylineTheC

        NonNegativeInteger getPolylineTheC​(int ROIIndex,
                                           int shapeIndex)
        Get the TheC property of Polyline.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the TheC property.
      • getPolylineTheT

        NonNegativeInteger getPolylineTheT​(int ROIIndex,
                                           int shapeIndex)
        Get the TheT property of Polyline.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the TheT property.
      • getPolylineTheZ

        NonNegativeInteger getPolylineTheZ​(int ROIIndex,
                                           int shapeIndex)
        Get the TheZ property of Polyline.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the TheZ property.
      • getPolylineTransform

        AffineTransform getPolylineTransform​(int ROIIndex,
                                             int shapeIndex)
        Get the Transform property of Polyline.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Transform property.
      • getProjectAnnotationRef

        String getProjectAnnotationRef​(int projectIndex,
                                       int annotationRefIndex)
        Get the AnnotationRef property of Project.
        Parameters:
        projectIndex - the Project index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getProjectDatasetRef

        String getProjectDatasetRef​(int projectIndex,
                                    int datasetRefIndex)
        Get the DatasetRef property of Project.
        Parameters:
        projectIndex - the Project index.
        datasetRefIndex - DatasetRef index.
        Returns:
        the DatasetRef property.
      • getProjectDescription

        String getProjectDescription​(int projectIndex)
        Get the Description property of Project.
        Parameters:
        projectIndex - the Project index.
        Returns:
        the Description property.
      • getProjectExperimenterGroupRef

        String getProjectExperimenterGroupRef​(int projectIndex)
        Get the ExperimenterGroupRef property of Project.
        Parameters:
        projectIndex - the Project index.
        Returns:
        the ExperimenterGroupRef property.
      • getProjectExperimenterRef

        String getProjectExperimenterRef​(int projectIndex)
        Get the ExperimenterRef property of Project.
        Parameters:
        projectIndex - the Project index.
        Returns:
        the ExperimenterRef property.
      • getProjectID

        String getProjectID​(int projectIndex)
        Get the ID property of Project.
        Parameters:
        projectIndex - the Project index.
        Returns:
        the ID property.
      • getProjectName

        String getProjectName​(int projectIndex)
        Get the Name property of Project.
        Parameters:
        projectIndex - the Project index.
        Returns:
        the Name property.
      • getROIAnnotationRef

        String getROIAnnotationRef​(int ROIIndex,
                                   int annotationRefIndex)
        Get the AnnotationRef property of ROI.
        Parameters:
        ROIIndex - the ROI index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getROIDescription

        String getROIDescription​(int ROIIndex)
        Get the Description property of ROI.
        Parameters:
        ROIIndex - the ROI index.
        Returns:
        the Description property.
      • getROIID

        String getROIID​(int ROIIndex)
        Get the ID property of ROI.
        Parameters:
        ROIIndex - the ROI index.
        Returns:
        the ID property.
      • getROIName

        String getROIName​(int ROIIndex)
        Get the Name property of ROI.
        Parameters:
        ROIIndex - the ROI index.
        Returns:
        the Name property.
      • getReagentAnnotationRef

        String getReagentAnnotationRef​(int screenIndex,
                                       int reagentIndex,
                                       int annotationRefIndex)
        Get the AnnotationRef property of Reagent.
        Parameters:
        screenIndex - the Screen index.
        reagentIndex - the Reagent index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getReagentDescription

        String getReagentDescription​(int screenIndex,
                                     int reagentIndex)
        Get the Description property of Reagent.
        Parameters:
        screenIndex - the Screen index.
        reagentIndex - the Reagent index.
        Returns:
        the Description property.
      • getReagentID

        String getReagentID​(int screenIndex,
                            int reagentIndex)
        Get the ID property of Reagent.
        Parameters:
        screenIndex - the Screen index.
        reagentIndex - the Reagent index.
        Returns:
        the ID property.
      • getReagentName

        String getReagentName​(int screenIndex,
                              int reagentIndex)
        Get the Name property of Reagent.
        Parameters:
        screenIndex - the Screen index.
        reagentIndex - the Reagent index.
        Returns:
        the Name property.
      • getReagentReagentIdentifier

        String getReagentReagentIdentifier​(int screenIndex,
                                           int reagentIndex)
        Get the ReagentIdentifier property of Reagent.
        Parameters:
        screenIndex - the Screen index.
        reagentIndex - the Reagent index.
        Returns:
        the ReagentIdentifier property.
      • getRectangleAnnotationRef

        String getRectangleAnnotationRef​(int ROIIndex,
                                         int shapeIndex,
                                         int annotationRefIndex)
        Get the AnnotationRef property of Rectangle.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getRectangleFillColor

        Color getRectangleFillColor​(int ROIIndex,
                                    int shapeIndex)
        Get the FillColor property of Rectangle.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FillColor property.
      • getRectangleFillRule

        FillRule getRectangleFillRule​(int ROIIndex,
                                      int shapeIndex)
        Get the FillRule property of Rectangle.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FillRule property.
      • getRectangleFontFamily

        FontFamily getRectangleFontFamily​(int ROIIndex,
                                          int shapeIndex)
        Get the FontFamily property of Rectangle.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FontFamily property.
      • getRectangleFontSize

        Length getRectangleFontSize​(int ROIIndex,
                                    int shapeIndex)
        Get the FontSize property of Rectangle.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FontSize property.
      • getRectangleFontStyle

        FontStyle getRectangleFontStyle​(int ROIIndex,
                                        int shapeIndex)
        Get the FontStyle property of Rectangle.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the FontStyle property.
      • getRectangleHeight

        Double getRectangleHeight​(int ROIIndex,
                                  int shapeIndex)
        Get the Height property of Rectangle.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Height property.
      • getRectangleID

        String getRectangleID​(int ROIIndex,
                              int shapeIndex)
        Get the ID property of Rectangle.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the ID property.
      • getRectangleLocked

        Boolean getRectangleLocked​(int ROIIndex,
                                   int shapeIndex)
        Get the Locked property of Rectangle.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Locked property.
      • getRectangleStrokeColor

        Color getRectangleStrokeColor​(int ROIIndex,
                                      int shapeIndex)
        Get the StrokeColor property of Rectangle.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the StrokeColor property.
      • getRectangleStrokeDashArray

        String getRectangleStrokeDashArray​(int ROIIndex,
                                           int shapeIndex)
        Get the StrokeDashArray property of Rectangle.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the StrokeDashArray property.
      • getRectangleStrokeWidth

        Length getRectangleStrokeWidth​(int ROIIndex,
                                       int shapeIndex)
        Get the StrokeWidth property of Rectangle.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the StrokeWidth property.
      • getRectangleText

        String getRectangleText​(int ROIIndex,
                                int shapeIndex)
        Get the Text property of Rectangle.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Text property.
      • getRectangleTheC

        NonNegativeInteger getRectangleTheC​(int ROIIndex,
                                            int shapeIndex)
        Get the TheC property of Rectangle.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the TheC property.
      • getRectangleTheT

        NonNegativeInteger getRectangleTheT​(int ROIIndex,
                                            int shapeIndex)
        Get the TheT property of Rectangle.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the TheT property.
      • getRectangleTheZ

        NonNegativeInteger getRectangleTheZ​(int ROIIndex,
                                            int shapeIndex)
        Get the TheZ property of Rectangle.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the TheZ property.
      • getRectangleTransform

        AffineTransform getRectangleTransform​(int ROIIndex,
                                              int shapeIndex)
        Get the Transform property of Rectangle.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Transform property.
      • getRectangleWidth

        Double getRectangleWidth​(int ROIIndex,
                                 int shapeIndex)
        Get the Width property of Rectangle.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Width property.
      • getRectangleX

        Double getRectangleX​(int ROIIndex,
                             int shapeIndex)
        Get the X property of Rectangle.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the X property.
      • getRectangleY

        Double getRectangleY​(int ROIIndex,
                             int shapeIndex)
        Get the Y property of Rectangle.
        Parameters:
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        Returns:
        the Y property.
      • getRightsRightsHeld

        String getRightsRightsHeld()
        Get the RightsHeld property of Rights.
        Returns:
        the RightsHeld property.
      • getRightsRightsHolder

        String getRightsRightsHolder()
        Get the RightsHolder property of Rights.
        Returns:
        the RightsHolder property.
      • getScreenAnnotationRef

        String getScreenAnnotationRef​(int screenIndex,
                                      int annotationRefIndex)
        Get the AnnotationRef property of Screen.
        Parameters:
        screenIndex - the Screen index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getScreenDescription

        String getScreenDescription​(int screenIndex)
        Get the Description property of Screen.
        Parameters:
        screenIndex - the Screen index.
        Returns:
        the Description property.
      • getScreenID

        String getScreenID​(int screenIndex)
        Get the ID property of Screen.
        Parameters:
        screenIndex - the Screen index.
        Returns:
        the ID property.
      • getScreenName

        String getScreenName​(int screenIndex)
        Get the Name property of Screen.
        Parameters:
        screenIndex - the Screen index.
        Returns:
        the Name property.
      • getScreenPlateRef

        String getScreenPlateRef​(int screenIndex,
                                 int plateRefIndex)
        Get the PlateRef property of Screen.
        Parameters:
        screenIndex - the Screen index.
        plateRefIndex - PlateRef index.
        Returns:
        the PlateRef property.
      • getScreenProtocolDescription

        String getScreenProtocolDescription​(int screenIndex)
        Get the ProtocolDescription property of Screen.
        Parameters:
        screenIndex - the Screen index.
        Returns:
        the ProtocolDescription property.
      • getScreenProtocolIdentifier

        String getScreenProtocolIdentifier​(int screenIndex)
        Get the ProtocolIdentifier property of Screen.
        Parameters:
        screenIndex - the Screen index.
        Returns:
        the ProtocolIdentifier property.
      • getScreenReagentSetDescription

        String getScreenReagentSetDescription​(int screenIndex)
        Get the ReagentSetDescription property of Screen.
        Parameters:
        screenIndex - the Screen index.
        Returns:
        the ReagentSetDescription property.
      • getScreenReagentSetIdentifier

        String getScreenReagentSetIdentifier​(int screenIndex)
        Get the ReagentSetIdentifier property of Screen.
        Parameters:
        screenIndex - the Screen index.
        Returns:
        the ReagentSetIdentifier property.
      • getScreenType

        String getScreenType​(int screenIndex)
        Get the Type property of Screen.
        Parameters:
        screenIndex - the Screen index.
        Returns:
        the Type property.
      • getStageLabelName

        String getStageLabelName​(int imageIndex)
        Get the Name property of StageLabel.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the Name property.
      • getStageLabelX

        Length getStageLabelX​(int imageIndex)
        Get the X property of StageLabel.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the X property.
      • getStageLabelY

        Length getStageLabelY​(int imageIndex)
        Get the Y property of StageLabel.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the Y property.
      • getStageLabelZ

        Length getStageLabelZ​(int imageIndex)
        Get the Z property of StageLabel.
        Parameters:
        imageIndex - the Image index.
        Returns:
        the Z property.
      • getTagAnnotationAnnotationRef

        String getTagAnnotationAnnotationRef​(int tagAnnotationIndex,
                                             int annotationRefIndex)
        Get the AnnotationRef property of TagAnnotation.
        Parameters:
        tagAnnotationIndex - the TagAnnotation index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getTagAnnotationAnnotator

        String getTagAnnotationAnnotator​(int tagAnnotationIndex)
        Get the Annotator property of TagAnnotation.
        Parameters:
        tagAnnotationIndex - the TagAnnotation index.
        Returns:
        the Annotator property.
      • getTagAnnotationDescription

        String getTagAnnotationDescription​(int tagAnnotationIndex)
        Get the Description property of TagAnnotation.
        Parameters:
        tagAnnotationIndex - the TagAnnotation index.
        Returns:
        the Description property.
      • getTagAnnotationID

        String getTagAnnotationID​(int tagAnnotationIndex)
        Get the ID property of TagAnnotation.
        Parameters:
        tagAnnotationIndex - the TagAnnotation index.
        Returns:
        the ID property.
      • getTagAnnotationNamespace

        String getTagAnnotationNamespace​(int tagAnnotationIndex)
        Get the Namespace property of TagAnnotation.
        Parameters:
        tagAnnotationIndex - the TagAnnotation index.
        Returns:
        the Namespace property.
      • getTagAnnotationValue

        String getTagAnnotationValue​(int tagAnnotationIndex)
        Get the Value property of TagAnnotation.
        Parameters:
        tagAnnotationIndex - the TagAnnotation index.
        Returns:
        the Value property.
      • getTermAnnotationAnnotationRef

        String getTermAnnotationAnnotationRef​(int termAnnotationIndex,
                                              int annotationRefIndex)
        Get the AnnotationRef property of TermAnnotation.
        Parameters:
        termAnnotationIndex - the TermAnnotation index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getTermAnnotationAnnotator

        String getTermAnnotationAnnotator​(int termAnnotationIndex)
        Get the Annotator property of TermAnnotation.
        Parameters:
        termAnnotationIndex - the TermAnnotation index.
        Returns:
        the Annotator property.
      • getTermAnnotationDescription

        String getTermAnnotationDescription​(int termAnnotationIndex)
        Get the Description property of TermAnnotation.
        Parameters:
        termAnnotationIndex - the TermAnnotation index.
        Returns:
        the Description property.
      • getTermAnnotationID

        String getTermAnnotationID​(int termAnnotationIndex)
        Get the ID property of TermAnnotation.
        Parameters:
        termAnnotationIndex - the TermAnnotation index.
        Returns:
        the ID property.
      • getTermAnnotationNamespace

        String getTermAnnotationNamespace​(int termAnnotationIndex)
        Get the Namespace property of TermAnnotation.
        Parameters:
        termAnnotationIndex - the TermAnnotation index.
        Returns:
        the Namespace property.
      • getTermAnnotationValue

        String getTermAnnotationValue​(int termAnnotationIndex)
        Get the Value property of TermAnnotation.
        Parameters:
        termAnnotationIndex - the TermAnnotation index.
        Returns:
        the Value property.
      • getTiffDataFirstC

        NonNegativeInteger getTiffDataFirstC​(int imageIndex,
                                             int tiffDataIndex)
        Get the FirstC property of TiffData.
        Parameters:
        imageIndex - the Image index.
        tiffDataIndex - the TiffData index.
        Returns:
        the FirstC property.
      • getTiffDataFirstT

        NonNegativeInteger getTiffDataFirstT​(int imageIndex,
                                             int tiffDataIndex)
        Get the FirstT property of TiffData.
        Parameters:
        imageIndex - the Image index.
        tiffDataIndex - the TiffData index.
        Returns:
        the FirstT property.
      • getTiffDataFirstZ

        NonNegativeInteger getTiffDataFirstZ​(int imageIndex,
                                             int tiffDataIndex)
        Get the FirstZ property of TiffData.
        Parameters:
        imageIndex - the Image index.
        tiffDataIndex - the TiffData index.
        Returns:
        the FirstZ property.
      • getTiffDataIFD

        NonNegativeInteger getTiffDataIFD​(int imageIndex,
                                          int tiffDataIndex)
        Get the IFD property of TiffData.
        Parameters:
        imageIndex - the Image index.
        tiffDataIndex - the TiffData index.
        Returns:
        the IFD property.
      • getTiffDataPlaneCount

        NonNegativeInteger getTiffDataPlaneCount​(int imageIndex,
                                                 int tiffDataIndex)
        Get the PlaneCount property of TiffData.
        Parameters:
        imageIndex - the Image index.
        tiffDataIndex - the TiffData index.
        Returns:
        the PlaneCount property.
      • getTimestampAnnotationAnnotationRef

        String getTimestampAnnotationAnnotationRef​(int timestampAnnotationIndex,
                                                   int annotationRefIndex)
        Get the AnnotationRef property of TimestampAnnotation.
        Parameters:
        timestampAnnotationIndex - the TimestampAnnotation index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getTimestampAnnotationAnnotator

        String getTimestampAnnotationAnnotator​(int timestampAnnotationIndex)
        Get the Annotator property of TimestampAnnotation.
        Parameters:
        timestampAnnotationIndex - the TimestampAnnotation index.
        Returns:
        the Annotator property.
      • getTimestampAnnotationDescription

        String getTimestampAnnotationDescription​(int timestampAnnotationIndex)
        Get the Description property of TimestampAnnotation.
        Parameters:
        timestampAnnotationIndex - the TimestampAnnotation index.
        Returns:
        the Description property.
      • getTimestampAnnotationID

        String getTimestampAnnotationID​(int timestampAnnotationIndex)
        Get the ID property of TimestampAnnotation.
        Parameters:
        timestampAnnotationIndex - the TimestampAnnotation index.
        Returns:
        the ID property.
      • getTimestampAnnotationNamespace

        String getTimestampAnnotationNamespace​(int timestampAnnotationIndex)
        Get the Namespace property of TimestampAnnotation.
        Parameters:
        timestampAnnotationIndex - the TimestampAnnotation index.
        Returns:
        the Namespace property.
      • getTimestampAnnotationValue

        Timestamp getTimestampAnnotationValue​(int timestampAnnotationIndex)
        Get the Value property of TimestampAnnotation.
        Parameters:
        timestampAnnotationIndex - the TimestampAnnotation index.
        Returns:
        the Value property.
      • getTransmittanceRangeCutIn

        Length getTransmittanceRangeCutIn​(int instrumentIndex,
                                          int filterIndex)
        Get the CutIn property of TransmittanceRange.
        Parameters:
        instrumentIndex - the Instrument index.
        filterIndex - the Filter index.
        Returns:
        the CutIn property.
      • getTransmittanceRangeCutInTolerance

        Length getTransmittanceRangeCutInTolerance​(int instrumentIndex,
                                                   int filterIndex)
        Get the CutInTolerance property of TransmittanceRange.
        Parameters:
        instrumentIndex - the Instrument index.
        filterIndex - the Filter index.
        Returns:
        the CutInTolerance property.
      • getTransmittanceRangeCutOut

        Length getTransmittanceRangeCutOut​(int instrumentIndex,
                                           int filterIndex)
        Get the CutOut property of TransmittanceRange.
        Parameters:
        instrumentIndex - the Instrument index.
        filterIndex - the Filter index.
        Returns:
        the CutOut property.
      • getTransmittanceRangeCutOutTolerance

        Length getTransmittanceRangeCutOutTolerance​(int instrumentIndex,
                                                    int filterIndex)
        Get the CutOutTolerance property of TransmittanceRange.
        Parameters:
        instrumentIndex - the Instrument index.
        filterIndex - the Filter index.
        Returns:
        the CutOutTolerance property.
      • getTransmittanceRangeTransmittance

        PercentFraction getTransmittanceRangeTransmittance​(int instrumentIndex,
                                                           int filterIndex)
        Get the Transmittance property of TransmittanceRange.
        Parameters:
        instrumentIndex - the Instrument index.
        filterIndex - the Filter index.
        Returns:
        the Transmittance property.
      • getUUIDFileName

        String getUUIDFileName​(int imageIndex,
                               int tiffDataIndex)
        Get the FileName property of UUID.
        Parameters:
        imageIndex - the Image index.
        tiffDataIndex - the TiffData index.
        Returns:
        the FileName property.
      • getWellAnnotationRef

        String getWellAnnotationRef​(int plateIndex,
                                    int wellIndex,
                                    int annotationRefIndex)
        Get the AnnotationRef property of Well.
        Parameters:
        plateIndex - the Plate index.
        wellIndex - the Well index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getWellColor

        Color getWellColor​(int plateIndex,
                           int wellIndex)
        Get the Color property of Well.
        Parameters:
        plateIndex - the Plate index.
        wellIndex - the Well index.
        Returns:
        the Color property.
      • getWellColumn

        NonNegativeInteger getWellColumn​(int plateIndex,
                                         int wellIndex)
        Get the Column property of Well.
        Parameters:
        plateIndex - the Plate index.
        wellIndex - the Well index.
        Returns:
        the Column property.
      • getWellExternalDescription

        String getWellExternalDescription​(int plateIndex,
                                          int wellIndex)
        Get the ExternalDescription property of Well.
        Parameters:
        plateIndex - the Plate index.
        wellIndex - the Well index.
        Returns:
        the ExternalDescription property.
      • getWellExternalIdentifier

        String getWellExternalIdentifier​(int plateIndex,
                                         int wellIndex)
        Get the ExternalIdentifier property of Well.
        Parameters:
        plateIndex - the Plate index.
        wellIndex - the Well index.
        Returns:
        the ExternalIdentifier property.
      • getWellID

        String getWellID​(int plateIndex,
                         int wellIndex)
        Get the ID property of Well.
        Parameters:
        plateIndex - the Plate index.
        wellIndex - the Well index.
        Returns:
        the ID property.
      • getWellReagentRef

        String getWellReagentRef​(int plateIndex,
                                 int wellIndex)
        Get the ReagentRef property of Well.
        Parameters:
        plateIndex - the Plate index.
        wellIndex - the Well index.
        Returns:
        the ReagentRef property.
      • getWellRow

        NonNegativeInteger getWellRow​(int plateIndex,
                                      int wellIndex)
        Get the Row property of Well.
        Parameters:
        plateIndex - the Plate index.
        wellIndex - the Well index.
        Returns:
        the Row property.
      • getWellType

        String getWellType​(int plateIndex,
                           int wellIndex)
        Get the Type property of Well.
        Parameters:
        plateIndex - the Plate index.
        wellIndex - the Well index.
        Returns:
        the Type property.
      • getWellSampleID

        String getWellSampleID​(int plateIndex,
                               int wellIndex,
                               int wellSampleIndex)
        Get the ID property of WellSample.
        Parameters:
        plateIndex - the Plate index.
        wellIndex - the Well index.
        wellSampleIndex - the WellSample index.
        Returns:
        the ID property.
      • getWellSampleImageRef

        String getWellSampleImageRef​(int plateIndex,
                                     int wellIndex,
                                     int wellSampleIndex)
        Get the ImageRef property of WellSample.
        Parameters:
        plateIndex - the Plate index.
        wellIndex - the Well index.
        wellSampleIndex - the WellSample index.
        Returns:
        the ImageRef property.
      • getWellSampleIndex

        NonNegativeInteger getWellSampleIndex​(int plateIndex,
                                              int wellIndex,
                                              int wellSampleIndex)
        Get the Index property of WellSample.
        Parameters:
        plateIndex - the Plate index.
        wellIndex - the Well index.
        wellSampleIndex - the WellSample index.
        Returns:
        the Index property.
      • getWellSamplePositionX

        Length getWellSamplePositionX​(int plateIndex,
                                      int wellIndex,
                                      int wellSampleIndex)
        Get the PositionX property of WellSample.
        Parameters:
        plateIndex - the Plate index.
        wellIndex - the Well index.
        wellSampleIndex - the WellSample index.
        Returns:
        the PositionX property.
      • getWellSamplePositionY

        Length getWellSamplePositionY​(int plateIndex,
                                      int wellIndex,
                                      int wellSampleIndex)
        Get the PositionY property of WellSample.
        Parameters:
        plateIndex - the Plate index.
        wellIndex - the Well index.
        wellSampleIndex - the WellSample index.
        Returns:
        the PositionY property.
      • getWellSampleTimepoint

        Timestamp getWellSampleTimepoint​(int plateIndex,
                                         int wellIndex,
                                         int wellSampleIndex)
        Get the Timepoint property of WellSample.
        Parameters:
        plateIndex - the Plate index.
        wellIndex - the Well index.
        wellSampleIndex - the WellSample index.
        Returns:
        the Timepoint property.
      • getXMLAnnotationAnnotationRef

        String getXMLAnnotationAnnotationRef​(int XMLAnnotationIndex,
                                             int annotationRefIndex)
        Get the AnnotationRef property of XMLAnnotation.
        Parameters:
        XMLAnnotationIndex - the XMLAnnotation index.
        annotationRefIndex - AnnotationRef index.
        Returns:
        the AnnotationRef property.
      • getXMLAnnotationAnnotator

        String getXMLAnnotationAnnotator​(int XMLAnnotationIndex)
        Get the Annotator property of XMLAnnotation.
        Parameters:
        XMLAnnotationIndex - the XMLAnnotation index.
        Returns:
        the Annotator property.
      • getXMLAnnotationDescription

        String getXMLAnnotationDescription​(int XMLAnnotationIndex)
        Get the Description property of XMLAnnotation.
        Parameters:
        XMLAnnotationIndex - the XMLAnnotation index.
        Returns:
        the Description property.
      • getXMLAnnotationID

        String getXMLAnnotationID​(int XMLAnnotationIndex)
        Get the ID property of XMLAnnotation.
        Parameters:
        XMLAnnotationIndex - the XMLAnnotation index.
        Returns:
        the ID property.
      • getXMLAnnotationNamespace

        String getXMLAnnotationNamespace​(int XMLAnnotationIndex)
        Get the Namespace property of XMLAnnotation.
        Parameters:
        XMLAnnotationIndex - the XMLAnnotation index.
        Returns:
        the Namespace property.
      • getXMLAnnotationValue

        String getXMLAnnotationValue​(int XMLAnnotationIndex)
        Get the Value property of XMLAnnotation.
        Parameters:
        XMLAnnotationIndex - the XMLAnnotation index.
        Returns:
        the Value property.