1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<html>
<head>
<title>libics: ICS and Ics_Header structures</title>
<link rel="stylesheet" href="libics.css" type="text/css" title="default">
<!--[if lte IE 6]>
<link rel="stylesheet" href="iexplorefix.css" type="text/css" title="default">
<![endif]-->
</head>
<body>
<p class=header>libics v.1.6.8 Online Documentation. ©2000-2010 by Cris Luengo and others.</p>
<div class="navbar">
<ul>
<li><a href=".">libics home</a></li>
<li><a href="Documentation.html" class="selected">Documentation</a>
<ul>
<li><a href="Usage.html">Usage of libics</a></li>
<li><a href="TopLevelFunctions.html">Top-level interface</a></li>
<li><a href="LowLevelFunctions.html">Low-level interface</a></li>
<li><a href="Ics_Header.html" class="selected">Ics_Header</a>
<ul>
<li><a href="#general">General information</a></li>
<li><a href="#format">Format</a></li>
<li><a href="#data">Data</a></li>
<li><a href="#StandardParams">Parameters</a></li>
<li><a href="#MicroscopyParams">Microscopy parameters</a></li>
</ul>
</li>
<li><a href="Ics_DataRepresentation.html">Ics_DataRepresentation</a></li>
<li><a href="Ics_ImelRepresentation.html">Ics_ImelRepresentation</a></li>
<li><a href="Ics_Error.html">Ics_Error</a></li>
<li><a href="Enums.html">Other enums</a></li>
</ul>
</li>
<li><a href="Credits.html">Credits</a></li>
<li><a href="Links.html">Links</a></li>
<li><a href="https://github.com/svi-opensource/libics/releases">Download</a></li>
<li><a href="https://github.com/svi-opensource/libics">GitHub</a></li>
</ul>
</div>
<h1>ICS structure and Ics_Header structure</h1>
<p>The <tt class="typeident">ICS</tt> data structure, which is the same
as the <tt class="typeident">Ics_Header</tt> data structure, contains
the fields described below.</p>
<p>All arrays are already allocated (static arrays). This determines the
maximum sizes allowed. If larger sizes are required, you must change some
values defined in "<tt class="preprocess">libics.h</tt>" and re-compile
the library.</p>
<p><strong>Warning:</strong> The <tt class="typeident">Ics_Header</tt>
structure is likely to change in the future. It is recommended that
you <strong>only</strong> use the top-level interface functions to access
this structure. This information is provided to help you understand libics,
not to help you mess around with its internals.</p>
<h2><a name="general"></a>General information on the open file</h2>
<p>These are used by the library to store the current state of the ICS
"stream". They don't influence what is written to the file.</p>
<h3 class="ident">BlockRead</h3>
<p>When data is read in blocks (using
<tt class="funcident"><a href="TopLevelFunctions.html#IcsGetDataBlock">IcsGetDataBlock</a></tt>
and
<tt class="funcident"><a href="TopLevelFunctions.html#IcsSkipDataBlock">IcsSkipDataBlock</a></tt>)
this pointer is set to a structure that contains information on the open
data file.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="keyword">void</tt>*</p>
<h3 class="ident">Filename</h3>
<p>Contains the name of the ICS file, including extension and path.
If the ICS file in question is an ICS version 1.0, it is also used to locate the
corresponding .ids file (data file).</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="keyword">char</tt> [<tt class="constant">ICS_MAXPATHLEN</tt>]</p>
<h3 class="ident">FileMode</h3>
<p>Specifies whether the ICS "stream" is open for
reading or writing.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="typeident"><a href="Enums.html#Ics_FileMode">Ics_FileMode</a></tt></p>
<h2><a name="format"></a>ICS format</h2>
<p>These values determine how the files are written (or how to read them).</p>
<h3 class="ident">Version</h3>
<p>ICS version.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="keyword">int</tt></p>
<p class="info"><span class="headtxt">value</span>: 1 for ICS version 1.0,
2 to ICS version 2.0.</p>
<h3 class="ident"><a name="Dimensions"></a>Dimensions</h3>
<p>Number of dimensions of the data, not including the
pixel depth. Its maximum value is <tt class="constant">ICS_MAXDIM</tt>,
and determines the amount of useful values in
<tt class="varident"><a href="#Dim">Dim</a></tt>.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="keyword">int</tt></p>
<p class="info"><span class="headtxt">access</span>:
<tt class="funcident"><a href="TopLevelFunctions.html#IcsGetLayout">IcsGetLayout</a></tt>,
<tt class="funcident"><a href="TopLevelFunctions.html#IcsSetLayout">IcsSetLayout</a></tt>.</p>
<h3 class="ident"><a name="Data"></a>Data</h3>
<p>Pointer to the image data to be written. Not used
when reading.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="keyword">void const*</tt></p>
<p class="info"><span class="headtxt">access</span>:
<tt class="funcident"><a href="TopLevelFunctions.html#IcsSetData">IcsSetData</a></tt>,
<tt class="funcident"><a href="TopLevelFunctions.html#IcsSetDataWithStrides">IcsSetDataWithStrides</a></tt>.</p>
<h3 class="ident">DataLength</h3>
<p>Size of the image data pointed to by
<tt class="varident"><a href="#Data">Data</a></tt>.
Not used when reading.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="keyword">size_t</tt></p>
<p class="info"><span class="headtxt">access</span>:
<tt class="funcident"><a href="TopLevelFunctions.html#IcsSetData">IcsSetData</a></tt>,
<tt class="funcident"><a href="TopLevelFunctions.html#IcsSetDataWithStrides">IcsSetDataWithStrides</a></tt>.</p>
<h3 class="ident">DataStrides</h3>
<p>Pointer to an array with distance in pixels to the
neighbors. Not used when reading.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="keyword">ptrdiff_t const*</tt></p>
<p class="info"><span class="headtxt">access</span>:
<tt class="funcident"><a href="TopLevelFunctions.html#IcsSetDataWithStrides">IcsSetDataWithStrides</a></tt>.</p>
<h3 class="ident">Compression</h3>
<p>Compression technique used.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="typeident"><a href="Enums.html#Ics_Compression">Ics_Compression</a></tt></p>
<p class="info"><span class="headtxt">access</span>:
<tt class="funcident"><a href="TopLevelFunctions.html#IcsSetCompression">IcsSetCompression</a></tt>.</p>
<h3 class="ident">CompLevel</h3>
<p>Parameter for the compression. Not set when
reading.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="keyword">int</tt></p>
<p class="info"><span class="headtxt">access</span>:
<tt class="funcident"><a href="TopLevelFunctions.html#IcsSetCompression">IcsSetCompression</a></tt>.</p>
<h3 class="ident"><a name="History"></a>History</h3>
<p>Pointer to a structure with "history" lines read or to be written
to the ICS file. The structure itself is hidden from the library user.
Use the top-level interface to add, delete, replace or retrieve history
lines.
<tt class="funcident"><a href="TopLevelFunctions.html#IcsAddHistoryString">IcsAddHistoryString</a></tt>
automatically allocates this structure as needed, and
<tt class="funcident"><a href="TopLevelFunctions.html#IcsClose">IcsClose</a></tt>
frees the memory associated with this structure. If not using the high-level
interface to write the ICS header, use
<tt class="funcident"><a href="LowLevelFunctions.html#IcsFreeHistory">IcsFreeHistory</a></tt>.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="keyword">void</tt>*</p>
<p class="info"><span class="headtxt">access</span>:
<tt class="funcident"><a href="TopLevelFunctions.html#IcsAddHistory">IcsAddHistory</a></tt>,
<tt class="funcident"><a href="TopLevelFunctions.html#IcsDeleteHistory">IcsDeleteHistory</a></tt>,
<tt class="funcident"><a href="TopLevelFunctions.html#IcsDeleteHistoryStringI">IcsDeleteHistoryStringI</a></tt>,
<tt class="funcident"><a href="TopLevelFunctions.html#IcsGetHistoryKeyValue">IcsGetHistoryKeyValue</a></tt>,
<tt class="funcident"><a href="TopLevelFunctions.html#IcsGetHistoryKeyValueI">IcsGetHistoryKeyValueI</a></tt>,
<tt class="funcident"><a href="TopLevelFunctions.html#IcsGetHistoryString">IcsGetHistoryString</a></tt>,
<tt class="funcident"><a href="TopLevelFunctions.html#IcsGetHistoryStringI">IcsGetHistoryStringI</a></tt>,
<tt class="funcident"><a href="TopLevelFunctions.html#IcsGetNumHistoryStrings">IcsGetNumHistoryStrings</a></tt>,
<tt class="funcident"><a href="TopLevelFunctions.html#IcsNewHistoryIterator">IcsNewHistoryIterator</a></tt>,
<tt class="funcident"><a href="TopLevelFunctions.html#IcsReplaceHistoryStringI">IcsReplaceHistoryStringI</a></tt>,
<tt class="funcident"><a href="LowLevelFunctions.html#IcsFreeHistory">IcsFreeHistory</a></tt>.</p>
<h3 class="ident"><a name="WriteSensor"></a>WriteSensor</h3>
<p>Determines if the <a href="#MicroscopyParams">
Special microscopy parameters</a> will be written or not.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="keyword">int</tt></p>
<p class="info"><span class="headtxt">value</span>:
zero to ignore parameters, non-zero to write them.</p>
<h2><a name="data"></a>ICS data</h2>
<p>These are values that are read from or written to the ICS file,
and define the image data. These are vital to the interpretation of
the image.</p>
<h3 class="ident">ByteOrder</h3>
<p>The storage order of the bytes is written here.
Ignored when writing. Don't change the values when reading.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="keyword">int</tt> [<tt class="constant">ICS_MAX_IMEL_SIZE</tt>]</p>
<h3 class="ident"><a name="Dim"></a>Dim</h3>
<p>Contains the dimension-specific data. There are
<tt class="varident"><a href="#Dimensions">Dimensions</a></tt> valid
entries.</p>
<p>The <tt class="varident">Size</tt> field is the
only vital element, and gives the dimensions of the image data. The other
fields are described <a href="#Dim2">below</a>.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="typeident"><a href="Ics_DataRepresentation.html">Ics_DataRepresentation</a></tt>
[<tt class="constant">ICS_MAXDIM</tt>]</p>
<p class="info"><span class="headtxt">access</span>:
<tt class="funcident"><a href="TopLevelFunctions.html#IcsGetLayout">IcsGetLayout</a></tt>,
<tt class="funcident"><a href="TopLevelFunctions.html#IcsSetLayout">IcsSetLayout</a></tt>.</p>
<h3 class="ident"><a name="Imel"></a>Imel</h3>
<p>Contains the imel-specific data.</p>
<p>The <tt class="varident">DataType</tt> is the
only vital element, and specifies the data representation. Without this
field it is not possible to use the
<tt class="varident"><a href="#Data">Data</a></tt>. The
<tt class="varident">SigBits</tt> field can be used additionally
to indicate how many of the bits are significant (or actually used).
The other fields are described <a href="#Imel2">below</a>.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="typeident"><a href="Ics_ImelRepresentation.html">Ics_ImelRepresentation</a></tt></p>
<p class="info"><span class="headtxt">access</span>:
<tt class="funcident"><a href="TopLevelFunctions.html#IcsGetImelSize">IcsGetImelSize</a></tt>,
<tt class="funcident"><a href="TopLevelFunctions.html#IcsGetLayout">IcsGetLayout</a></tt>,
<tt class="funcident"><a href="TopLevelFunctions.html#IcsSetLayout">IcsSetLayout</a></tt>,
<tt class="funcident"><a href="TopLevelFunctions.html#IcsGetSignificantBits">IcsGetSignificantBits</a></tt>,
<tt class="funcident"><a href="TopLevelFunctions.html#IcsSetSignificantBits">IcsSetSignificantBits</a></tt>.</p>
<h3 class="ident">ScilType</h3>
<p>This parameter is used only by SCIL_Image. If you want
to read your image with SCIL_Image, there must be a valid string here.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="keyword">char</tt> [<tt class="constant">ICS_STRLEN_TOKEN</tt>]</p>
<p class="info"><span class="headtxt">value</span>:
<tt class="constant">"g2d"</tt>, <tt class="constant">"g3d"</tt>,
<tt class="constant">"f2d"</tt>, <tt class="constant">"f3d"</tt>,
<tt class="constant">"c2d"</tt>, <tt class="constant">"c3d"</tt>,
<tt class="constant">"b2d"</tt>, <tt class="constant">"b3d"</tt>,
<tt class="constant">"l2d"</tt>, <tt class="constant">"l3d"</tt>,
<tt class="constant">"col2d"</tt> or <tt class="constant">"col3d"</tt>.</p>
<p class="info"><span class="headtxt">access</span>:
<tt class="funcident"><a href="TopLevelFunctions.html#IcsGetScilType">IcsGetScilType</a></tt>,
<tt class="funcident"><a href="TopLevelFunctions.html#IcsGuessScilType">IcsGuessScilType</a></tt>,
<tt class="funcident"><a href="TopLevelFunctions.html#IcsSetScilType">IcsSetScilType</a></tt>.</p>
<h3 class="ident"><a name="SrcFile"></a>SrcFile</h3>
<p>Source file name.</p>
<p>When writing an ICS version 2 file, set this to the
name of the file that contains the image data. If this string is not empty,
<tt class="varident"><a href="#Data">Data</a></tt> is ignored, and
<tt class="funcident"><a href="LowLevelFunctions.html#IdsWrite">IdsWrite</a></tt>
does nothing. If it is empty, the data pointed to by
<tt class="varident"><a href="#Data">Data</a></tt> is written to the
end of the ICS file.</p>
<p>When reading, this is set to the name of the file
that contains the image data, even if the data is in the ICS file
itself.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="keyword">char</tt> [<tt class="constant">ICS_MAXPATHLEN</tt>]</p>
<p class="info"><span class="headtxt">access</span>:
<tt class="funcident"><a href="TopLevelFunctions.html#IcsSetSource">IcsSetSource</a></tt>.</p>
<h3 class="ident">SrcOffset</h3>
<p>Offset into source file. This is ignored when
writing and <tt class="varident"><a href="#SrcFile">SrcFile</a></tt> is
empty.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="keyword">size_t</tt></p>
<p class="info"><span class="headtxt">access</span>:
<tt class="funcident"><a href="TopLevelFunctions.html#IcsSetSource">IcsSetSource</a></tt>.</p>
<h2><a name="StandardParams"></a>ICS parameters</h2>
<p>These values are copied as-is to the ICS file, and define the circumstances
under which the image was taken. None of these are vital to understand the
image data, but can be very useful.</p>
<h3 class="ident">Coord</h3>
<p>The coordinate system used.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="keyword">char</tt> [<tt class="constant">ICS_STRLEN_TOKEN</tt>]</p>
<p class="info"><span class="headtxt">value</span>:
<tt class="constant">"video"</tt>, <tt class="constant">"cartesian"</tt>
or anything else you can come up with. The default is
<tt class="constant">"video"</tt>, which means that the origin is the
upper left pixel.</p>
<p class="info"><span class="headtxt">access</span>:
<tt class="funcident"><a href="TopLevelFunctions.html#IcsGetCoordinateSystem">IcsGetCoordinateSystem</a></tt>,
<tt class="funcident"><a href="TopLevelFunctions.html#IcsSetCoordinateSystem">IcsSetCoordinateSystem</a></tt>.</p>
<h3 class="ident"><a name="Dim2"></a>Dim</h3>
<p>Contains the dimension-specific data. There are
<tt class="varident"><a href="#Dimensions">Dimensions</a></tt> valid
entries.</p>
<p>The <tt class="varident">Origin</tt>,
<tt class="varident">Scale</tt> and <tt class="varident">Unit</tt>
fields give information on the position of the image in the real world.</p>
<p>The <tt class="varident">Order</tt> and
<tt class="varident">Label</tt> fields define the meaning of each of
the dimensions in the image.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="typeident"><a href="Ics_DataRepresentation.html">Ics_DataRepresentation</a></tt>
[<tt class="constant">ICS_MAXDIM</tt>]</p>
<p class="info"><span class="headtxt">access</span>:
<tt class="funcident"><a href="TopLevelFunctions.html#IcsGetOrder">IcsGetOrder</a></tt>,
<tt class="funcident"><a href="TopLevelFunctions.html#IcsGetPosition">IcsGetPosition</a></tt>,
<tt class="funcident"><a href="TopLevelFunctions.html#IcsSetOrder">IcsSetOrder</a></tt>,
<tt class="funcident"><a href="TopLevelFunctions.html#IcsSetPosition">IcsSetPosition</a></tt>.</p>
<h3 class="ident"><a name="Imel2"></a>Imel</h3>
<p>Contains the imel-specific data.</p>
<p>The <tt class="varident">Origin</tt>,
<tt class="varident">Scale</tt> and <tt class="varident">Unit</tt>
fields specify the physical meaning of the values in the image.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="typeident"><a href="Ics_ImelRepresentation.html">Ics_ImelRepresentation</a></tt></p>
<p class="info"><span class="headtxt">access</span>:
<tt class="funcident"><a href="TopLevelFunctions.html#IcsGetImelUnits">IcsGetImelUnits</a></tt>,
<tt class="funcident"><a href="TopLevelFunctions.html#IcsSetImelUnits">IcsSetImelUnits</a></tt>.</p>
<h2><a name="MicroscopyParams"></a>Special microscopy parameters</h2>
<p>These values are also copied as-is to the ICS file, under the token
'sensor'. This is a token not defined in the standard, and provides
specialized information for certain applications. All microscope
parameters can be coded in here. If you want these values to be
written to the file you need to set
<tt class="varident"><a href="#WriteSensor">WriteSensor</a></tt>
to a non-zero value.
The recommended way to access these parameters is to use the
<tt class="funcident"><a href="TopLevelFunctions.html#sensor">Sensor</a></tt>
functions.
</p>
<h3 class="ident"><a name="ExPhotonCnt"></a>ExPhotonCnt</h3>
<p>Number of excitation photons.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="keyword">int</tt> [<tt class="constant">ICS_MAX_LAMBDA</tt>]</p>
<h3 class="ident"><a name="LambdaEm"></a>LambdaEm</h3>
<p>Excitation wavelength in nm.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="keyword">double</tt> [<tt class="constant">ICS_MAX_LAMBDA</tt>]</p>
<h3 class="ident"><a name="LambdaEx"></a>LambdaEx</h3>
<p>Emission wavelength in nm.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="keyword">double</tt> [<tt class="constant">ICS_MAX_LAMBDA</tt>]</p>
<h3 class="ident">Model</h3>
<p>Model or make.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="keyword">char</tt> [<tt class="constant">ICS_STRLEN_OTHER</tt>]</p>
<h3 class="ident">NumAperture</h3>
<p>Numerical Aperture.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="keyword">double</tt></p>
<h3 class="ident"><a name="PinholeRadius"></a>PinholeRadius</h3>
<p>Back projected microns.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="keyword">double</tt> [<tt class="constant">ICS_MAX_LAMBDA</tt>]</p>
<h3 class="ident"><a name="PinholeSpacing"></a>PinholeSpacing</h3>
<p>Nipkow Disk pinhole spacing.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="keyword">double</tt></p>
<h3 class="ident">RefrInxLensMedium</h3>
<p>Refractive index of design medium.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="keyword">double</tt></p>
<h3 class="ident">RefrInxMedium</h3>
<p>Refractive index of embedding medium.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="keyword">double</tt></p>
<h3 class="ident">SensorChannels</h3>
<p>Number of channels. Defines the number of useful
entries in
<tt class="varident"><a href="#PinholeRadius">PinholeRadius</a></tt>,
<tt class="varident"><a href="#LambdaEx">LambdaEx</a></tt>,
<tt class="varident"><a href="#LambdaEm">LambdaEm</a></tt> and
<tt class="varident"><a href="#ExPhotonCnt">ExPhotonCnt</a></tt>.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="keyword">int</tt></p>
<h3 class="ident">StedDepletionMode</h3>
<p>STED depletion mode.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="keyword">char</tt> [<tt class="constant">ICS_STRLEN_TOKEN</tt>]</p>
<h3 class="ident">StedImmFraction</h3>
<p>STED immunity fraction.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="keyword">double</tt></p>
<h3 class="ident">StedLambda</h3>
<p>STED wavelength in nm.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="keyword">double</tt></p>
<h3 class="ident">StedPPMode</h3>
<p>STED phase plate mode.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="keyword">char</tt> [<tt class="constant">ICS_STRLEN_TOKEN</tt>]</p>
<h3 class="ident">StedSatFactor</h3>
<p>STED saturation factor.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="keyword">double</tt></p>
<h3 class="ident">StedVPPM</h3>
<p>STED vortex to phase plate mix.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="keyword">double</tt></p>
<h3 class="ident">Type</h3>
<p>Sensor type.</p>
<p class="info"><span class="headtxt">type</span>:
<tt class="keyword">char</tt> [<tt class="constant">ICS_STRLEN_TOKEN</tt>]</p>
<h2><a name="MicroscopyParamTokens"></a>Microscopy parameter tokens</h2>
<p>Every microscopy parameter has a token that can be used in the generic
<span class="typeident"><a href="TopLevelFunctions.html#sensor">Set and Get functions</a></span>
to change the value(s). The possible tokens are:
<tt class="constant"><br/><br/>
ICS_SENSOR_IMAGING_DIRECTION<br/>
ICS_SENSOR_NUMERICAL_APERTURE<br/>
ICS_SENSOR_OBJECTIVE_QUALITY<br/>
ICS_SENSOR_MEDIUM_REFRACTIVE_INDEX<br/>
ICS_SENSOR_LENS_REFRACTIVE_INDEX<br/>
ICS_SENSOR_PINHOLE_RADIUS<br/>
ICS_SENSOR_ILL_PINHOLE_RADIUS<br/>
ICS_SENSOR_PINHOLE_SPACING<br/>
ICS_SENSOR_EXCITATION_BEAM_FILL<br/>
ICS_SENSOR_LAMBDA_EXCITATION<br/>
ICS_SENSOR_LAMBDA_EMISSION<br/>
ICS_SENSOR_PHOTON_COUNT<br/>
ICS_SENSOR_INTERFACE_PRIMARY<br/>
ICS_SENSOR_INTERFACE_SECONDARY<br/>
ICS_SENSOR_DESCRIPTION<br/>
<br/>
ICS_SENSOR_DETECTOR_MAGN<br/>
ICS_SENSOR_DETECTOR_PPU<br/>
ICS_SENSOR_DETECTOR_BASELINE<br/>
ICS_SENSOR_DETECTOR_LINE_AVG_COUNT<br/>
ICS_SENSOR_DETECTOR_NOISE_GAIN<br/>
<br/>
ICS_SENSOR_DETECTOR_OFFSET<br/>
ICS_SENSOR_DETECTOR_SENSITIVITY<br/>
ICS_SENSOR_DETECTOR_RADIUS<br/>
ICS_SENSOR_DETECTOR_SCALE<br/>
ICS_SENSOR_DETECTOR_STRETCH<br/>
ICS_SENSOR_DETECTOR_ROT<br/>
ICS_SENSOR_DETECTOR_MIRROR<br/>
ICS_SENSOR_DETECTOR_MODEL<br/>
ICS_SENSOR_DETECTOR_REDUCEHIST<br/>
<br/>
ICS_SENSOR_STED_DEPLETION_MODE<br/>
ICS_SENSOR_STED_LAMBDA<br/>
ICS_SENSOR_STED_SATURATION_FACTOR<br/>
ICS_SENSOR_STED_IMM_FRACTION<br/>
ICS_SENSOR_STED_VPPM<br/>
<br/>
ICS_SENSOR_SPIM_EXCITATION_TYPE<br/>
ICS_SENSOR_SPIM_FILL_FACTOR<br/>
ICS_SENSOR_SPIM_PLANE_NA<br/>
ICS_SENSOR_SPIM_PLANE_GAUSS_WIDTH<br/>
ICS_SENSOR_SPIM_PLANE_PROP_DIR<br/>
ICS_SENSOR_SPIM_PLANE_CENTER_OFF<br/>
ICS_SENSOR_SPIM_PLANE_FOCUS_OFF<br/>
<br/>
ICS_SENSOR_SCATTER_MODEL<br/>
ICS_SENSOR_SCATTER_FREE_PATH<br/>
ICS_SENSOR_SCATTER_REL_CONTRIB<br/>
ICS_SENSOR_SCATTER_BLURRING<br/>
</tt>
</p>
<h2><a name="SensorStates"></a>Microscopy parameter states</h2>
<p>Every microscopy parameter has a state indicating where the parameter came from /
the level of confidence we have in the parameter. Possible values:<br/><br/>
<tt class="constant">IcsSensorState_default</tt><br/>
<tt class="constant">IcsSensorState_estimated</tt><br/>
<tt class="constant">IcsSensorState_reported</tt><br/>
<tt class="constant">IcsSensorState_verified</tt><br/>
</p>
</body>
</html>
|
