1 | //#--------------------------------------------------------------------------- |
---|
2 | //# STFITSImageWriter.cc: Class to write out single dish spectra as FITS images |
---|
3 | //#--------------------------------------------------------------------------- |
---|
4 | //# Copyright (C) 2008 |
---|
5 | //# ATNF |
---|
6 | //# |
---|
7 | //# This program is free software; you can redistribute it and/or modify it |
---|
8 | //# under the terms of the GNU General Public License as published by the Free |
---|
9 | //# Software Foundation; either version 2 of the License, or (at your option) |
---|
10 | //# any later version. |
---|
11 | //# |
---|
12 | //# This program is distributed in the hope that it will be useful, but |
---|
13 | //# WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
14 | //# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General |
---|
15 | //# Public License for more details. |
---|
16 | //# |
---|
17 | //# You should have received a copy of the GNU General Public License along |
---|
18 | //# with this program; if not, write to the Free Software Foundation, Inc., |
---|
19 | //# 675 Massachusetts Ave, Cambridge, MA 02139, USA. |
---|
20 | //# |
---|
21 | //# Correspondence concerning this software should be addressed as follows: |
---|
22 | //# Internet email: Malte.Marquarding@csiro.au |
---|
23 | //# Postal address: Malte Marquarding, |
---|
24 | //# Australia Telescope National Facility, |
---|
25 | //# P.O. Box 76, |
---|
26 | //# Epping, NSW, 2121, |
---|
27 | //# AUSTRALIA |
---|
28 | //# |
---|
29 | //# $Id: $ |
---|
30 | //#--------------------------------------------------------------------------- |
---|
31 | |
---|
32 | #include <fitsio.h> |
---|
33 | #include <images/Images/TempImage.h> |
---|
34 | |
---|
35 | #include <lattices/Lattices/ArrayLattice.h> |
---|
36 | |
---|
37 | #include <measures/Measures/MEpoch.h> |
---|
38 | #include <measures/Measures/Stokes.h> |
---|
39 | |
---|
40 | #include <tables/Tables/Table.h> |
---|
41 | #include <tables/Tables/TableIter.h> |
---|
42 | #include <tables/Tables/TableRecord.h> |
---|
43 | #include <casa/Containers/RecordField.h> |
---|
44 | #include <tables/Tables/TableRow.h> |
---|
45 | #include <tables/Tables/ScalarColumn.h> |
---|
46 | #include <tables/Tables/ArrayColumn.h> |
---|
47 | |
---|
48 | |
---|
49 | #include <coordinates/Coordinates/CoordinateUtil.h> |
---|
50 | #include <coordinates/Coordinates/CoordinateSystem.h> |
---|
51 | #include <coordinates/Coordinates/SpectralCoordinate.h> |
---|
52 | #include <coordinates/Coordinates/DirectionCoordinate.h> |
---|
53 | #include <coordinates/Coordinates/StokesCoordinate.h> |
---|
54 | #include <coordinates/Coordinates/ObsInfo.h> |
---|
55 | |
---|
56 | #include <images/Images/ImageFITSConverter.h> |
---|
57 | #include <images/Images/TempImage.h> |
---|
58 | |
---|
59 | #include <lattices/Lattices/ArrayLattice.h> |
---|
60 | |
---|
61 | |
---|
62 | //#include "STDefs.h" |
---|
63 | #include "STHeader.h" |
---|
64 | #include "Scantable.h" |
---|
65 | #include "STFITSImageWriter.h" |
---|
66 | |
---|
67 | using namespace casa; |
---|
68 | using namespace asap; |
---|
69 | |
---|
70 | |
---|
71 | STFITSImageWriter::STFITSImageWriter() : isClass_(False) |
---|
72 | {;} |
---|
73 | |
---|
74 | STFITSImageWriter::~STFITSImageWriter() |
---|
75 | {;} |
---|
76 | |
---|
77 | |
---|
78 | Bool STFITSImageWriter::write(const Scantable& stable, |
---|
79 | const String& fileName) |
---|
80 | { |
---|
81 | |
---|
82 | // Get global Header from Table |
---|
83 | |
---|
84 | STHeader hdr = stable.getHeader(); |
---|
85 | |
---|
86 | // Column keywords |
---|
87 | |
---|
88 | Table tab = stable.table(); |
---|
89 | |
---|
90 | // Temps |
---|
91 | |
---|
92 | const Unit RAD(String("rad")); |
---|
93 | |
---|
94 | // Open and write header file |
---|
95 | |
---|
96 | String rootName(fileName); |
---|
97 | if (rootName.length()==0) rootName = String("fits"); |
---|
98 | |
---|
99 | ObsInfo oi; |
---|
100 | oi.setTelescope(String(hdr.antennaname)); |
---|
101 | oi.setObserver(String(hdr.observer)); |
---|
102 | |
---|
103 | uInt maxMem = 128; |
---|
104 | Bool preferVelocity = False; |
---|
105 | Bool opticalVelocity = False; |
---|
106 | Int bitPix = -32; // FLoating point |
---|
107 | Float minPix = 1.0; |
---|
108 | Float maxPix = -1.0; |
---|
109 | Bool overWrite = True; |
---|
110 | Bool degLast = False; |
---|
111 | Bool reallyVerbose = False; |
---|
112 | String errMsg; |
---|
113 | |
---|
114 | |
---|
115 | Block<String> cols(5); |
---|
116 | cols[0] = String("SCANNO"); |
---|
117 | cols[1] = String("CYCLENO"); |
---|
118 | cols[2] = String("BEAMNO"); |
---|
119 | cols[3] = String("IFNO"); |
---|
120 | cols[4] = String("POLNO"); |
---|
121 | TableIterator iter(tab, cols); |
---|
122 | // Open data file |
---|
123 | |
---|
124 | while ( !iter.pastEnd() ) { |
---|
125 | Table t = iter.table(); |
---|
126 | ROTableRow row(t); |
---|
127 | const TableRecord& rec = row.get(0); |
---|
128 | String dirtype = stable.getDirectionRefString(); |
---|
129 | ostringstream onstr; |
---|
130 | if (rootName.length()==0) { |
---|
131 | rootName = "fits"; |
---|
132 | } |
---|
133 | if (tab.nrow() > 1) { |
---|
134 | if (stable.nscan() > 1) |
---|
135 | onstr << "_SCAN" << rec.asuInt("SCANNO"); |
---|
136 | if (stable.ncycle(rec.asuInt("SCANNO")) > 1) |
---|
137 | onstr << "_CYCLE" << rec.asuInt("CYCLENO"); |
---|
138 | if (stable.nbeam(rec.asuInt("SCANNO")) > 1) |
---|
139 | onstr << "_BEAM" << rec.asuInt("BEAMNO"); |
---|
140 | if (stable.nif(rec.asuInt("SCANNO")) > 1) |
---|
141 | onstr << "_IF" << rec.asuInt("IFNO"); |
---|
142 | if (stable.npol(rec.asuInt("SCANNO")) > 1) |
---|
143 | onstr << "_POL" << rec.asuInt("POLNO"); |
---|
144 | } |
---|
145 | String fileName = rootName + String(onstr) + String(".fits"); |
---|
146 | int row0 = t.rowNumbers(tab)[0]; |
---|
147 | |
---|
148 | const MPosition& mp = stable.getAntennaPosition(); |
---|
149 | const MDirection& md = stable.getDirection(row0); |
---|
150 | const MEpoch& me = stable.getEpoch(row0); |
---|
151 | oi.setObsDate(me); |
---|
152 | |
---|
153 | const Double& rf = |
---|
154 | stable.molecules().getRestFrequency(rec.asuInt("MOLECULE_ID") ); |
---|
155 | SpectralCoordinate sC = |
---|
156 | stable.frequencies().getSpectralCoordinate(md, mp, me, rf, |
---|
157 | rec.asuInt("FREQ_ID")); |
---|
158 | |
---|
159 | Int polno = rec.asuInt("POLNO"); |
---|
160 | Stokes::StokesTypes stokes = |
---|
161 | Stokes::type(stable.getPolarizationLabel(polno, stable.getPolType())); |
---|
162 | Vector<Int> whichStokes(1); |
---|
163 | whichStokes(0) = Int(stokes); |
---|
164 | StokesCoordinate stC(whichStokes); |
---|
165 | |
---|
166 | |
---|
167 | CoordinateSystem cSys; |
---|
168 | Vector<Double> lonlat = md.getAngle().getValue(); |
---|
169 | DirectionCoordinate dC = |
---|
170 | getDirectionCoordinate(stable.getDirectionRefString(), |
---|
171 | lonlat[0], lonlat[1]); |
---|
172 | cSys.addCoordinate(sC); |
---|
173 | cSys.addCoordinate(dC); |
---|
174 | cSys.addCoordinate(stC); |
---|
175 | cSys.setObsInfo(oi); |
---|
176 | |
---|
177 | Vector<Float> spec = rec.asArrayFloat("SPECTRA"); |
---|
178 | Vector<uChar> flag = rec.asArrayuChar("FLAGTRA"); |
---|
179 | Vector<Bool> bflag(flag.shape()); |
---|
180 | convertArray(bflag, flag); |
---|
181 | |
---|
182 | // Create casacore Image |
---|
183 | IPosition shp(4, 1); |
---|
184 | shp(0)= spec.nelements(); |
---|
185 | TempImage<Float> tIm(shp, cSys); |
---|
186 | tIm.put(spec); |
---|
187 | ArrayLattice<Bool> latMask(shp); |
---|
188 | IPosition where(4,0); |
---|
189 | IPosition stride(4,1); |
---|
190 | latMask.putSlice(!bflag, where, stride); |
---|
191 | tIm.attachMask(latMask); |
---|
192 | if (isClass_) { |
---|
193 | preferVelocity = True; |
---|
194 | } |
---|
195 | Bool ok = ImageFITSConverter::ImageToFITS(errMsg, tIm, fileName, |
---|
196 | maxMem, preferVelocity, |
---|
197 | opticalVelocity, bitPix, |
---|
198 | minPix, maxPix, overWrite, |
---|
199 | degLast, reallyVerbose); |
---|
200 | if (!ok) { |
---|
201 | throw(AipsError(errMsg)); |
---|
202 | } |
---|
203 | |
---|
204 | int status = 0; |
---|
205 | fitsfile *fptr; |
---|
206 | if( fits_open_file(&fptr, fileName.c_str(), READWRITE, &status) ) |
---|
207 | throw AipsError("Coudn't open fits file for modification"); |
---|
208 | |
---|
209 | if (isClass_) { |
---|
210 | // Add CLASS specific information |
---|
211 | // Apply hacks to fits file so it can be read by class |
---|
212 | // modifications are |
---|
213 | // CTYPE1 : FREQ-XYZ -> FREQ |
---|
214 | // CRVAL1 : -> CRVAL1-RESTFREQ |
---|
215 | |
---|
216 | // Use preferVelocity which seems to work. |
---|
217 | // When no restfrequency is given this will set up the correct |
---|
218 | // frequency axis. Otherwise it uses a velocity axis |
---|
219 | char ctyp[84]; |
---|
220 | fits_read_key(fptr, TSTRING, "CTYPE1", ctyp, NULL, &status); |
---|
221 | if (String(ctyp).contains("FREQ", 0)) { |
---|
222 | float restf,refval; |
---|
223 | fits_read_key(fptr, TFLOAT, "CRVAL1", |
---|
224 | &refval, NULL, &status); |
---|
225 | restf = 0.0; |
---|
226 | if ( fits_update_key(fptr, TFLOAT, "CRVAL1", &restf, |
---|
227 | NULL, &status) ) { |
---|
228 | throw AipsError("Couldn't modify CRVAL1"); |
---|
229 | } |
---|
230 | if ( fits_update_key(fptr, TFLOAT, "RESTFREQ", &refval, |
---|
231 | NULL, &status) ) { |
---|
232 | throw AipsError("Couldn't modify RESTFREQ"); |
---|
233 | } |
---|
234 | } else { |
---|
235 | float refval = sC.referenceValue()[0]; |
---|
236 | if ( fits_update_key(fptr, TFLOAT, "RESTFREQ", &refval, |
---|
237 | NULL, &status) ) { |
---|
238 | throw AipsError("Couldn't modify RESTFREQ"); |
---|
239 | } |
---|
240 | |
---|
241 | } |
---|
242 | } |
---|
243 | |
---|
244 | Float tsys = stable.getTsys(row0); |
---|
245 | if ( fits_update_key(fptr, TFLOAT, "TSYS", &tsys, |
---|
246 | "System temperature", &status) ) { |
---|
247 | throw AipsError("Couldn't modify TSYS"); |
---|
248 | } |
---|
249 | Float otime = Float(stable.getIntTime(row0)); |
---|
250 | if ( fits_update_key(fptr, TFLOAT, "OBSTIME", &otime, |
---|
251 | "Integration time", &status) ) { |
---|
252 | throw AipsError("Couldn't modify OBSTIME"); |
---|
253 | } |
---|
254 | |
---|
255 | const char* oname = stable.getSourceName(row0).c_str(); |
---|
256 | if ( fits_update_key(fptr, TSTRING, "OBJECT", (char *)oname, |
---|
257 | NULL, &status) ) { |
---|
258 | throw AipsError("Couldn't modify OBJECT"); |
---|
259 | } |
---|
260 | Float elev = stable.getElevation(row0)/C::pi*180.0; |
---|
261 | if ( fits_update_key(fptr, TFLOAT, "ELEVATIO", &elev, |
---|
262 | "Telescope elevation (degrees)", &status) ) { |
---|
263 | throw AipsError("Couldn't modify ELEVATIO"); |
---|
264 | } |
---|
265 | Float azi = stable.getAzimuth(row0)/C::pi*180.0; |
---|
266 | if ( fits_update_key(fptr, TFLOAT, "AZIMUTH", &azi, |
---|
267 | "Telescope azimuth (degrees)", &status) ) { |
---|
268 | throw AipsError("Couldn't modify AZIMUTH"); |
---|
269 | } |
---|
270 | fits_close_file(fptr, &status); |
---|
271 | ostringstream oss; |
---|
272 | oss << "Wrote " << fileName; |
---|
273 | pushLog(String(oss)); |
---|
274 | //pushLog(String(oss)); |
---|
275 | ++iter; |
---|
276 | } |
---|
277 | return True; |
---|
278 | } |
---|
279 | |
---|
280 | DirectionCoordinate |
---|
281 | STFITSImageWriter::getDirectionCoordinate(const String& reff, |
---|
282 | Double lon, Double lat) |
---|
283 | { |
---|
284 | |
---|
285 | Projection proj(Projection::SIN); // What should we use ? |
---|
286 | Matrix<Double> xForm(2,2); |
---|
287 | xForm = 0.0; xForm.diagonal() = 1.0; |
---|
288 | Vector<Double> incLonLat(2,0.0); |
---|
289 | Vector<Double> refPixLonLat(2,0.0); |
---|
290 | MDirection::Types mdt; |
---|
291 | if (!MDirection::getType(mdt, reff)) { |
---|
292 | throw(AipsError("Illegal Direction frame.")); |
---|
293 | } |
---|
294 | return DirectionCoordinate(mdt, proj, lon, lat, |
---|
295 | incLonLat[0], incLonLat[1], xForm, |
---|
296 | refPixLonLat[0], refPixLonLat[1]); |
---|
297 | |
---|
298 | } |
---|
299 | |
---|