-
Notifications
You must be signed in to change notification settings - Fork 242
/
PrintTimestamps.java
167 lines (151 loc) · 6.24 KB
/
PrintTimestamps.java
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
/*
* #%L
* OME Bio-Formats package for reading and converting biological file formats.
* %%
* Copyright (C) 2005 - 2017 Open Microscopy Environment:
* - Board of Regents of the University of Wisconsin-Madison
* - Glencoe Software, Inc.
* - University of Dundee
* %%
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as
* published by the Free Software Foundation, either version 2 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public
* License along with this program. If not, see
* <http://www.gnu.org/licenses/gpl-2.0.html>.
* #L%
*/
import java.util.Arrays;
import loci.common.DateTools;
import loci.common.services.ServiceFactory;
import loci.formats.FormatReader;
import loci.formats.IFormatReader;
import loci.formats.ImageReader;
import loci.formats.meta.IMetadata;
import loci.formats.services.OMEXMLService;
import ome.xml.model.primitives.NonNegativeInteger;
import ome.units.quantity.Time;
import ome.units.UNITS;
/**
* Uses Bio-Formats to extract timestamp information
* in a format-independent manner from a dataset.
*/
public class PrintTimestamps {
/** Outputs dimensional information. */
public static void printDimensions(IFormatReader reader) {
// output dimensional information
int sizeX = reader.getSizeX();
int sizeY = reader.getSizeY();
int sizeZ = reader.getSizeZ();
int sizeC = reader.getSizeC();
int sizeT = reader.getSizeT();
int imageCount = reader.getImageCount();
System.out.println();
System.out.println("Image dimensions:");
System.out.println("\tWidth = " + sizeX);
System.out.println("\tHeight = " + sizeY);
System.out.println("\tFocal planes = " + sizeZ);
System.out.println("\tChannels = " + sizeC);
System.out.println("\tTimepoints = " + sizeT);
System.out.println("\tTotal planes = " + imageCount);
}
/** Outputs global timing details. */
public static void printGlobalTiming(IMetadata meta, int series) {
String imageName = meta.getImageName(series);
String creationDate = null;
if (meta.getImageAcquisitionDate(series) != null) {
creationDate = meta.getImageAcquisitionDate(series).getValue();
}
Time timeInc = meta.getPixelsTimeIncrement(series);
System.out.println();
System.out.println("Global timing information:");
System.out.println("\tImage name = " + imageName);
System.out.println("\tCreation date = " + creationDate);
if (creationDate != null) {
System.out.println("\tCreation time (in ms since epoch) = " +
DateTools.getTime(creationDate, DateTools.ISO8601_FORMAT));
}
System.out.println("\tTime increment (in seconds) = " + timeInc.value(UNITS.SECOND).doubleValue());
}
/** Outputs timing details per timepoint. */
public static void printTimingPerTimepoint(IMetadata meta, int series) {
System.out.println();
System.out.println(
"Timing information per timepoint (from beginning of experiment):");
int planeCount = meta.getPlaneCount(series);
for (int i = 0; i < planeCount; i++) {
Time deltaT = meta.getPlaneDeltaT(series, i);
if (deltaT == null) continue;
// convert plane ZCT coordinates into image plane index
int z = meta.getPlaneTheZ(series, i).getValue().intValue();
int c = meta.getPlaneTheC(series, i).getValue().intValue();
int t = meta.getPlaneTheT(series, i).getValue().intValue();
if (z == 0 && c == 0) {
System.out.println("\tTimepoint #" + t + " = " + deltaT.value(UNITS.SECOND).doubleValue() + " s");
}
}
}
/**
* Outputs timing details per plane.
*
* This information may seem redundant or unnecessary, but it is possible
* that two image planes recorded at the same timepoint actually have
* slightly different timestamps. Thus, OME allows for recording a separate
* timestamp for every individual image plane.
*/
public static void printTimingPerPlane(IMetadata meta, int series) {
System.out.println();
System.out.println(
"Timing information per plane (from beginning of experiment):");
int planeCount = meta.getPlaneCount(series);
for (int i = 0; i < planeCount; i++) {
Time deltaT = meta.getPlaneDeltaT(series, i);
if (deltaT == null) continue;
// convert plane ZCT coordinates into image plane index
int z = meta.getPlaneTheZ(series, i).getValue().intValue();
int c = meta.getPlaneTheC(series, i).getValue().intValue();
int t = meta.getPlaneTheT(series, i).getValue().intValue();
System.out.println("\tZ " + z + ", C " + c + ", T " + t + " = " +
deltaT.value(UNITS.SECOND).doubleValue() + " s");
}
}
public static void main(String[] args) throws Exception {
// parse command line arguments
if (args.length < 1) {
System.err.println("Usage: java PrintTimestamps imageFile [seriesNo]");
System.exit(1);
}
String id = args[0];
int series = args.length > 1 ? Integer.parseInt(args[1]) : 0;
// enable debugging
//FormatReader.debug = true;
// create OME-XML metadata store of the latest schema version
ServiceFactory factory = new ServiceFactory();
OMEXMLService service = factory.getInstance(OMEXMLService.class);
IMetadata meta = service.createOMEXMLMetadata();
// or if you want a specific schema version, you can use:
//IMetadata meta = service.createOMEXMLMetadata(null, "2009-02");
//meta.createRoot();
// create format reader
IFormatReader reader = new ImageReader();
reader.setMetadataStore(meta);
// initialize file
System.out.println("Initializing " + id);
reader.setId(id);
int seriesCount = reader.getSeriesCount();
if (series < seriesCount) reader.setSeries(series);
series = reader.getSeries();
System.out.println("\tImage series = " + series + " of " + seriesCount);
printDimensions(reader);
printGlobalTiming(meta, series);
printTimingPerTimepoint(meta, series);
printTimingPerPlane(meta, series);
}
}