1 package nom.tam.fits;
2
3 import java.io.PrintStream;
4
5 import nom.tam.fits.header.IFitsHeader;
6 import nom.tam.fits.header.Standard;
7 import nom.tam.util.ArrayDataOutput;
8 import nom.tam.util.ArrayFuncs;
9 import nom.tam.util.ColumnTable;
10 import nom.tam.util.Cursor;
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 import static nom.tam.fits.header.Standard.NAXIS1;
44 import static nom.tam.fits.header.Standard.NAXIS2;
45 import static nom.tam.fits.header.Standard.TDIMn;
46 import static nom.tam.fits.header.Standard.TDISPn;
47 import static nom.tam.fits.header.Standard.TFIELDS;
48 import static nom.tam.fits.header.Standard.TFORMn;
49 import static nom.tam.fits.header.Standard.TNULLn;
50 import static nom.tam.fits.header.Standard.TSCALn;
51 import static nom.tam.fits.header.Standard.TTYPEn;
52 import static nom.tam.fits.header.Standard.TUNITn;
53 import static nom.tam.fits.header.Standard.TZEROn;
54 import static nom.tam.fits.header.Standard.XTENSION;
55
56
57
58
59
60
61
62 @SuppressWarnings("deprecation")
63 public class BinaryTableHDU extends TableHDU<BinaryTable> {
64
65
66 private static final IFitsHeader[] KEY_STEMS = {TTYPEn, TFORMn, TUNITn, TNULLn, TSCALn, TZEROn, TDISPn, TDIMn};
67
68
69
70
71
72
73
74
75
76 public BinaryTableHDU(Header hdr, BinaryTable datum) {
77 super(hdr, datum);
78 }
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98 public static BinaryTableHDU wrap(BinaryTable tab) throws FitsException {
99 BinaryTableHDU hdu = new BinaryTableHDU(new Header(), tab);
100 tab.fillHeader(hdu.myHeader);
101 return hdu;
102 }
103
104 @Override
105 protected final String getCanonicalXtension() {
106 return Standard.XTENSION_BINTABLE;
107 }
108
109
110
111
112
113
114
115
116
117
118
119
120 @Deprecated
121 public static BinaryTable encapsulate(Object o) throws FitsException {
122 if (o instanceof ColumnTable) {
123 return new BinaryTable((ColumnTable<?>) o);
124 }
125 if (o instanceof Object[][]) {
126 return BinaryTable.fromRowMajor((Object[][]) o);
127 }
128 if (o instanceof Object[]) {
129 return BinaryTable.fromColumnMajor((Object[]) o);
130 }
131 throw new FitsException("Unable to encapsulate object of type:" + o.getClass().getName() + " as BinaryTable");
132 }
133
134
135
136
137
138
139
140
141
142
143
144
145 @Deprecated
146 public static boolean isData(Object o) {
147 return o instanceof nom.tam.util.ColumnTable || o instanceof Object[][] || o instanceof Object[];
148 }
149
150
151
152
153
154
155
156
157
158
159 @Deprecated
160 public static boolean isHeader(Header header) {
161 String xten = header.getStringValue(XTENSION);
162 if (xten == null) {
163 return false;
164 }
165 xten = xten.trim();
166 return xten.equals(Standard.XTENSION_BINTABLE) || xten.equals("A3DTABLE");
167 }
168
169
170
171
172
173
174
175
176
177
178
179
180 @Deprecated
181 public static BinaryTable manufactureData(Header header) throws FitsException {
182 return new BinaryTable(header);
183 }
184
185
186
187
188
189
190
191
192
193
194
195 @Deprecated
196 public static Header manufactureHeader(Data data) throws FitsException {
197 Header hdr = new Header();
198 data.fillHeader(hdr);
199 return hdr;
200 }
201
202 @Override
203 public int addColumn(Object data) throws FitsException {
204 int n = myData.addColumn(data);
205 myHeader.addValue(Standard.NAXISn.n(1), myData.getRowBytes());
206 Cursor<String, HeaderCard> c = myHeader.iterator();
207 c.end();
208 myData.fillForColumn(myHeader, c, n - 1);
209 return super.addColumn(data);
210 }
211
212
213
214
215
216
217 protected static IFitsHeader[] binaryTableColumnKeyStems() {
218 return KEY_STEMS;
219 }
220
221 @Override
222 protected IFitsHeader[] columnKeyStems() {
223 return BinaryTableHDU.KEY_STEMS;
224 }
225
226 @Override
227 public void info(PrintStream stream) {
228 stream.println(" Binary Table");
229 stream.println(" Header Information:");
230
231 int nhcol = myHeader.getIntValue(TFIELDS, -1);
232 int nrow = myHeader.getIntValue(NAXIS2, -1);
233 int rowsize = myHeader.getIntValue(NAXIS1, -1);
234
235 stream.print(" " + nhcol + " fields");
236 stream.println(", " + nrow + " rows of length " + rowsize);
237
238 for (int i = 1; i <= nhcol; i++) {
239 stream.print(" " + i + ":");
240 prtField(stream, "Name", TTYPEn.n(i).key());
241 prtField(stream, "Format", TFORMn.n(i).key());
242 prtField(stream, "Dimens", TDIMn.n(i).key());
243 stream.println("");
244 }
245
246 stream.println(" Data Information:");
247 stream.println(" Number of rows=" + myData.getNRows());
248 stream.println(" Number of columns=" + myData.getNCols());
249 stream.println(" Heap size is: " + myData.getParameterSize() + " bytes");
250
251 Object[] cols = myData.getFlatColumns();
252 for (int i = 0; i < cols.length; i++) {
253 stream.println(" " + i + ":" + ArrayFuncs.arrayDescription(cols[i]));
254 }
255 }
256
257
258
259
260
261
262
263
264 @Deprecated
265 public boolean isHeader() {
266 return isHeader(myHeader);
267 }
268
269 private void prtField(PrintStream stream, String type, String field) {
270 String val = myHeader.getStringValue(field);
271 if (val != null) {
272 stream.print(type + '=' + val + "; ");
273 }
274 }
275
276
277
278
279
280
281
282
283
284
285
286
287 public BinaryTable.ColumnDesc getColumnDescriptor(int col) {
288 return myData.getDescriptor(col);
289 }
290
291 @Override
292 public void setColumnName(int index, String name, String comment)
293 throws IndexOutOfBoundsException, HeaderCardException {
294 super.setColumnName(index, name, comment);
295 getColumnDescriptor(index).name(name);
296 }
297
298
299
300
301
302
303
304
305
306
307
308
309
310 public final boolean convertToBits(int col) throws FitsException {
311 if (!myData.convertToBits(col)) {
312 return false;
313 }
314
315
316 myHeader.getCard(Standard.TFORMn.n(col + 1)).setValue(getColumnDescriptor(col).getTFORM());
317
318 return true;
319 }
320
321
322
323
324
325
326
327
328
329
330
331
332
333 public boolean setComplexColumn(int index) throws FitsException {
334 if (!myData.setComplexColumn(index)) {
335 return false;
336 }
337
338
339 myHeader.getCard(Standard.TFORMn.n(index + 1)).setValue(getColumnDescriptor(index).getTFORM());
340
341
342 if (myHeader.containsKey(Standard.TDIMn.n(index + 1))) {
343 String tdim = getColumnDescriptor(index).getTDIM();
344 if (tdim != null) {
345 myHeader.getCard(Standard.TDIMn.n(index + 1)).setValue(tdim);
346 } else {
347 myHeader.deleteKey(Standard.TDIMn.n(index + 1));
348 }
349 }
350
351 return true;
352 }
353
354
355 @Override
356 public void write(ArrayDataOutput out) throws FitsException {
357 myData.fillHeader(myHeader, false);
358 super.write(out);
359 }
360 }