source: trunk/components/bio-formats-ice/src/bio-formats.ice @ 5463

Revision 5463, 63.1 KB checked in by curtis, 10 years ago (diff)

Update Bio-Formats Ice package.

Line 
1//
2// bio-formats.ice
3//
4
5/*
6OME Bio-Formats package for reading and converting biological file formats.
7Copyright (C) 2005-2009 UW-Madison LOCI and Glencoe Software, Inc.
8
9This program is free software; you can redistribute it and/or modify
10it under the terms of the GNU General Public License as published by
11the Free Software Foundation; either version 2 of the License, or
12(at your option) any later version.
13
14This program is distributed in the hope that it will be useful,
15but WITHOUT ANY WARRANTY; without even the implied warranty of
16MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17GNU General Public License for more details.
18
19You should have received a copy of the GNU General Public License
20along with this program; if not, write to the Free Software
21Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
22*/
23
24/*-----------------------------------------------------------------------------
25 *
26 * THIS IS AUTOMATICALLY GENERATED CODE.  DO NOT MODIFY.
27 * Created by curtis via MetadataAutogen on Sep 10, 2009 7:46:33 PM CDT
28 *
29 *-----------------------------------------------------------------------------
30 */
31
32[["java:package:loci.ice"]]
33
34module formats {
35
36  sequence<byte> ByteSeq;
37  sequence<ByteSeq> ByteByteSeq;
38  sequence<short> ShortSeq;
39  sequence<ShortSeq> ShortShortSeq;
40  sequence<int> IntSeq;
41  sequence<string> StringSeq;
42
43  interface MetadataRetrieve;
44  interface MetadataStore;
45
46  interface IFormatReader {
47    void setId(string id);
48
49    void setRetrieveAsStore(MetadataRetrieve* retrieve);
50    //const int MUST_GROUP = 0;
51    //const int CAN_GROUP = 1;
52    //const int CANNOT_GROUP = 2;
53
54    bool isThisType(string name, bool open);
55    //bool isThisType2(ByteSeq block);
56    int getImageCount();
57    bool isRGB();
58    int getSizeX();
59    int getSizeY();
60    int getSizeZ();
61    int getSizeC();
62    int getSizeT();
63    int getPixelType();
64    int getEffectiveSizeC();
65    int getRGBChannelCount();
66    bool isIndexed();
67    bool isFalseColor();
68    ByteByteSeq get8BitLookupTable();
69    ShortShortSeq get16BitLookupTable();
70    IntSeq getChannelDimLengths();
71    StringSeq getChannelDimTypes();
72    int getThumbSizeX();
73    int getThumbSizeY();
74    bool isLittleEndian();
75    string getDimensionOrder();
76    bool isOrderCertain();
77    bool isInterleaved();
78    bool isInterleavedSubC(int subC);
79    //ByteSeq openBytes1(int no);
80    ByteSeq openBytes(int no, int x, int y, int width, int height);
81    //ByteSeq openBytes3(int no, ByteSeq buf);
82    //ByteSeq openBytes4(int no, ByteSeq buf,
83    //  int x, int y, int width, int height);
84    ByteSeq openThumbBytes(int no);
85    void closeFile(bool fileOnly);
86    string getFormat();
87    StringSeq getSuffixes();
88    void close();
89    int getSeriesCount();
90    void setSeries(int no);
91    int getSeries();
92    void setNormalized(bool normalize);
93    bool isNormalized();
94    void setMetadataCollected(bool collect);
95    bool isMetadataCollected();
96    void setOriginalMetadataPopulated(bool populate);
97    bool isOriginalMetadataPopulated();
98    void setGroupFiles(bool group);
99    bool isGroupFiles();
100    bool isMetadataComplete();
101    int fileGroupOption(string id);
102    StringSeq getUsedFiles();
103    string getCurrentFile();
104    int getIndex(int z, int c, int t);
105    IntSeq getZCTCoords(int index);
106    //Object getMetadataValue(string field);
107    //Hashtable getMetadata();
108    //CoreMetadata getCoreMetadata();
109    void setMetadataFiltered(bool filter);
110    bool isMetadataFiltered();
111    void setMetadataStore(MetadataStore* store);
112    //MetadataStore* getMetadataStore();
113    //Object getMetadataStoreRoot();
114    //IFormatReader[] getUnderlyingReaders();
115  };
116
117  interface IFormatWriter {
118    void setId(string id);
119    void setStoreAsRetrieve(MetadataStore* store);
120    void close();
121    void saveBytes1(ByteSeq bytes, bool last);
122    void saveBytes2(ByteSeq bytes, int series, bool lastInSeries, bool last);
123    bool canDoStacks();
124    void setMetadataRetrieve(MetadataRetrieve* r);
125    MetadataRetrieve getMetadataRetrieve();
126    void setFramesPerSecond(int rate);
127    int getFramesPerSecond();
128    StringSeq getCompressionTypes();
129    IntSeq getPixelTypes();
130    bool isSupportedType(int type);
131    void setCompression(string compress);
132    bool isThisType(string name);
133    string getFormat();
134    StringSeq getSuffixes();
135  };
136
137  interface MetadataStore {
138    MetadataStore getServant();
139    string getOMEXML();
140
141    void createRoot();
142    //void setRoot(Object root);
143    //Object getRoot();
144
145    // - Entity storage -
146
147    void setUUID(string uuid);
148
149    // - Arc property storage -
150    void setArcType(string type, int instrumentIndex, int lightSourceIndex);
151
152    // - ChannelComponent property storage -
153    void setChannelComponentColorDomain(string colorDomain, int imageIndex, int logicalChannelIndex, int channelComponentIndex);
154    void setChannelComponentIndex(int index, int imageIndex, int logicalChannelIndex, int channelComponentIndex);
155    void setChannelComponentPixels(string pixels, int imageIndex, int logicalChannelIndex, int channelComponentIndex);
156
157    // - Circle property storage -
158    void setCircleCx(string cx, int imageIndex, int roiIndex, int shapeIndex);
159    void setCircleCy(string cy, int imageIndex, int roiIndex, int shapeIndex);
160    void setCircleID(string id, int imageIndex, int roiIndex, int shapeIndex);
161    void setCircleR(string r, int imageIndex, int roiIndex, int shapeIndex);
162    void setCircleTransform(string transform, int imageIndex, int roiIndex, int shapeIndex);
163
164    // - Contact property storage -
165    void setContactExperimenter(string experimenter, int groupIndex);
166
167    // - Dataset property storage -
168    void setDatasetDescription(string description, int datasetIndex);
169    void setDatasetExperimenterRef(string experimenterRef, int datasetIndex);
170    void setDatasetGroupRef(string groupRef, int datasetIndex);
171    void setDatasetID(string id, int datasetIndex);
172    void setDatasetLocked(bool locked, int datasetIndex);
173    void setDatasetName(string name, int datasetIndex);
174
175    // - DatasetRef property storage -
176    void setDatasetRefID(string id, int imageIndex, int datasetRefIndex);
177
178    // - Detector property storage -
179    void setDetectorAmplificationGain(float amplificationGain, int instrumentIndex, int detectorIndex);
180    void setDetectorGain(float gain, int instrumentIndex, int detectorIndex);
181    void setDetectorID(string id, int instrumentIndex, int detectorIndex);
182    void setDetectorManufacturer(string manufacturer, int instrumentIndex, int detectorIndex);
183    void setDetectorModel(string model, int instrumentIndex, int detectorIndex);
184    void setDetectorOffset(float offset, int instrumentIndex, int detectorIndex);
185    void setDetectorSerialNumber(string serialNumber, int instrumentIndex, int detectorIndex);
186    void setDetectorType(string type, int instrumentIndex, int detectorIndex);
187    void setDetectorVoltage(float voltage, int instrumentIndex, int detectorIndex);
188    void setDetectorZoom(float zoom, int instrumentIndex, int detectorIndex);
189
190    // - DetectorSettings property storage -
191    void setDetectorSettingsBinning(string binning, int imageIndex, int logicalChannelIndex);
192    void setDetectorSettingsDetector(string detector, int imageIndex, int logicalChannelIndex);
193    void setDetectorSettingsGain(float gain, int imageIndex, int logicalChannelIndex);
194    void setDetectorSettingsOffset(float offset, int imageIndex, int logicalChannelIndex);
195    void setDetectorSettingsReadOutRate(float readOutRate, int imageIndex, int logicalChannelIndex);
196    void setDetectorSettingsVoltage(float voltage, int imageIndex, int logicalChannelIndex);
197
198    // - Dichroic property storage -
199    void setDichroicID(string id, int instrumentIndex, int dichroicIndex);
200    void setDichroicLotNumber(string lotNumber, int instrumentIndex, int dichroicIndex);
201    void setDichroicManufacturer(string manufacturer, int instrumentIndex, int dichroicIndex);
202    void setDichroicModel(string model, int instrumentIndex, int dichroicIndex);
203
204    // - Dimensions property storage -
205    void setDimensionsPhysicalSizeX(float physicalSizeX, int imageIndex, int pixelsIndex);
206    void setDimensionsPhysicalSizeY(float physicalSizeY, int imageIndex, int pixelsIndex);
207    void setDimensionsPhysicalSizeZ(float physicalSizeZ, int imageIndex, int pixelsIndex);
208    void setDimensionsTimeIncrement(float timeIncrement, int imageIndex, int pixelsIndex);
209    void setDimensionsWaveIncrement(int waveIncrement, int imageIndex, int pixelsIndex);
210    void setDimensionsWaveStart(int waveStart, int imageIndex, int pixelsIndex);
211
212    // - DisplayOptions property storage -
213    void setDisplayOptionsDisplay(string display, int imageIndex);
214    void setDisplayOptionsID(string id, int imageIndex);
215    void setDisplayOptionsZoom(float zoom, int imageIndex);
216
217    // - Ellipse property storage -
218    void setEllipseCx(string cx, int imageIndex, int roiIndex, int shapeIndex);
219    void setEllipseCy(string cy, int imageIndex, int roiIndex, int shapeIndex);
220    void setEllipseID(string id, int imageIndex, int roiIndex, int shapeIndex);
221    void setEllipseRx(string rx, int imageIndex, int roiIndex, int shapeIndex);
222    void setEllipseRy(string ry, int imageIndex, int roiIndex, int shapeIndex);
223    void setEllipseTransform(string transform, int imageIndex, int roiIndex, int shapeIndex);
224
225    // - EmFilter property storage -
226    void setEmFilterLotNumber(string lotNumber, int instrumentIndex, int filterIndex);
227    void setEmFilterManufacturer(string manufacturer, int instrumentIndex, int filterIndex);
228    void setEmFilterModel(string model, int instrumentIndex, int filterIndex);
229    void setEmFilterType(string type, int instrumentIndex, int filterIndex);
230
231    // - ExFilter property storage -
232    void setExFilterLotNumber(string lotNumber, int instrumentIndex, int filterIndex);
233    void setExFilterManufacturer(string manufacturer, int instrumentIndex, int filterIndex);
234    void setExFilterModel(string model, int instrumentIndex, int filterIndex);
235    void setExFilterType(string type, int instrumentIndex, int filterIndex);
236
237    // - Experiment property storage -
238    void setExperimentDescription(string description, int experimentIndex);
239    void setExperimentExperimenterRef(string experimenterRef, int experimentIndex);
240    void setExperimentID(string id, int experimentIndex);
241    void setExperimentType(string type, int experimentIndex);
242
243    // - Experimenter property storage -
244    void setExperimenterEmail(string email, int experimenterIndex);
245    void setExperimenterFirstName(string firstName, int experimenterIndex);
246    void setExperimenterID(string id, int experimenterIndex);
247    void setExperimenterInstitution(string institution, int experimenterIndex);
248    void setExperimenterLastName(string lastName, int experimenterIndex);
249    void setExperimenterOMEName(string omeName, int experimenterIndex);
250
251    // - ExperimenterMembership property storage -
252    void setExperimenterMembershipGroup(string group, int experimenterIndex, int groupRefIndex);
253
254    // - Filament property storage -
255    void setFilamentType(string type, int instrumentIndex, int lightSourceIndex);
256
257    // - Filter property storage -
258    void setFilterFilterWheel(string filterWheel, int instrumentIndex, int filterIndex);
259    void setFilterID(string id, int instrumentIndex, int filterIndex);
260    void setFilterLotNumber(string lotNumber, int instrumentIndex, int filterIndex);
261    void setFilterManufacturer(string manufacturer, int instrumentIndex, int filterIndex);
262    void setFilterModel(string model, int instrumentIndex, int filterIndex);
263    void setFilterType(string type, int instrumentIndex, int filterIndex);
264
265    // - FilterSet property storage -
266    void setFilterSetDichroic(string dichroic, int instrumentIndex, int filterSetIndex);
267    void setFilterSetEmFilter(string emFilter, int instrumentIndex, int filterSetIndex);
268    void setFilterSetExFilter(string exFilter, int instrumentIndex, int filterSetIndex);
269    void setFilterSetID(string id, int instrumentIndex, int filterSetIndex);
270    void setFilterSetLotNumber(string lotNumber, int instrumentIndex, int filterSetIndex);
271    void setFilterSetManufacturer(string manufacturer, int instrumentIndex, int filterSetIndex);
272    void setFilterSetModel(string model, int instrumentIndex, int filterSetIndex);
273
274    // - Group property storage -
275    void setGroupID(string id, int groupIndex);
276    void setGroupName(string name, int groupIndex);
277
278    // - GroupRef property storage -
279
280    // - Image property storage -
281    void setImageAcquiredPixels(string acquiredPixels, int imageIndex);
282    void setImageCreationDate(string creationDate, int imageIndex);
283    void setImageDefaultPixels(string defaultPixels, int imageIndex);
284    void setImageDescription(string description, int imageIndex);
285    void setImageExperimentRef(string experimentRef, int imageIndex);
286    void setImageExperimenterRef(string experimenterRef, int imageIndex);
287    void setImageGroupRef(string groupRef, int imageIndex);
288    void setImageID(string id, int imageIndex);
289    void setImageInstrumentRef(string instrumentRef, int imageIndex);
290    void setImageName(string name, int imageIndex);
291
292    // - ImagingEnvironment property storage -
293    void setImagingEnvironmentAirPressure(float airPressure, int imageIndex);
294    void setImagingEnvironmentCO2Percent(float cO2Percent, int imageIndex);
295    void setImagingEnvironmentHumidity(float humidity, int imageIndex);
296    void setImagingEnvironmentTemperature(float temperature, int imageIndex);
297
298    // - Instrument property storage -
299    void setInstrumentID(string id, int instrumentIndex);
300
301    // - Laser property storage -
302    void setLaserFrequencyMultiplication(int frequencyMultiplication, int instrumentIndex, int lightSourceIndex);
303    void setLaserLaserMedium(string laserMedium, int instrumentIndex, int lightSourceIndex);
304    void setLaserPockelCell(bool pockelCell, int instrumentIndex, int lightSourceIndex);
305    void setLaserPulse(string pulse, int instrumentIndex, int lightSourceIndex);
306    void setLaserRepetitionRate(bool repetitionRate, int instrumentIndex, int lightSourceIndex);
307    void setLaserTuneable(bool tuneable, int instrumentIndex, int lightSourceIndex);
308    void setLaserType(string type, int instrumentIndex, int lightSourceIndex);
309    void setLaserWavelength(int wavelength, int instrumentIndex, int lightSourceIndex);
310
311    // - LightSource property storage -
312    void setLightSourceID(string id, int instrumentIndex, int lightSourceIndex);
313    void setLightSourceManufacturer(string manufacturer, int instrumentIndex, int lightSourceIndex);
314    void setLightSourceModel(string model, int instrumentIndex, int lightSourceIndex);
315    void setLightSourcePower(float power, int instrumentIndex, int lightSourceIndex);
316    void setLightSourceSerialNumber(string serialNumber, int instrumentIndex, int lightSourceIndex);
317
318    // - LightSourceRef property storage -
319    void setLightSourceRefAttenuation(float attenuation, int imageIndex, int microbeamManipulationIndex, int lightSourceRefIndex);
320    void setLightSourceRefLightSource(string lightSource, int imageIndex, int microbeamManipulationIndex, int lightSourceRefIndex);
321    void setLightSourceRefWavelength(int wavelength, int imageIndex, int microbeamManipulationIndex, int lightSourceRefIndex);
322
323    // - LightSourceSettings property storage -
324    void setLightSourceSettingsAttenuation(float attenuation, int imageIndex, int logicalChannelIndex);
325    void setLightSourceSettingsLightSource(string lightSource, int imageIndex, int logicalChannelIndex);
326    void setLightSourceSettingsWavelength(int wavelength, int imageIndex, int logicalChannelIndex);
327
328    // - Line property storage -
329    void setLineID(string id, int imageIndex, int roiIndex, int shapeIndex);
330    void setLineTransform(string transform, int imageIndex, int roiIndex, int shapeIndex);
331    void setLineX1(string x1, int imageIndex, int roiIndex, int shapeIndex);
332    void setLineX2(string x2, int imageIndex, int roiIndex, int shapeIndex);
333    void setLineY1(string y1, int imageIndex, int roiIndex, int shapeIndex);
334    void setLineY2(string y2, int imageIndex, int roiIndex, int shapeIndex);
335
336    // - LogicalChannel property storage -
337    void setLogicalChannelContrastMethod(string contrastMethod, int imageIndex, int logicalChannelIndex);
338    void setLogicalChannelDetector(string detector, int imageIndex, int logicalChannelIndex);
339    void setLogicalChannelEmWave(int emWave, int imageIndex, int logicalChannelIndex);
340    void setLogicalChannelExWave(int exWave, int imageIndex, int logicalChannelIndex);
341    void setLogicalChannelFilterSet(string filterSet, int imageIndex, int logicalChannelIndex);
342    void setLogicalChannelFluor(string fluor, int imageIndex, int logicalChannelIndex);
343    void setLogicalChannelID(string id, int imageIndex, int logicalChannelIndex);
344    void setLogicalChannelIlluminationType(string illuminationType, int imageIndex, int logicalChannelIndex);
345    void setLogicalChannelLightSource(string lightSource, int imageIndex, int logicalChannelIndex);
346    void setLogicalChannelMode(string mode, int imageIndex, int logicalChannelIndex);
347    void setLogicalChannelName(string name, int imageIndex, int logicalChannelIndex);
348    void setLogicalChannelNdFilter(float ndFilter, int imageIndex, int logicalChannelIndex);
349    void setLogicalChannelOTF(string otf, int imageIndex, int logicalChannelIndex);
350    void setLogicalChannelPhotometricInterpretation(string photometricInterpretation, int imageIndex, int logicalChannelIndex);
351    void setLogicalChannelPinholeSize(float pinholeSize, int imageIndex, int logicalChannelIndex);
352    void setLogicalChannelPockelCellSetting(int pockelCellSetting, int imageIndex, int logicalChannelIndex);
353    void setLogicalChannelSamplesPerPixel(int samplesPerPixel, int imageIndex, int logicalChannelIndex);
354    void setLogicalChannelSecondaryEmissionFilter(string secondaryEmissionFilter, int imageIndex, int logicalChannelIndex);
355    void setLogicalChannelSecondaryExcitationFilter(string secondaryExcitationFilter, int imageIndex, int logicalChannelIndex);
356
357    // - Mask property storage -
358    void setMaskHeight(string height, int imageIndex, int roiIndex, int shapeIndex);
359    void setMaskID(string id, int imageIndex, int roiIndex, int shapeIndex);
360    void setMaskTransform(string transform, int imageIndex, int roiIndex, int shapeIndex);
361    void setMaskWidth(string width, int imageIndex, int roiIndex, int shapeIndex);
362    void setMaskX(string x, int imageIndex, int roiIndex, int shapeIndex);
363    void setMaskY(string y, int imageIndex, int roiIndex, int shapeIndex);
364
365    // - MaskPixels property storage -
366    void setMaskPixelsBigEndian(bool bigEndian, int imageIndex, int roiIndex, int shapeIndex);
367    void setMaskPixelsBinData(string binData, int imageIndex, int roiIndex, int shapeIndex);
368    void setMaskPixelsExtendedPixelType(string extendedPixelType, int imageIndex, int roiIndex, int shapeIndex);
369    void setMaskPixelsID(string id, int imageIndex, int roiIndex, int shapeIndex);
370    void setMaskPixelsSizeX(int sizeX, int imageIndex, int roiIndex, int shapeIndex);
371    void setMaskPixelsSizeY(int sizeY, int imageIndex, int roiIndex, int shapeIndex);
372
373    // - MicrobeamManipulation property storage -
374    void setMicrobeamManipulationExperimenterRef(string experimenterRef, int imageIndex, int microbeamManipulationIndex);
375    void setMicrobeamManipulationID(string id, int imageIndex, int microbeamManipulationIndex);
376    void setMicrobeamManipulationType(string type, int imageIndex, int microbeamManipulationIndex);
377
378    // - MicrobeamManipulationRef property storage -
379    void setMicrobeamManipulationRefID(string id, int experimentIndex, int microbeamManipulationRefIndex);
380
381    // - Microscope property storage -
382    void setMicroscopeID(string id, int instrumentIndex);
383    void setMicroscopeManufacturer(string manufacturer, int instrumentIndex);
384    void setMicroscopeModel(string model, int instrumentIndex);
385    void setMicroscopeSerialNumber(string serialNumber, int instrumentIndex);
386    void setMicroscopeType(string type, int instrumentIndex);
387
388    // - OTF property storage -
389    void setOTFBinaryFile(string binaryFile, int instrumentIndex, int otfIndex);
390    void setOTFID(string id, int instrumentIndex, int otfIndex);
391    void setOTFObjective(string objective, int instrumentIndex, int otfIndex);
392    void setOTFOpticalAxisAveraged(bool opticalAxisAveraged, int instrumentIndex, int otfIndex);
393    void setOTFPixelType(string pixelType, int instrumentIndex, int otfIndex);
394    void setOTFSizeX(int sizeX, int instrumentIndex, int otfIndex);
395    void setOTFSizeY(int sizeY, int instrumentIndex, int otfIndex);
396
397    // - Objective property storage -
398    void setObjectiveCalibratedMagnification(float calibratedMagnification, int instrumentIndex, int objectiveIndex);
399    void setObjectiveCorrection(string correction, int instrumentIndex, int objectiveIndex);
400    void setObjectiveID(string id, int instrumentIndex, int objectiveIndex);
401    void setObjectiveImmersion(string immersion, int instrumentIndex, int objectiveIndex);
402    void setObjectiveIris(bool iris, int instrumentIndex, int objectiveIndex);
403    void setObjectiveLensNA(float lensNA, int instrumentIndex, int objectiveIndex);
404    void setObjectiveManufacturer(string manufacturer, int instrumentIndex, int objectiveIndex);
405    void setObjectiveModel(string model, int instrumentIndex, int objectiveIndex);
406    void setObjectiveNominalMagnification(int nominalMagnification, int instrumentIndex, int objectiveIndex);
407    void setObjectiveSerialNumber(string serialNumber, int instrumentIndex, int objectiveIndex);
408    void setObjectiveWorkingDistance(float workingDistance, int instrumentIndex, int objectiveIndex);
409
410    // - ObjectiveSettings property storage -
411    void setObjectiveSettingsCorrectionCollar(float correctionCollar, int imageIndex);
412    void setObjectiveSettingsMedium(string medium, int imageIndex);
413    void setObjectiveSettingsObjective(string objective, int imageIndex);
414    void setObjectiveSettingsRefractiveIndex(float refractiveIndex, int imageIndex);
415
416    // - Path property storage -
417    void setPathD(string d, int imageIndex, int roiIndex, int shapeIndex);
418    void setPathID(string id, int imageIndex, int roiIndex, int shapeIndex);
419
420    // - Pixels property storage -
421    void setPixelsBigEndian(bool bigEndian, int imageIndex, int pixelsIndex);
422    void setPixelsDimensionOrder(string dimensionOrder, int imageIndex, int pixelsIndex);
423    void setPixelsID(string id, int imageIndex, int pixelsIndex);
424    void setPixelsPixelType(string pixelType, int imageIndex, int pixelsIndex);
425    void setPixelsSizeC(int sizeC, int imageIndex, int pixelsIndex);
426    void setPixelsSizeT(int sizeT, int imageIndex, int pixelsIndex);
427    void setPixelsSizeX(int sizeX, int imageIndex, int pixelsIndex);
428    void setPixelsSizeY(int sizeY, int imageIndex, int pixelsIndex);
429    void setPixelsSizeZ(int sizeZ, int imageIndex, int pixelsIndex);
430
431    // - Plane property storage -
432    void setPlaneHashSHA1(string hashSHA1, int imageIndex, int pixelsIndex, int planeIndex);
433    void setPlaneID(string id, int imageIndex, int pixelsIndex, int planeIndex);
434    void setPlaneTheC(int theC, int imageIndex, int pixelsIndex, int planeIndex);
435    void setPlaneTheT(int theT, int imageIndex, int pixelsIndex, int planeIndex);
436    void setPlaneTheZ(int theZ, int imageIndex, int pixelsIndex, int planeIndex);
437
438    // - PlaneTiming property storage -
439    void setPlaneTimingDeltaT(float deltaT, int imageIndex, int pixelsIndex, int planeIndex);
440    void setPlaneTimingExposureTime(float exposureTime, int imageIndex, int pixelsIndex, int planeIndex);
441
442    // - Plate property storage -
443    void setPlateColumnNamingConvention(string columnNamingConvention, int plateIndex);
444    void setPlateDescription(string description, int plateIndex);
445    void setPlateExternalIdentifier(string externalIdentifier, int plateIndex);
446    void setPlateID(string id, int plateIndex);
447    void setPlateName(string name, int plateIndex);
448    void setPlateRowNamingConvention(string rowNamingConvention, int plateIndex);
449    void setPlateStatus(string status, int plateIndex);
450    void setPlateWellOriginX(double wellOriginX, int plateIndex);
451    void setPlateWellOriginY(double wellOriginY, int plateIndex);
452
453    // - PlateRef property storage -
454    void setPlateRefID(string id, int screenIndex, int plateRefIndex);
455    void setPlateRefSample(int sample, int screenIndex, int plateRefIndex);
456    void setPlateRefWell(string well, int screenIndex, int plateRefIndex);
457
458    // - Point property storage -
459    void setPointCx(string cx, int imageIndex, int roiIndex, int shapeIndex);
460    void setPointCy(string cy, int imageIndex, int roiIndex, int shapeIndex);
461    void setPointID(string id, int imageIndex, int roiIndex, int shapeIndex);
462    void setPointR(string r, int imageIndex, int roiIndex, int shapeIndex);
463    void setPointTransform(string transform, int imageIndex, int roiIndex, int shapeIndex);
464
465    // - Polygon property storage -
466    void setPolygonID(string id, int imageIndex, int roiIndex, int shapeIndex);
467    void setPolygonPoints(string points, int imageIndex, int roiIndex, int shapeIndex);
468    void setPolygonTransform(string transform, int imageIndex, int roiIndex, int shapeIndex);
469
470    // - Polyline property storage -
471    void setPolylineID(string id, int imageIndex, int roiIndex, int shapeIndex);
472    void setPolylinePoints(string points, int imageIndex, int roiIndex, int shapeIndex);
473    void setPolylineTransform(string transform, int imageIndex, int roiIndex, int shapeIndex);
474
475    // - Project property storage -
476    void setProjectDescription(string description, int projectIndex);
477    void setProjectExperimenterRef(string experimenterRef, int projectIndex);
478    void setProjectGroupRef(string groupRef, int projectIndex);
479    void setProjectID(string id, int projectIndex);
480    void setProjectName(string name, int projectIndex);
481
482    // - ProjectRef property storage -
483    void setProjectRefID(string id, int datasetIndex, int projectRefIndex);
484
485    // - Pump property storage -
486    void setPumpLightSource(string lightSource, int instrumentIndex, int lightSourceIndex);
487
488    // - ROI property storage -
489    void setROIID(string id, int imageIndex, int roiIndex);
490    void setROIT0(int t0, int imageIndex, int roiIndex);
491    void setROIT1(int t1, int imageIndex, int roiIndex);
492    void setROIX0(int x0, int imageIndex, int roiIndex);
493    void setROIX1(int x1, int imageIndex, int roiIndex);
494    void setROIY0(int y0, int imageIndex, int roiIndex);
495    void setROIY1(int y1, int imageIndex, int roiIndex);
496    void setROIZ0(int z0, int imageIndex, int roiIndex);
497    void setROIZ1(int z1, int imageIndex, int roiIndex);
498
499    // - ROIRef property storage -
500    void setROIRefID(string id, int imageIndex, int microbeamManipulationIndex, int roiRefIndex);
501
502    // - Reagent property storage -
503    void setReagentDescription(string description, int screenIndex, int reagentIndex);
504    void setReagentID(string id, int screenIndex, int reagentIndex);
505    void setReagentName(string name, int screenIndex, int reagentIndex);
506    void setReagentReagentIdentifier(string reagentIdentifier, int screenIndex, int reagentIndex);
507
508    // - Rect property storage -
509    void setRectHeight(string height, int imageIndex, int roiIndex, int shapeIndex);
510    void setRectID(string id, int imageIndex, int roiIndex, int shapeIndex);
511    void setRectTransform(string transform, int imageIndex, int roiIndex, int shapeIndex);
512    void setRectWidth(string width, int imageIndex, int roiIndex, int shapeIndex);
513    void setRectX(string x, int imageIndex, int roiIndex, int shapeIndex);
514    void setRectY(string y, int imageIndex, int roiIndex, int shapeIndex);
515
516    // - Region property storage -
517    void setRegionID(string id, int imageIndex, int regionIndex);
518    void setRegionName(string name, int imageIndex, int regionIndex);
519    void setRegionTag(string tag, int imageIndex, int regionIndex);
520
521    // - RoiLink property storage -
522    void setRoiLinkDirection(string direction, int imageIndex, int roiIndex, int roiLinkIndex);
523    void setRoiLinkName(string name, int imageIndex, int roiIndex, int roiLinkIndex);
524    void setRoiLinkRef(string ref, int imageIndex, int roiIndex, int roiLinkIndex);
525
526    // - Screen property storage -
527    void setScreenDescription(string description, int screenIndex);
528    void setScreenExtern(string extern, int screenIndex);
529    void setScreenID(string id, int screenIndex);
530    void setScreenName(string name, int screenIndex);
531    void setScreenProtocolDescription(string protocolDescription, int screenIndex);
532    void setScreenProtocolIdentifier(string protocolIdentifier, int screenIndex);
533    void setScreenReagentSetDescription(string reagentSetDescription, int screenIndex);
534    void setScreenReagentSetIdentifier(string reagentSetIdentifier, int screenIndex);
535    void setScreenType(string type, int screenIndex);
536
537    // - ScreenAcquisition property storage -
538    void setScreenAcquisitionEndTime(string endTime, int screenIndex, int screenAcquisitionIndex);
539    void setScreenAcquisitionID(string id, int screenIndex, int screenAcquisitionIndex);
540    void setScreenAcquisitionStartTime(string startTime, int screenIndex, int screenAcquisitionIndex);
541
542    // - ScreenRef property storage -
543    void setScreenRefID(string id, int plateIndex, int screenRefIndex);
544
545    // - Shape property storage -
546    void setShapeBaselineShift(string baselineShift, int imageIndex, int roiIndex, int shapeIndex);
547    void setShapeDirection(string direction, int imageIndex, int roiIndex, int shapeIndex);
548    void setShapeFillColor(string fillColor, int imageIndex, int roiIndex, int shapeIndex);
549    void setShapeFillOpacity(string fillOpacity, int imageIndex, int roiIndex, int shapeIndex);
550    void setShapeFillRule(string fillRule, int imageIndex, int roiIndex, int shapeIndex);
551    void setShapeFontFamily(string fontFamily, int imageIndex, int roiIndex, int shapeIndex);
552    void setShapeFontSize(int fontSize, int imageIndex, int roiIndex, int shapeIndex);
553    void setShapeFontStretch(string fontStretch, int imageIndex, int roiIndex, int shapeIndex);
554    void setShapeFontStyle(string fontStyle, int imageIndex, int roiIndex, int shapeIndex);
555    void setShapeFontVariant(string fontVariant, int imageIndex, int roiIndex, int shapeIndex);
556    void setShapeFontWeight(string fontWeight, int imageIndex, int roiIndex, int shapeIndex);
557    void setShapeG(string g, int imageIndex, int roiIndex, int shapeIndex);
558    void setShapeGlyphOrientationVertical(int glyphOrientationVertical, int imageIndex, int roiIndex, int shapeIndex);
559    void setShapeID(string id, int imageIndex, int roiIndex, int shapeIndex);
560    void setShapeLocked(bool locked, int imageIndex, int roiIndex, int shapeIndex);
561    void setShapeStrokeAttribute(string strokeAttribute, int imageIndex, int roiIndex, int shapeIndex);
562    void setShapeStrokeColor(string strokeColor, int imageIndex, int roiIndex, int shapeIndex);
563    void setShapeStrokeDashArray(string strokeDashArray, int imageIndex, int roiIndex, int shapeIndex);
564    void setShapeStrokeLineCap(string strokeLineCap, int imageIndex, int roiIndex, int shapeIndex);
565    void setShapeStrokeLineJoin(string strokeLineJoin, int imageIndex, int roiIndex, int shapeIndex);
566    void setShapeStrokeMiterLimit(int strokeMiterLimit, int imageIndex, int roiIndex, int shapeIndex);
567    void setShapeStrokeOpacity(float strokeOpacity, int imageIndex, int roiIndex, int shapeIndex);
568    void setShapeStrokeWidth(int strokeWidth, int imageIndex, int roiIndex, int shapeIndex);
569    void setShapeText(string text, int imageIndex, int roiIndex, int shapeIndex);
570    void setShapeTextAnchor(string textAnchor, int imageIndex, int roiIndex, int shapeIndex);
571    void setShapeTextDecoration(string textDecoration, int imageIndex, int roiIndex, int shapeIndex);
572    void setShapeTextFill(string textFill, int imageIndex, int roiIndex, int shapeIndex);
573    void setShapeTextStroke(string textStroke, int imageIndex, int roiIndex, int shapeIndex);
574    void setShapeTheT(int theT, int imageIndex, int roiIndex, int shapeIndex);
575    void setShapeTheZ(int theZ, int imageIndex, int roiIndex, int shapeIndex);
576    void setShapeVectorEffect(string vectorEffect, int imageIndex, int roiIndex, int shapeIndex);
577    void setShapeVisibility(bool visibility, int imageIndex, int roiIndex, int shapeIndex);
578    void setShapeWritingMode(string writingMode, int imageIndex, int roiIndex, int shapeIndex);
579
580    // - StageLabel property storage -
581    void setStageLabelName(string name, int imageIndex);
582    void setStageLabelX(float x, int imageIndex);
583    void setStageLabelY(float y, int imageIndex);
584    void setStageLabelZ(float z, int imageIndex);
585
586    // - StagePosition property storage -
587    void setStagePositionPositionX(float positionX, int imageIndex, int pixelsIndex, int planeIndex);
588    void setStagePositionPositionY(float positionY, int imageIndex, int pixelsIndex, int planeIndex);
589    void setStagePositionPositionZ(float positionZ, int imageIndex, int pixelsIndex, int planeIndex);
590
591    // - Thumbnail property storage -
592    void setThumbnailHref(string href, int imageIndex);
593    void setThumbnailID(string id, int imageIndex);
594    void setThumbnailMIMEtype(string mimEtype, int imageIndex);
595
596    // - TiffData property storage -
597    void setTiffDataFileName(string fileName, int imageIndex, int pixelsIndex, int tiffDataIndex);
598    void setTiffDataFirstC(int firstC, int imageIndex, int pixelsIndex, int tiffDataIndex);
599    void setTiffDataFirstT(int firstT, int imageIndex, int pixelsIndex, int tiffDataIndex);
600    void setTiffDataFirstZ(int firstZ, int imageIndex, int pixelsIndex, int tiffDataIndex);
601    void setTiffDataIFD(int ifd, int imageIndex, int pixelsIndex, int tiffDataIndex);
602    void setTiffDataNumPlanes(int numPlanes, int imageIndex, int pixelsIndex, int tiffDataIndex);
603    void setTiffDataUUID(string uuid, int imageIndex, int pixelsIndex, int tiffDataIndex);
604
605    // - TransmittanceRange property storage -
606    void setTransmittanceRangeCutIn(int cutIn, int instrumentIndex, int filterIndex);
607    void setTransmittanceRangeCutInTolerance(int cutInTolerance, int instrumentIndex, int filterIndex);
608    void setTransmittanceRangeCutOut(int cutOut, int instrumentIndex, int filterIndex);
609    void setTransmittanceRangeCutOutTolerance(int cutOutTolerance, int instrumentIndex, int filterIndex);
610    void setTransmittanceRangeTransmittance(int transmittance, int instrumentIndex, int filterIndex);
611
612    // - Well property storage -
613    void setWellColumn(int column, int plateIndex, int wellIndex);
614    void setWellExternalDescription(string externalDescription, int plateIndex, int wellIndex);
615    void setWellExternalIdentifier(string externalIdentifier, int plateIndex, int wellIndex);
616    void setWellID(string id, int plateIndex, int wellIndex);
617    void setWellReagent(string reagent, int plateIndex, int wellIndex);
618    void setWellRow(int row, int plateIndex, int wellIndex);
619    void setWellType(string type, int plateIndex, int wellIndex);
620
621    // - WellSample property storage -
622    void setWellSampleID(string id, int plateIndex, int wellIndex, int wellSampleIndex);
623    void setWellSampleImageRef(string imageRef, int plateIndex, int wellIndex, int wellSampleIndex);
624    void setWellSampleIndex(int index, int plateIndex, int wellIndex, int wellSampleIndex);
625    void setWellSamplePosX(float posX, int plateIndex, int wellIndex, int wellSampleIndex);
626    void setWellSamplePosY(float posY, int plateIndex, int wellIndex, int wellSampleIndex);
627    void setWellSampleTimepoint(int timepoint, int plateIndex, int wellIndex, int wellSampleIndex);
628
629    // - WellSampleRef property storage -
630    void setWellSampleRefID(string id, int screenIndex, int screenAcquisitionIndex, int wellSampleRefIndex);
631  };
632
633  interface MetadataRetrieve {
634    MetadataRetrieve getServant();
635    string getOMEXML();
636
637    // - Entity counting -
638
639    int getChannelComponentCount(int imageIndex, int logicalChannelIndex);
640    int getDatasetCount();
641    int getDatasetRefCount(int imageIndex);
642    int getDetectorCount(int instrumentIndex);
643    int getDichroicCount(int instrumentIndex);
644    int getExperimentCount();
645    int getExperimenterCount();
646    int getExperimenterMembershipCount(int experimenterIndex);
647    int getFilterCount(int instrumentIndex);
648    int getFilterSetCount(int instrumentIndex);
649    int getGroupCount();
650    int getGroupRefCount(int experimenterIndex);
651    int getImageCount();
652    int getInstrumentCount();
653    int getLightSourceCount(int instrumentIndex);
654    int getLightSourceRefCount(int imageIndex, int microbeamManipulationIndex);
655    int getLogicalChannelCount(int imageIndex);
656    int getMicrobeamManipulationCount(int imageIndex);
657    int getMicrobeamManipulationRefCount(int experimentIndex);
658    int getOTFCount(int instrumentIndex);
659    int getObjectiveCount(int instrumentIndex);
660    int getPixelsCount(int imageIndex);
661    int getPlaneCount(int imageIndex, int pixelsIndex);
662    int getPlateCount();
663    int getPlateRefCount(int screenIndex);
664    int getProjectCount();
665    int getProjectRefCount(int datasetIndex);
666    int getROICount(int imageIndex);
667    int getROIRefCount(int imageIndex, int microbeamManipulationIndex);
668    int getReagentCount(int screenIndex);
669    int getRegionCount(int imageIndex);
670    int getRoiLinkCount(int imageIndex, int roiIndex);
671    int getScreenCount();
672    int getScreenAcquisitionCount(int screenIndex);
673    int getScreenRefCount(int plateIndex);
674    int getShapeCount(int imageIndex, int roiIndex);
675    int getTiffDataCount(int imageIndex, int pixelsIndex);
676    int getWellCount(int plateIndex);
677    int getWellSampleCount(int plateIndex, int wellIndex);
678    int getWellSampleRefCount(int screenIndex, int screenAcquisitionIndex);
679
680    // - Entity retrieval -
681
682    string getUUID();
683
684    // - Arc property retrieval -
685
686    string getArcType(int instrumentIndex, int lightSourceIndex);
687
688    // - ChannelComponent property retrieval -
689
690    string getChannelComponentColorDomain(int imageIndex, int logicalChannelIndex, int channelComponentIndex);
691    int getChannelComponentIndex(int imageIndex, int logicalChannelIndex, int channelComponentIndex);
692    string getChannelComponentPixels(int imageIndex, int logicalChannelIndex, int channelComponentIndex);
693
694    // - Circle property retrieval -
695
696    string getCircleCx(int imageIndex, int roiIndex, int shapeIndex);
697    string getCircleCy(int imageIndex, int roiIndex, int shapeIndex);
698    string getCircleID(int imageIndex, int roiIndex, int shapeIndex);
699    string getCircleR(int imageIndex, int roiIndex, int shapeIndex);
700    string getCircleTransform(int imageIndex, int roiIndex, int shapeIndex);
701
702    // - Contact property retrieval -
703
704    string getContactExperimenter(int groupIndex);
705
706    // - Dataset property retrieval -
707
708    string getDatasetDescription(int datasetIndex);
709    string getDatasetExperimenterRef(int datasetIndex);
710    string getDatasetGroupRef(int datasetIndex);
711    string getDatasetID(int datasetIndex);
712    bool getDatasetLocked(int datasetIndex);
713    string getDatasetName(int datasetIndex);
714
715    // - DatasetRef property retrieval -
716
717    string getDatasetRefID(int imageIndex, int datasetRefIndex);
718
719    // - Detector property retrieval -
720
721    float getDetectorAmplificationGain(int instrumentIndex, int detectorIndex);
722    float getDetectorGain(int instrumentIndex, int detectorIndex);
723    string getDetectorID(int instrumentIndex, int detectorIndex);
724    string getDetectorManufacturer(int instrumentIndex, int detectorIndex);
725    string getDetectorModel(int instrumentIndex, int detectorIndex);
726    float getDetectorOffset(int instrumentIndex, int detectorIndex);
727    string getDetectorSerialNumber(int instrumentIndex, int detectorIndex);
728    string getDetectorType(int instrumentIndex, int detectorIndex);
729    float getDetectorVoltage(int instrumentIndex, int detectorIndex);
730    float getDetectorZoom(int instrumentIndex, int detectorIndex);
731
732    // - DetectorSettings property retrieval -
733
734    string getDetectorSettingsBinning(int imageIndex, int logicalChannelIndex);
735    string getDetectorSettingsDetector(int imageIndex, int logicalChannelIndex);
736    float getDetectorSettingsGain(int imageIndex, int logicalChannelIndex);
737    float getDetectorSettingsOffset(int imageIndex, int logicalChannelIndex);
738    float getDetectorSettingsReadOutRate(int imageIndex, int logicalChannelIndex);
739    float getDetectorSettingsVoltage(int imageIndex, int logicalChannelIndex);
740
741    // - Dichroic property retrieval -
742
743    string getDichroicID(int instrumentIndex, int dichroicIndex);
744    string getDichroicLotNumber(int instrumentIndex, int dichroicIndex);
745    string getDichroicManufacturer(int instrumentIndex, int dichroicIndex);
746    string getDichroicModel(int instrumentIndex, int dichroicIndex);
747
748    // - Dimensions property retrieval -
749
750    float getDimensionsPhysicalSizeX(int imageIndex, int pixelsIndex);
751    float getDimensionsPhysicalSizeY(int imageIndex, int pixelsIndex);
752    float getDimensionsPhysicalSizeZ(int imageIndex, int pixelsIndex);
753    float getDimensionsTimeIncrement(int imageIndex, int pixelsIndex);
754    int getDimensionsWaveIncrement(int imageIndex, int pixelsIndex);
755    int getDimensionsWaveStart(int imageIndex, int pixelsIndex);
756
757    // - DisplayOptions property retrieval -
758
759    string getDisplayOptionsDisplay(int imageIndex);
760    string getDisplayOptionsID(int imageIndex);
761    float getDisplayOptionsZoom(int imageIndex);
762
763    // - Ellipse property retrieval -
764
765    string getEllipseCx(int imageIndex, int roiIndex, int shapeIndex);
766    string getEllipseCy(int imageIndex, int roiIndex, int shapeIndex);
767    string getEllipseID(int imageIndex, int roiIndex, int shapeIndex);
768    string getEllipseRx(int imageIndex, int roiIndex, int shapeIndex);
769    string getEllipseRy(int imageIndex, int roiIndex, int shapeIndex);
770    string getEllipseTransform(int imageIndex, int roiIndex, int shapeIndex);
771
772    // - EmFilter property retrieval -
773
774    string getEmFilterLotNumber(int instrumentIndex, int filterIndex);
775    string getEmFilterManufacturer(int instrumentIndex, int filterIndex);
776    string getEmFilterModel(int instrumentIndex, int filterIndex);
777    string getEmFilterType(int instrumentIndex, int filterIndex);
778
779    // - ExFilter property retrieval -
780
781    string getExFilterLotNumber(int instrumentIndex, int filterIndex);
782    string getExFilterManufacturer(int instrumentIndex, int filterIndex);
783    string getExFilterModel(int instrumentIndex, int filterIndex);
784    string getExFilterType(int instrumentIndex, int filterIndex);
785
786    // - Experiment property retrieval -
787
788    string getExperimentDescription(int experimentIndex);
789    string getExperimentExperimenterRef(int experimentIndex);
790    string getExperimentID(int experimentIndex);
791    string getExperimentType(int experimentIndex);
792
793    // - Experimenter property retrieval -
794
795    string getExperimenterEmail(int experimenterIndex);
796    string getExperimenterFirstName(int experimenterIndex);
797    string getExperimenterID(int experimenterIndex);
798    string getExperimenterInstitution(int experimenterIndex);
799    string getExperimenterLastName(int experimenterIndex);
800    string getExperimenterOMEName(int experimenterIndex);
801
802    // - ExperimenterMembership property retrieval -
803
804    string getExperimenterMembershipGroup(int experimenterIndex, int groupRefIndex);
805
806    // - Filament property retrieval -
807
808    string getFilamentType(int instrumentIndex, int lightSourceIndex);
809
810    // - Filter property retrieval -
811
812    string getFilterFilterWheel(int instrumentIndex, int filterIndex);
813    string getFilterID(int instrumentIndex, int filterIndex);
814    string getFilterLotNumber(int instrumentIndex, int filterIndex);
815    string getFilterManufacturer(int instrumentIndex, int filterIndex);
816    string getFilterModel(int instrumentIndex, int filterIndex);
817    string getFilterType(int instrumentIndex, int filterIndex);
818
819    // - FilterSet property retrieval -
820
821    string getFilterSetDichroic(int instrumentIndex, int filterSetIndex);
822    string getFilterSetEmFilter(int instrumentIndex, int filterSetIndex);
823    string getFilterSetExFilter(int instrumentIndex, int filterSetIndex);
824    string getFilterSetID(int instrumentIndex, int filterSetIndex);
825    string getFilterSetLotNumber(int instrumentIndex, int filterSetIndex);
826    string getFilterSetManufacturer(int instrumentIndex, int filterSetIndex);
827    string getFilterSetModel(int instrumentIndex, int filterSetIndex);
828
829    // - Group property retrieval -
830
831    string getGroupID(int groupIndex);
832    string getGroupName(int groupIndex);
833
834    // - GroupRef property retrieval -
835
836
837    // - Image property retrieval -
838
839    string getImageAcquiredPixels(int imageIndex);
840    string getImageCreationDate(int imageIndex);
841    string getImageDefaultPixels(int imageIndex);
842    string getImageDescription(int imageIndex);
843    string getImageExperimentRef(int imageIndex);
844    string getImageExperimenterRef(int imageIndex);
845    string getImageGroupRef(int imageIndex);
846    string getImageID(int imageIndex);
847    string getImageInstrumentRef(int imageIndex);
848    string getImageName(int imageIndex);
849
850    // - ImagingEnvironment property retrieval -
851
852    float getImagingEnvironmentAirPressure(int imageIndex);
853    float getImagingEnvironmentCO2Percent(int imageIndex);
854    float getImagingEnvironmentHumidity(int imageIndex);
855    float getImagingEnvironmentTemperature(int imageIndex);
856
857    // - Instrument property retrieval -
858
859    string getInstrumentID(int instrumentIndex);
860
861    // - Laser property retrieval -
862
863    int getLaserFrequencyMultiplication(int instrumentIndex, int lightSourceIndex);
864    string getLaserLaserMedium(int instrumentIndex, int lightSourceIndex);
865    bool getLaserPockelCell(int instrumentIndex, int lightSourceIndex);
866    string getLaserPulse(int instrumentIndex, int lightSourceIndex);
867    bool getLaserRepetitionRate(int instrumentIndex, int lightSourceIndex);
868    bool getLaserTuneable(int instrumentIndex, int lightSourceIndex);
869    string getLaserType(int instrumentIndex, int lightSourceIndex);
870    int getLaserWavelength(int instrumentIndex, int lightSourceIndex);
871
872    // - LightSource property retrieval -
873
874    string getLightSourceID(int instrumentIndex, int lightSourceIndex);
875    string getLightSourceManufacturer(int instrumentIndex, int lightSourceIndex);
876    string getLightSourceModel(int instrumentIndex, int lightSourceIndex);
877    float getLightSourcePower(int instrumentIndex, int lightSourceIndex);
878    string getLightSourceSerialNumber(int instrumentIndex, int lightSourceIndex);
879
880    // - LightSourceRef property retrieval -
881
882    float getLightSourceRefAttenuation(int imageIndex, int microbeamManipulationIndex, int lightSourceRefIndex);
883    string getLightSourceRefLightSource(int imageIndex, int microbeamManipulationIndex, int lightSourceRefIndex);
884    int getLightSourceRefWavelength(int imageIndex, int microbeamManipulationIndex, int lightSourceRefIndex);
885
886    // - LightSourceSettings property retrieval -
887
888    float getLightSourceSettingsAttenuation(int imageIndex, int logicalChannelIndex);
889    string getLightSourceSettingsLightSource(int imageIndex, int logicalChannelIndex);
890    int getLightSourceSettingsWavelength(int imageIndex, int logicalChannelIndex);
891
892    // - Line property retrieval -
893
894    string getLineID(int imageIndex, int roiIndex, int shapeIndex);
895    string getLineTransform(int imageIndex, int roiIndex, int shapeIndex);
896    string getLineX1(int imageIndex, int roiIndex, int shapeIndex);
897    string getLineX2(int imageIndex, int roiIndex, int shapeIndex);
898    string getLineY1(int imageIndex, int roiIndex, int shapeIndex);
899    string getLineY2(int imageIndex, int roiIndex, int shapeIndex);
900
901    // - LogicalChannel property retrieval -
902
903    string getLogicalChannelContrastMethod(int imageIndex, int logicalChannelIndex);
904    string getLogicalChannelDetector(int imageIndex, int logicalChannelIndex);
905    int getLogicalChannelEmWave(int imageIndex, int logicalChannelIndex);
906    int getLogicalChannelExWave(int imageIndex, int logicalChannelIndex);
907    string getLogicalChannelFilterSet(int imageIndex, int logicalChannelIndex);
908    string getLogicalChannelFluor(int imageIndex, int logicalChannelIndex);
909    string getLogicalChannelID(int imageIndex, int logicalChannelIndex);
910    string getLogicalChannelIlluminationType(int imageIndex, int logicalChannelIndex);
911    string getLogicalChannelLightSource(int imageIndex, int logicalChannelIndex);
912    string getLogicalChannelMode(int imageIndex, int logicalChannelIndex);
913    string getLogicalChannelName(int imageIndex, int logicalChannelIndex);
914    float getLogicalChannelNdFilter(int imageIndex, int logicalChannelIndex);
915    string getLogicalChannelOTF(int imageIndex, int logicalChannelIndex);
916    string getLogicalChannelPhotometricInterpretation(int imageIndex, int logicalChannelIndex);
917    float getLogicalChannelPinholeSize(int imageIndex, int logicalChannelIndex);
918    int getLogicalChannelPockelCellSetting(int imageIndex, int logicalChannelIndex);
919    int getLogicalChannelSamplesPerPixel(int imageIndex, int logicalChannelIndex);
920    string getLogicalChannelSecondaryEmissionFilter(int imageIndex, int logicalChannelIndex);
921    string getLogicalChannelSecondaryExcitationFilter(int imageIndex, int logicalChannelIndex);
922
923    // - Mask property retrieval -
924
925    string getMaskHeight(int imageIndex, int roiIndex, int shapeIndex);
926    string getMaskID(int imageIndex, int roiIndex, int shapeIndex);
927    string getMaskTransform(int imageIndex, int roiIndex, int shapeIndex);
928    string getMaskWidth(int imageIndex, int roiIndex, int shapeIndex);
929    string getMaskX(int imageIndex, int roiIndex, int shapeIndex);
930    string getMaskY(int imageIndex, int roiIndex, int shapeIndex);
931
932    // - MaskPixels property retrieval -
933
934    bool getMaskPixelsBigEndian(int imageIndex, int roiIndex, int shapeIndex);
935    string getMaskPixelsBinData(int imageIndex, int roiIndex, int shapeIndex);
936    string getMaskPixelsExtendedPixelType(int imageIndex, int roiIndex, int shapeIndex);
937    string getMaskPixelsID(int imageIndex, int roiIndex, int shapeIndex);
938    int getMaskPixelsSizeX(int imageIndex, int roiIndex, int shapeIndex);
939    int getMaskPixelsSizeY(int imageIndex, int roiIndex, int shapeIndex);
940
941    // - MicrobeamManipulation property retrieval -
942
943    string getMicrobeamManipulationExperimenterRef(int imageIndex, int microbeamManipulationIndex);
944    string getMicrobeamManipulationID(int imageIndex, int microbeamManipulationIndex);
945    string getMicrobeamManipulationType(int imageIndex, int microbeamManipulationIndex);
946
947    // - MicrobeamManipulationRef property retrieval -
948
949    string getMicrobeamManipulationRefID(int experimentIndex, int microbeamManipulationRefIndex);
950
951    // - Microscope property retrieval -
952
953    string getMicroscopeID(int instrumentIndex);
954    string getMicroscopeManufacturer(int instrumentIndex);
955    string getMicroscopeModel(int instrumentIndex);
956    string getMicroscopeSerialNumber(int instrumentIndex);
957    string getMicroscopeType(int instrumentIndex);
958
959    // - OTF property retrieval -
960
961    string getOTFBinaryFile(int instrumentIndex, int otfIndex);
962    string getOTFID(int instrumentIndex, int otfIndex);
963    string getOTFObjective(int instrumentIndex, int otfIndex);
964    bool getOTFOpticalAxisAveraged(int instrumentIndex, int otfIndex);
965    string getOTFPixelType(int instrumentIndex, int otfIndex);
966    int getOTFSizeX(int instrumentIndex, int otfIndex);
967    int getOTFSizeY(int instrumentIndex, int otfIndex);
968
969    // - Objective property retrieval -
970
971    float getObjectiveCalibratedMagnification(int instrumentIndex, int objectiveIndex);
972    string getObjectiveCorrection(int instrumentIndex, int objectiveIndex);
973    string getObjectiveID(int instrumentIndex, int objectiveIndex);
974    string getObjectiveImmersion(int instrumentIndex, int objectiveIndex);
975    bool getObjectiveIris(int instrumentIndex, int objectiveIndex);
976    float getObjectiveLensNA(int instrumentIndex, int objectiveIndex);
977    string getObjectiveManufacturer(int instrumentIndex, int objectiveIndex);
978    string getObjectiveModel(int instrumentIndex, int objectiveIndex);
979    int getObjectiveNominalMagnification(int instrumentIndex, int objectiveIndex);
980    string getObjectiveSerialNumber(int instrumentIndex, int objectiveIndex);
981    float getObjectiveWorkingDistance(int instrumentIndex, int objectiveIndex);
982
983    // - ObjectiveSettings property retrieval -
984
985    float getObjectiveSettingsCorrectionCollar(int imageIndex);
986    string getObjectiveSettingsMedium(int imageIndex);
987    string getObjectiveSettingsObjective(int imageIndex);
988    float getObjectiveSettingsRefractiveIndex(int imageIndex);
989
990    // - Path property retrieval -
991
992    string getPathD(int imageIndex, int roiIndex, int shapeIndex);
993    string getPathID(int imageIndex, int roiIndex, int shapeIndex);
994
995    // - Pixels property retrieval -
996
997    bool getPixelsBigEndian(int imageIndex, int pixelsIndex);
998    string getPixelsDimensionOrder(int imageIndex, int pixelsIndex);
999    string getPixelsID(int imageIndex, int pixelsIndex);
1000    string getPixelsPixelType(int imageIndex, int pixelsIndex);
1001    int getPixelsSizeC(int imageIndex, int pixelsIndex);
1002    int getPixelsSizeT(int imageIndex, int pixelsIndex);
1003    int getPixelsSizeX(int imageIndex, int pixelsIndex);
1004    int getPixelsSizeY(int imageIndex, int pixelsIndex);
1005    int getPixelsSizeZ(int imageIndex, int pixelsIndex);
1006
1007    // - Plane property retrieval -
1008
1009    string getPlaneHashSHA1(int imageIndex, int pixelsIndex, int planeIndex);
1010    string getPlaneID(int imageIndex, int pixelsIndex, int planeIndex);
1011    int getPlaneTheC(int imageIndex, int pixelsIndex, int planeIndex);
1012    int getPlaneTheT(int imageIndex, int pixelsIndex, int planeIndex);
1013    int getPlaneTheZ(int imageIndex, int pixelsIndex, int planeIndex);
1014
1015    // - PlaneTiming property retrieval -
1016
1017    float getPlaneTimingDeltaT(int imageIndex, int pixelsIndex, int planeIndex);
1018    float getPlaneTimingExposureTime(int imageIndex, int pixelsIndex, int planeIndex);
1019
1020    // - Plate property retrieval -
1021
1022    string getPlateColumnNamingConvention(int plateIndex);
1023    string getPlateDescription(int plateIndex);
1024    string getPlateExternalIdentifier(int plateIndex);
1025    string getPlateID(int plateIndex);
1026    string getPlateName(int plateIndex);
1027    string getPlateRowNamingConvention(int plateIndex);
1028    string getPlateStatus(int plateIndex);
1029    double getPlateWellOriginX(int plateIndex);
1030    double getPlateWellOriginY(int plateIndex);
1031
1032    // - PlateRef property retrieval -
1033
1034    string getPlateRefID(int screenIndex, int plateRefIndex);
1035    int getPlateRefSample(int screenIndex, int plateRefIndex);
1036    string getPlateRefWell(int screenIndex, int plateRefIndex);
1037
1038    // - Point property retrieval -
1039
1040    string getPointCx(int imageIndex, int roiIndex, int shapeIndex);
1041    string getPointCy(int imageIndex, int roiIndex, int shapeIndex);
1042    string getPointID(int imageIndex, int roiIndex, int shapeIndex);
1043    string getPointR(int imageIndex, int roiIndex, int shapeIndex);
1044    string getPointTransform(int imageIndex, int roiIndex, int shapeIndex);
1045
1046    // - Polygon property retrieval -
1047
1048    string getPolygonID(int imageIndex, int roiIndex, int shapeIndex);
1049    string getPolygonPoints(int imageIndex, int roiIndex, int shapeIndex);
1050    string getPolygonTransform(int imageIndex, int roiIndex, int shapeIndex);
1051
1052    // - Polyline property retrieval -
1053
1054    string getPolylineID(int imageIndex, int roiIndex, int shapeIndex);
1055    string getPolylinePoints(int imageIndex, int roiIndex, int shapeIndex);
1056    string getPolylineTransform(int imageIndex, int roiIndex, int shapeIndex);
1057
1058    // - Project property retrieval -
1059
1060    string getProjectDescription(int projectIndex);
1061    string getProjectExperimenterRef(int projectIndex);
1062    string getProjectGroupRef(int projectIndex);
1063    string getProjectID(int projectIndex);
1064    string getProjectName(int projectIndex);
1065
1066    // - ProjectRef property retrieval -
1067
1068    string getProjectRefID(int datasetIndex, int projectRefIndex);
1069
1070    // - Pump property retrieval -
1071
1072    string getPumpLightSource(int instrumentIndex, int lightSourceIndex);
1073
1074    // - ROI property retrieval -
1075
1076    string getROIID(int imageIndex, int roiIndex);
1077    int getROIT0(int imageIndex, int roiIndex);
1078    int getROIT1(int imageIndex, int roiIndex);
1079    int getROIX0(int imageIndex, int roiIndex);
1080    int getROIX1(int imageIndex, int roiIndex);
1081    int getROIY0(int imageIndex, int roiIndex);
1082    int getROIY1(int imageIndex, int roiIndex);
1083    int getROIZ0(int imageIndex, int roiIndex);
1084    int getROIZ1(int imageIndex, int roiIndex);
1085
1086    // - ROIRef property retrieval -
1087
1088    string getROIRefID(int imageIndex, int microbeamManipulationIndex, int roiRefIndex);
1089
1090    // - Reagent property retrieval -
1091
1092    string getReagentDescription(int screenIndex, int reagentIndex);
1093    string getReagentID(int screenIndex, int reagentIndex);
1094    string getReagentName(int screenIndex, int reagentIndex);
1095    string getReagentReagentIdentifier(int screenIndex, int reagentIndex);
1096
1097    // - Rect property retrieval -
1098
1099    string getRectHeight(int imageIndex, int roiIndex, int shapeIndex);
1100    string getRectID(int imageIndex, int roiIndex, int shapeIndex);
1101    string getRectTransform(int imageIndex, int roiIndex, int shapeIndex);
1102    string getRectWidth(int imageIndex, int roiIndex, int shapeIndex);
1103    string getRectX(int imageIndex, int roiIndex, int shapeIndex);
1104    string getRectY(int imageIndex, int roiIndex, int shapeIndex);
1105
1106    // - Region property retrieval -
1107
1108    string getRegionID(int imageIndex, int regionIndex);
1109    string getRegionName(int imageIndex, int regionIndex);
1110    string getRegionTag(int imageIndex, int regionIndex);
1111
1112    // - RoiLink property retrieval -
1113
1114    string getRoiLinkDirection(int imageIndex, int roiIndex, int roiLinkIndex);
1115    string getRoiLinkName(int imageIndex, int roiIndex, int roiLinkIndex);
1116    string getRoiLinkRef(int imageIndex, int roiIndex, int roiLinkIndex);
1117
1118    // - Screen property retrieval -
1119
1120    string getScreenDescription(int screenIndex);
1121    string getScreenExtern(int screenIndex);
1122    string getScreenID(int screenIndex);
1123    string getScreenName(int screenIndex);
1124    string getScreenProtocolDescription(int screenIndex);
1125    string getScreenProtocolIdentifier(int screenIndex);
1126    string getScreenReagentSetDescription(int screenIndex);
1127    string getScreenReagentSetIdentifier(int screenIndex);
1128    string getScreenType(int screenIndex);
1129
1130    // - ScreenAcquisition property retrieval -
1131
1132    string getScreenAcquisitionEndTime(int screenIndex, int screenAcquisitionIndex);
1133    string getScreenAcquisitionID(int screenIndex, int screenAcquisitionIndex);
1134    string getScreenAcquisitionStartTime(int screenIndex, int screenAcquisitionIndex);
1135
1136    // - ScreenRef property retrieval -
1137
1138    string getScreenRefID(int plateIndex, int screenRefIndex);
1139
1140    // - Shape property retrieval -
1141
1142    string getShapeBaselineShift(int imageIndex, int roiIndex, int shapeIndex);
1143    string getShapeDirection(int imageIndex, int roiIndex, int shapeIndex);
1144    string getShapeFillColor(int imageIndex, int roiIndex, int shapeIndex);
1145    string getShapeFillOpacity(int imageIndex, int roiIndex, int shapeIndex);
1146    string getShapeFillRule(int imageIndex, int roiIndex, int shapeIndex);
1147    string getShapeFontFamily(int imageIndex, int roiIndex, int shapeIndex);
1148    int getShapeFontSize(int imageIndex, int roiIndex, int shapeIndex);
1149    string getShapeFontStretch(int imageIndex, int roiIndex, int shapeIndex);
1150    string getShapeFontStyle(int imageIndex, int roiIndex, int shapeIndex);
1151    string getShapeFontVariant(int imageIndex, int roiIndex, int shapeIndex);
1152    string getShapeFontWeight(int imageIndex, int roiIndex, int shapeIndex);
1153    string getShapeG(int imageIndex, int roiIndex, int shapeIndex);
1154    int getShapeGlyphOrientationVertical(int imageIndex, int roiIndex, int shapeIndex);
1155    string getShapeID(int imageIndex, int roiIndex, int shapeIndex);
1156    bool getShapeLocked(int imageIndex, int roiIndex, int shapeIndex);
1157    string getShapeStrokeAttribute(int imageIndex, int roiIndex, int shapeIndex);
1158    string getShapeStrokeColor(int imageIndex, int roiIndex, int shapeIndex);
1159    string getShapeStrokeDashArray(int imageIndex, int roiIndex, int shapeIndex);
1160    string getShapeStrokeLineCap(int imageIndex, int roiIndex, int shapeIndex);
1161    string getShapeStrokeLineJoin(int imageIndex, int roiIndex, int shapeIndex);
1162    int getShapeStrokeMiterLimit(int imageIndex, int roiIndex, int shapeIndex);
1163    float getShapeStrokeOpacity(int imageIndex, int roiIndex, int shapeIndex);
1164    int getShapeStrokeWidth(int imageIndex, int roiIndex, int shapeIndex);
1165    string getShapeText(int imageIndex, int roiIndex, int shapeIndex);
1166    string getShapeTextAnchor(int imageIndex, int roiIndex, int shapeIndex);
1167    string getShapeTextDecoration(int imageIndex, int roiIndex, int shapeIndex);
1168    string getShapeTextFill(int imageIndex, int roiIndex, int shapeIndex);
1169    string getShapeTextStroke(int imageIndex, int roiIndex, int shapeIndex);
1170    int getShapeTheT(int imageIndex, int roiIndex, int shapeIndex);
1171    int getShapeTheZ(int imageIndex, int roiIndex, int shapeIndex);
1172    string getShapeVectorEffect(int imageIndex, int roiIndex, int shapeIndex);
1173    bool getShapeVisibility(int imageIndex, int roiIndex, int shapeIndex);
1174    string getShapeWritingMode(int imageIndex, int roiIndex, int shapeIndex);
1175
1176    // - StageLabel property retrieval -
1177
1178    string getStageLabelName(int imageIndex);
1179    float getStageLabelX(int imageIndex);
1180    float getStageLabelY(int imageIndex);
1181    float getStageLabelZ(int imageIndex);
1182
1183    // - StagePosition property retrieval -
1184
1185    float getStagePositionPositionX(int imageIndex, int pixelsIndex, int planeIndex);
1186    float getStagePositionPositionY(int imageIndex, int pixelsIndex, int planeIndex);
1187    float getStagePositionPositionZ(int imageIndex, int pixelsIndex, int planeIndex);
1188
1189    // - Thumbnail property retrieval -
1190
1191    string getThumbnailHref(int imageIndex);
1192    string getThumbnailID(int imageIndex);
1193    string getThumbnailMIMEtype(int imageIndex);
1194
1195    // - TiffData property retrieval -
1196
1197    string getTiffDataFileName(int imageIndex, int pixelsIndex, int tiffDataIndex);
1198    int getTiffDataFirstC(int imageIndex, int pixelsIndex, int tiffDataIndex);
1199    int getTiffDataFirstT(int imageIndex, int pixelsIndex, int tiffDataIndex);
1200    int getTiffDataFirstZ(int imageIndex, int pixelsIndex, int tiffDataIndex);
1201    int getTiffDataIFD(int imageIndex, int pixelsIndex, int tiffDataIndex);
1202    int getTiffDataNumPlanes(int imageIndex, int pixelsIndex, int tiffDataIndex);
1203    string getTiffDataUUID(int imageIndex, int pixelsIndex, int tiffDataIndex);
1204
1205    // - TransmittanceRange property retrieval -
1206
1207    int getTransmittanceRangeCutIn(int instrumentIndex, int filterIndex);
1208    int getTransmittanceRangeCutInTolerance(int instrumentIndex, int filterIndex);
1209    int getTransmittanceRangeCutOut(int instrumentIndex, int filterIndex);
1210    int getTransmittanceRangeCutOutTolerance(int instrumentIndex, int filterIndex);
1211    int getTransmittanceRangeTransmittance(int instrumentIndex, int filterIndex);
1212
1213    // - Well property retrieval -
1214
1215    int getWellColumn(int plateIndex, int wellIndex);
1216    string getWellExternalDescription(int plateIndex, int wellIndex);
1217    string getWellExternalIdentifier(int plateIndex, int wellIndex);
1218    string getWellID(int plateIndex, int wellIndex);
1219    string getWellReagent(int plateIndex, int wellIndex);
1220    int getWellRow(int plateIndex, int wellIndex);
1221    string getWellType(int plateIndex, int wellIndex);
1222
1223    // - WellSample property retrieval -
1224
1225    string getWellSampleID(int plateIndex, int wellIndex, int wellSampleIndex);
1226    string getWellSampleImageRef(int plateIndex, int wellIndex, int wellSampleIndex);
1227    int getWellSampleIndex(int plateIndex, int wellIndex, int wellSampleIndex);
1228    float getWellSamplePosX(int plateIndex, int wellIndex, int wellSampleIndex);
1229    float getWellSamplePosY(int plateIndex, int wellIndex, int wellSampleIndex);
1230    int getWellSampleTimepoint(int plateIndex, int wellIndex, int wellSampleIndex);
1231
1232    // - WellSampleRef property retrieval -
1233
1234    string getWellSampleRefID(int screenIndex, int screenAcquisitionIndex, int wellSampleRefIndex);
1235  };
1236};
Note: See TracBrowser for help on using the repository browser.