Package ome.xml.meta

Interface MetadataStore

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

    public interface MetadataStore
    extends BaseMetadata
    A proxy whose responsibility it is to marshal biological image data into a particular storage medium.

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

    The MetadataStore interface goes hand in hand with the MetadataRetrieve 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.

    Important note: It is strongly recommended that applications (e.g., file format readers) using MetadataStore populate information in a linear order. Specifically, iterating over entities from "leftmost" index to "rightmost" index is required for certain MetadataStore implementations such as OMERO's OMEROMetadataStore. For example, when populating Image, Pixels and Plane information, an outer loop should iterate across imageIndex, an inner loop should iterate across pixelsIndex, and an innermost loop should handle planeIndex. For an illustration of the ideal traversal order, see MetadataConverter.convertMetadata(ome.xml.meta.MetadataRetrieve, ome.xml.meta.MetadataStore).

    Author:
    Chris Allan callan at blackcat.ca, Curtis Rueden ctrueden at wisc.edu
    • Method Detail

      • createRoot

        void createRoot()
        Create root node. The action taken here is specific to the concrete metadata implementation.
      • getRoot

        MetadataRoot getRoot()
        Get the root node of the metadata. Note that the root node type will be specific to the concrete metadata implementation.
        Returns:
        the root node.
      • setRoot

        void setRoot​(MetadataRoot root)
        Set the root node of the metadata. Note that the root node type will be specific to the concrete metadata implementation. An exception will be thrown if the root node is of an incompatible type.
        Parameters:
        root - the root node.
      • setMapAnnotationValue

        void setMapAnnotationValue​(List<MapPair> value,
                                   int mapAnnotationIndex)
        Set the values of a MapAnnotation.
        Parameters:
        value - the MapAnnotation values to set.
        mapAnnotationIndex - the MapAnnotation index.
      • setGenericExcitationSourceMap

        void setGenericExcitationSourceMap​(List<MapPair> map,
                                           int instrumentIndex,
                                           int lightSourceIndex)
        Set the MapAnnotation values of a GenericExcitationSource.
        Parameters:
        map - the MapAnnotation values to set.
        instrumentIndex - the Instrument index.
      • setImagingEnvironmentMap

        void setImagingEnvironmentMap​(List<MapPair> map,
                                      int imageIndex)
        Set the MapAnnotation values of an ImagingEnvironment.
        Parameters:
        map - the MapAnnotation values to set.
        imageIndex - the Image index.
      • setUUID

        void setUUID​(String uuid)
        Set the UUID associated with this collection of metadata.
        Parameters:
        uuid - the UUID to set.
      • setCreator

        default void setCreator​(String creator)
        Set the Creator associated with this collection of metadata.
        Parameters:
        creator - the Creator to set.
      • setArcAnnotationRef

        void setArcAnnotationRef​(String annotation,
                                 int instrumentIndex,
                                 int lightSourceIndex,
                                 int annotationRefIndex)
        Set the AnnotationRef property of Arc.
        Parameters:
        annotation - AnnotationRef to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        annotationRefIndex - AnnotationRef index (unused).
      • setArcID

        void setArcID​(String id,
                      int instrumentIndex,
                      int lightSourceIndex)
        Set the ID property of Arc.
        Parameters:
        id - ID to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setArcLotNumber

        void setArcLotNumber​(String lotNumber,
                             int instrumentIndex,
                             int lightSourceIndex)
        Set the LotNumber property of Arc.
        Parameters:
        lotNumber - LotNumber to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setArcManufacturer

        void setArcManufacturer​(String manufacturer,
                                int instrumentIndex,
                                int lightSourceIndex)
        Set the Manufacturer property of Arc.
        Parameters:
        manufacturer - Manufacturer to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setArcModel

        void setArcModel​(String model,
                         int instrumentIndex,
                         int lightSourceIndex)
        Set the Model property of Arc.
        Parameters:
        model - Model to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setArcPower

        void setArcPower​(Power power,
                         int instrumentIndex,
                         int lightSourceIndex)
        Set the Power property of Arc.
        Parameters:
        power - Power to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setArcSerialNumber

        void setArcSerialNumber​(String serialNumber,
                                int instrumentIndex,
                                int lightSourceIndex)
        Set the SerialNumber property of Arc.
        Parameters:
        serialNumber - SerialNumber to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setArcType

        void setArcType​(ArcType type,
                        int instrumentIndex,
                        int lightSourceIndex)
        Set the Type property of Arc.
        Parameters:
        type - Type to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setBinaryFileBinData

        void setBinaryFileBinData​(byte[] base64Binary,
                                  int fileAnnotationIndex)
        Set the Base64Binary property of BinData.
        Parameters:
        base64Binary - Base64Binary to set.
        fileAnnotationIndex - the FileAnnotation index.
      • setMaskBinData

        void setMaskBinData​(byte[] base64Binary,
                            int ROIIndex,
                            int shapeIndex)
        Set the Base64Binary property of BinData.
        Parameters:
        base64Binary - Base64Binary to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPixelsBinData

        void setPixelsBinData​(byte[] base64Binary,
                              int imageIndex,
                              int binDataIndex)
        Set the Base64Binary property of BinData.
        Parameters:
        base64Binary - Base64Binary to set.
        imageIndex - the Image index.
        binDataIndex - the BinData index.
      • setBinaryFileBinDataBigEndian

        void setBinaryFileBinDataBigEndian​(Boolean bigEndian,
                                           int fileAnnotationIndex)
        Set the BigEndian property of BinData.
        Parameters:
        bigEndian - BigEndian to set.
        fileAnnotationIndex - the FileAnnotation index.
      • setMaskBinDataBigEndian

        void setMaskBinDataBigEndian​(Boolean bigEndian,
                                     int ROIIndex,
                                     int shapeIndex)
        Set the BigEndian property of BinData.
        Parameters:
        bigEndian - BigEndian to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPixelsBinDataBigEndian

        void setPixelsBinDataBigEndian​(Boolean bigEndian,
                                       int imageIndex,
                                       int binDataIndex)
        Set the BigEndian property of BinData.
        Parameters:
        bigEndian - BigEndian to set.
        imageIndex - the Image index.
        binDataIndex - the BinData index.
      • setBinaryFileBinDataCompression

        void setBinaryFileBinDataCompression​(Compression compression,
                                             int fileAnnotationIndex)
        Set the Compression property of BinData.
        Parameters:
        compression - Compression to set.
        fileAnnotationIndex - the FileAnnotation index.
      • setMaskBinDataCompression

        void setMaskBinDataCompression​(Compression compression,
                                       int ROIIndex,
                                       int shapeIndex)
        Set the Compression property of BinData.
        Parameters:
        compression - Compression to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPixelsBinDataCompression

        void setPixelsBinDataCompression​(Compression compression,
                                         int imageIndex,
                                         int binDataIndex)
        Set the Compression property of BinData.
        Parameters:
        compression - Compression to set.
        imageIndex - the Image index.
        binDataIndex - the BinData index.
      • setBinaryFileBinDataLength

        void setBinaryFileBinDataLength​(NonNegativeLong length,
                                        int fileAnnotationIndex)
        Set the Length property of BinData.
        Parameters:
        length - Length to set.
        fileAnnotationIndex - the FileAnnotation index.
      • setMaskBinDataLength

        void setMaskBinDataLength​(NonNegativeLong length,
                                  int ROIIndex,
                                  int shapeIndex)
        Set the Length property of BinData.
        Parameters:
        length - Length to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPixelsBinDataLength

        void setPixelsBinDataLength​(NonNegativeLong length,
                                    int imageIndex,
                                    int binDataIndex)
        Set the Length property of BinData.
        Parameters:
        length - Length to set.
        imageIndex - the Image index.
        binDataIndex - the BinData index.
      • setBinaryFileFileName

        void setBinaryFileFileName​(String fileName,
                                   int fileAnnotationIndex)
        Set the FileName property of BinaryFile.
        Parameters:
        fileName - FileName to set.
        fileAnnotationIndex - the FileAnnotation index.
      • setBinaryFileMIMEType

        void setBinaryFileMIMEType​(String mimeType,
                                   int fileAnnotationIndex)
        Set the MIMEType property of BinaryFile.
        Parameters:
        mimeType - MIMEType to set.
        fileAnnotationIndex - the FileAnnotation index.
      • setBinaryFileSize

        void setBinaryFileSize​(NonNegativeLong size,
                               int fileAnnotationIndex)
        Set the Size property of BinaryFile.
        Parameters:
        size - Size to set.
        fileAnnotationIndex - the FileAnnotation index.
      • setBinaryOnlyMetadataFile

        void setBinaryOnlyMetadataFile​(String metadataFile)
        Set the MetadataFile property of BinaryOnly.
        Parameters:
        metadataFile - MetadataFile to set.
      • setBinaryOnlyUUID

        void setBinaryOnlyUUID​(String uuid)
        Set the UUID property of BinaryOnly.
        Parameters:
        uuid - UUID to set.
      • setBooleanAnnotationAnnotationRef

        void setBooleanAnnotationAnnotationRef​(String annotation,
                                               int booleanAnnotationIndex,
                                               int annotationRefIndex)
        Set the AnnotationRef property of BooleanAnnotation.
        Parameters:
        annotation - AnnotationRef to set.
        booleanAnnotationIndex - the BooleanAnnotation index.
        annotationRefIndex - AnnotationRef index (unused).
      • setBooleanAnnotationAnnotator

        void setBooleanAnnotationAnnotator​(String annotator,
                                           int booleanAnnotationIndex)
        Set the Annotator property of BooleanAnnotation.
        Parameters:
        annotator - Annotator to set.
        booleanAnnotationIndex - the BooleanAnnotation index.
      • setBooleanAnnotationDescription

        void setBooleanAnnotationDescription​(String description,
                                             int booleanAnnotationIndex)
        Set the Description property of BooleanAnnotation.
        Parameters:
        description - Description to set.
        booleanAnnotationIndex - the BooleanAnnotation index.
      • setBooleanAnnotationID

        void setBooleanAnnotationID​(String id,
                                    int booleanAnnotationIndex)
        Set the ID property of BooleanAnnotation.
        Parameters:
        id - ID to set.
        booleanAnnotationIndex - the BooleanAnnotation index.
      • setBooleanAnnotationNamespace

        void setBooleanAnnotationNamespace​(String namespace,
                                           int booleanAnnotationIndex)
        Set the Namespace property of BooleanAnnotation.
        Parameters:
        namespace - Namespace to set.
        booleanAnnotationIndex - the BooleanAnnotation index.
      • setBooleanAnnotationValue

        void setBooleanAnnotationValue​(Boolean value,
                                       int booleanAnnotationIndex)
        Set the Value property of BooleanAnnotation.
        Parameters:
        value - Value to set.
        booleanAnnotationIndex - the BooleanAnnotation index.
      • setChannelAcquisitionMode

        void setChannelAcquisitionMode​(AcquisitionMode acquisitionMode,
                                       int imageIndex,
                                       int channelIndex)
        Set the AcquisitionMode property of Channel.
        Parameters:
        acquisitionMode - AcquisitionMode to set.
        imageIndex - the Image index.
        channelIndex - the Channel index.
      • setChannelAnnotationRef

        void setChannelAnnotationRef​(String annotation,
                                     int imageIndex,
                                     int channelIndex,
                                     int annotationRefIndex)
        Set the AnnotationRef property of Channel.
        Parameters:
        annotation - AnnotationRef to set.
        imageIndex - the Image index.
        channelIndex - the Channel index.
        annotationRefIndex - AnnotationRef index (unused).
      • setChannelColor

        void setChannelColor​(Color color,
                             int imageIndex,
                             int channelIndex)
        Set the Color property of Channel.
        Parameters:
        color - Color to set.
        imageIndex - the Image index.
        channelIndex - the Channel index.
      • setChannelContrastMethod

        void setChannelContrastMethod​(ContrastMethod contrastMethod,
                                      int imageIndex,
                                      int channelIndex)
        Set the ContrastMethod property of Channel.
        Parameters:
        contrastMethod - ContrastMethod to set.
        imageIndex - the Image index.
        channelIndex - the Channel index.
      • setChannelEmissionWavelength

        void setChannelEmissionWavelength​(Length emissionWavelength,
                                          int imageIndex,
                                          int channelIndex)
        Set the EmissionWavelength property of Channel.
        Parameters:
        emissionWavelength - EmissionWavelength to set.
        imageIndex - the Image index.
        channelIndex - the Channel index.
      • setChannelExcitationWavelength

        void setChannelExcitationWavelength​(Length excitationWavelength,
                                            int imageIndex,
                                            int channelIndex)
        Set the ExcitationWavelength property of Channel.
        Parameters:
        excitationWavelength - ExcitationWavelength to set.
        imageIndex - the Image index.
        channelIndex - the Channel index.
      • setChannelFilterSetRef

        void setChannelFilterSetRef​(String filterSet,
                                    int imageIndex,
                                    int channelIndex)
        Set the FilterSetRef property of Channel.
        Parameters:
        filterSet - FilterSetRef to set.
        imageIndex - the Image index.
        channelIndex - the Channel index.
      • setChannelFluor

        void setChannelFluor​(String fluor,
                             int imageIndex,
                             int channelIndex)
        Set the Fluor property of Channel.
        Parameters:
        fluor - Fluor to set.
        imageIndex - the Image index.
        channelIndex - the Channel index.
      • setChannelID

        void setChannelID​(String id,
                          int imageIndex,
                          int channelIndex)
        Set the ID property of Channel.
        Parameters:
        id - ID to set.
        imageIndex - the Image index.
        channelIndex - the Channel index.
      • setChannelIlluminationType

        void setChannelIlluminationType​(IlluminationType illuminationType,
                                        int imageIndex,
                                        int channelIndex)
        Set the IlluminationType property of Channel.
        Parameters:
        illuminationType - IlluminationType to set.
        imageIndex - the Image index.
        channelIndex - the Channel index.
      • setChannelNDFilter

        void setChannelNDFilter​(Double ndFilter,
                                int imageIndex,
                                int channelIndex)
        Set the NDFilter property of Channel.
        Parameters:
        ndFilter - NDFilter to set.
        imageIndex - the Image index.
        channelIndex - the Channel index.
      • setChannelName

        void setChannelName​(String name,
                            int imageIndex,
                            int channelIndex)
        Set the Name property of Channel.
        Parameters:
        name - Name to set.
        imageIndex - the Image index.
        channelIndex - the Channel index.
      • setChannelPinholeSize

        void setChannelPinholeSize​(Length pinholeSize,
                                   int imageIndex,
                                   int channelIndex)
        Set the PinholeSize property of Channel.
        Parameters:
        pinholeSize - PinholeSize to set.
        imageIndex - the Image index.
        channelIndex - the Channel index.
      • setChannelPockelCellSetting

        void setChannelPockelCellSetting​(Integer pockelCellSetting,
                                         int imageIndex,
                                         int channelIndex)
        Set the PockelCellSetting property of Channel.
        Parameters:
        pockelCellSetting - PockelCellSetting to set.
        imageIndex - the Image index.
        channelIndex - the Channel index.
      • setChannelSamplesPerPixel

        void setChannelSamplesPerPixel​(PositiveInteger samplesPerPixel,
                                       int imageIndex,
                                       int channelIndex)
        Set the SamplesPerPixel property of Channel.
        Parameters:
        samplesPerPixel - SamplesPerPixel to set.
        imageIndex - the Image index.
        channelIndex - the Channel index.
      • setCommentAnnotationAnnotationRef

        void setCommentAnnotationAnnotationRef​(String annotation,
                                               int commentAnnotationIndex,
                                               int annotationRefIndex)
        Set the AnnotationRef property of CommentAnnotation.
        Parameters:
        annotation - AnnotationRef to set.
        commentAnnotationIndex - the CommentAnnotation index.
        annotationRefIndex - AnnotationRef index (unused).
      • setCommentAnnotationAnnotator

        void setCommentAnnotationAnnotator​(String annotator,
                                           int commentAnnotationIndex)
        Set the Annotator property of CommentAnnotation.
        Parameters:
        annotator - Annotator to set.
        commentAnnotationIndex - the CommentAnnotation index.
      • setCommentAnnotationDescription

        void setCommentAnnotationDescription​(String description,
                                             int commentAnnotationIndex)
        Set the Description property of CommentAnnotation.
        Parameters:
        description - Description to set.
        commentAnnotationIndex - the CommentAnnotation index.
      • setCommentAnnotationID

        void setCommentAnnotationID​(String id,
                                    int commentAnnotationIndex)
        Set the ID property of CommentAnnotation.
        Parameters:
        id - ID to set.
        commentAnnotationIndex - the CommentAnnotation index.
      • setCommentAnnotationNamespace

        void setCommentAnnotationNamespace​(String namespace,
                                           int commentAnnotationIndex)
        Set the Namespace property of CommentAnnotation.
        Parameters:
        namespace - Namespace to set.
        commentAnnotationIndex - the CommentAnnotation index.
      • setCommentAnnotationValue

        void setCommentAnnotationValue​(String value,
                                       int commentAnnotationIndex)
        Set the Value property of CommentAnnotation.
        Parameters:
        value - Value to set.
        commentAnnotationIndex - the CommentAnnotation index.
      • setDatasetAnnotationRef

        void setDatasetAnnotationRef​(String annotation,
                                     int datasetIndex,
                                     int annotationRefIndex)
        Set the AnnotationRef property of Dataset.
        Parameters:
        annotation - AnnotationRef to set.
        datasetIndex - the Dataset index.
        annotationRefIndex - AnnotationRef index (unused).
      • setDatasetDescription

        void setDatasetDescription​(String description,
                                   int datasetIndex)
        Set the Description property of Dataset.
        Parameters:
        description - Description to set.
        datasetIndex - the Dataset index.
      • setDatasetExperimenterGroupRef

        void setDatasetExperimenterGroupRef​(String experimenterGroup,
                                            int datasetIndex)
        Set the ExperimenterGroupRef property of Dataset.
        Parameters:
        experimenterGroup - ExperimenterGroupRef to set.
        datasetIndex - the Dataset index.
      • setDatasetExperimenterRef

        void setDatasetExperimenterRef​(String experimenter,
                                       int datasetIndex)
        Set the ExperimenterRef property of Dataset.
        Parameters:
        experimenter - ExperimenterRef to set.
        datasetIndex - the Dataset index.
      • setDatasetID

        void setDatasetID​(String id,
                          int datasetIndex)
        Set the ID property of Dataset.
        Parameters:
        id - ID to set.
        datasetIndex - the Dataset index.
      • setDatasetImageRef

        void setDatasetImageRef​(String image,
                                int datasetIndex,
                                int imageRefIndex)
        Set the ImageRef property of Dataset.
        Parameters:
        image - ImageRef to set.
        datasetIndex - the Dataset index.
        imageRefIndex - ImageRef index (unused).
      • setDatasetName

        void setDatasetName​(String name,
                            int datasetIndex)
        Set the Name property of Dataset.
        Parameters:
        name - Name to set.
        datasetIndex - the Dataset index.
      • setDetectorAmplificationGain

        void setDetectorAmplificationGain​(Double amplificationGain,
                                          int instrumentIndex,
                                          int detectorIndex)
        Set the AmplificationGain property of Detector.
        Parameters:
        amplificationGain - AmplificationGain to set.
        instrumentIndex - the Instrument index.
        detectorIndex - the Detector index.
      • setDetectorAnnotationRef

        void setDetectorAnnotationRef​(String annotation,
                                      int instrumentIndex,
                                      int detectorIndex,
                                      int annotationRefIndex)
        Set the AnnotationRef property of Detector.
        Parameters:
        annotation - AnnotationRef to set.
        instrumentIndex - the Instrument index.
        detectorIndex - the Detector index.
        annotationRefIndex - AnnotationRef index (unused).
      • setDetectorGain

        void setDetectorGain​(Double gain,
                             int instrumentIndex,
                             int detectorIndex)
        Set the Gain property of Detector.
        Parameters:
        gain - Gain to set.
        instrumentIndex - the Instrument index.
        detectorIndex - the Detector index.
      • setDetectorID

        void setDetectorID​(String id,
                           int instrumentIndex,
                           int detectorIndex)
        Set the ID property of Detector.
        Parameters:
        id - ID to set.
        instrumentIndex - the Instrument index.
        detectorIndex - the Detector index.
      • setDetectorLotNumber

        void setDetectorLotNumber​(String lotNumber,
                                  int instrumentIndex,
                                  int detectorIndex)
        Set the LotNumber property of Detector.
        Parameters:
        lotNumber - LotNumber to set.
        instrumentIndex - the Instrument index.
        detectorIndex - the Detector index.
      • setDetectorManufacturer

        void setDetectorManufacturer​(String manufacturer,
                                     int instrumentIndex,
                                     int detectorIndex)
        Set the Manufacturer property of Detector.
        Parameters:
        manufacturer - Manufacturer to set.
        instrumentIndex - the Instrument index.
        detectorIndex - the Detector index.
      • setDetectorModel

        void setDetectorModel​(String model,
                              int instrumentIndex,
                              int detectorIndex)
        Set the Model property of Detector.
        Parameters:
        model - Model to set.
        instrumentIndex - the Instrument index.
        detectorIndex - the Detector index.
      • setDetectorOffset

        void setDetectorOffset​(Double offset,
                               int instrumentIndex,
                               int detectorIndex)
        Set the Offset property of Detector.
        Parameters:
        offset - Offset to set.
        instrumentIndex - the Instrument index.
        detectorIndex - the Detector index.
      • setDetectorSerialNumber

        void setDetectorSerialNumber​(String serialNumber,
                                     int instrumentIndex,
                                     int detectorIndex)
        Set the SerialNumber property of Detector.
        Parameters:
        serialNumber - SerialNumber to set.
        instrumentIndex - the Instrument index.
        detectorIndex - the Detector index.
      • setDetectorType

        void setDetectorType​(DetectorType type,
                             int instrumentIndex,
                             int detectorIndex)
        Set the Type property of Detector.
        Parameters:
        type - Type to set.
        instrumentIndex - the Instrument index.
        detectorIndex - the Detector index.
      • setDetectorVoltage

        void setDetectorVoltage​(ElectricPotential voltage,
                                int instrumentIndex,
                                int detectorIndex)
        Set the Voltage property of Detector.
        Parameters:
        voltage - Voltage to set.
        instrumentIndex - the Instrument index.
        detectorIndex - the Detector index.
      • setDetectorZoom

        void setDetectorZoom​(Double zoom,
                             int instrumentIndex,
                             int detectorIndex)
        Set the Zoom property of Detector.
        Parameters:
        zoom - Zoom to set.
        instrumentIndex - the Instrument index.
        detectorIndex - the Detector index.
      • setDetectorSettingsBinning

        void setDetectorSettingsBinning​(Binning binning,
                                        int imageIndex,
                                        int channelIndex)
        Set the Binning property of DetectorSettings.
        Parameters:
        binning - Binning to set.
        imageIndex - the Image index.
        channelIndex - the Channel index.
      • setDetectorSettingsGain

        void setDetectorSettingsGain​(Double gain,
                                     int imageIndex,
                                     int channelIndex)
        Set the Gain property of DetectorSettings.
        Parameters:
        gain - Gain to set.
        imageIndex - the Image index.
        channelIndex - the Channel index.
      • setDetectorSettingsID

        void setDetectorSettingsID​(String id,
                                   int imageIndex,
                                   int channelIndex)
        Set the ID property of DetectorSettings.
        Parameters:
        id - ID to set.
        imageIndex - the Image index.
        channelIndex - the Channel index.
      • setDetectorSettingsIntegration

        void setDetectorSettingsIntegration​(PositiveInteger integration,
                                            int imageIndex,
                                            int channelIndex)
        Set the Integration property of DetectorSettings.
        Parameters:
        integration - Integration to set.
        imageIndex - the Image index.
        channelIndex - the Channel index.
      • setDetectorSettingsOffset

        void setDetectorSettingsOffset​(Double offset,
                                       int imageIndex,
                                       int channelIndex)
        Set the Offset property of DetectorSettings.
        Parameters:
        offset - Offset to set.
        imageIndex - the Image index.
        channelIndex - the Channel index.
      • setDetectorSettingsReadOutRate

        void setDetectorSettingsReadOutRate​(Frequency readOutRate,
                                            int imageIndex,
                                            int channelIndex)
        Set the ReadOutRate property of DetectorSettings.
        Parameters:
        readOutRate - ReadOutRate to set.
        imageIndex - the Image index.
        channelIndex - the Channel index.
      • setDetectorSettingsVoltage

        void setDetectorSettingsVoltage​(ElectricPotential voltage,
                                        int imageIndex,
                                        int channelIndex)
        Set the Voltage property of DetectorSettings.
        Parameters:
        voltage - Voltage to set.
        imageIndex - the Image index.
        channelIndex - the Channel index.
      • setDetectorSettingsZoom

        void setDetectorSettingsZoom​(Double zoom,
                                     int imageIndex,
                                     int channelIndex)
        Set the Zoom property of DetectorSettings.
        Parameters:
        zoom - Zoom to set.
        imageIndex - the Image index.
        channelIndex - the Channel index.
      • setDichroicAnnotationRef

        void setDichroicAnnotationRef​(String annotation,
                                      int instrumentIndex,
                                      int dichroicIndex,
                                      int annotationRefIndex)
        Set the AnnotationRef property of Dichroic.
        Parameters:
        annotation - AnnotationRef to set.
        instrumentIndex - the Instrument index.
        dichroicIndex - the Dichroic index.
        annotationRefIndex - AnnotationRef index (unused).
      • setDichroicID

        void setDichroicID​(String id,
                           int instrumentIndex,
                           int dichroicIndex)
        Set the ID property of Dichroic.
        Parameters:
        id - ID to set.
        instrumentIndex - the Instrument index.
        dichroicIndex - the Dichroic index.
      • setDichroicLotNumber

        void setDichroicLotNumber​(String lotNumber,
                                  int instrumentIndex,
                                  int dichroicIndex)
        Set the LotNumber property of Dichroic.
        Parameters:
        lotNumber - LotNumber to set.
        instrumentIndex - the Instrument index.
        dichroicIndex - the Dichroic index.
      • setDichroicManufacturer

        void setDichroicManufacturer​(String manufacturer,
                                     int instrumentIndex,
                                     int dichroicIndex)
        Set the Manufacturer property of Dichroic.
        Parameters:
        manufacturer - Manufacturer to set.
        instrumentIndex - the Instrument index.
        dichroicIndex - the Dichroic index.
      • setDichroicModel

        void setDichroicModel​(String model,
                              int instrumentIndex,
                              int dichroicIndex)
        Set the Model property of Dichroic.
        Parameters:
        model - Model to set.
        instrumentIndex - the Instrument index.
        dichroicIndex - the Dichroic index.
      • setDichroicSerialNumber

        void setDichroicSerialNumber​(String serialNumber,
                                     int instrumentIndex,
                                     int dichroicIndex)
        Set the SerialNumber property of Dichroic.
        Parameters:
        serialNumber - SerialNumber to set.
        instrumentIndex - the Instrument index.
        dichroicIndex - the Dichroic index.
      • setDoubleAnnotationAnnotationRef

        void setDoubleAnnotationAnnotationRef​(String annotation,
                                              int doubleAnnotationIndex,
                                              int annotationRefIndex)
        Set the AnnotationRef property of DoubleAnnotation.
        Parameters:
        annotation - AnnotationRef to set.
        doubleAnnotationIndex - the DoubleAnnotation index.
        annotationRefIndex - AnnotationRef index (unused).
      • setDoubleAnnotationAnnotator

        void setDoubleAnnotationAnnotator​(String annotator,
                                          int doubleAnnotationIndex)
        Set the Annotator property of DoubleAnnotation.
        Parameters:
        annotator - Annotator to set.
        doubleAnnotationIndex - the DoubleAnnotation index.
      • setDoubleAnnotationDescription

        void setDoubleAnnotationDescription​(String description,
                                            int doubleAnnotationIndex)
        Set the Description property of DoubleAnnotation.
        Parameters:
        description - Description to set.
        doubleAnnotationIndex - the DoubleAnnotation index.
      • setDoubleAnnotationID

        void setDoubleAnnotationID​(String id,
                                   int doubleAnnotationIndex)
        Set the ID property of DoubleAnnotation.
        Parameters:
        id - ID to set.
        doubleAnnotationIndex - the DoubleAnnotation index.
      • setDoubleAnnotationNamespace

        void setDoubleAnnotationNamespace​(String namespace,
                                          int doubleAnnotationIndex)
        Set the Namespace property of DoubleAnnotation.
        Parameters:
        namespace - Namespace to set.
        doubleAnnotationIndex - the DoubleAnnotation index.
      • setDoubleAnnotationValue

        void setDoubleAnnotationValue​(Double value,
                                      int doubleAnnotationIndex)
        Set the Value property of DoubleAnnotation.
        Parameters:
        value - Value to set.
        doubleAnnotationIndex - the DoubleAnnotation index.
      • setEllipseAnnotationRef

        void setEllipseAnnotationRef​(String annotation,
                                     int ROIIndex,
                                     int shapeIndex,
                                     int annotationRefIndex)
        Set the AnnotationRef property of Ellipse.
        Parameters:
        annotation - AnnotationRef to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        annotationRefIndex - AnnotationRef index (unused).
      • setEllipseFillColor

        void setEllipseFillColor​(Color fillColor,
                                 int ROIIndex,
                                 int shapeIndex)
        Set the FillColor property of Ellipse.
        Parameters:
        fillColor - FillColor to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setEllipseFillRule

        void setEllipseFillRule​(FillRule fillRule,
                                int ROIIndex,
                                int shapeIndex)
        Set the FillRule property of Ellipse.
        Parameters:
        fillRule - FillRule to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setEllipseFontFamily

        void setEllipseFontFamily​(FontFamily fontFamily,
                                  int ROIIndex,
                                  int shapeIndex)
        Set the FontFamily property of Ellipse.
        Parameters:
        fontFamily - FontFamily to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setEllipseFontSize

        void setEllipseFontSize​(Length fontSize,
                                int ROIIndex,
                                int shapeIndex)
        Set the FontSize property of Ellipse.
        Parameters:
        fontSize - FontSize to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setEllipseFontStyle

        void setEllipseFontStyle​(FontStyle fontStyle,
                                 int ROIIndex,
                                 int shapeIndex)
        Set the FontStyle property of Ellipse.
        Parameters:
        fontStyle - FontStyle to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setEllipseID

        void setEllipseID​(String id,
                          int ROIIndex,
                          int shapeIndex)
        Set the ID property of Ellipse.
        Parameters:
        id - ID to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setEllipseLocked

        void setEllipseLocked​(Boolean locked,
                              int ROIIndex,
                              int shapeIndex)
        Set the Locked property of Ellipse.
        Parameters:
        locked - Locked to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setEllipseRadiusX

        void setEllipseRadiusX​(Double radiusX,
                               int ROIIndex,
                               int shapeIndex)
        Set the RadiusX property of Ellipse.
        Parameters:
        radiusX - RadiusX to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setEllipseRadiusY

        void setEllipseRadiusY​(Double radiusY,
                               int ROIIndex,
                               int shapeIndex)
        Set the RadiusY property of Ellipse.
        Parameters:
        radiusY - RadiusY to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setEllipseStrokeColor

        void setEllipseStrokeColor​(Color strokeColor,
                                   int ROIIndex,
                                   int shapeIndex)
        Set the StrokeColor property of Ellipse.
        Parameters:
        strokeColor - StrokeColor to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setEllipseStrokeDashArray

        void setEllipseStrokeDashArray​(String strokeDashArray,
                                       int ROIIndex,
                                       int shapeIndex)
        Set the StrokeDashArray property of Ellipse.
        Parameters:
        strokeDashArray - StrokeDashArray to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setEllipseStrokeWidth

        void setEllipseStrokeWidth​(Length strokeWidth,
                                   int ROIIndex,
                                   int shapeIndex)
        Set the StrokeWidth property of Ellipse.
        Parameters:
        strokeWidth - StrokeWidth to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setEllipseText

        void setEllipseText​(String text,
                            int ROIIndex,
                            int shapeIndex)
        Set the Text property of Ellipse.
        Parameters:
        text - Text to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setEllipseTheC

        void setEllipseTheC​(NonNegativeInteger theC,
                            int ROIIndex,
                            int shapeIndex)
        Set the TheC property of Ellipse.
        Parameters:
        theC - TheC to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setEllipseTheT

        void setEllipseTheT​(NonNegativeInteger theT,
                            int ROIIndex,
                            int shapeIndex)
        Set the TheT property of Ellipse.
        Parameters:
        theT - TheT to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setEllipseTheZ

        void setEllipseTheZ​(NonNegativeInteger theZ,
                            int ROIIndex,
                            int shapeIndex)
        Set the TheZ property of Ellipse.
        Parameters:
        theZ - TheZ to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setEllipseTransform

        void setEllipseTransform​(AffineTransform transform,
                                 int ROIIndex,
                                 int shapeIndex)
        Set the Transform property of Ellipse.
        Parameters:
        transform - Transform to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setEllipseX

        void setEllipseX​(Double x,
                         int ROIIndex,
                         int shapeIndex)
        Set the X property of Ellipse.
        Parameters:
        x - X to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setEllipseY

        void setEllipseY​(Double y,
                         int ROIIndex,
                         int shapeIndex)
        Set the Y property of Ellipse.
        Parameters:
        y - Y to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setExperimentDescription

        void setExperimentDescription​(String description,
                                      int experimentIndex)
        Set the Description property of Experiment.
        Parameters:
        description - Description to set.
        experimentIndex - the Experiment index.
      • setExperimentExperimenterRef

        void setExperimentExperimenterRef​(String experimenter,
                                          int experimentIndex)
        Set the ExperimenterRef property of Experiment.
        Parameters:
        experimenter - ExperimenterRef to set.
        experimentIndex - the Experiment index.
      • setExperimentID

        void setExperimentID​(String id,
                             int experimentIndex)
        Set the ID property of Experiment.
        Parameters:
        id - ID to set.
        experimentIndex - the Experiment index.
      • setExperimentType

        void setExperimentType​(ExperimentType type,
                               int experimentIndex)
        Set the Type property of Experiment.
        Parameters:
        type - Type to set.
        experimentIndex - the Experiment index.
      • setExperimenterAnnotationRef

        void setExperimenterAnnotationRef​(String annotation,
                                          int experimenterIndex,
                                          int annotationRefIndex)
        Set the AnnotationRef property of Experimenter.
        Parameters:
        annotation - AnnotationRef to set.
        experimenterIndex - the Experimenter index.
        annotationRefIndex - AnnotationRef index (unused).
      • setExperimenterEmail

        void setExperimenterEmail​(String email,
                                  int experimenterIndex)
        Set the Email property of Experimenter.
        Parameters:
        email - Email to set.
        experimenterIndex - the Experimenter index.
      • setExperimenterFirstName

        void setExperimenterFirstName​(String firstName,
                                      int experimenterIndex)
        Set the FirstName property of Experimenter.
        Parameters:
        firstName - FirstName to set.
        experimenterIndex - the Experimenter index.
      • setExperimenterID

        void setExperimenterID​(String id,
                               int experimenterIndex)
        Set the ID property of Experimenter.
        Parameters:
        id - ID to set.
        experimenterIndex - the Experimenter index.
      • setExperimenterInstitution

        void setExperimenterInstitution​(String institution,
                                        int experimenterIndex)
        Set the Institution property of Experimenter.
        Parameters:
        institution - Institution to set.
        experimenterIndex - the Experimenter index.
      • setExperimenterLastName

        void setExperimenterLastName​(String lastName,
                                     int experimenterIndex)
        Set the LastName property of Experimenter.
        Parameters:
        lastName - LastName to set.
        experimenterIndex - the Experimenter index.
      • setExperimenterMiddleName

        void setExperimenterMiddleName​(String middleName,
                                       int experimenterIndex)
        Set the MiddleName property of Experimenter.
        Parameters:
        middleName - MiddleName to set.
        experimenterIndex - the Experimenter index.
      • setExperimenterUserName

        void setExperimenterUserName​(String userName,
                                     int experimenterIndex)
        Set the UserName property of Experimenter.
        Parameters:
        userName - UserName to set.
        experimenterIndex - the Experimenter index.
      • setExperimenterGroupAnnotationRef

        void setExperimenterGroupAnnotationRef​(String annotation,
                                               int experimenterGroupIndex,
                                               int annotationRefIndex)
        Set the AnnotationRef property of ExperimenterGroup.
        Parameters:
        annotation - AnnotationRef to set.
        experimenterGroupIndex - the ExperimenterGroup index.
        annotationRefIndex - AnnotationRef index (unused).
      • setExperimenterGroupDescription

        void setExperimenterGroupDescription​(String description,
                                             int experimenterGroupIndex)
        Set the Description property of ExperimenterGroup.
        Parameters:
        description - Description to set.
        experimenterGroupIndex - the ExperimenterGroup index.
      • setExperimenterGroupExperimenterRef

        void setExperimenterGroupExperimenterRef​(String experimenter,
                                                 int experimenterGroupIndex,
                                                 int experimenterRefIndex)
        Set the ExperimenterRef property of ExperimenterGroup.
        Parameters:
        experimenter - ExperimenterRef to set.
        experimenterGroupIndex - the ExperimenterGroup index.
        experimenterRefIndex - ExperimenterRef index (unused).
      • setExperimenterGroupID

        void setExperimenterGroupID​(String id,
                                    int experimenterGroupIndex)
        Set the ID property of ExperimenterGroup.
        Parameters:
        id - ID to set.
        experimenterGroupIndex - the ExperimenterGroup index.
      • setExperimenterGroupLeader

        void setExperimenterGroupLeader​(String leader,
                                        int experimenterGroupIndex,
                                        int leaderIndex)
        Set the Leader property of ExperimenterGroup.
        Parameters:
        leader - Leader to set.
        experimenterGroupIndex - the ExperimenterGroup index.
        leaderIndex - Leader index (unused).
      • setExperimenterGroupName

        void setExperimenterGroupName​(String name,
                                      int experimenterGroupIndex)
        Set the Name property of ExperimenterGroup.
        Parameters:
        name - Name to set.
        experimenterGroupIndex - the ExperimenterGroup index.
      • setFilamentAnnotationRef

        void setFilamentAnnotationRef​(String annotation,
                                      int instrumentIndex,
                                      int lightSourceIndex,
                                      int annotationRefIndex)
        Set the AnnotationRef property of Filament.
        Parameters:
        annotation - AnnotationRef to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        annotationRefIndex - AnnotationRef index (unused).
      • setFilamentID

        void setFilamentID​(String id,
                           int instrumentIndex,
                           int lightSourceIndex)
        Set the ID property of Filament.
        Parameters:
        id - ID to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setFilamentLotNumber

        void setFilamentLotNumber​(String lotNumber,
                                  int instrumentIndex,
                                  int lightSourceIndex)
        Set the LotNumber property of Filament.
        Parameters:
        lotNumber - LotNumber to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setFilamentManufacturer

        void setFilamentManufacturer​(String manufacturer,
                                     int instrumentIndex,
                                     int lightSourceIndex)
        Set the Manufacturer property of Filament.
        Parameters:
        manufacturer - Manufacturer to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setFilamentModel

        void setFilamentModel​(String model,
                              int instrumentIndex,
                              int lightSourceIndex)
        Set the Model property of Filament.
        Parameters:
        model - Model to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setFilamentPower

        void setFilamentPower​(Power power,
                              int instrumentIndex,
                              int lightSourceIndex)
        Set the Power property of Filament.
        Parameters:
        power - Power to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setFilamentSerialNumber

        void setFilamentSerialNumber​(String serialNumber,
                                     int instrumentIndex,
                                     int lightSourceIndex)
        Set the SerialNumber property of Filament.
        Parameters:
        serialNumber - SerialNumber to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setFilamentType

        void setFilamentType​(FilamentType type,
                             int instrumentIndex,
                             int lightSourceIndex)
        Set the Type property of Filament.
        Parameters:
        type - Type to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setFileAnnotationAnnotationRef

        void setFileAnnotationAnnotationRef​(String annotation,
                                            int fileAnnotationIndex,
                                            int annotationRefIndex)
        Set the AnnotationRef property of FileAnnotation.
        Parameters:
        annotation - AnnotationRef to set.
        fileAnnotationIndex - the FileAnnotation index.
        annotationRefIndex - AnnotationRef index (unused).
      • setFileAnnotationAnnotator

        void setFileAnnotationAnnotator​(String annotator,
                                        int fileAnnotationIndex)
        Set the Annotator property of FileAnnotation.
        Parameters:
        annotator - Annotator to set.
        fileAnnotationIndex - the FileAnnotation index.
      • setFileAnnotationDescription

        void setFileAnnotationDescription​(String description,
                                          int fileAnnotationIndex)
        Set the Description property of FileAnnotation.
        Parameters:
        description - Description to set.
        fileAnnotationIndex - the FileAnnotation index.
      • setFileAnnotationID

        void setFileAnnotationID​(String id,
                                 int fileAnnotationIndex)
        Set the ID property of FileAnnotation.
        Parameters:
        id - ID to set.
        fileAnnotationIndex - the FileAnnotation index.
      • setFileAnnotationNamespace

        void setFileAnnotationNamespace​(String namespace,
                                        int fileAnnotationIndex)
        Set the Namespace property of FileAnnotation.
        Parameters:
        namespace - Namespace to set.
        fileAnnotationIndex - the FileAnnotation index.
      • setFilterAnnotationRef

        void setFilterAnnotationRef​(String annotation,
                                    int instrumentIndex,
                                    int filterIndex,
                                    int annotationRefIndex)
        Set the AnnotationRef property of Filter.
        Parameters:
        annotation - AnnotationRef to set.
        instrumentIndex - the Instrument index.
        filterIndex - the Filter index.
        annotationRefIndex - AnnotationRef index (unused).
      • setFilterFilterWheel

        void setFilterFilterWheel​(String filterWheel,
                                  int instrumentIndex,
                                  int filterIndex)
        Set the FilterWheel property of Filter.
        Parameters:
        filterWheel - FilterWheel to set.
        instrumentIndex - the Instrument index.
        filterIndex - the Filter index.
      • setFilterID

        void setFilterID​(String id,
                         int instrumentIndex,
                         int filterIndex)
        Set the ID property of Filter.
        Parameters:
        id - ID to set.
        instrumentIndex - the Instrument index.
        filterIndex - the Filter index.
      • setFilterLotNumber

        void setFilterLotNumber​(String lotNumber,
                                int instrumentIndex,
                                int filterIndex)
        Set the LotNumber property of Filter.
        Parameters:
        lotNumber - LotNumber to set.
        instrumentIndex - the Instrument index.
        filterIndex - the Filter index.
      • setFilterManufacturer

        void setFilterManufacturer​(String manufacturer,
                                   int instrumentIndex,
                                   int filterIndex)
        Set the Manufacturer property of Filter.
        Parameters:
        manufacturer - Manufacturer to set.
        instrumentIndex - the Instrument index.
        filterIndex - the Filter index.
      • setFilterModel

        void setFilterModel​(String model,
                            int instrumentIndex,
                            int filterIndex)
        Set the Model property of Filter.
        Parameters:
        model - Model to set.
        instrumentIndex - the Instrument index.
        filterIndex - the Filter index.
      • setFilterSerialNumber

        void setFilterSerialNumber​(String serialNumber,
                                   int instrumentIndex,
                                   int filterIndex)
        Set the SerialNumber property of Filter.
        Parameters:
        serialNumber - SerialNumber to set.
        instrumentIndex - the Instrument index.
        filterIndex - the Filter index.
      • setFilterType

        void setFilterType​(FilterType type,
                           int instrumentIndex,
                           int filterIndex)
        Set the Type property of Filter.
        Parameters:
        type - Type to set.
        instrumentIndex - the Instrument index.
        filterIndex - the Filter index.
      • setFilterSetDichroicRef

        void setFilterSetDichroicRef​(String dichroic,
                                     int instrumentIndex,
                                     int filterSetIndex)
        Set the DichroicRef property of FilterSet.
        Parameters:
        dichroic - DichroicRef to set.
        instrumentIndex - the Instrument index.
        filterSetIndex - the FilterSet index.
      • setFilterSetEmissionFilterRef

        void setFilterSetEmissionFilterRef​(String emissionFilter,
                                           int instrumentIndex,
                                           int filterSetIndex,
                                           int emissionFilterRefIndex)
        Set the EmissionFilterRef property of FilterSet.
        Parameters:
        emissionFilter - EmissionFilterRef to set.
        instrumentIndex - the Instrument index.
        filterSetIndex - the FilterSet index.
        emissionFilterRefIndex - EmissionFilterRef index (unused).
      • setFilterSetExcitationFilterRef

        void setFilterSetExcitationFilterRef​(String excitationFilter,
                                             int instrumentIndex,
                                             int filterSetIndex,
                                             int excitationFilterRefIndex)
        Set the ExcitationFilterRef property of FilterSet.
        Parameters:
        excitationFilter - ExcitationFilterRef to set.
        instrumentIndex - the Instrument index.
        filterSetIndex - the FilterSet index.
        excitationFilterRefIndex - ExcitationFilterRef index (unused).
      • setFilterSetID

        void setFilterSetID​(String id,
                            int instrumentIndex,
                            int filterSetIndex)
        Set the ID property of FilterSet.
        Parameters:
        id - ID to set.
        instrumentIndex - the Instrument index.
        filterSetIndex - the FilterSet index.
      • setFilterSetLotNumber

        void setFilterSetLotNumber​(String lotNumber,
                                   int instrumentIndex,
                                   int filterSetIndex)
        Set the LotNumber property of FilterSet.
        Parameters:
        lotNumber - LotNumber to set.
        instrumentIndex - the Instrument index.
        filterSetIndex - the FilterSet index.
      • setFilterSetManufacturer

        void setFilterSetManufacturer​(String manufacturer,
                                      int instrumentIndex,
                                      int filterSetIndex)
        Set the Manufacturer property of FilterSet.
        Parameters:
        manufacturer - Manufacturer to set.
        instrumentIndex - the Instrument index.
        filterSetIndex - the FilterSet index.
      • setFilterSetModel

        void setFilterSetModel​(String model,
                               int instrumentIndex,
                               int filterSetIndex)
        Set the Model property of FilterSet.
        Parameters:
        model - Model to set.
        instrumentIndex - the Instrument index.
        filterSetIndex - the FilterSet index.
      • setFilterSetSerialNumber

        void setFilterSetSerialNumber​(String serialNumber,
                                      int instrumentIndex,
                                      int filterSetIndex)
        Set the SerialNumber property of FilterSet.
        Parameters:
        serialNumber - SerialNumber to set.
        instrumentIndex - the Instrument index.
        filterSetIndex - the FilterSet index.
      • setFolderAnnotationRef

        void setFolderAnnotationRef​(String annotation,
                                    int folderIndex,
                                    int annotationRefIndex)
        Set the AnnotationRef property of Folder.
        Parameters:
        annotation - AnnotationRef to set.
        folderIndex - the Folder index.
        annotationRefIndex - AnnotationRef index (unused).
      • setFolderDescription

        void setFolderDescription​(String description,
                                  int folderIndex)
        Set the Description property of Folder.
        Parameters:
        description - Description to set.
        folderIndex - the Folder index.
      • setFolderFolderRef

        void setFolderFolderRef​(String folder,
                                int folderIndex,
                                int folderRefIndex)
        Set the FolderRef property of Folder.
        Parameters:
        folder - FolderRef to set.
        folderIndex - the Folder index.
        folderRefIndex - FolderRef index (unused).
      • setFolderID

        void setFolderID​(String id,
                         int folderIndex)
        Set the ID property of Folder.
        Parameters:
        id - ID to set.
        folderIndex - the Folder index.
      • setFolderImageRef

        void setFolderImageRef​(String image,
                               int folderIndex,
                               int imageRefIndex)
        Set the ImageRef property of Folder.
        Parameters:
        image - ImageRef to set.
        folderIndex - the Folder index.
        imageRefIndex - ImageRef index (unused).
      • setFolderName

        void setFolderName​(String name,
                           int folderIndex)
        Set the Name property of Folder.
        Parameters:
        name - Name to set.
        folderIndex - the Folder index.
      • setFolderROIRef

        void setFolderROIRef​(String roi,
                             int folderIndex,
                             int ROIRefIndex)
        Set the ROIRef property of Folder.
        Parameters:
        roi - ROIRef to set.
        folderIndex - the Folder index.
        ROIRefIndex - ROIRef index (unused).
      • setGenericExcitationSourceAnnotationRef

        void setGenericExcitationSourceAnnotationRef​(String annotation,
                                                     int instrumentIndex,
                                                     int lightSourceIndex,
                                                     int annotationRefIndex)
        Set the AnnotationRef property of GenericExcitationSource.
        Parameters:
        annotation - AnnotationRef to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        annotationRefIndex - AnnotationRef index (unused).
      • setGenericExcitationSourceID

        void setGenericExcitationSourceID​(String id,
                                          int instrumentIndex,
                                          int lightSourceIndex)
        Set the ID property of GenericExcitationSource.
        Parameters:
        id - ID to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setGenericExcitationSourceLotNumber

        void setGenericExcitationSourceLotNumber​(String lotNumber,
                                                 int instrumentIndex,
                                                 int lightSourceIndex)
        Set the LotNumber property of GenericExcitationSource.
        Parameters:
        lotNumber - LotNumber to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setGenericExcitationSourceManufacturer

        void setGenericExcitationSourceManufacturer​(String manufacturer,
                                                    int instrumentIndex,
                                                    int lightSourceIndex)
        Set the Manufacturer property of GenericExcitationSource.
        Parameters:
        manufacturer - Manufacturer to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setGenericExcitationSourceModel

        void setGenericExcitationSourceModel​(String model,
                                             int instrumentIndex,
                                             int lightSourceIndex)
        Set the Model property of GenericExcitationSource.
        Parameters:
        model - Model to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setGenericExcitationSourcePower

        void setGenericExcitationSourcePower​(Power power,
                                             int instrumentIndex,
                                             int lightSourceIndex)
        Set the Power property of GenericExcitationSource.
        Parameters:
        power - Power to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setGenericExcitationSourceSerialNumber

        void setGenericExcitationSourceSerialNumber​(String serialNumber,
                                                    int instrumentIndex,
                                                    int lightSourceIndex)
        Set the SerialNumber property of GenericExcitationSource.
        Parameters:
        serialNumber - SerialNumber to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setImageAcquisitionDate

        void setImageAcquisitionDate​(Timestamp acquisitionDate,
                                     int imageIndex)
        Set the AcquisitionDate property of Image.
        Parameters:
        acquisitionDate - AcquisitionDate to set.
        imageIndex - the Image index.
      • setImageAnnotationRef

        void setImageAnnotationRef​(String annotation,
                                   int imageIndex,
                                   int annotationRefIndex)
        Set the AnnotationRef property of Image.
        Parameters:
        annotation - AnnotationRef to set.
        imageIndex - the Image index.
        annotationRefIndex - AnnotationRef index (unused).
      • setImageDescription

        void setImageDescription​(String description,
                                 int imageIndex)
        Set the Description property of Image.
        Parameters:
        description - Description to set.
        imageIndex - the Image index.
      • setImageExperimentRef

        void setImageExperimentRef​(String experiment,
                                   int imageIndex)
        Set the ExperimentRef property of Image.
        Parameters:
        experiment - ExperimentRef to set.
        imageIndex - the Image index.
      • setImageExperimenterGroupRef

        void setImageExperimenterGroupRef​(String experimenterGroup,
                                          int imageIndex)
        Set the ExperimenterGroupRef property of Image.
        Parameters:
        experimenterGroup - ExperimenterGroupRef to set.
        imageIndex - the Image index.
      • setImageExperimenterRef

        void setImageExperimenterRef​(String experimenter,
                                     int imageIndex)
        Set the ExperimenterRef property of Image.
        Parameters:
        experimenter - ExperimenterRef to set.
        imageIndex - the Image index.
      • setImageID

        void setImageID​(String id,
                        int imageIndex)
        Set the ID property of Image.
        Parameters:
        id - ID to set.
        imageIndex - the Image index.
      • setImageInstrumentRef

        void setImageInstrumentRef​(String instrument,
                                   int imageIndex)
        Set the InstrumentRef property of Image.
        Parameters:
        instrument - InstrumentRef to set.
        imageIndex - the Image index.
      • setImageMicrobeamManipulationRef

        void setImageMicrobeamManipulationRef​(String microbeamManipulation,
                                              int imageIndex,
                                              int microbeamManipulationRefIndex)
        Set the MicrobeamManipulationRef property of Image.
        Parameters:
        microbeamManipulation - MicrobeamManipulationRef to set.
        imageIndex - the Image index.
        microbeamManipulationRefIndex - MicrobeamManipulationRef index (unused).
      • setImageName

        void setImageName​(String name,
                          int imageIndex)
        Set the Name property of Image.
        Parameters:
        name - Name to set.
        imageIndex - the Image index.
      • setImageROIRef

        void setImageROIRef​(String roi,
                            int imageIndex,
                            int ROIRefIndex)
        Set the ROIRef property of Image.
        Parameters:
        roi - ROIRef to set.
        imageIndex - the Image index.
        ROIRefIndex - ROIRef index (unused).
      • setImagingEnvironmentAirPressure

        void setImagingEnvironmentAirPressure​(Pressure airPressure,
                                              int imageIndex)
        Set the AirPressure property of ImagingEnvironment.
        Parameters:
        airPressure - AirPressure to set.
        imageIndex - the Image index.
      • setImagingEnvironmentCO2Percent

        void setImagingEnvironmentCO2Percent​(PercentFraction co2Percent,
                                             int imageIndex)
        Set the CO2Percent property of ImagingEnvironment.
        Parameters:
        co2Percent - CO2Percent to set.
        imageIndex - the Image index.
      • setImagingEnvironmentHumidity

        void setImagingEnvironmentHumidity​(PercentFraction humidity,
                                           int imageIndex)
        Set the Humidity property of ImagingEnvironment.
        Parameters:
        humidity - Humidity to set.
        imageIndex - the Image index.
      • setImagingEnvironmentTemperature

        void setImagingEnvironmentTemperature​(Temperature temperature,
                                              int imageIndex)
        Set the Temperature property of ImagingEnvironment.
        Parameters:
        temperature - Temperature to set.
        imageIndex - the Image index.
      • setInstrumentAnnotationRef

        void setInstrumentAnnotationRef​(String annotation,
                                        int instrumentIndex,
                                        int annotationRefIndex)
        Set the AnnotationRef property of Instrument.
        Parameters:
        annotation - AnnotationRef to set.
        instrumentIndex - the Instrument index.
        annotationRefIndex - AnnotationRef index (unused).
      • setInstrumentID

        void setInstrumentID​(String id,
                             int instrumentIndex)
        Set the ID property of Instrument.
        Parameters:
        id - ID to set.
        instrumentIndex - the Instrument index.
      • setLabelAnnotationRef

        void setLabelAnnotationRef​(String annotation,
                                   int ROIIndex,
                                   int shapeIndex,
                                   int annotationRefIndex)
        Set the AnnotationRef property of Label.
        Parameters:
        annotation - AnnotationRef to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        annotationRefIndex - AnnotationRef index (unused).
      • setLabelFillColor

        void setLabelFillColor​(Color fillColor,
                               int ROIIndex,
                               int shapeIndex)
        Set the FillColor property of Label.
        Parameters:
        fillColor - FillColor to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLabelFillRule

        void setLabelFillRule​(FillRule fillRule,
                              int ROIIndex,
                              int shapeIndex)
        Set the FillRule property of Label.
        Parameters:
        fillRule - FillRule to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLabelFontFamily

        void setLabelFontFamily​(FontFamily fontFamily,
                                int ROIIndex,
                                int shapeIndex)
        Set the FontFamily property of Label.
        Parameters:
        fontFamily - FontFamily to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLabelFontSize

        void setLabelFontSize​(Length fontSize,
                              int ROIIndex,
                              int shapeIndex)
        Set the FontSize property of Label.
        Parameters:
        fontSize - FontSize to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLabelFontStyle

        void setLabelFontStyle​(FontStyle fontStyle,
                               int ROIIndex,
                               int shapeIndex)
        Set the FontStyle property of Label.
        Parameters:
        fontStyle - FontStyle to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLabelID

        void setLabelID​(String id,
                        int ROIIndex,
                        int shapeIndex)
        Set the ID property of Label.
        Parameters:
        id - ID to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLabelLocked

        void setLabelLocked​(Boolean locked,
                            int ROIIndex,
                            int shapeIndex)
        Set the Locked property of Label.
        Parameters:
        locked - Locked to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLabelStrokeColor

        void setLabelStrokeColor​(Color strokeColor,
                                 int ROIIndex,
                                 int shapeIndex)
        Set the StrokeColor property of Label.
        Parameters:
        strokeColor - StrokeColor to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLabelStrokeDashArray

        void setLabelStrokeDashArray​(String strokeDashArray,
                                     int ROIIndex,
                                     int shapeIndex)
        Set the StrokeDashArray property of Label.
        Parameters:
        strokeDashArray - StrokeDashArray to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLabelStrokeWidth

        void setLabelStrokeWidth​(Length strokeWidth,
                                 int ROIIndex,
                                 int shapeIndex)
        Set the StrokeWidth property of Label.
        Parameters:
        strokeWidth - StrokeWidth to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLabelText

        void setLabelText​(String text,
                          int ROIIndex,
                          int shapeIndex)
        Set the Text property of Label.
        Parameters:
        text - Text to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLabelTheC

        void setLabelTheC​(NonNegativeInteger theC,
                          int ROIIndex,
                          int shapeIndex)
        Set the TheC property of Label.
        Parameters:
        theC - TheC to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLabelTheT

        void setLabelTheT​(NonNegativeInteger theT,
                          int ROIIndex,
                          int shapeIndex)
        Set the TheT property of Label.
        Parameters:
        theT - TheT to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLabelTheZ

        void setLabelTheZ​(NonNegativeInteger theZ,
                          int ROIIndex,
                          int shapeIndex)
        Set the TheZ property of Label.
        Parameters:
        theZ - TheZ to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLabelTransform

        void setLabelTransform​(AffineTransform transform,
                               int ROIIndex,
                               int shapeIndex)
        Set the Transform property of Label.
        Parameters:
        transform - Transform to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLabelX

        void setLabelX​(Double x,
                       int ROIIndex,
                       int shapeIndex)
        Set the X property of Label.
        Parameters:
        x - X to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLabelY

        void setLabelY​(Double y,
                       int ROIIndex,
                       int shapeIndex)
        Set the Y property of Label.
        Parameters:
        y - Y to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLaserAnnotationRef

        void setLaserAnnotationRef​(String annotation,
                                   int instrumentIndex,
                                   int lightSourceIndex,
                                   int annotationRefIndex)
        Set the AnnotationRef property of Laser.
        Parameters:
        annotation - AnnotationRef to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        annotationRefIndex - AnnotationRef index (unused).
      • setLaserFrequencyMultiplication

        void setLaserFrequencyMultiplication​(PositiveInteger frequencyMultiplication,
                                             int instrumentIndex,
                                             int lightSourceIndex)
        Set the FrequencyMultiplication property of Laser.
        Parameters:
        frequencyMultiplication - FrequencyMultiplication to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setLaserID

        void setLaserID​(String id,
                        int instrumentIndex,
                        int lightSourceIndex)
        Set the ID property of Laser.
        Parameters:
        id - ID to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setLaserLaserMedium

        void setLaserLaserMedium​(LaserMedium laserMedium,
                                 int instrumentIndex,
                                 int lightSourceIndex)
        Set the LaserMedium property of Laser.
        Parameters:
        laserMedium - LaserMedium to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setLaserLotNumber

        void setLaserLotNumber​(String lotNumber,
                               int instrumentIndex,
                               int lightSourceIndex)
        Set the LotNumber property of Laser.
        Parameters:
        lotNumber - LotNumber to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setLaserManufacturer

        void setLaserManufacturer​(String manufacturer,
                                  int instrumentIndex,
                                  int lightSourceIndex)
        Set the Manufacturer property of Laser.
        Parameters:
        manufacturer - Manufacturer to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setLaserModel

        void setLaserModel​(String model,
                           int instrumentIndex,
                           int lightSourceIndex)
        Set the Model property of Laser.
        Parameters:
        model - Model to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setLaserPockelCell

        void setLaserPockelCell​(Boolean pockelCell,
                                int instrumentIndex,
                                int lightSourceIndex)
        Set the PockelCell property of Laser.
        Parameters:
        pockelCell - PockelCell to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setLaserPower

        void setLaserPower​(Power power,
                           int instrumentIndex,
                           int lightSourceIndex)
        Set the Power property of Laser.
        Parameters:
        power - Power to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setLaserPulse

        void setLaserPulse​(Pulse pulse,
                           int instrumentIndex,
                           int lightSourceIndex)
        Set the Pulse property of Laser.
        Parameters:
        pulse - Pulse to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setLaserPump

        void setLaserPump​(String pump,
                          int instrumentIndex,
                          int lightSourceIndex)
        Set the Pump property of Laser.
        Parameters:
        pump - Pump to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setLaserRepetitionRate

        void setLaserRepetitionRate​(Frequency repetitionRate,
                                    int instrumentIndex,
                                    int lightSourceIndex)
        Set the RepetitionRate property of Laser.
        Parameters:
        repetitionRate - RepetitionRate to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setLaserSerialNumber

        void setLaserSerialNumber​(String serialNumber,
                                  int instrumentIndex,
                                  int lightSourceIndex)
        Set the SerialNumber property of Laser.
        Parameters:
        serialNumber - SerialNumber to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setLaserTuneable

        void setLaserTuneable​(Boolean tuneable,
                              int instrumentIndex,
                              int lightSourceIndex)
        Set the Tuneable property of Laser.
        Parameters:
        tuneable - Tuneable to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setLaserType

        void setLaserType​(LaserType type,
                          int instrumentIndex,
                          int lightSourceIndex)
        Set the Type property of Laser.
        Parameters:
        type - Type to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setLaserWavelength

        void setLaserWavelength​(Length wavelength,
                                int instrumentIndex,
                                int lightSourceIndex)
        Set the Wavelength property of Laser.
        Parameters:
        wavelength - Wavelength to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setLightEmittingDiodeAnnotationRef

        void setLightEmittingDiodeAnnotationRef​(String annotation,
                                                int instrumentIndex,
                                                int lightSourceIndex,
                                                int annotationRefIndex)
        Set the AnnotationRef property of LightEmittingDiode.
        Parameters:
        annotation - AnnotationRef to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
        annotationRefIndex - AnnotationRef index (unused).
      • setLightEmittingDiodeID

        void setLightEmittingDiodeID​(String id,
                                     int instrumentIndex,
                                     int lightSourceIndex)
        Set the ID property of LightEmittingDiode.
        Parameters:
        id - ID to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setLightEmittingDiodeLotNumber

        void setLightEmittingDiodeLotNumber​(String lotNumber,
                                            int instrumentIndex,
                                            int lightSourceIndex)
        Set the LotNumber property of LightEmittingDiode.
        Parameters:
        lotNumber - LotNumber to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setLightEmittingDiodeManufacturer

        void setLightEmittingDiodeManufacturer​(String manufacturer,
                                               int instrumentIndex,
                                               int lightSourceIndex)
        Set the Manufacturer property of LightEmittingDiode.
        Parameters:
        manufacturer - Manufacturer to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setLightEmittingDiodeModel

        void setLightEmittingDiodeModel​(String model,
                                        int instrumentIndex,
                                        int lightSourceIndex)
        Set the Model property of LightEmittingDiode.
        Parameters:
        model - Model to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setLightEmittingDiodePower

        void setLightEmittingDiodePower​(Power power,
                                        int instrumentIndex,
                                        int lightSourceIndex)
        Set the Power property of LightEmittingDiode.
        Parameters:
        power - Power to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setLightEmittingDiodeSerialNumber

        void setLightEmittingDiodeSerialNumber​(String serialNumber,
                                               int instrumentIndex,
                                               int lightSourceIndex)
        Set the SerialNumber property of LightEmittingDiode.
        Parameters:
        serialNumber - SerialNumber to set.
        instrumentIndex - the Instrument index.
        lightSourceIndex - the LightSource index.
      • setLightPathAnnotationRef

        void setLightPathAnnotationRef​(String annotation,
                                       int imageIndex,
                                       int channelIndex,
                                       int annotationRefIndex)
        Set the AnnotationRef property of LightPath.
        Parameters:
        annotation - AnnotationRef to set.
        imageIndex - the Image index.
        channelIndex - the Channel index.
        annotationRefIndex - AnnotationRef index (unused).
      • setLightPathDichroicRef

        void setLightPathDichroicRef​(String dichroic,
                                     int imageIndex,
                                     int channelIndex)
        Set the DichroicRef property of LightPath.
        Parameters:
        dichroic - DichroicRef to set.
        imageIndex - the Image index.
        channelIndex - the Channel index.
      • setLightPathEmissionFilterRef

        void setLightPathEmissionFilterRef​(String emissionFilter,
                                           int imageIndex,
                                           int channelIndex,
                                           int emissionFilterRefIndex)
        Set the EmissionFilterRef property of LightPath.
        Parameters:
        emissionFilter - EmissionFilterRef to set.
        imageIndex - the Image index.
        channelIndex - the Channel index.
        emissionFilterRefIndex - EmissionFilterRef index (unused).
      • setLightPathExcitationFilterRef

        void setLightPathExcitationFilterRef​(String excitationFilter,
                                             int imageIndex,
                                             int channelIndex,
                                             int excitationFilterRefIndex)
        Set the ExcitationFilterRef property of LightPath.
        Parameters:
        excitationFilter - ExcitationFilterRef to set.
        imageIndex - the Image index.
        channelIndex - the Channel index.
        excitationFilterRefIndex - ExcitationFilterRef index (unused).
      • setChannelLightSourceSettingsAttenuation

        void setChannelLightSourceSettingsAttenuation​(PercentFraction attenuation,
                                                      int imageIndex,
                                                      int channelIndex)
        Set the Attenuation property of LightSourceSettings.
        Parameters:
        attenuation - Attenuation to set.
        imageIndex - the Image index.
        channelIndex - the Channel index.
      • setMicrobeamManipulationLightSourceSettingsAttenuation

        void setMicrobeamManipulationLightSourceSettingsAttenuation​(PercentFraction attenuation,
                                                                    int experimentIndex,
                                                                    int microbeamManipulationIndex,
                                                                    int lightSourceSettingsIndex)
        Set the Attenuation property of LightSourceSettings.
        Parameters:
        attenuation - Attenuation to set.
        experimentIndex - the Experiment index.
        microbeamManipulationIndex - the MicrobeamManipulation index.
        lightSourceSettingsIndex - the LightSourceSettings index.
      • setChannelLightSourceSettingsID

        void setChannelLightSourceSettingsID​(String id,
                                             int imageIndex,
                                             int channelIndex)
        Set the ID property of LightSourceSettings.
        Parameters:
        id - ID to set.
        imageIndex - the Image index.
        channelIndex - the Channel index.
      • setMicrobeamManipulationLightSourceSettingsID

        void setMicrobeamManipulationLightSourceSettingsID​(String id,
                                                           int experimentIndex,
                                                           int microbeamManipulationIndex,
                                                           int lightSourceSettingsIndex)
        Set the ID property of LightSourceSettings.
        Parameters:
        id - ID to set.
        experimentIndex - the Experiment index.
        microbeamManipulationIndex - the MicrobeamManipulation index.
        lightSourceSettingsIndex - the LightSourceSettings index.
      • setChannelLightSourceSettingsWavelength

        void setChannelLightSourceSettingsWavelength​(Length wavelength,
                                                     int imageIndex,
                                                     int channelIndex)
        Set the Wavelength property of LightSourceSettings.
        Parameters:
        wavelength - Wavelength to set.
        imageIndex - the Image index.
        channelIndex - the Channel index.
      • setMicrobeamManipulationLightSourceSettingsWavelength

        void setMicrobeamManipulationLightSourceSettingsWavelength​(Length wavelength,
                                                                   int experimentIndex,
                                                                   int microbeamManipulationIndex,
                                                                   int lightSourceSettingsIndex)
        Set the Wavelength property of LightSourceSettings.
        Parameters:
        wavelength - Wavelength to set.
        experimentIndex - the Experiment index.
        microbeamManipulationIndex - the MicrobeamManipulation index.
        lightSourceSettingsIndex - the LightSourceSettings index.
      • setLineAnnotationRef

        void setLineAnnotationRef​(String annotation,
                                  int ROIIndex,
                                  int shapeIndex,
                                  int annotationRefIndex)
        Set the AnnotationRef property of Line.
        Parameters:
        annotation - AnnotationRef to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        annotationRefIndex - AnnotationRef index (unused).
      • setLineFillColor

        void setLineFillColor​(Color fillColor,
                              int ROIIndex,
                              int shapeIndex)
        Set the FillColor property of Line.
        Parameters:
        fillColor - FillColor to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLineFillRule

        void setLineFillRule​(FillRule fillRule,
                             int ROIIndex,
                             int shapeIndex)
        Set the FillRule property of Line.
        Parameters:
        fillRule - FillRule to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLineFontFamily

        void setLineFontFamily​(FontFamily fontFamily,
                               int ROIIndex,
                               int shapeIndex)
        Set the FontFamily property of Line.
        Parameters:
        fontFamily - FontFamily to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLineFontSize

        void setLineFontSize​(Length fontSize,
                             int ROIIndex,
                             int shapeIndex)
        Set the FontSize property of Line.
        Parameters:
        fontSize - FontSize to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLineFontStyle

        void setLineFontStyle​(FontStyle fontStyle,
                              int ROIIndex,
                              int shapeIndex)
        Set the FontStyle property of Line.
        Parameters:
        fontStyle - FontStyle to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLineID

        void setLineID​(String id,
                       int ROIIndex,
                       int shapeIndex)
        Set the ID property of Line.
        Parameters:
        id - ID to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLineLocked

        void setLineLocked​(Boolean locked,
                           int ROIIndex,
                           int shapeIndex)
        Set the Locked property of Line.
        Parameters:
        locked - Locked to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLineMarkerEnd

        void setLineMarkerEnd​(Marker markerEnd,
                              int ROIIndex,
                              int shapeIndex)
        Set the MarkerEnd property of Line.
        Parameters:
        markerEnd - MarkerEnd to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLineMarkerStart

        void setLineMarkerStart​(Marker markerStart,
                                int ROIIndex,
                                int shapeIndex)
        Set the MarkerStart property of Line.
        Parameters:
        markerStart - MarkerStart to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLineStrokeColor

        void setLineStrokeColor​(Color strokeColor,
                                int ROIIndex,
                                int shapeIndex)
        Set the StrokeColor property of Line.
        Parameters:
        strokeColor - StrokeColor to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLineStrokeDashArray

        void setLineStrokeDashArray​(String strokeDashArray,
                                    int ROIIndex,
                                    int shapeIndex)
        Set the StrokeDashArray property of Line.
        Parameters:
        strokeDashArray - StrokeDashArray to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLineStrokeWidth

        void setLineStrokeWidth​(Length strokeWidth,
                                int ROIIndex,
                                int shapeIndex)
        Set the StrokeWidth property of Line.
        Parameters:
        strokeWidth - StrokeWidth to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLineText

        void setLineText​(String text,
                         int ROIIndex,
                         int shapeIndex)
        Set the Text property of Line.
        Parameters:
        text - Text to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLineTheC

        void setLineTheC​(NonNegativeInteger theC,
                         int ROIIndex,
                         int shapeIndex)
        Set the TheC property of Line.
        Parameters:
        theC - TheC to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLineTheT

        void setLineTheT​(NonNegativeInteger theT,
                         int ROIIndex,
                         int shapeIndex)
        Set the TheT property of Line.
        Parameters:
        theT - TheT to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLineTheZ

        void setLineTheZ​(NonNegativeInteger theZ,
                         int ROIIndex,
                         int shapeIndex)
        Set the TheZ property of Line.
        Parameters:
        theZ - TheZ to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLineTransform

        void setLineTransform​(AffineTransform transform,
                              int ROIIndex,
                              int shapeIndex)
        Set the Transform property of Line.
        Parameters:
        transform - Transform to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLineX1

        void setLineX1​(Double x1,
                       int ROIIndex,
                       int shapeIndex)
        Set the X1 property of Line.
        Parameters:
        x1 - X1 to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLineX2

        void setLineX2​(Double x2,
                       int ROIIndex,
                       int shapeIndex)
        Set the X2 property of Line.
        Parameters:
        x2 - X2 to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLineY1

        void setLineY1​(Double y1,
                       int ROIIndex,
                       int shapeIndex)
        Set the Y1 property of Line.
        Parameters:
        y1 - Y1 to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setLineY2

        void setLineY2​(Double y2,
                       int ROIIndex,
                       int shapeIndex)
        Set the Y2 property of Line.
        Parameters:
        y2 - Y2 to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setListAnnotationAnnotationRef

        void setListAnnotationAnnotationRef​(String annotation,
                                            int listAnnotationIndex,
                                            int annotationRefIndex)
        Set the AnnotationRef property of ListAnnotation.
        Parameters:
        annotation - AnnotationRef to set.
        listAnnotationIndex - the ListAnnotation index.
        annotationRefIndex - AnnotationRef index (unused).
      • setListAnnotationAnnotator

        void setListAnnotationAnnotator​(String annotator,
                                        int listAnnotationIndex)
        Set the Annotator property of ListAnnotation.
        Parameters:
        annotator - Annotator to set.
        listAnnotationIndex - the ListAnnotation index.
      • setListAnnotationDescription

        void setListAnnotationDescription​(String description,
                                          int listAnnotationIndex)
        Set the Description property of ListAnnotation.
        Parameters:
        description - Description to set.
        listAnnotationIndex - the ListAnnotation index.
      • setListAnnotationID

        void setListAnnotationID​(String id,
                                 int listAnnotationIndex)
        Set the ID property of ListAnnotation.
        Parameters:
        id - ID to set.
        listAnnotationIndex - the ListAnnotation index.
      • setListAnnotationNamespace

        void setListAnnotationNamespace​(String namespace,
                                        int listAnnotationIndex)
        Set the Namespace property of ListAnnotation.
        Parameters:
        namespace - Namespace to set.
        listAnnotationIndex - the ListAnnotation index.
      • setLongAnnotationAnnotationRef

        void setLongAnnotationAnnotationRef​(String annotation,
                                            int longAnnotationIndex,
                                            int annotationRefIndex)
        Set the AnnotationRef property of LongAnnotation.
        Parameters:
        annotation - AnnotationRef to set.
        longAnnotationIndex - the LongAnnotation index.
        annotationRefIndex - AnnotationRef index (unused).
      • setLongAnnotationAnnotator

        void setLongAnnotationAnnotator​(String annotator,
                                        int longAnnotationIndex)
        Set the Annotator property of LongAnnotation.
        Parameters:
        annotator - Annotator to set.
        longAnnotationIndex - the LongAnnotation index.
      • setLongAnnotationDescription

        void setLongAnnotationDescription​(String description,
                                          int longAnnotationIndex)
        Set the Description property of LongAnnotation.
        Parameters:
        description - Description to set.
        longAnnotationIndex - the LongAnnotation index.
      • setLongAnnotationID

        void setLongAnnotationID​(String id,
                                 int longAnnotationIndex)
        Set the ID property of LongAnnotation.
        Parameters:
        id - ID to set.
        longAnnotationIndex - the LongAnnotation index.
      • setLongAnnotationNamespace

        void setLongAnnotationNamespace​(String namespace,
                                        int longAnnotationIndex)
        Set the Namespace property of LongAnnotation.
        Parameters:
        namespace - Namespace to set.
        longAnnotationIndex - the LongAnnotation index.
      • setLongAnnotationValue

        void setLongAnnotationValue​(Long value,
                                    int longAnnotationIndex)
        Set the Value property of LongAnnotation.
        Parameters:
        value - Value to set.
        longAnnotationIndex - the LongAnnotation index.
      • setMapAnnotationAnnotationRef

        void setMapAnnotationAnnotationRef​(String annotation,
                                           int mapAnnotationIndex,
                                           int annotationRefIndex)
        Set the AnnotationRef property of MapAnnotation.
        Parameters:
        annotation - AnnotationRef to set.
        mapAnnotationIndex - the MapAnnotation index.
        annotationRefIndex - AnnotationRef index (unused).
      • setMapAnnotationAnnotator

        void setMapAnnotationAnnotator​(String annotator,
                                       int mapAnnotationIndex)
        Set the Annotator property of MapAnnotation.
        Parameters:
        annotator - Annotator to set.
        mapAnnotationIndex - the MapAnnotation index.
      • setMapAnnotationDescription

        void setMapAnnotationDescription​(String description,
                                         int mapAnnotationIndex)
        Set the Description property of MapAnnotation.
        Parameters:
        description - Description to set.
        mapAnnotationIndex - the MapAnnotation index.
      • setMapAnnotationID

        void setMapAnnotationID​(String id,
                                int mapAnnotationIndex)
        Set the ID property of MapAnnotation.
        Parameters:
        id - ID to set.
        mapAnnotationIndex - the MapAnnotation index.
      • setMapAnnotationNamespace

        void setMapAnnotationNamespace​(String namespace,
                                       int mapAnnotationIndex)
        Set the Namespace property of MapAnnotation.
        Parameters:
        namespace - Namespace to set.
        mapAnnotationIndex - the MapAnnotation index.
      • setMaskAnnotationRef

        void setMaskAnnotationRef​(String annotation,
                                  int ROIIndex,
                                  int shapeIndex,
                                  int annotationRefIndex)
        Set the AnnotationRef property of Mask.
        Parameters:
        annotation - AnnotationRef to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        annotationRefIndex - AnnotationRef index (unused).
      • setMaskFillColor

        void setMaskFillColor​(Color fillColor,
                              int ROIIndex,
                              int shapeIndex)
        Set the FillColor property of Mask.
        Parameters:
        fillColor - FillColor to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setMaskFillRule

        void setMaskFillRule​(FillRule fillRule,
                             int ROIIndex,
                             int shapeIndex)
        Set the FillRule property of Mask.
        Parameters:
        fillRule - FillRule to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setMaskFontFamily

        void setMaskFontFamily​(FontFamily fontFamily,
                               int ROIIndex,
                               int shapeIndex)
        Set the FontFamily property of Mask.
        Parameters:
        fontFamily - FontFamily to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setMaskFontSize

        void setMaskFontSize​(Length fontSize,
                             int ROIIndex,
                             int shapeIndex)
        Set the FontSize property of Mask.
        Parameters:
        fontSize - FontSize to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setMaskFontStyle

        void setMaskFontStyle​(FontStyle fontStyle,
                              int ROIIndex,
                              int shapeIndex)
        Set the FontStyle property of Mask.
        Parameters:
        fontStyle - FontStyle to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setMaskHeight

        void setMaskHeight​(Double height,
                           int ROIIndex,
                           int shapeIndex)
        Set the Height property of Mask.
        Parameters:
        height - Height to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setMaskID

        void setMaskID​(String id,
                       int ROIIndex,
                       int shapeIndex)
        Set the ID property of Mask.
        Parameters:
        id - ID to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setMaskLocked

        void setMaskLocked​(Boolean locked,
                           int ROIIndex,
                           int shapeIndex)
        Set the Locked property of Mask.
        Parameters:
        locked - Locked to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setMaskStrokeColor

        void setMaskStrokeColor​(Color strokeColor,
                                int ROIIndex,
                                int shapeIndex)
        Set the StrokeColor property of Mask.
        Parameters:
        strokeColor - StrokeColor to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setMaskStrokeDashArray

        void setMaskStrokeDashArray​(String strokeDashArray,
                                    int ROIIndex,
                                    int shapeIndex)
        Set the StrokeDashArray property of Mask.
        Parameters:
        strokeDashArray - StrokeDashArray to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setMaskStrokeWidth

        void setMaskStrokeWidth​(Length strokeWidth,
                                int ROIIndex,
                                int shapeIndex)
        Set the StrokeWidth property of Mask.
        Parameters:
        strokeWidth - StrokeWidth to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setMaskText

        void setMaskText​(String text,
                         int ROIIndex,
                         int shapeIndex)
        Set the Text property of Mask.
        Parameters:
        text - Text to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setMaskTheC

        void setMaskTheC​(NonNegativeInteger theC,
                         int ROIIndex,
                         int shapeIndex)
        Set the TheC property of Mask.
        Parameters:
        theC - TheC to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setMaskTheT

        void setMaskTheT​(NonNegativeInteger theT,
                         int ROIIndex,
                         int shapeIndex)
        Set the TheT property of Mask.
        Parameters:
        theT - TheT to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setMaskTheZ

        void setMaskTheZ​(NonNegativeInteger theZ,
                         int ROIIndex,
                         int shapeIndex)
        Set the TheZ property of Mask.
        Parameters:
        theZ - TheZ to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setMaskTransform

        void setMaskTransform​(AffineTransform transform,
                              int ROIIndex,
                              int shapeIndex)
        Set the Transform property of Mask.
        Parameters:
        transform - Transform to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setMaskWidth

        void setMaskWidth​(Double width,
                          int ROIIndex,
                          int shapeIndex)
        Set the Width property of Mask.
        Parameters:
        width - Width to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setMaskX

        void setMaskX​(Double x,
                      int ROIIndex,
                      int shapeIndex)
        Set the X property of Mask.
        Parameters:
        x - X to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setMaskY

        void setMaskY​(Double y,
                      int ROIIndex,
                      int shapeIndex)
        Set the Y property of Mask.
        Parameters:
        y - Y to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setMicrobeamManipulationDescription

        void setMicrobeamManipulationDescription​(String description,
                                                 int experimentIndex,
                                                 int microbeamManipulationIndex)
        Set the Description property of MicrobeamManipulation.
        Parameters:
        description - Description to set.
        experimentIndex - the Experiment index.
        microbeamManipulationIndex - the MicrobeamManipulation index.
      • setMicrobeamManipulationExperimenterRef

        void setMicrobeamManipulationExperimenterRef​(String experimenter,
                                                     int experimentIndex,
                                                     int microbeamManipulationIndex)
        Set the ExperimenterRef property of MicrobeamManipulation.
        Parameters:
        experimenter - ExperimenterRef to set.
        experimentIndex - the Experiment index.
        microbeamManipulationIndex - the MicrobeamManipulation index.
      • setMicrobeamManipulationID

        void setMicrobeamManipulationID​(String id,
                                        int experimentIndex,
                                        int microbeamManipulationIndex)
        Set the ID property of MicrobeamManipulation.
        Parameters:
        id - ID to set.
        experimentIndex - the Experiment index.
        microbeamManipulationIndex - the MicrobeamManipulation index.
      • setMicrobeamManipulationROIRef

        void setMicrobeamManipulationROIRef​(String roi,
                                            int experimentIndex,
                                            int microbeamManipulationIndex,
                                            int ROIRefIndex)
        Set the ROIRef property of MicrobeamManipulation.
        Parameters:
        roi - ROIRef to set.
        experimentIndex - the Experiment index.
        microbeamManipulationIndex - the MicrobeamManipulation index.
        ROIRefIndex - ROIRef index (unused).
      • setMicrobeamManipulationType

        void setMicrobeamManipulationType​(MicrobeamManipulationType type,
                                          int experimentIndex,
                                          int microbeamManipulationIndex)
        Set the Type property of MicrobeamManipulation.
        Parameters:
        type - Type to set.
        experimentIndex - the Experiment index.
        microbeamManipulationIndex - the MicrobeamManipulation index.
      • setMicroscopeLotNumber

        void setMicroscopeLotNumber​(String lotNumber,
                                    int instrumentIndex)
        Set the LotNumber property of Microscope.
        Parameters:
        lotNumber - LotNumber to set.
        instrumentIndex - the Instrument index.
      • setMicroscopeManufacturer

        void setMicroscopeManufacturer​(String manufacturer,
                                       int instrumentIndex)
        Set the Manufacturer property of Microscope.
        Parameters:
        manufacturer - Manufacturer to set.
        instrumentIndex - the Instrument index.
      • setMicroscopeModel

        void setMicroscopeModel​(String model,
                                int instrumentIndex)
        Set the Model property of Microscope.
        Parameters:
        model - Model to set.
        instrumentIndex - the Instrument index.
      • setMicroscopeSerialNumber

        void setMicroscopeSerialNumber​(String serialNumber,
                                       int instrumentIndex)
        Set the SerialNumber property of Microscope.
        Parameters:
        serialNumber - SerialNumber to set.
        instrumentIndex - the Instrument index.
      • setMicroscopeType

        void setMicroscopeType​(MicroscopeType type,
                               int instrumentIndex)
        Set the Type property of Microscope.
        Parameters:
        type - Type to set.
        instrumentIndex - the Instrument index.
      • setObjectiveAnnotationRef

        void setObjectiveAnnotationRef​(String annotation,
                                       int instrumentIndex,
                                       int objectiveIndex,
                                       int annotationRefIndex)
        Set the AnnotationRef property of Objective.
        Parameters:
        annotation - AnnotationRef to set.
        instrumentIndex - the Instrument index.
        objectiveIndex - the Objective index.
        annotationRefIndex - AnnotationRef index (unused).
      • setObjectiveCalibratedMagnification

        void setObjectiveCalibratedMagnification​(Double calibratedMagnification,
                                                 int instrumentIndex,
                                                 int objectiveIndex)
        Set the CalibratedMagnification property of Objective.
        Parameters:
        calibratedMagnification - CalibratedMagnification to set.
        instrumentIndex - the Instrument index.
        objectiveIndex - the Objective index.
      • setObjectiveCorrection

        void setObjectiveCorrection​(Correction correction,
                                    int instrumentIndex,
                                    int objectiveIndex)
        Set the Correction property of Objective.
        Parameters:
        correction - Correction to set.
        instrumentIndex - the Instrument index.
        objectiveIndex - the Objective index.
      • setObjectiveID

        void setObjectiveID​(String id,
                            int instrumentIndex,
                            int objectiveIndex)
        Set the ID property of Objective.
        Parameters:
        id - ID to set.
        instrumentIndex - the Instrument index.
        objectiveIndex - the Objective index.
      • setObjectiveImmersion

        void setObjectiveImmersion​(Immersion immersion,
                                   int instrumentIndex,
                                   int objectiveIndex)
        Set the Immersion property of Objective.
        Parameters:
        immersion - Immersion to set.
        instrumentIndex - the Instrument index.
        objectiveIndex - the Objective index.
      • setObjectiveIris

        void setObjectiveIris​(Boolean iris,
                              int instrumentIndex,
                              int objectiveIndex)
        Set the Iris property of Objective.
        Parameters:
        iris - Iris to set.
        instrumentIndex - the Instrument index.
        objectiveIndex - the Objective index.
      • setObjectiveLensNA

        void setObjectiveLensNA​(Double lensNA,
                                int instrumentIndex,
                                int objectiveIndex)
        Set the LensNA property of Objective.
        Parameters:
        lensNA - LensNA to set.
        instrumentIndex - the Instrument index.
        objectiveIndex - the Objective index.
      • setObjectiveLotNumber

        void setObjectiveLotNumber​(String lotNumber,
                                   int instrumentIndex,
                                   int objectiveIndex)
        Set the LotNumber property of Objective.
        Parameters:
        lotNumber - LotNumber to set.
        instrumentIndex - the Instrument index.
        objectiveIndex - the Objective index.
      • setObjectiveManufacturer

        void setObjectiveManufacturer​(String manufacturer,
                                      int instrumentIndex,
                                      int objectiveIndex)
        Set the Manufacturer property of Objective.
        Parameters:
        manufacturer - Manufacturer to set.
        instrumentIndex - the Instrument index.
        objectiveIndex - the Objective index.
      • setObjectiveModel

        void setObjectiveModel​(String model,
                               int instrumentIndex,
                               int objectiveIndex)
        Set the Model property of Objective.
        Parameters:
        model - Model to set.
        instrumentIndex - the Instrument index.
        objectiveIndex - the Objective index.
      • setObjectiveNominalMagnification

        void setObjectiveNominalMagnification​(Double nominalMagnification,
                                              int instrumentIndex,
                                              int objectiveIndex)
        Set the NominalMagnification property of Objective.
        Parameters:
        nominalMagnification - NominalMagnification to set.
        instrumentIndex - the Instrument index.
        objectiveIndex - the Objective index.
      • setObjectiveSerialNumber

        void setObjectiveSerialNumber​(String serialNumber,
                                      int instrumentIndex,
                                      int objectiveIndex)
        Set the SerialNumber property of Objective.
        Parameters:
        serialNumber - SerialNumber to set.
        instrumentIndex - the Instrument index.
        objectiveIndex - the Objective index.
      • setObjectiveWorkingDistance

        void setObjectiveWorkingDistance​(Length workingDistance,
                                         int instrumentIndex,
                                         int objectiveIndex)
        Set the WorkingDistance property of Objective.
        Parameters:
        workingDistance - WorkingDistance to set.
        instrumentIndex - the Instrument index.
        objectiveIndex - the Objective index.
      • setObjectiveSettingsCorrectionCollar

        void setObjectiveSettingsCorrectionCollar​(Double correctionCollar,
                                                  int imageIndex)
        Set the CorrectionCollar property of ObjectiveSettings.
        Parameters:
        correctionCollar - CorrectionCollar to set.
        imageIndex - the Image index.
      • setObjectiveSettingsID

        void setObjectiveSettingsID​(String id,
                                    int imageIndex)
        Set the ID property of ObjectiveSettings.
        Parameters:
        id - ID to set.
        imageIndex - the Image index.
      • setObjectiveSettingsMedium

        void setObjectiveSettingsMedium​(Medium medium,
                                        int imageIndex)
        Set the Medium property of ObjectiveSettings.
        Parameters:
        medium - Medium to set.
        imageIndex - the Image index.
      • setObjectiveSettingsRefractiveIndex

        void setObjectiveSettingsRefractiveIndex​(Double refractiveIndex,
                                                 int imageIndex)
        Set the RefractiveIndex property of ObjectiveSettings.
        Parameters:
        refractiveIndex - RefractiveIndex to set.
        imageIndex - the Image index.
      • setPixelsBigEndian

        void setPixelsBigEndian​(Boolean bigEndian,
                                int imageIndex)
        Set the BigEndian property of Pixels.
        Parameters:
        bigEndian - BigEndian to set.
        imageIndex - the Image index.
      • setPixelsDimensionOrder

        void setPixelsDimensionOrder​(DimensionOrder dimensionOrder,
                                     int imageIndex)
        Set the DimensionOrder property of Pixels.
        Parameters:
        dimensionOrder - DimensionOrder to set.
        imageIndex - the Image index.
      • setPixelsID

        void setPixelsID​(String id,
                         int imageIndex)
        Set the ID property of Pixels.
        Parameters:
        id - ID to set.
        imageIndex - the Image index.
      • setPixelsInterleaved

        void setPixelsInterleaved​(Boolean interleaved,
                                  int imageIndex)
        Set the Interleaved property of Pixels.
        Parameters:
        interleaved - Interleaved to set.
        imageIndex - the Image index.
      • setPixelsPhysicalSizeX

        void setPixelsPhysicalSizeX​(Length physicalSizeX,
                                    int imageIndex)
        Set the PhysicalSizeX property of Pixels.
        Parameters:
        physicalSizeX - PhysicalSizeX to set.
        imageIndex - the Image index.
      • setPixelsPhysicalSizeY

        void setPixelsPhysicalSizeY​(Length physicalSizeY,
                                    int imageIndex)
        Set the PhysicalSizeY property of Pixels.
        Parameters:
        physicalSizeY - PhysicalSizeY to set.
        imageIndex - the Image index.
      • setPixelsPhysicalSizeZ

        void setPixelsPhysicalSizeZ​(Length physicalSizeZ,
                                    int imageIndex)
        Set the PhysicalSizeZ property of Pixels.
        Parameters:
        physicalSizeZ - PhysicalSizeZ to set.
        imageIndex - the Image index.
      • setPixelsSignificantBits

        void setPixelsSignificantBits​(PositiveInteger significantBits,
                                      int imageIndex)
        Set the SignificantBits property of Pixels.
        Parameters:
        significantBits - SignificantBits to set.
        imageIndex - the Image index.
      • setPixelsSizeC

        void setPixelsSizeC​(PositiveInteger sizeC,
                            int imageIndex)
        Set the SizeC property of Pixels.
        Parameters:
        sizeC - SizeC to set.
        imageIndex - the Image index.
      • setPixelsSizeT

        void setPixelsSizeT​(PositiveInteger sizeT,
                            int imageIndex)
        Set the SizeT property of Pixels.
        Parameters:
        sizeT - SizeT to set.
        imageIndex - the Image index.
      • setPixelsSizeX

        void setPixelsSizeX​(PositiveInteger sizeX,
                            int imageIndex)
        Set the SizeX property of Pixels.
        Parameters:
        sizeX - SizeX to set.
        imageIndex - the Image index.
      • setPixelsSizeY

        void setPixelsSizeY​(PositiveInteger sizeY,
                            int imageIndex)
        Set the SizeY property of Pixels.
        Parameters:
        sizeY - SizeY to set.
        imageIndex - the Image index.
      • setPixelsSizeZ

        void setPixelsSizeZ​(PositiveInteger sizeZ,
                            int imageIndex)
        Set the SizeZ property of Pixels.
        Parameters:
        sizeZ - SizeZ to set.
        imageIndex - the Image index.
      • setPixelsTimeIncrement

        void setPixelsTimeIncrement​(Time timeIncrement,
                                    int imageIndex)
        Set the TimeIncrement property of Pixels.
        Parameters:
        timeIncrement - TimeIncrement to set.
        imageIndex - the Image index.
      • setPixelsType

        void setPixelsType​(PixelType type,
                           int imageIndex)
        Set the Type property of Pixels.
        Parameters:
        type - Type to set.
        imageIndex - the Image index.
      • setPlaneAnnotationRef

        void setPlaneAnnotationRef​(String annotation,
                                   int imageIndex,
                                   int planeIndex,
                                   int annotationRefIndex)
        Set the AnnotationRef property of Plane.
        Parameters:
        annotation - AnnotationRef to set.
        imageIndex - the Image index.
        planeIndex - the Plane index.
        annotationRefIndex - AnnotationRef index (unused).
      • setPlaneDeltaT

        void setPlaneDeltaT​(Time deltaT,
                            int imageIndex,
                            int planeIndex)
        Set the DeltaT property of Plane.
        Parameters:
        deltaT - DeltaT to set.
        imageIndex - the Image index.
        planeIndex - the Plane index.
      • setPlaneExposureTime

        void setPlaneExposureTime​(Time exposureTime,
                                  int imageIndex,
                                  int planeIndex)
        Set the ExposureTime property of Plane.
        Parameters:
        exposureTime - ExposureTime to set.
        imageIndex - the Image index.
        planeIndex - the Plane index.
      • setPlaneHashSHA1

        void setPlaneHashSHA1​(String hashSHA1,
                              int imageIndex,
                              int planeIndex)
        Set the HashSHA1 property of Plane.
        Parameters:
        hashSHA1 - HashSHA1 to set.
        imageIndex - the Image index.
        planeIndex - the Plane index.
      • setPlanePositionX

        void setPlanePositionX​(Length positionX,
                               int imageIndex,
                               int planeIndex)
        Set the PositionX property of Plane.
        Parameters:
        positionX - PositionX to set.
        imageIndex - the Image index.
        planeIndex - the Plane index.
      • setPlanePositionY

        void setPlanePositionY​(Length positionY,
                               int imageIndex,
                               int planeIndex)
        Set the PositionY property of Plane.
        Parameters:
        positionY - PositionY to set.
        imageIndex - the Image index.
        planeIndex - the Plane index.
      • setPlanePositionZ

        void setPlanePositionZ​(Length positionZ,
                               int imageIndex,
                               int planeIndex)
        Set the PositionZ property of Plane.
        Parameters:
        positionZ - PositionZ to set.
        imageIndex - the Image index.
        planeIndex - the Plane index.
      • setPlaneTheC

        void setPlaneTheC​(NonNegativeInteger theC,
                          int imageIndex,
                          int planeIndex)
        Set the TheC property of Plane.
        Parameters:
        theC - TheC to set.
        imageIndex - the Image index.
        planeIndex - the Plane index.
      • setPlaneTheT

        void setPlaneTheT​(NonNegativeInteger theT,
                          int imageIndex,
                          int planeIndex)
        Set the TheT property of Plane.
        Parameters:
        theT - TheT to set.
        imageIndex - the Image index.
        planeIndex - the Plane index.
      • setPlaneTheZ

        void setPlaneTheZ​(NonNegativeInteger theZ,
                          int imageIndex,
                          int planeIndex)
        Set the TheZ property of Plane.
        Parameters:
        theZ - TheZ to set.
        imageIndex - the Image index.
        planeIndex - the Plane index.
      • setPlateAnnotationRef

        void setPlateAnnotationRef​(String annotation,
                                   int plateIndex,
                                   int annotationRefIndex)
        Set the AnnotationRef property of Plate.
        Parameters:
        annotation - AnnotationRef to set.
        plateIndex - the Plate index.
        annotationRefIndex - AnnotationRef index (unused).
      • setPlateColumnNamingConvention

        void setPlateColumnNamingConvention​(NamingConvention columnNamingConvention,
                                            int plateIndex)
        Set the ColumnNamingConvention property of Plate.
        Parameters:
        columnNamingConvention - ColumnNamingConvention to set.
        plateIndex - the Plate index.
      • setPlateColumns

        void setPlateColumns​(PositiveInteger columns,
                             int plateIndex)
        Set the Columns property of Plate.
        Parameters:
        columns - Columns to set.
        plateIndex - the Plate index.
      • setPlateDescription

        void setPlateDescription​(String description,
                                 int plateIndex)
        Set the Description property of Plate.
        Parameters:
        description - Description to set.
        plateIndex - the Plate index.
      • setPlateExternalIdentifier

        void setPlateExternalIdentifier​(String externalIdentifier,
                                        int plateIndex)
        Set the ExternalIdentifier property of Plate.
        Parameters:
        externalIdentifier - ExternalIdentifier to set.
        plateIndex - the Plate index.
      • setPlateFieldIndex

        void setPlateFieldIndex​(NonNegativeInteger fieldIndex,
                                int plateIndex)
        Set the FieldIndex property of Plate.
        Parameters:
        fieldIndex - FieldIndex to set.
        plateIndex - the Plate index.
      • setPlateID

        void setPlateID​(String id,
                        int plateIndex)
        Set the ID property of Plate.
        Parameters:
        id - ID to set.
        plateIndex - the Plate index.
      • setPlateName

        void setPlateName​(String name,
                          int plateIndex)
        Set the Name property of Plate.
        Parameters:
        name - Name to set.
        plateIndex - the Plate index.
      • setPlateRowNamingConvention

        void setPlateRowNamingConvention​(NamingConvention rowNamingConvention,
                                         int plateIndex)
        Set the RowNamingConvention property of Plate.
        Parameters:
        rowNamingConvention - RowNamingConvention to set.
        plateIndex - the Plate index.
      • setPlateRows

        void setPlateRows​(PositiveInteger rows,
                          int plateIndex)
        Set the Rows property of Plate.
        Parameters:
        rows - Rows to set.
        plateIndex - the Plate index.
      • setPlateStatus

        void setPlateStatus​(String status,
                            int plateIndex)
        Set the Status property of Plate.
        Parameters:
        status - Status to set.
        plateIndex - the Plate index.
      • setPlateWellOriginX

        void setPlateWellOriginX​(Length wellOriginX,
                                 int plateIndex)
        Set the WellOriginX property of Plate.
        Parameters:
        wellOriginX - WellOriginX to set.
        plateIndex - the Plate index.
      • setPlateWellOriginY

        void setPlateWellOriginY​(Length wellOriginY,
                                 int plateIndex)
        Set the WellOriginY property of Plate.
        Parameters:
        wellOriginY - WellOriginY to set.
        plateIndex - the Plate index.
      • setPlateAcquisitionAnnotationRef

        void setPlateAcquisitionAnnotationRef​(String annotation,
                                              int plateIndex,
                                              int plateAcquisitionIndex,
                                              int annotationRefIndex)
        Set the AnnotationRef property of PlateAcquisition.
        Parameters:
        annotation - AnnotationRef to set.
        plateIndex - the Plate index.
        plateAcquisitionIndex - the PlateAcquisition index.
        annotationRefIndex - AnnotationRef index (unused).
      • setPlateAcquisitionDescription

        void setPlateAcquisitionDescription​(String description,
                                            int plateIndex,
                                            int plateAcquisitionIndex)
        Set the Description property of PlateAcquisition.
        Parameters:
        description - Description to set.
        plateIndex - the Plate index.
        plateAcquisitionIndex - the PlateAcquisition index.
      • setPlateAcquisitionEndTime

        void setPlateAcquisitionEndTime​(Timestamp endTime,
                                        int plateIndex,
                                        int plateAcquisitionIndex)
        Set the EndTime property of PlateAcquisition.
        Parameters:
        endTime - EndTime to set.
        plateIndex - the Plate index.
        plateAcquisitionIndex - the PlateAcquisition index.
      • setPlateAcquisitionID

        void setPlateAcquisitionID​(String id,
                                   int plateIndex,
                                   int plateAcquisitionIndex)
        Set the ID property of PlateAcquisition.
        Parameters:
        id - ID to set.
        plateIndex - the Plate index.
        plateAcquisitionIndex - the PlateAcquisition index.
      • setPlateAcquisitionMaximumFieldCount

        void setPlateAcquisitionMaximumFieldCount​(PositiveInteger maximumFieldCount,
                                                  int plateIndex,
                                                  int plateAcquisitionIndex)
        Set the MaximumFieldCount property of PlateAcquisition.
        Parameters:
        maximumFieldCount - MaximumFieldCount to set.
        plateIndex - the Plate index.
        plateAcquisitionIndex - the PlateAcquisition index.
      • setPlateAcquisitionName

        void setPlateAcquisitionName​(String name,
                                     int plateIndex,
                                     int plateAcquisitionIndex)
        Set the Name property of PlateAcquisition.
        Parameters:
        name - Name to set.
        plateIndex - the Plate index.
        plateAcquisitionIndex - the PlateAcquisition index.
      • setPlateAcquisitionStartTime

        void setPlateAcquisitionStartTime​(Timestamp startTime,
                                          int plateIndex,
                                          int plateAcquisitionIndex)
        Set the StartTime property of PlateAcquisition.
        Parameters:
        startTime - StartTime to set.
        plateIndex - the Plate index.
        plateAcquisitionIndex - the PlateAcquisition index.
      • setPlateAcquisitionWellSampleRef

        void setPlateAcquisitionWellSampleRef​(String wellSample,
                                              int plateIndex,
                                              int plateAcquisitionIndex,
                                              int wellSampleRefIndex)
        Set the WellSampleRef property of PlateAcquisition.
        Parameters:
        wellSample - WellSampleRef to set.
        plateIndex - the Plate index.
        plateAcquisitionIndex - the PlateAcquisition index.
        wellSampleRefIndex - WellSampleRef index (unused).
      • setPointAnnotationRef

        void setPointAnnotationRef​(String annotation,
                                   int ROIIndex,
                                   int shapeIndex,
                                   int annotationRefIndex)
        Set the AnnotationRef property of Point.
        Parameters:
        annotation - AnnotationRef to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        annotationRefIndex - AnnotationRef index (unused).
      • setPointFillColor

        void setPointFillColor​(Color fillColor,
                               int ROIIndex,
                               int shapeIndex)
        Set the FillColor property of Point.
        Parameters:
        fillColor - FillColor to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPointFillRule

        void setPointFillRule​(FillRule fillRule,
                              int ROIIndex,
                              int shapeIndex)
        Set the FillRule property of Point.
        Parameters:
        fillRule - FillRule to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPointFontFamily

        void setPointFontFamily​(FontFamily fontFamily,
                                int ROIIndex,
                                int shapeIndex)
        Set the FontFamily property of Point.
        Parameters:
        fontFamily - FontFamily to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPointFontSize

        void setPointFontSize​(Length fontSize,
                              int ROIIndex,
                              int shapeIndex)
        Set the FontSize property of Point.
        Parameters:
        fontSize - FontSize to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPointFontStyle

        void setPointFontStyle​(FontStyle fontStyle,
                               int ROIIndex,
                               int shapeIndex)
        Set the FontStyle property of Point.
        Parameters:
        fontStyle - FontStyle to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPointID

        void setPointID​(String id,
                        int ROIIndex,
                        int shapeIndex)
        Set the ID property of Point.
        Parameters:
        id - ID to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPointLocked

        void setPointLocked​(Boolean locked,
                            int ROIIndex,
                            int shapeIndex)
        Set the Locked property of Point.
        Parameters:
        locked - Locked to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPointStrokeColor

        void setPointStrokeColor​(Color strokeColor,
                                 int ROIIndex,
                                 int shapeIndex)
        Set the StrokeColor property of Point.
        Parameters:
        strokeColor - StrokeColor to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPointStrokeDashArray

        void setPointStrokeDashArray​(String strokeDashArray,
                                     int ROIIndex,
                                     int shapeIndex)
        Set the StrokeDashArray property of Point.
        Parameters:
        strokeDashArray - StrokeDashArray to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPointStrokeWidth

        void setPointStrokeWidth​(Length strokeWidth,
                                 int ROIIndex,
                                 int shapeIndex)
        Set the StrokeWidth property of Point.
        Parameters:
        strokeWidth - StrokeWidth to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPointText

        void setPointText​(String text,
                          int ROIIndex,
                          int shapeIndex)
        Set the Text property of Point.
        Parameters:
        text - Text to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPointTheC

        void setPointTheC​(NonNegativeInteger theC,
                          int ROIIndex,
                          int shapeIndex)
        Set the TheC property of Point.
        Parameters:
        theC - TheC to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPointTheT

        void setPointTheT​(NonNegativeInteger theT,
                          int ROIIndex,
                          int shapeIndex)
        Set the TheT property of Point.
        Parameters:
        theT - TheT to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPointTheZ

        void setPointTheZ​(NonNegativeInteger theZ,
                          int ROIIndex,
                          int shapeIndex)
        Set the TheZ property of Point.
        Parameters:
        theZ - TheZ to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPointTransform

        void setPointTransform​(AffineTransform transform,
                               int ROIIndex,
                               int shapeIndex)
        Set the Transform property of Point.
        Parameters:
        transform - Transform to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPointX

        void setPointX​(Double x,
                       int ROIIndex,
                       int shapeIndex)
        Set the X property of Point.
        Parameters:
        x - X to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPointY

        void setPointY​(Double y,
                       int ROIIndex,
                       int shapeIndex)
        Set the Y property of Point.
        Parameters:
        y - Y to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolygonAnnotationRef

        void setPolygonAnnotationRef​(String annotation,
                                     int ROIIndex,
                                     int shapeIndex,
                                     int annotationRefIndex)
        Set the AnnotationRef property of Polygon.
        Parameters:
        annotation - AnnotationRef to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        annotationRefIndex - AnnotationRef index (unused).
      • setPolygonFillColor

        void setPolygonFillColor​(Color fillColor,
                                 int ROIIndex,
                                 int shapeIndex)
        Set the FillColor property of Polygon.
        Parameters:
        fillColor - FillColor to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolygonFillRule

        void setPolygonFillRule​(FillRule fillRule,
                                int ROIIndex,
                                int shapeIndex)
        Set the FillRule property of Polygon.
        Parameters:
        fillRule - FillRule to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolygonFontFamily

        void setPolygonFontFamily​(FontFamily fontFamily,
                                  int ROIIndex,
                                  int shapeIndex)
        Set the FontFamily property of Polygon.
        Parameters:
        fontFamily - FontFamily to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolygonFontSize

        void setPolygonFontSize​(Length fontSize,
                                int ROIIndex,
                                int shapeIndex)
        Set the FontSize property of Polygon.
        Parameters:
        fontSize - FontSize to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolygonFontStyle

        void setPolygonFontStyle​(FontStyle fontStyle,
                                 int ROIIndex,
                                 int shapeIndex)
        Set the FontStyle property of Polygon.
        Parameters:
        fontStyle - FontStyle to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolygonID

        void setPolygonID​(String id,
                          int ROIIndex,
                          int shapeIndex)
        Set the ID property of Polygon.
        Parameters:
        id - ID to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolygonLocked

        void setPolygonLocked​(Boolean locked,
                              int ROIIndex,
                              int shapeIndex)
        Set the Locked property of Polygon.
        Parameters:
        locked - Locked to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolygonPoints

        void setPolygonPoints​(String points,
                              int ROIIndex,
                              int shapeIndex)
        Set the Points property of Polygon.
        Parameters:
        points - Points to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolygonStrokeColor

        void setPolygonStrokeColor​(Color strokeColor,
                                   int ROIIndex,
                                   int shapeIndex)
        Set the StrokeColor property of Polygon.
        Parameters:
        strokeColor - StrokeColor to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolygonStrokeDashArray

        void setPolygonStrokeDashArray​(String strokeDashArray,
                                       int ROIIndex,
                                       int shapeIndex)
        Set the StrokeDashArray property of Polygon.
        Parameters:
        strokeDashArray - StrokeDashArray to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolygonStrokeWidth

        void setPolygonStrokeWidth​(Length strokeWidth,
                                   int ROIIndex,
                                   int shapeIndex)
        Set the StrokeWidth property of Polygon.
        Parameters:
        strokeWidth - StrokeWidth to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolygonText

        void setPolygonText​(String text,
                            int ROIIndex,
                            int shapeIndex)
        Set the Text property of Polygon.
        Parameters:
        text - Text to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolygonTheC

        void setPolygonTheC​(NonNegativeInteger theC,
                            int ROIIndex,
                            int shapeIndex)
        Set the TheC property of Polygon.
        Parameters:
        theC - TheC to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolygonTheT

        void setPolygonTheT​(NonNegativeInteger theT,
                            int ROIIndex,
                            int shapeIndex)
        Set the TheT property of Polygon.
        Parameters:
        theT - TheT to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolygonTheZ

        void setPolygonTheZ​(NonNegativeInteger theZ,
                            int ROIIndex,
                            int shapeIndex)
        Set the TheZ property of Polygon.
        Parameters:
        theZ - TheZ to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolygonTransform

        void setPolygonTransform​(AffineTransform transform,
                                 int ROIIndex,
                                 int shapeIndex)
        Set the Transform property of Polygon.
        Parameters:
        transform - Transform to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolylineAnnotationRef

        void setPolylineAnnotationRef​(String annotation,
                                      int ROIIndex,
                                      int shapeIndex,
                                      int annotationRefIndex)
        Set the AnnotationRef property of Polyline.
        Parameters:
        annotation - AnnotationRef to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        annotationRefIndex - AnnotationRef index (unused).
      • setPolylineFillColor

        void setPolylineFillColor​(Color fillColor,
                                  int ROIIndex,
                                  int shapeIndex)
        Set the FillColor property of Polyline.
        Parameters:
        fillColor - FillColor to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolylineFillRule

        void setPolylineFillRule​(FillRule fillRule,
                                 int ROIIndex,
                                 int shapeIndex)
        Set the FillRule property of Polyline.
        Parameters:
        fillRule - FillRule to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolylineFontFamily

        void setPolylineFontFamily​(FontFamily fontFamily,
                                   int ROIIndex,
                                   int shapeIndex)
        Set the FontFamily property of Polyline.
        Parameters:
        fontFamily - FontFamily to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolylineFontSize

        void setPolylineFontSize​(Length fontSize,
                                 int ROIIndex,
                                 int shapeIndex)
        Set the FontSize property of Polyline.
        Parameters:
        fontSize - FontSize to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolylineFontStyle

        void setPolylineFontStyle​(FontStyle fontStyle,
                                  int ROIIndex,
                                  int shapeIndex)
        Set the FontStyle property of Polyline.
        Parameters:
        fontStyle - FontStyle to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolylineID

        void setPolylineID​(String id,
                           int ROIIndex,
                           int shapeIndex)
        Set the ID property of Polyline.
        Parameters:
        id - ID to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolylineLocked

        void setPolylineLocked​(Boolean locked,
                               int ROIIndex,
                               int shapeIndex)
        Set the Locked property of Polyline.
        Parameters:
        locked - Locked to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolylineMarkerEnd

        void setPolylineMarkerEnd​(Marker markerEnd,
                                  int ROIIndex,
                                  int shapeIndex)
        Set the MarkerEnd property of Polyline.
        Parameters:
        markerEnd - MarkerEnd to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolylineMarkerStart

        void setPolylineMarkerStart​(Marker markerStart,
                                    int ROIIndex,
                                    int shapeIndex)
        Set the MarkerStart property of Polyline.
        Parameters:
        markerStart - MarkerStart to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolylinePoints

        void setPolylinePoints​(String points,
                               int ROIIndex,
                               int shapeIndex)
        Set the Points property of Polyline.
        Parameters:
        points - Points to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolylineStrokeColor

        void setPolylineStrokeColor​(Color strokeColor,
                                    int ROIIndex,
                                    int shapeIndex)
        Set the StrokeColor property of Polyline.
        Parameters:
        strokeColor - StrokeColor to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolylineStrokeDashArray

        void setPolylineStrokeDashArray​(String strokeDashArray,
                                        int ROIIndex,
                                        int shapeIndex)
        Set the StrokeDashArray property of Polyline.
        Parameters:
        strokeDashArray - StrokeDashArray to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolylineStrokeWidth

        void setPolylineStrokeWidth​(Length strokeWidth,
                                    int ROIIndex,
                                    int shapeIndex)
        Set the StrokeWidth property of Polyline.
        Parameters:
        strokeWidth - StrokeWidth to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolylineText

        void setPolylineText​(String text,
                             int ROIIndex,
                             int shapeIndex)
        Set the Text property of Polyline.
        Parameters:
        text - Text to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolylineTheC

        void setPolylineTheC​(NonNegativeInteger theC,
                             int ROIIndex,
                             int shapeIndex)
        Set the TheC property of Polyline.
        Parameters:
        theC - TheC to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolylineTheT

        void setPolylineTheT​(NonNegativeInteger theT,
                             int ROIIndex,
                             int shapeIndex)
        Set the TheT property of Polyline.
        Parameters:
        theT - TheT to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolylineTheZ

        void setPolylineTheZ​(NonNegativeInteger theZ,
                             int ROIIndex,
                             int shapeIndex)
        Set the TheZ property of Polyline.
        Parameters:
        theZ - TheZ to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setPolylineTransform

        void setPolylineTransform​(AffineTransform transform,
                                  int ROIIndex,
                                  int shapeIndex)
        Set the Transform property of Polyline.
        Parameters:
        transform - Transform to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setProjectAnnotationRef

        void setProjectAnnotationRef​(String annotation,
                                     int projectIndex,
                                     int annotationRefIndex)
        Set the AnnotationRef property of Project.
        Parameters:
        annotation - AnnotationRef to set.
        projectIndex - the Project index.
        annotationRefIndex - AnnotationRef index (unused).
      • setProjectDatasetRef

        void setProjectDatasetRef​(String dataset,
                                  int projectIndex,
                                  int datasetRefIndex)
        Set the DatasetRef property of Project.
        Parameters:
        dataset - DatasetRef to set.
        projectIndex - the Project index.
        datasetRefIndex - DatasetRef index (unused).
      • setProjectDescription

        void setProjectDescription​(String description,
                                   int projectIndex)
        Set the Description property of Project.
        Parameters:
        description - Description to set.
        projectIndex - the Project index.
      • setProjectExperimenterGroupRef

        void setProjectExperimenterGroupRef​(String experimenterGroup,
                                            int projectIndex)
        Set the ExperimenterGroupRef property of Project.
        Parameters:
        experimenterGroup - ExperimenterGroupRef to set.
        projectIndex - the Project index.
      • setProjectExperimenterRef

        void setProjectExperimenterRef​(String experimenter,
                                       int projectIndex)
        Set the ExperimenterRef property of Project.
        Parameters:
        experimenter - ExperimenterRef to set.
        projectIndex - the Project index.
      • setProjectID

        void setProjectID​(String id,
                          int projectIndex)
        Set the ID property of Project.
        Parameters:
        id - ID to set.
        projectIndex - the Project index.
      • setProjectName

        void setProjectName​(String name,
                            int projectIndex)
        Set the Name property of Project.
        Parameters:
        name - Name to set.
        projectIndex - the Project index.
      • setROIAnnotationRef

        void setROIAnnotationRef​(String annotation,
                                 int ROIIndex,
                                 int annotationRefIndex)
        Set the AnnotationRef property of ROI.
        Parameters:
        annotation - AnnotationRef to set.
        ROIIndex - the ROI index.
        annotationRefIndex - AnnotationRef index (unused).
      • setROIDescription

        void setROIDescription​(String description,
                               int ROIIndex)
        Set the Description property of ROI.
        Parameters:
        description - Description to set.
        ROIIndex - the ROI index.
      • setROIID

        void setROIID​(String id,
                      int ROIIndex)
        Set the ID property of ROI.
        Parameters:
        id - ID to set.
        ROIIndex - the ROI index.
      • setROIName

        void setROIName​(String name,
                        int ROIIndex)
        Set the Name property of ROI.
        Parameters:
        name - Name to set.
        ROIIndex - the ROI index.
      • setReagentAnnotationRef

        void setReagentAnnotationRef​(String annotation,
                                     int screenIndex,
                                     int reagentIndex,
                                     int annotationRefIndex)
        Set the AnnotationRef property of Reagent.
        Parameters:
        annotation - AnnotationRef to set.
        screenIndex - the Screen index.
        reagentIndex - the Reagent index.
        annotationRefIndex - AnnotationRef index (unused).
      • setReagentDescription

        void setReagentDescription​(String description,
                                   int screenIndex,
                                   int reagentIndex)
        Set the Description property of Reagent.
        Parameters:
        description - Description to set.
        screenIndex - the Screen index.
        reagentIndex - the Reagent index.
      • setReagentID

        void setReagentID​(String id,
                          int screenIndex,
                          int reagentIndex)
        Set the ID property of Reagent.
        Parameters:
        id - ID to set.
        screenIndex - the Screen index.
        reagentIndex - the Reagent index.
      • setReagentName

        void setReagentName​(String name,
                            int screenIndex,
                            int reagentIndex)
        Set the Name property of Reagent.
        Parameters:
        name - Name to set.
        screenIndex - the Screen index.
        reagentIndex - the Reagent index.
      • setReagentReagentIdentifier

        void setReagentReagentIdentifier​(String reagentIdentifier,
                                         int screenIndex,
                                         int reagentIndex)
        Set the ReagentIdentifier property of Reagent.
        Parameters:
        reagentIdentifier - ReagentIdentifier to set.
        screenIndex - the Screen index.
        reagentIndex - the Reagent index.
      • setRectangleAnnotationRef

        void setRectangleAnnotationRef​(String annotation,
                                       int ROIIndex,
                                       int shapeIndex,
                                       int annotationRefIndex)
        Set the AnnotationRef property of Rectangle.
        Parameters:
        annotation - AnnotationRef to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
        annotationRefIndex - AnnotationRef index (unused).
      • setRectangleFillColor

        void setRectangleFillColor​(Color fillColor,
                                   int ROIIndex,
                                   int shapeIndex)
        Set the FillColor property of Rectangle.
        Parameters:
        fillColor - FillColor to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setRectangleFillRule

        void setRectangleFillRule​(FillRule fillRule,
                                  int ROIIndex,
                                  int shapeIndex)
        Set the FillRule property of Rectangle.
        Parameters:
        fillRule - FillRule to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setRectangleFontFamily

        void setRectangleFontFamily​(FontFamily fontFamily,
                                    int ROIIndex,
                                    int shapeIndex)
        Set the FontFamily property of Rectangle.
        Parameters:
        fontFamily - FontFamily to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setRectangleFontSize

        void setRectangleFontSize​(Length fontSize,
                                  int ROIIndex,
                                  int shapeIndex)
        Set the FontSize property of Rectangle.
        Parameters:
        fontSize - FontSize to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setRectangleFontStyle

        void setRectangleFontStyle​(FontStyle fontStyle,
                                   int ROIIndex,
                                   int shapeIndex)
        Set the FontStyle property of Rectangle.
        Parameters:
        fontStyle - FontStyle to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setRectangleHeight

        void setRectangleHeight​(Double height,
                                int ROIIndex,
                                int shapeIndex)
        Set the Height property of Rectangle.
        Parameters:
        height - Height to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setRectangleID

        void setRectangleID​(String id,
                            int ROIIndex,
                            int shapeIndex)
        Set the ID property of Rectangle.
        Parameters:
        id - ID to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setRectangleLocked

        void setRectangleLocked​(Boolean locked,
                                int ROIIndex,
                                int shapeIndex)
        Set the Locked property of Rectangle.
        Parameters:
        locked - Locked to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setRectangleStrokeColor

        void setRectangleStrokeColor​(Color strokeColor,
                                     int ROIIndex,
                                     int shapeIndex)
        Set the StrokeColor property of Rectangle.
        Parameters:
        strokeColor - StrokeColor to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setRectangleStrokeDashArray

        void setRectangleStrokeDashArray​(String strokeDashArray,
                                         int ROIIndex,
                                         int shapeIndex)
        Set the StrokeDashArray property of Rectangle.
        Parameters:
        strokeDashArray - StrokeDashArray to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setRectangleStrokeWidth

        void setRectangleStrokeWidth​(Length strokeWidth,
                                     int ROIIndex,
                                     int shapeIndex)
        Set the StrokeWidth property of Rectangle.
        Parameters:
        strokeWidth - StrokeWidth to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setRectangleText

        void setRectangleText​(String text,
                              int ROIIndex,
                              int shapeIndex)
        Set the Text property of Rectangle.
        Parameters:
        text - Text to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setRectangleTheC

        void setRectangleTheC​(NonNegativeInteger theC,
                              int ROIIndex,
                              int shapeIndex)
        Set the TheC property of Rectangle.
        Parameters:
        theC - TheC to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setRectangleTheT

        void setRectangleTheT​(NonNegativeInteger theT,
                              int ROIIndex,
                              int shapeIndex)
        Set the TheT property of Rectangle.
        Parameters:
        theT - TheT to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setRectangleTheZ

        void setRectangleTheZ​(NonNegativeInteger theZ,
                              int ROIIndex,
                              int shapeIndex)
        Set the TheZ property of Rectangle.
        Parameters:
        theZ - TheZ to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setRectangleTransform

        void setRectangleTransform​(AffineTransform transform,
                                   int ROIIndex,
                                   int shapeIndex)
        Set the Transform property of Rectangle.
        Parameters:
        transform - Transform to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setRectangleWidth

        void setRectangleWidth​(Double width,
                               int ROIIndex,
                               int shapeIndex)
        Set the Width property of Rectangle.
        Parameters:
        width - Width to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setRectangleX

        void setRectangleX​(Double x,
                           int ROIIndex,
                           int shapeIndex)
        Set the X property of Rectangle.
        Parameters:
        x - X to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setRectangleY

        void setRectangleY​(Double y,
                           int ROIIndex,
                           int shapeIndex)
        Set the Y property of Rectangle.
        Parameters:
        y - Y to set.
        ROIIndex - the ROI index.
        shapeIndex - the Shape index.
      • setRightsRightsHeld

        void setRightsRightsHeld​(String rightsHeld)
        Set the RightsHeld property of Rights.
        Parameters:
        rightsHeld - RightsHeld to set.
      • setRightsRightsHolder

        void setRightsRightsHolder​(String rightsHolder)
        Set the RightsHolder property of Rights.
        Parameters:
        rightsHolder - RightsHolder to set.
      • setScreenAnnotationRef

        void setScreenAnnotationRef​(String annotation,
                                    int screenIndex,
                                    int annotationRefIndex)
        Set the AnnotationRef property of Screen.
        Parameters:
        annotation - AnnotationRef to set.
        screenIndex - the Screen index.
        annotationRefIndex - AnnotationRef index (unused).
      • setScreenDescription

        void setScreenDescription​(String description,
                                  int screenIndex)
        Set the Description property of Screen.
        Parameters:
        description - Description to set.
        screenIndex - the Screen index.
      • setScreenID

        void setScreenID​(String id,
                         int screenIndex)
        Set the ID property of Screen.
        Parameters:
        id - ID to set.
        screenIndex - the Screen index.
      • setScreenName

        void setScreenName​(String name,
                           int screenIndex)
        Set the Name property of Screen.
        Parameters:
        name - Name to set.
        screenIndex - the Screen index.
      • setScreenPlateRef

        void setScreenPlateRef​(String plate,
                               int screenIndex,
                               int plateRefIndex)
        Set the PlateRef property of Screen.
        Parameters:
        plate - PlateRef to set.
        screenIndex - the Screen index.
        plateRefIndex - PlateRef index (unused).
      • setScreenProtocolDescription

        void setScreenProtocolDescription​(String protocolDescription,
                                          int screenIndex)
        Set the ProtocolDescription property of Screen.
        Parameters:
        protocolDescription - ProtocolDescription to set.
        screenIndex - the Screen index.
      • setScreenProtocolIdentifier

        void setScreenProtocolIdentifier​(String protocolIdentifier,
                                         int screenIndex)
        Set the ProtocolIdentifier property of Screen.
        Parameters:
        protocolIdentifier - ProtocolIdentifier to set.
        screenIndex - the Screen index.
      • setScreenReagentSetDescription

        void setScreenReagentSetDescription​(String reagentSetDescription,
                                            int screenIndex)
        Set the ReagentSetDescription property of Screen.
        Parameters:
        reagentSetDescription - ReagentSetDescription to set.
        screenIndex - the Screen index.
      • setScreenReagentSetIdentifier

        void setScreenReagentSetIdentifier​(String reagentSetIdentifier,
                                           int screenIndex)
        Set the ReagentSetIdentifier property of Screen.
        Parameters:
        reagentSetIdentifier - ReagentSetIdentifier to set.
        screenIndex - the Screen index.
      • setScreenType

        void setScreenType​(String type,
                           int screenIndex)
        Set the Type property of Screen.
        Parameters:
        type - Type to set.
        screenIndex - the Screen index.
      • setStageLabelName

        void setStageLabelName​(String name,
                               int imageIndex)
        Set the Name property of StageLabel.
        Parameters:
        name - Name to set.
        imageIndex - the Image index.
      • setStageLabelX

        void setStageLabelX​(Length x,
                            int imageIndex)
        Set the X property of StageLabel.
        Parameters:
        x - X to set.
        imageIndex - the Image index.
      • setStageLabelY

        void setStageLabelY​(Length y,
                            int imageIndex)
        Set the Y property of StageLabel.
        Parameters:
        y - Y to set.
        imageIndex - the Image index.
      • setStageLabelZ

        void setStageLabelZ​(Length z,
                            int imageIndex)
        Set the Z property of StageLabel.
        Parameters:
        z - Z to set.
        imageIndex - the Image index.
      • setTagAnnotationAnnotationRef

        void setTagAnnotationAnnotationRef​(String annotation,
                                           int tagAnnotationIndex,
                                           int annotationRefIndex)
        Set the AnnotationRef property of TagAnnotation.
        Parameters:
        annotation - AnnotationRef to set.
        tagAnnotationIndex - the TagAnnotation index.
        annotationRefIndex - AnnotationRef index (unused).
      • setTagAnnotationAnnotator

        void setTagAnnotationAnnotator​(String annotator,
                                       int tagAnnotationIndex)
        Set the Annotator property of TagAnnotation.
        Parameters:
        annotator - Annotator to set.
        tagAnnotationIndex - the TagAnnotation index.
      • setTagAnnotationDescription

        void setTagAnnotationDescription​(String description,
                                         int tagAnnotationIndex)
        Set the Description property of TagAnnotation.
        Parameters:
        description - Description to set.
        tagAnnotationIndex - the TagAnnotation index.
      • setTagAnnotationID

        void setTagAnnotationID​(String id,
                                int tagAnnotationIndex)
        Set the ID property of TagAnnotation.
        Parameters:
        id - ID to set.
        tagAnnotationIndex - the TagAnnotation index.
      • setTagAnnotationNamespace

        void setTagAnnotationNamespace​(String namespace,
                                       int tagAnnotationIndex)
        Set the Namespace property of TagAnnotation.
        Parameters:
        namespace - Namespace to set.
        tagAnnotationIndex - the TagAnnotation index.
      • setTagAnnotationValue

        void setTagAnnotationValue​(String value,
                                   int tagAnnotationIndex)
        Set the Value property of TagAnnotation.
        Parameters:
        value - Value to set.
        tagAnnotationIndex - the TagAnnotation index.
      • setTermAnnotationAnnotationRef

        void setTermAnnotationAnnotationRef​(String annotation,
                                            int termAnnotationIndex,
                                            int annotationRefIndex)
        Set the AnnotationRef property of TermAnnotation.
        Parameters:
        annotation - AnnotationRef to set.
        termAnnotationIndex - the TermAnnotation index.
        annotationRefIndex - AnnotationRef index (unused).
      • setTermAnnotationAnnotator

        void setTermAnnotationAnnotator​(String annotator,
                                        int termAnnotationIndex)
        Set the Annotator property of TermAnnotation.
        Parameters:
        annotator - Annotator to set.
        termAnnotationIndex - the TermAnnotation index.
      • setTermAnnotationDescription

        void setTermAnnotationDescription​(String description,
                                          int termAnnotationIndex)
        Set the Description property of TermAnnotation.
        Parameters:
        description - Description to set.
        termAnnotationIndex - the TermAnnotation index.
      • setTermAnnotationID

        void setTermAnnotationID​(String id,
                                 int termAnnotationIndex)
        Set the ID property of TermAnnotation.
        Parameters:
        id - ID to set.
        termAnnotationIndex - the TermAnnotation index.
      • setTermAnnotationNamespace

        void setTermAnnotationNamespace​(String namespace,
                                        int termAnnotationIndex)
        Set the Namespace property of TermAnnotation.
        Parameters:
        namespace - Namespace to set.
        termAnnotationIndex - the TermAnnotation index.
      • setTermAnnotationValue

        void setTermAnnotationValue​(String value,
                                    int termAnnotationIndex)
        Set the Value property of TermAnnotation.
        Parameters:
        value - Value to set.
        termAnnotationIndex - the TermAnnotation index.
      • setTiffDataFirstC

        void setTiffDataFirstC​(NonNegativeInteger firstC,
                               int imageIndex,
                               int tiffDataIndex)
        Set the FirstC property of TiffData.
        Parameters:
        firstC - FirstC to set.
        imageIndex - the Image index.
        tiffDataIndex - the TiffData index.
      • setTiffDataFirstT

        void setTiffDataFirstT​(NonNegativeInteger firstT,
                               int imageIndex,
                               int tiffDataIndex)
        Set the FirstT property of TiffData.
        Parameters:
        firstT - FirstT to set.
        imageIndex - the Image index.
        tiffDataIndex - the TiffData index.
      • setTiffDataFirstZ

        void setTiffDataFirstZ​(NonNegativeInteger firstZ,
                               int imageIndex,
                               int tiffDataIndex)
        Set the FirstZ property of TiffData.
        Parameters:
        firstZ - FirstZ to set.
        imageIndex - the Image index.
        tiffDataIndex - the TiffData index.
      • setTiffDataIFD

        void setTiffDataIFD​(NonNegativeInteger ifd,
                            int imageIndex,
                            int tiffDataIndex)
        Set the IFD property of TiffData.
        Parameters:
        ifd - IFD to set.
        imageIndex - the Image index.
        tiffDataIndex - the TiffData index.
      • setTiffDataPlaneCount

        void setTiffDataPlaneCount​(NonNegativeInteger planeCount,
                                   int imageIndex,
                                   int tiffDataIndex)
        Set the PlaneCount property of TiffData.
        Parameters:
        planeCount - PlaneCount to set.
        imageIndex - the Image index.
        tiffDataIndex - the TiffData index.
      • setTimestampAnnotationAnnotationRef

        void setTimestampAnnotationAnnotationRef​(String annotation,
                                                 int timestampAnnotationIndex,
                                                 int annotationRefIndex)
        Set the AnnotationRef property of TimestampAnnotation.
        Parameters:
        annotation - AnnotationRef to set.
        timestampAnnotationIndex - the TimestampAnnotation index.
        annotationRefIndex - AnnotationRef index (unused).
      • setTimestampAnnotationAnnotator

        void setTimestampAnnotationAnnotator​(String annotator,
                                             int timestampAnnotationIndex)
        Set the Annotator property of TimestampAnnotation.
        Parameters:
        annotator - Annotator to set.
        timestampAnnotationIndex - the TimestampAnnotation index.
      • setTimestampAnnotationDescription

        void setTimestampAnnotationDescription​(String description,
                                               int timestampAnnotationIndex)
        Set the Description property of TimestampAnnotation.
        Parameters:
        description - Description to set.
        timestampAnnotationIndex - the TimestampAnnotation index.
      • setTimestampAnnotationID

        void setTimestampAnnotationID​(String id,
                                      int timestampAnnotationIndex)
        Set the ID property of TimestampAnnotation.
        Parameters:
        id - ID to set.
        timestampAnnotationIndex - the TimestampAnnotation index.
      • setTimestampAnnotationNamespace

        void setTimestampAnnotationNamespace​(String namespace,
                                             int timestampAnnotationIndex)
        Set the Namespace property of TimestampAnnotation.
        Parameters:
        namespace - Namespace to set.
        timestampAnnotationIndex - the TimestampAnnotation index.
      • setTimestampAnnotationValue

        void setTimestampAnnotationValue​(Timestamp value,
                                         int timestampAnnotationIndex)
        Set the Value property of TimestampAnnotation.
        Parameters:
        value - Value to set.
        timestampAnnotationIndex - the TimestampAnnotation index.
      • setTransmittanceRangeCutIn

        void setTransmittanceRangeCutIn​(Length cutIn,
                                        int instrumentIndex,
                                        int filterIndex)
        Set the CutIn property of TransmittanceRange.
        Parameters:
        cutIn - CutIn to set.
        instrumentIndex - the Instrument index.
        filterIndex - the Filter index.
      • setTransmittanceRangeCutInTolerance

        void setTransmittanceRangeCutInTolerance​(Length cutInTolerance,
                                                 int instrumentIndex,
                                                 int filterIndex)
        Set the CutInTolerance property of TransmittanceRange.
        Parameters:
        cutInTolerance - CutInTolerance to set.
        instrumentIndex - the Instrument index.
        filterIndex - the Filter index.
      • setTransmittanceRangeCutOut

        void setTransmittanceRangeCutOut​(Length cutOut,
                                         int instrumentIndex,
                                         int filterIndex)
        Set the CutOut property of TransmittanceRange.
        Parameters:
        cutOut - CutOut to set.
        instrumentIndex - the Instrument index.
        filterIndex - the Filter index.
      • setTransmittanceRangeCutOutTolerance

        void setTransmittanceRangeCutOutTolerance​(Length cutOutTolerance,
                                                  int instrumentIndex,
                                                  int filterIndex)
        Set the CutOutTolerance property of TransmittanceRange.
        Parameters:
        cutOutTolerance - CutOutTolerance to set.
        instrumentIndex - the Instrument index.
        filterIndex - the Filter index.
      • setTransmittanceRangeTransmittance

        void setTransmittanceRangeTransmittance​(PercentFraction transmittance,
                                                int instrumentIndex,
                                                int filterIndex)
        Set the Transmittance property of TransmittanceRange.
        Parameters:
        transmittance - Transmittance to set.
        instrumentIndex - the Instrument index.
        filterIndex - the Filter index.
      • setUUIDValue

        void setUUIDValue​(String value,
                          int imageIndex,
                          int tiffDataIndex)
        Set the text value of UUID.
        Parameters:
        value - text value.
        imageIndex - the Image index.
        tiffDataIndex - the TiffData index.
      • setUUIDFileName

        void setUUIDFileName​(String fileName,
                             int imageIndex,
                             int tiffDataIndex)
        Set the FileName property of UUID.
        Parameters:
        fileName - FileName to set.
        imageIndex - the Image index.
        tiffDataIndex - the TiffData index.
      • setWellAnnotationRef

        void setWellAnnotationRef​(String annotation,
                                  int plateIndex,
                                  int wellIndex,
                                  int annotationRefIndex)
        Set the AnnotationRef property of Well.
        Parameters:
        annotation - AnnotationRef to set.
        plateIndex - the Plate index.
        wellIndex - the Well index.
        annotationRefIndex - AnnotationRef index (unused).
      • setWellColor

        void setWellColor​(Color color,
                          int plateIndex,
                          int wellIndex)
        Set the Color property of Well.
        Parameters:
        color - Color to set.
        plateIndex - the Plate index.
        wellIndex - the Well index.
      • setWellColumn

        void setWellColumn​(NonNegativeInteger column,
                           int plateIndex,
                           int wellIndex)
        Set the Column property of Well.
        Parameters:
        column - Column to set.
        plateIndex - the Plate index.
        wellIndex - the Well index.
      • setWellExternalDescription

        void setWellExternalDescription​(String externalDescription,
                                        int plateIndex,
                                        int wellIndex)
        Set the ExternalDescription property of Well.
        Parameters:
        externalDescription - ExternalDescription to set.
        plateIndex - the Plate index.
        wellIndex - the Well index.
      • setWellExternalIdentifier

        void setWellExternalIdentifier​(String externalIdentifier,
                                       int plateIndex,
                                       int wellIndex)
        Set the ExternalIdentifier property of Well.
        Parameters:
        externalIdentifier - ExternalIdentifier to set.
        plateIndex - the Plate index.
        wellIndex - the Well index.
      • setWellID

        void setWellID​(String id,
                       int plateIndex,
                       int wellIndex)
        Set the ID property of Well.
        Parameters:
        id - ID to set.
        plateIndex - the Plate index.
        wellIndex - the Well index.
      • setWellReagentRef

        void setWellReagentRef​(String reagent,
                               int plateIndex,
                               int wellIndex)
        Set the ReagentRef property of Well.
        Parameters:
        reagent - ReagentRef to set.
        plateIndex - the Plate index.
        wellIndex - the Well index.
      • setWellRow

        void setWellRow​(NonNegativeInteger row,
                        int plateIndex,
                        int wellIndex)
        Set the Row property of Well.
        Parameters:
        row - Row to set.
        plateIndex - the Plate index.
        wellIndex - the Well index.
      • setWellType

        void setWellType​(String type,
                         int plateIndex,
                         int wellIndex)
        Set the Type property of Well.
        Parameters:
        type - Type to set.
        plateIndex - the Plate index.
        wellIndex - the Well index.
      • setWellSampleID

        void setWellSampleID​(String id,
                             int plateIndex,
                             int wellIndex,
                             int wellSampleIndex)
        Set the ID property of WellSample.
        Parameters:
        id - ID to set.
        plateIndex - the Plate index.
        wellIndex - the Well index.
        wellSampleIndex - the WellSample index.
      • setWellSampleImageRef

        void setWellSampleImageRef​(String image,
                                   int plateIndex,
                                   int wellIndex,
                                   int wellSampleIndex)
        Set the ImageRef property of WellSample.
        Parameters:
        image - ImageRef to set.
        plateIndex - the Plate index.
        wellIndex - the Well index.
        wellSampleIndex - the WellSample index.
      • setWellSampleIndex

        void setWellSampleIndex​(NonNegativeInteger index,
                                int plateIndex,
                                int wellIndex,
                                int wellSampleIndex)
        Set the Index property of WellSample.
        Parameters:
        index - Index to set.
        plateIndex - the Plate index.
        wellIndex - the Well index.
        wellSampleIndex - the WellSample index.
      • setWellSamplePositionX

        void setWellSamplePositionX​(Length positionX,
                                    int plateIndex,
                                    int wellIndex,
                                    int wellSampleIndex)
        Set the PositionX property of WellSample.
        Parameters:
        positionX - PositionX to set.
        plateIndex - the Plate index.
        wellIndex - the Well index.
        wellSampleIndex - the WellSample index.
      • setWellSamplePositionY

        void setWellSamplePositionY​(Length positionY,
                                    int plateIndex,
                                    int wellIndex,
                                    int wellSampleIndex)
        Set the PositionY property of WellSample.
        Parameters:
        positionY - PositionY to set.
        plateIndex - the Plate index.
        wellIndex - the Well index.
        wellSampleIndex - the WellSample index.
      • setWellSampleTimepoint

        void setWellSampleTimepoint​(Timestamp timepoint,
                                    int plateIndex,
                                    int wellIndex,
                                    int wellSampleIndex)
        Set the Timepoint property of WellSample.
        Parameters:
        timepoint - Timepoint to set.
        plateIndex - the Plate index.
        wellIndex - the Well index.
        wellSampleIndex - the WellSample index.
      • setXMLAnnotationAnnotationRef

        void setXMLAnnotationAnnotationRef​(String annotation,
                                           int XMLAnnotationIndex,
                                           int annotationRefIndex)
        Set the AnnotationRef property of XMLAnnotation.
        Parameters:
        annotation - AnnotationRef to set.
        XMLAnnotationIndex - the XMLAnnotation index.
        annotationRefIndex - AnnotationRef index (unused).
      • setXMLAnnotationAnnotator

        void setXMLAnnotationAnnotator​(String annotator,
                                       int XMLAnnotationIndex)
        Set the Annotator property of XMLAnnotation.
        Parameters:
        annotator - Annotator to set.
        XMLAnnotationIndex - the XMLAnnotation index.
      • setXMLAnnotationDescription

        void setXMLAnnotationDescription​(String description,
                                         int XMLAnnotationIndex)
        Set the Description property of XMLAnnotation.
        Parameters:
        description - Description to set.
        XMLAnnotationIndex - the XMLAnnotation index.
      • setXMLAnnotationID

        void setXMLAnnotationID​(String id,
                                int XMLAnnotationIndex)
        Set the ID property of XMLAnnotation.
        Parameters:
        id - ID to set.
        XMLAnnotationIndex - the XMLAnnotation index.
      • setXMLAnnotationNamespace

        void setXMLAnnotationNamespace​(String namespace,
                                       int XMLAnnotationIndex)
        Set the Namespace property of XMLAnnotation.
        Parameters:
        namespace - Namespace to set.
        XMLAnnotationIndex - the XMLAnnotation index.
      • setXMLAnnotationValue

        void setXMLAnnotationValue​(String value,
                                   int XMLAnnotationIndex)
        Set the Value property of XMLAnnotation.
        Parameters:
        value - Value to set.
        XMLAnnotationIndex - the XMLAnnotation index.