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

Revision 4953, 31.4 KB checked in by melissa, 11 years ago (diff)

Switched licenses from GPL v3 or later to GPL v2 or later.

Line 
1//
2// bio-formats.ice
3//
4
5/*
6OME Bio-Formats package for reading and converting biological file formats.
7Copyright (C) 2005-@year@ 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 Oct 24, 2008 8:37:23 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
156    // - Detector property storage -
157    void setDetectorGain(float gain, int instrumentIndex, int detectorIndex);
158    void setDetectorID(string id, int instrumentIndex, int detectorIndex);
159    void setDetectorManufacturer(string manufacturer, int instrumentIndex, int detectorIndex);
160    void setDetectorModel(string model, int instrumentIndex, int detectorIndex);
161    void setDetectorOffset(float offset, int instrumentIndex, int detectorIndex);
162    void setDetectorSerialNumber(string serialNumber, int instrumentIndex, int detectorIndex);
163    void setDetectorType(string type, int instrumentIndex, int detectorIndex);
164    void setDetectorVoltage(float voltage, int instrumentIndex, int detectorIndex);
165
166    // - DetectorSettings property storage -
167    void setDetectorSettingsDetector(string detector, int imageIndex, int logicalChannelIndex);
168    void setDetectorSettingsGain(float gain, int imageIndex, int logicalChannelIndex);
169    void setDetectorSettingsOffset(float offset, int imageIndex, int logicalChannelIndex);
170
171    // - Dimensions property storage -
172    void setDimensionsPhysicalSizeX(float physicalSizeX, int imageIndex, int pixelsIndex);
173    void setDimensionsPhysicalSizeY(float physicalSizeY, int imageIndex, int pixelsIndex);
174    void setDimensionsPhysicalSizeZ(float physicalSizeZ, int imageIndex, int pixelsIndex);
175    void setDimensionsTimeIncrement(float timeIncrement, int imageIndex, int pixelsIndex);
176    void setDimensionsWaveIncrement(int waveIncrement, int imageIndex, int pixelsIndex);
177    void setDimensionsWaveStart(int waveStart, int imageIndex, int pixelsIndex);
178
179    // - DisplayOptions property storage -
180    void setDisplayOptionsID(string id, int imageIndex);
181    void setDisplayOptionsZoom(float zoom, int imageIndex);
182
183    // - DisplayOptionsProjection property storage -
184    void setDisplayOptionsProjectionZStart(int zStart, int imageIndex);
185    void setDisplayOptionsProjectionZStop(int zStop, int imageIndex);
186
187    // - DisplayOptionsTime property storage -
188    void setDisplayOptionsTimeTStart(int tStart, int imageIndex);
189    void setDisplayOptionsTimeTStop(int tStop, int imageIndex);
190
191    // - Experiment property storage -
192    void setExperimentDescription(string description, int experimentIndex);
193    void setExperimentID(string id, int experimentIndex);
194    void setExperimentType(string type, int experimentIndex);
195
196    // - Experimenter property storage -
197    void setExperimenterEmail(string email, int experimenterIndex);
198    void setExperimenterFirstName(string firstName, int experimenterIndex);
199    void setExperimenterID(string id, int experimenterIndex);
200    void setExperimenterInstitution(string institution, int experimenterIndex);
201    void setExperimenterLastName(string lastName, int experimenterIndex);
202
203    // - ExperimenterMembership property storage -
204    void setExperimenterMembershipGroup(string group, int experimenterIndex, int groupRefIndex);
205
206    // - Filament property storage -
207    void setFilamentType(string type, int instrumentIndex, int lightSourceIndex);
208
209    // - GroupRef property storage -
210
211    // - Image property storage -
212    void setImageCreationDate(string creationDate, int imageIndex);
213    void setImageDefaultPixels(string defaultPixels, int imageIndex);
214    void setImageDescription(string description, int imageIndex);
215    void setImageID(string id, int imageIndex);
216    void setImageInstrumentRef(string instrumentRef, int imageIndex);
217    void setImageName(string name, int imageIndex);
218
219    // - ImagingEnvironment property storage -
220    void setImagingEnvironmentAirPressure(float airPressure, int imageIndex);
221    void setImagingEnvironmentCO2Percent(float cO2Percent, int imageIndex);
222    void setImagingEnvironmentHumidity(float humidity, int imageIndex);
223    void setImagingEnvironmentTemperature(float temperature, int imageIndex);
224
225    // - Instrument property storage -
226    void setInstrumentID(string id, int instrumentIndex);
227
228    // - Laser property storage -
229    void setLaserFrequencyMultiplication(int frequencyMultiplication, int instrumentIndex, int lightSourceIndex);
230    void setLaserLaserMedium(string laserMedium, int instrumentIndex, int lightSourceIndex);
231    void setLaserPulse(string pulse, int instrumentIndex, int lightSourceIndex);
232    void setLaserTuneable(bool tuneable, int instrumentIndex, int lightSourceIndex);
233    void setLaserType(string type, int instrumentIndex, int lightSourceIndex);
234    void setLaserWavelength(int wavelength, int instrumentIndex, int lightSourceIndex);
235
236    // - LightSource property storage -
237    void setLightSourceID(string id, int instrumentIndex, int lightSourceIndex);
238    void setLightSourceManufacturer(string manufacturer, int instrumentIndex, int lightSourceIndex);
239    void setLightSourceModel(string model, int instrumentIndex, int lightSourceIndex);
240    void setLightSourcePower(float power, int instrumentIndex, int lightSourceIndex);
241    void setLightSourceSerialNumber(string serialNumber, int instrumentIndex, int lightSourceIndex);
242
243    // - LightSourceSettings property storage -
244    void setLightSourceSettingsAttenuation(float attenuation, int imageIndex, int logicalChannelIndex);
245    void setLightSourceSettingsLightSource(string lightSource, int imageIndex, int logicalChannelIndex);
246    void setLightSourceSettingsWavelength(int wavelength, int imageIndex, int logicalChannelIndex);
247
248    // - LogicalChannel property storage -
249    void setLogicalChannelContrastMethod(string contrastMethod, int imageIndex, int logicalChannelIndex);
250    void setLogicalChannelEmWave(int emWave, int imageIndex, int logicalChannelIndex);
251    void setLogicalChannelExWave(int exWave, int imageIndex, int logicalChannelIndex);
252    void setLogicalChannelFluor(string fluor, int imageIndex, int logicalChannelIndex);
253    void setLogicalChannelID(string id, int imageIndex, int logicalChannelIndex);
254    void setLogicalChannelIlluminationType(string illuminationType, int imageIndex, int logicalChannelIndex);
255    void setLogicalChannelMode(string mode, int imageIndex, int logicalChannelIndex);
256    void setLogicalChannelName(string name, int imageIndex, int logicalChannelIndex);
257    void setLogicalChannelNdFilter(float ndFilter, int imageIndex, int logicalChannelIndex);
258    void setLogicalChannelOTF(string otf, int imageIndex, int logicalChannelIndex);
259    void setLogicalChannelPhotometricInterpretation(string photometricInterpretation, int imageIndex, int logicalChannelIndex);
260    void setLogicalChannelPinholeSize(float pinholeSize, int imageIndex, int logicalChannelIndex);
261    void setLogicalChannelPockelCellSetting(int pockelCellSetting, int imageIndex, int logicalChannelIndex);
262    void setLogicalChannelSamplesPerPixel(int samplesPerPixel, int imageIndex, int logicalChannelIndex);
263
264    // - OTF property storage -
265    void setOTFID(string id, int instrumentIndex, int otfIndex);
266    void setOTFObjective(string objective, int instrumentIndex, int otfIndex);
267    void setOTFOpticalAxisAveraged(bool opticalAxisAveraged, int instrumentIndex, int otfIndex);
268    void setOTFPixelType(string pixelType, int instrumentIndex, int otfIndex);
269    void setOTFSizeX(int sizeX, int instrumentIndex, int otfIndex);
270    void setOTFSizeY(int sizeY, int instrumentIndex, int otfIndex);
271
272    // - Objective property storage -
273    void setObjectiveCalibratedMagnification(float calibratedMagnification, int instrumentIndex, int objectiveIndex);
274    void setObjectiveCorrection(string correction, int instrumentIndex, int objectiveIndex);
275    void setObjectiveID(string id, int instrumentIndex, int objectiveIndex);
276    void setObjectiveImmersion(string immersion, int instrumentIndex, int objectiveIndex);
277    void setObjectiveLensNA(float lensNA, int instrumentIndex, int objectiveIndex);
278    void setObjectiveManufacturer(string manufacturer, int instrumentIndex, int objectiveIndex);
279    void setObjectiveModel(string model, int instrumentIndex, int objectiveIndex);
280    void setObjectiveNominalMagnification(int nominalMagnification, int instrumentIndex, int objectiveIndex);
281    void setObjectiveSerialNumber(string serialNumber, int instrumentIndex, int objectiveIndex);
282    void setObjectiveWorkingDistance(float workingDistance, int instrumentIndex, int objectiveIndex);
283
284    // - Pixels property storage -
285    void setPixelsBigEndian(bool bigEndian, int imageIndex, int pixelsIndex);
286    void setPixelsDimensionOrder(string dimensionOrder, int imageIndex, int pixelsIndex);
287    void setPixelsID(string id, int imageIndex, int pixelsIndex);
288    void setPixelsPixelType(string pixelType, int imageIndex, int pixelsIndex);
289    void setPixelsSizeC(int sizeC, int imageIndex, int pixelsIndex);
290    void setPixelsSizeT(int sizeT, int imageIndex, int pixelsIndex);
291    void setPixelsSizeX(int sizeX, int imageIndex, int pixelsIndex);
292    void setPixelsSizeY(int sizeY, int imageIndex, int pixelsIndex);
293    void setPixelsSizeZ(int sizeZ, int imageIndex, int pixelsIndex);
294
295    // - Plane property storage -
296    void setPlaneTheC(int theC, int imageIndex, int pixelsIndex, int planeIndex);
297    void setPlaneTheT(int theT, int imageIndex, int pixelsIndex, int planeIndex);
298    void setPlaneTheZ(int theZ, int imageIndex, int pixelsIndex, int planeIndex);
299
300    // - PlaneTiming property storage -
301    void setPlaneTimingDeltaT(float deltaT, int imageIndex, int pixelsIndex, int planeIndex);
302    void setPlaneTimingExposureTime(float exposureTime, int imageIndex, int pixelsIndex, int planeIndex);
303
304    // - Plate property storage -
305    void setPlateDescription(string description, int plateIndex);
306    void setPlateExternalIdentifier(string externalIdentifier, int plateIndex);
307    void setPlateID(string id, int plateIndex);
308    void setPlateName(string name, int plateIndex);
309    void setPlateStatus(string status, int plateIndex);
310
311    // - PlateRef property storage -
312    void setPlateRefID(string id, int screenIndex, int plateRefIndex);
313
314    // - ROI property storage -
315    void setROIID(string id, int imageIndex, int roiIndex);
316    void setROIT0(int t0, int imageIndex, int roiIndex);
317    void setROIT1(int t1, int imageIndex, int roiIndex);
318    void setROIX0(int x0, int imageIndex, int roiIndex);
319    void setROIX1(int x1, int imageIndex, int roiIndex);
320    void setROIY0(int y0, int imageIndex, int roiIndex);
321    void setROIY1(int y1, int imageIndex, int roiIndex);
322    void setROIZ0(int z0, int imageIndex, int roiIndex);
323    void setROIZ1(int z1, int imageIndex, int roiIndex);
324
325    // - Reagent property storage -
326    void setReagentDescription(string description, int screenIndex, int reagentIndex);
327    void setReagentID(string id, int screenIndex, int reagentIndex);
328    void setReagentName(string name, int screenIndex, int reagentIndex);
329    void setReagentReagentIdentifier(string reagentIdentifier, int screenIndex, int reagentIndex);
330
331    // - Screen property storage -
332    void setScreenID(string id, int screenIndex);
333    void setScreenName(string name, int screenIndex);
334    void setScreenProtocolDescription(string protocolDescription, int screenIndex);
335    void setScreenProtocolIdentifier(string protocolIdentifier, int screenIndex);
336    void setScreenReagentSetDescription(string reagentSetDescription, int screenIndex);
337    void setScreenType(string type, int screenIndex);
338
339    // - ScreenAcquisition property storage -
340    void setScreenAcquisitionEndTime(string endTime, int screenIndex, int screenAcquisitionIndex);
341    void setScreenAcquisitionID(string id, int screenIndex, int screenAcquisitionIndex);
342    void setScreenAcquisitionStartTime(string startTime, int screenIndex, int screenAcquisitionIndex);
343
344    // - StageLabel property storage -
345    void setStageLabelName(string name, int imageIndex);
346    void setStageLabelX(float x, int imageIndex);
347    void setStageLabelY(float y, int imageIndex);
348    void setStageLabelZ(float z, int imageIndex);
349
350    // - StagePosition property storage -
351    void setStagePositionPositionX(float positionX, int imageIndex, int pixelsIndex, int planeIndex);
352    void setStagePositionPositionY(float positionY, int imageIndex, int pixelsIndex, int planeIndex);
353    void setStagePositionPositionZ(float positionZ, int imageIndex, int pixelsIndex, int planeIndex);
354
355    // - TiffData property storage -
356    void setTiffDataFileName(string fileName, int imageIndex, int pixelsIndex, int tiffDataIndex);
357    void setTiffDataFirstC(int firstC, int imageIndex, int pixelsIndex, int tiffDataIndex);
358    void setTiffDataFirstT(int firstT, int imageIndex, int pixelsIndex, int tiffDataIndex);
359    void setTiffDataFirstZ(int firstZ, int imageIndex, int pixelsIndex, int tiffDataIndex);
360    void setTiffDataIFD(int ifd, int imageIndex, int pixelsIndex, int tiffDataIndex);
361    void setTiffDataNumPlanes(int numPlanes, int imageIndex, int pixelsIndex, int tiffDataIndex);
362    void setTiffDataUUID(string uuid, int imageIndex, int pixelsIndex, int tiffDataIndex);
363
364    // - Well property storage -
365    void setWellColumn(int column, int plateIndex, int wellIndex);
366    void setWellExternalDescription(string externalDescription, int plateIndex, int wellIndex);
367    void setWellExternalIdentifier(string externalIdentifier, int plateIndex, int wellIndex);
368    void setWellID(string id, int plateIndex, int wellIndex);
369    void setWellRow(int row, int plateIndex, int wellIndex);
370    void setWellType(string type, int plateIndex, int wellIndex);
371
372    // - WellSample property storage -
373    void setWellSampleID(string id, int plateIndex, int wellIndex, int wellSampleIndex);
374    void setWellSampleIndex(int index, int plateIndex, int wellIndex, int wellSampleIndex);
375    void setWellSamplePosX(float posX, int plateIndex, int wellIndex, int wellSampleIndex);
376    void setWellSamplePosY(float posY, int plateIndex, int wellIndex, int wellSampleIndex);
377    void setWellSampleTimepoint(int timepoint, int plateIndex, int wellIndex, int wellSampleIndex);
378  };
379
380  interface MetadataRetrieve {
381    MetadataRetrieve getServant();
382    string getOMEXML();
383
384    // - Entity counting -
385
386    int getChannelComponentCount(int imageIndex, int logicalChannelIndex);
387    int getDetectorCount(int instrumentIndex);
388    int getExperimentCount();
389    int getExperimenterCount();
390    int getExperimenterMembershipCount(int experimenterIndex);
391    int getGroupRefCount(int experimenterIndex);
392    int getImageCount();
393    int getInstrumentCount();
394    int getLightSourceCount(int instrumentIndex);
395    int getLogicalChannelCount(int imageIndex);
396    int getOTFCount(int instrumentIndex);
397    int getObjectiveCount(int instrumentIndex);
398    int getPixelsCount(int imageIndex);
399    int getPlaneCount(int imageIndex, int pixelsIndex);
400    int getPlateCount();
401    int getPlateRefCount(int screenIndex);
402    int getROICount(int imageIndex);
403    int getReagentCount(int screenIndex);
404    int getScreenCount();
405    int getScreenAcquisitionCount(int screenIndex);
406    int getTiffDataCount(int imageIndex, int pixelsIndex);
407    int getWellCount(int plateIndex);
408    int getWellSampleCount(int plateIndex, int wellIndex);
409
410    // - Entity retrieval -
411
412    string getUUID();
413
414    // - Arc property retrieval -
415
416    string getArcType(int instrumentIndex, int lightSourceIndex);
417
418    // - ChannelComponent property retrieval -
419
420    string getChannelComponentColorDomain(int imageIndex, int logicalChannelIndex, int channelComponentIndex);
421    int getChannelComponentIndex(int imageIndex, int logicalChannelIndex, int channelComponentIndex);
422
423    // - Detector property retrieval -
424
425    float getDetectorGain(int instrumentIndex, int detectorIndex);
426    string getDetectorID(int instrumentIndex, int detectorIndex);
427    string getDetectorManufacturer(int instrumentIndex, int detectorIndex);
428    string getDetectorModel(int instrumentIndex, int detectorIndex);
429    float getDetectorOffset(int instrumentIndex, int detectorIndex);
430    string getDetectorSerialNumber(int instrumentIndex, int detectorIndex);
431    string getDetectorType(int instrumentIndex, int detectorIndex);
432    float getDetectorVoltage(int instrumentIndex, int detectorIndex);
433
434    // - DetectorSettings property retrieval -
435
436    string getDetectorSettingsDetector(int imageIndex, int logicalChannelIndex);
437    float getDetectorSettingsGain(int imageIndex, int logicalChannelIndex);
438    float getDetectorSettingsOffset(int imageIndex, int logicalChannelIndex);
439
440    // - Dimensions property retrieval -
441
442    float getDimensionsPhysicalSizeX(int imageIndex, int pixelsIndex);
443    float getDimensionsPhysicalSizeY(int imageIndex, int pixelsIndex);
444    float getDimensionsPhysicalSizeZ(int imageIndex, int pixelsIndex);
445    float getDimensionsTimeIncrement(int imageIndex, int pixelsIndex);
446    int getDimensionsWaveIncrement(int imageIndex, int pixelsIndex);
447    int getDimensionsWaveStart(int imageIndex, int pixelsIndex);
448
449    // - DisplayOptions property retrieval -
450
451    string getDisplayOptionsID(int imageIndex);
452    float getDisplayOptionsZoom(int imageIndex);
453
454    // - DisplayOptionsProjection property retrieval -
455
456    int getDisplayOptionsProjectionZStart(int imageIndex);
457    int getDisplayOptionsProjectionZStop(int imageIndex);
458
459    // - DisplayOptionsTime property retrieval -
460
461    int getDisplayOptionsTimeTStart(int imageIndex);
462    int getDisplayOptionsTimeTStop(int imageIndex);
463
464    // - Experiment property retrieval -
465
466    string getExperimentDescription(int experimentIndex);
467    string getExperimentID(int experimentIndex);
468    string getExperimentType(int experimentIndex);
469
470    // - Experimenter property retrieval -
471
472    string getExperimenterEmail(int experimenterIndex);
473    string getExperimenterFirstName(int experimenterIndex);
474    string getExperimenterID(int experimenterIndex);
475    string getExperimenterInstitution(int experimenterIndex);
476    string getExperimenterLastName(int experimenterIndex);
477
478    // - ExperimenterMembership property retrieval -
479
480    string getExperimenterMembershipGroup(int experimenterIndex, int groupRefIndex);
481
482    // - Filament property retrieval -
483
484    string getFilamentType(int instrumentIndex, int lightSourceIndex);
485
486    // - GroupRef property retrieval -
487
488
489    // - Image property retrieval -
490
491    string getImageCreationDate(int imageIndex);
492    string getImageDefaultPixels(int imageIndex);
493    string getImageDescription(int imageIndex);
494    string getImageID(int imageIndex);
495    string getImageInstrumentRef(int imageIndex);
496    string getImageName(int imageIndex);
497
498    // - ImagingEnvironment property retrieval -
499
500    float getImagingEnvironmentAirPressure(int imageIndex);
501    float getImagingEnvironmentCO2Percent(int imageIndex);
502    float getImagingEnvironmentHumidity(int imageIndex);
503    float getImagingEnvironmentTemperature(int imageIndex);
504
505    // - Instrument property retrieval -
506
507    string getInstrumentID(int instrumentIndex);
508
509    // - Laser property retrieval -
510
511    int getLaserFrequencyMultiplication(int instrumentIndex, int lightSourceIndex);
512    string getLaserLaserMedium(int instrumentIndex, int lightSourceIndex);
513    string getLaserPulse(int instrumentIndex, int lightSourceIndex);
514    bool getLaserTuneable(int instrumentIndex, int lightSourceIndex);
515    string getLaserType(int instrumentIndex, int lightSourceIndex);
516    int getLaserWavelength(int instrumentIndex, int lightSourceIndex);
517
518    // - LightSource property retrieval -
519
520    string getLightSourceID(int instrumentIndex, int lightSourceIndex);
521    string getLightSourceManufacturer(int instrumentIndex, int lightSourceIndex);
522    string getLightSourceModel(int instrumentIndex, int lightSourceIndex);
523    float getLightSourcePower(int instrumentIndex, int lightSourceIndex);
524    string getLightSourceSerialNumber(int instrumentIndex, int lightSourceIndex);
525
526    // - LightSourceSettings property retrieval -
527
528    float getLightSourceSettingsAttenuation(int imageIndex, int logicalChannelIndex);
529    string getLightSourceSettingsLightSource(int imageIndex, int logicalChannelIndex);
530    int getLightSourceSettingsWavelength(int imageIndex, int logicalChannelIndex);
531
532    // - LogicalChannel property retrieval -
533
534    string getLogicalChannelContrastMethod(int imageIndex, int logicalChannelIndex);
535    int getLogicalChannelEmWave(int imageIndex, int logicalChannelIndex);
536    int getLogicalChannelExWave(int imageIndex, int logicalChannelIndex);
537    string getLogicalChannelFluor(int imageIndex, int logicalChannelIndex);
538    string getLogicalChannelID(int imageIndex, int logicalChannelIndex);
539    string getLogicalChannelIlluminationType(int imageIndex, int logicalChannelIndex);
540    string getLogicalChannelMode(int imageIndex, int logicalChannelIndex);
541    string getLogicalChannelName(int imageIndex, int logicalChannelIndex);
542    float getLogicalChannelNdFilter(int imageIndex, int logicalChannelIndex);
543    string getLogicalChannelOTF(int imageIndex, int logicalChannelIndex);
544    string getLogicalChannelPhotometricInterpretation(int imageIndex, int logicalChannelIndex);
545    float getLogicalChannelPinholeSize(int imageIndex, int logicalChannelIndex);
546    int getLogicalChannelPockelCellSetting(int imageIndex, int logicalChannelIndex);
547    int getLogicalChannelSamplesPerPixel(int imageIndex, int logicalChannelIndex);
548
549    // - OTF property retrieval -
550
551    string getOTFID(int instrumentIndex, int otfIndex);
552    string getOTFObjective(int instrumentIndex, int otfIndex);
553    bool getOTFOpticalAxisAveraged(int instrumentIndex, int otfIndex);
554    string getOTFPixelType(int instrumentIndex, int otfIndex);
555    int getOTFSizeX(int instrumentIndex, int otfIndex);
556    int getOTFSizeY(int instrumentIndex, int otfIndex);
557
558    // - Objective property retrieval -
559
560    float getObjectiveCalibratedMagnification(int instrumentIndex, int objectiveIndex);
561    string getObjectiveCorrection(int instrumentIndex, int objectiveIndex);
562    string getObjectiveID(int instrumentIndex, int objectiveIndex);
563    string getObjectiveImmersion(int instrumentIndex, int objectiveIndex);
564    float getObjectiveLensNA(int instrumentIndex, int objectiveIndex);
565    string getObjectiveManufacturer(int instrumentIndex, int objectiveIndex);
566    string getObjectiveModel(int instrumentIndex, int objectiveIndex);
567    int getObjectiveNominalMagnification(int instrumentIndex, int objectiveIndex);
568    string getObjectiveSerialNumber(int instrumentIndex, int objectiveIndex);
569    float getObjectiveWorkingDistance(int instrumentIndex, int objectiveIndex);
570
571    // - Pixels property retrieval -
572
573    bool getPixelsBigEndian(int imageIndex, int pixelsIndex);
574    string getPixelsDimensionOrder(int imageIndex, int pixelsIndex);
575    string getPixelsID(int imageIndex, int pixelsIndex);
576    string getPixelsPixelType(int imageIndex, int pixelsIndex);
577    int getPixelsSizeC(int imageIndex, int pixelsIndex);
578    int getPixelsSizeT(int imageIndex, int pixelsIndex);
579    int getPixelsSizeX(int imageIndex, int pixelsIndex);
580    int getPixelsSizeY(int imageIndex, int pixelsIndex);
581    int getPixelsSizeZ(int imageIndex, int pixelsIndex);
582
583    // - Plane property retrieval -
584
585    int getPlaneTheC(int imageIndex, int pixelsIndex, int planeIndex);
586    int getPlaneTheT(int imageIndex, int pixelsIndex, int planeIndex);
587    int getPlaneTheZ(int imageIndex, int pixelsIndex, int planeIndex);
588
589    // - PlaneTiming property retrieval -
590
591    float getPlaneTimingDeltaT(int imageIndex, int pixelsIndex, int planeIndex);
592    float getPlaneTimingExposureTime(int imageIndex, int pixelsIndex, int planeIndex);
593
594    // - Plate property retrieval -
595
596    string getPlateDescription(int plateIndex);
597    string getPlateExternalIdentifier(int plateIndex);
598    string getPlateID(int plateIndex);
599    string getPlateName(int plateIndex);
600    string getPlateStatus(int plateIndex);
601
602    // - PlateRef property retrieval -
603
604    string getPlateRefID(int screenIndex, int plateRefIndex);
605
606    // - ROI property retrieval -
607
608    string getROIID(int imageIndex, int roiIndex);
609    int getROIT0(int imageIndex, int roiIndex);
610    int getROIT1(int imageIndex, int roiIndex);
611    int getROIX0(int imageIndex, int roiIndex);
612    int getROIX1(int imageIndex, int roiIndex);
613    int getROIY0(int imageIndex, int roiIndex);
614    int getROIY1(int imageIndex, int roiIndex);
615    int getROIZ0(int imageIndex, int roiIndex);
616    int getROIZ1(int imageIndex, int roiIndex);
617
618    // - Reagent property retrieval -
619
620    string getReagentDescription(int screenIndex, int reagentIndex);
621    string getReagentID(int screenIndex, int reagentIndex);
622    string getReagentName(int screenIndex, int reagentIndex);
623    string getReagentReagentIdentifier(int screenIndex, int reagentIndex);
624
625    // - Screen property retrieval -
626
627    string getScreenID(int screenIndex);
628    string getScreenName(int screenIndex);
629    string getScreenProtocolDescription(int screenIndex);
630    string getScreenProtocolIdentifier(int screenIndex);
631    string getScreenReagentSetDescription(int screenIndex);
632    string getScreenType(int screenIndex);
633
634    // - ScreenAcquisition property retrieval -
635
636    string getScreenAcquisitionEndTime(int screenIndex, int screenAcquisitionIndex);
637    string getScreenAcquisitionID(int screenIndex, int screenAcquisitionIndex);
638    string getScreenAcquisitionStartTime(int screenIndex, int screenAcquisitionIndex);
639
640    // - StageLabel property retrieval -
641
642    string getStageLabelName(int imageIndex);
643    float getStageLabelX(int imageIndex);
644    float getStageLabelY(int imageIndex);
645    float getStageLabelZ(int imageIndex);
646
647    // - StagePosition property retrieval -
648
649    float getStagePositionPositionX(int imageIndex, int pixelsIndex, int planeIndex);
650    float getStagePositionPositionY(int imageIndex, int pixelsIndex, int planeIndex);
651    float getStagePositionPositionZ(int imageIndex, int pixelsIndex, int planeIndex);
652
653    // - TiffData property retrieval -
654
655    string getTiffDataFileName(int imageIndex, int pixelsIndex, int tiffDataIndex);
656    int getTiffDataFirstC(int imageIndex, int pixelsIndex, int tiffDataIndex);
657    int getTiffDataFirstT(int imageIndex, int pixelsIndex, int tiffDataIndex);
658    int getTiffDataFirstZ(int imageIndex, int pixelsIndex, int tiffDataIndex);
659    int getTiffDataIFD(int imageIndex, int pixelsIndex, int tiffDataIndex);
660    int getTiffDataNumPlanes(int imageIndex, int pixelsIndex, int tiffDataIndex);
661    string getTiffDataUUID(int imageIndex, int pixelsIndex, int tiffDataIndex);
662
663    // - Well property retrieval -
664
665    int getWellColumn(int plateIndex, int wellIndex);
666    string getWellExternalDescription(int plateIndex, int wellIndex);
667    string getWellExternalIdentifier(int plateIndex, int wellIndex);
668    string getWellID(int plateIndex, int wellIndex);
669    int getWellRow(int plateIndex, int wellIndex);
670    string getWellType(int plateIndex, int wellIndex);
671
672    // - WellSample property retrieval -
673
674    string getWellSampleID(int plateIndex, int wellIndex, int wellSampleIndex);
675    int getWellSampleIndex(int plateIndex, int wellIndex, int wellSampleIndex);
676    float getWellSamplePosX(int plateIndex, int wellIndex, int wellSampleIndex);
677    float getWellSamplePosY(int plateIndex, int wellIndex, int wellSampleIndex);
678    int getWellSampleTimepoint(int plateIndex, int wellIndex, int wellSampleIndex);
679  };
680};
Note: See TracBrowser for help on using the repository browser.