source: trunk/loci/formats/doc/metadata-guide.txt @ 3118

Revision 3118, 3.9 KB checked in by curtis, 13 years ago (diff)

Initial skeleton for Bio-Formats Metadata Guide.

Line 
1                  Bio-Formats Metadata Guide by Curtis Rueden
2
3                                   Overview
4                                  ----------
5
6This document provides an explanation of Bio-Formats's capabilities with
7respect to metadata. Bio-Formats provides metadata facilities on three
8distinct levels:
9
101) Extraction of "core" metadata necessary to understand the image planes's
11   dimensional structure and binary encoding.
12
132) Thorough parsing of additional metadata in each format's original structure.
14
153) Standardization of proprietary metadata into the common OME data model.
16
17Each of these three facilities will be discussed in its own section.
18
19                                 Core Metadata
20                                ---------------
21
22For a series of images to form a coherent dataset, certain parameters are
23required to properly understand the data's structure. Such parameters
24constitute what Bio-Formats calls "core" metadata.
25
26The table below summarizes these parameters, with an explanation of each entry
27following. The first column lists methods of the IFormatReader interface
28relevant to obtaining core metadata values. The second column lists the
29corresponding field of the CoreMetadata class.
30
31      IFormatReader method | CoreMetadata parameter
32     ----------------------+------------------------
33         getCoreMetadata() | (all)
34          getSeriesCount() | -
35           getImageCount() | imageCount
36                getSizeX() | sizeX
37                getSizeY() | sizeY
38                getSizeZ() | sizeZ
39                getSizeC() | sizeC
40                getSizeT() | sizeT
41       getEffectiveSizeC() | effectiveSizeC = imageCount / (sizeZ * sizeT)
42      getRGBChannelCount() | rgbChannelCount = sizeC / effectiveSizeC
43                   isRGB() | rgb (true iff rgbChannelCount > 1)
44           getThumbSizeX() | thumbSizeX
45           getThumbSizeY() | thumbSizeY
46            getPixelType() | pixelType
47    getChannelDimLengths() | cLengths
48      getChannelDimTypes() | cTypes
49       getDimensionOrder() | currentOrder
50          isOrderCertain() | orderCertain
51          isLittleEndian() | littleEndian
52           isInterleaved() | interleaved
53        isInterleaved(int) | -
54             getMetadata() | seriesMetadata
55
56CoreMetadata getCoreMetadata() :
57  TODO.
58
59int getSeriesCount() :
60  TODO. setSeries(int), getSeries().
61
62int getImageCount() :
63  TODO.
64
65int getSizeX() :
66  TODO.
67
68int getSizeY() :
69  TODO.
70
71int getSizeZ() :
72  TODO.
73
74int getSizeC() :
75  TODO.
76
77int getSizeT() :
78  TODO.
79
80int getEffectiveSizeC() :
81  TODO.
82
83int getRGBChannelCount() :
84  TODO.
85
86boolean isRGB() :
87  TODO.
88
89int getThumbSizeX() :
90  TODO.
91
92int getThumbSizeY() :
93  TODO.
94
95int getPixelType() :
96  TODO.
97
98int[] getChannelDimLengths() :
99  TODO.
100
101String[] getChannelDimTypes() :
102  TODO.
103
104String getDimensionOrder() :
105  TODO.
106
107boolean isOrderCertain() :
108  TODO.
109
110boolean isLittleEndian() :
111  TODO.
112
113boolean isInterleaved() :
114  TODO.
115
116boolean isInterleaved(int) :
117  TODO.
118
119Hashtable getMetadata() :
120  TODO.
121
122Metadata classes:
123  CoreMetadata
124
125                               Original Metadata
126                              -------------------
127
128void setMetadataCollected(boolean) :
129  TODO.
130
131boolean isMetadataCollected() :
132  TODO.
133
134Object getMetadataValue(String) :
135  TODO.
136
137Hashtable getMetadata() :
138  TODO.
139
140void setMetadataFiltered(boolean) :
141  TODO.
142
143boolean isMetadataFiltered() :
144  TODO.
145
146                          Standardization to OME-XML
147                         ----------------------------
148
149IFormatReader:
150
151void setOriginalMetadataPopulated(boolean) :
152  TODO.
153
154boolean isOriginalMetadataPopulated() :
155  TODO.
156
157void isMetadataComplete() :
158  TODO.
159
160void setMetadataStore(MetadataStore) :
161  TODO.
162
163void getMetadataStore() :
164  TODO.
165
166void getMetadataStoreRoot() :
167  TODO.
168
169IFormatWriter:
170
171void setMetadataRetrieve(MetadataRetrieve) :
172  TODO.
173
174MetadataRetrieve getMetadataRetrieve() :
175  TODO.
176
177Metadata classes:
178  MetadataStore
179  MetadataRetrieve
180  OMEXMLMetadata
181  DummyMetadata
182  AggregateMetadataStore
183  MetadataTools
Note: See TracBrowser for help on using the repository browser.