source: branches/asap-3.x/src/STWriter.cpp@ 2797

Last change on this file since 2797 was 1688, checked in by Malte Marquarding, 15 years ago

re-upcase flux unit name
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 11.3 KB
Line 
1//#---------------------------------------------------------------------------
2//# STWriter.cc: ASAP class to write out single dish spectra.
3//#---------------------------------------------------------------------------
4//# Copyright (C) 2004
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: STWriter.cpp 1688 2010-02-10 00:54:56Z MalteMarquarding $
30//#---------------------------------------------------------------------------
31
32#include <string>
33
34#include <casa/aips.h>
35#include <casa/Arrays/Array.h>
36#include <casa/Arrays/Vector.h>
37#include <casa/BasicSL/Complex.h>
38#include <casa/Utilities/CountedPtr.h>
39#include <casa/Utilities/Assert.h>
40
41#include <atnf/PKSIO/PKSrecord.h>
42#include <atnf/PKSIO/PKSMS2writer.h>
43#include <atnf/PKSIO/PKSSDwriter.h>
44
45#include <tables/Tables/Table.h>
46#include <tables/Tables/TableIter.h>
47#include <tables/Tables/TableRow.h>
48#include <tables/Tables/ArrayColumn.h>
49
50#include "STFITSImageWriter.h"
51#include "STAsciiWriter.h"
52#include "STHeader.h"
53#include "STMath.h"
54
55
56#include "STWriter.h"
57
58using namespace casa;
59namespace asap {
60
61STWriter::STWriter(const std::string &format)
62{
63 format_ = format;
64 String t(format_);
65 t.upcase();
66 if (t == "MS2") {
67 writer_ = new PKSMS2writer();
68 } else if (t == "SDFITS") {
69 writer_ = new PKSSDwriter();
70 } else if (t == "ASCII" || t == "FITS" || t == "CLASS") {
71 writer_ = 0;
72 } else {
73 throw (AipsError("Unrecognized export format"));
74 }
75}
76
77STWriter::~STWriter()
78{
79 if (writer_) {
80 delete writer_;
81 }
82}
83
84Int STWriter::setFormat(const std::string &format)
85{
86 if (format != format_) {
87 if (writer_) delete writer_;
88 }
89
90 format_ = format;
91 String t(format_);
92 t.upcase();
93 if (t== "MS2") {
94 writer_ = new PKSMS2writer();
95 } else if (t== "SDFITS") {
96 writer_ = new PKSSDwriter();
97 } else if (t == "ASCII" || t == "FITS" || t == "CLASS") {
98 writer_ = 0;
99 } else {
100 throw (AipsError("Unrecognized Format"));
101 }
102 return 0;
103}
104
105Int STWriter::write(const CountedPtr<Scantable> in,
106 const std::string &filename)
107{
108 // If we write out foreign formats we have to convert the frequency system
109 // into the output frame, as we do everything related to SPectarlCoordinates
110 // in asap on-the-fly.
111
112 CountedPtr<Scantable> inst = in;
113 if (in->frequencies().getFrame(true) != in->frequencies().getFrame(false)) {
114 STMath stm(false);
115 inst = stm.frequencyAlign(in);
116 }
117
118 if (format_=="ASCII") {
119 STAsciiWriter iw;
120 // ASCII calls SpectralCoordinate::toWorld so no freqAlign use 'in'
121 if (iw.write(*in, filename)) {
122 return 0;
123 } else {
124 return 1;
125 }
126 } else if ( format_ == "FITS" || format_ == "CLASS") {
127 STFITSImageWriter iw;
128 if (format_ == "CLASS") {
129 iw.setClass(True);
130 }
131 if (iw.write(*inst, filename)) {
132 return 0;
133 }
134 }
135
136 // MS or SDFITS
137
138 // Extract the header from the table.
139 // this is a little different from what I have done
140 // before. Need to check with the Offline User Test data
141 STHeader hdr = inst->getHeader();
142 //const Int nPol = hdr.npol;
143 //const Int nChan = hdr.nchan;
144 std::vector<uint> ifs = inst->getIFNos();
145 int nIF = inst->nif();//ifs.size();
146 Vector<uInt> nPol(nIF),nChan(nIF);
147 Vector<Bool> havexpol(nIF);
148 String fluxUnit = hdr.fluxunit;
149 fluxUnit.upcase();
150 nPol = 0;nChan = 0; havexpol = False;
151 for (uint i=0;i<ifs.size();++i) {
152 nPol(ifs[i]) = inst->npol();
153 nChan(ifs[i]) = inst->nchan(ifs[i]);
154 havexpol(ifs[i]) = nPol(ifs[i]) > 2;
155 }
156 Vector<String> obstypes(2);
157 obstypes(0) = "TR";//on
158 obstypes(1) = "RF TR";//off
159 const Table table = inst->table();
160
161
162 // Create the output file and write static data.
163 Int status;
164 status = writer_->create(String(filename), hdr.observer, hdr.project,
165 hdr.antennaname, hdr.antennaposition,
166 hdr.obstype, hdr.fluxunit,
167 hdr.equinox, hdr.freqref,
168 nChan, nPol, havexpol, False);
169 if ( status ) {
170 throw(AipsError("Failed to create output file"));
171 }
172
173 Int count = 0;
174 PKSrecord pksrec;
175 pksrec.scanNo = 1;
176 // use spearate iterators to ensure renumbering of all numbers
177 TableIterator scanit(table, "SCANNO");
178 while (!scanit.pastEnd() ) {
179 Table stable = scanit.table();
180 TableIterator beamit(stable, "BEAMNO");
181 pksrec.beamNo = 1;
182 while (!beamit.pastEnd() ) {
183 Table btable = beamit.table();
184 TableIterator cycit(btable, "CYCLENO");
185 ROArrayColumn<Double> srateCol(btable, "SCANRATE");
186 Vector<Double> sratedbl;
187 srateCol.get(0, sratedbl);
188 Vector<Float> srateflt(sratedbl.nelements());
189 convertArray(srateflt, sratedbl);
190 pksrec.scanRate = srateflt;
191 ROArrayColumn<Double> spmCol(btable, "SRCPROPERMOTION");
192 spmCol.get(0, pksrec.srcPM);
193 ROArrayColumn <Double> sdirCol(btable, "SRCDIRECTION");
194 sdirCol.get(0, pksrec.srcDir);
195 ROScalarColumn<Double> svelCol(btable, "SRCVELOCITY");
196 svelCol.get(0, pksrec.srcVel);
197 ROScalarColumn<uInt> bCol(btable, "BEAMNO");
198 pksrec.beamNo = bCol(0)+1;
199 pksrec.cycleNo = 1;
200 while (!cycit.pastEnd() ) {
201 Table ctable = cycit.table();
202 TableIterator ifit(ctable, "IFNO");
203 MDirection::ScalarColumn dirCol(ctable, "DIRECTION");
204 pksrec.direction = dirCol(0).getAngle("rad").getValue();
205 pksrec.IFno = 1;
206 while (!ifit.pastEnd() ) {
207 Table itable = ifit.table();
208 TableRow row(itable);
209 // use the first row to fill in all the "metadata"
210 const TableRecord& rec = row.get(0);
211 ROArrayColumn<Float> specCol(itable, "SPECTRA");
212 pksrec.IFno = rec.asuInt("IFNO")+1;
213 uInt nchan = specCol(0).nelements();
214 Double crval,crpix;
215 Float tmp0,tmp1,tmp2,tmp3,tmp4;
216 String stmp0,stmp1;
217 inst->frequencies().getEntry(crpix,crval, pksrec.freqInc,
218 rec.asuInt("FREQ_ID"));
219 inst->focus().getEntry(pksrec.parAngle, pksrec.focusAxi, pksrec.focusTan,
220 pksrec.focusRot, tmp0,tmp1,tmp2,tmp3,tmp4,
221 rec.asuInt("FOCUS_ID"));
222 inst->molecules().getEntry(pksrec.restFreq,stmp0,stmp1,
223 rec.asuInt("MOLECULE_ID"));
224 inst->tcal().getEntry(pksrec.tcalTime, pksrec.tcal,
225 rec.asuInt("TCAL_ID"));
226 inst->weather().getEntry(pksrec.temperature, pksrec.pressure,
227 pksrec.humidity, pksrec.windSpeed,
228 pksrec.windAz, rec.asuInt("WEATHER_ID"));
229 Double pixel = Double(nchan/2);
230 pksrec.refFreq = (pixel-crpix)*pksrec.freqInc + crval;
231 // ok, now we have nrows for the n polarizations in this table
232 polConversion(pksrec.spectra, pksrec.flagged, pksrec.xPol, itable);
233 pksrec.tsys = tsysFromTable(itable);
234 // dummy data
235 uInt npol = pksrec.spectra.ncolumn();
236
237 pksrec.mjd = rec.asDouble("TIME");
238 pksrec.interval = rec.asDouble("INTERVAL");
239 pksrec.fieldName = rec.asString("FIELDNAME");
240 pksrec.srcName = rec.asString("SRCNAME");
241 pksrec.obsType = obstypes[rec.asInt("SRCTYPE")];
242 pksrec.bandwidth = nchan * abs(pksrec.freqInc);
243 pksrec.azimuth = rec.asFloat("AZIMUTH");
244 pksrec.elevation = rec.asFloat("ELEVATION");
245 pksrec.refBeam = rec.asInt("REFBEAMNO") + 1;
246 pksrec.sigma.resize(npol);
247 pksrec.sigma = 0.0f;
248 pksrec.calFctr.resize(npol);
249 pksrec.calFctr = 0.0f;
250 pksrec.baseLin.resize(npol,2);
251 pksrec.baseLin = 0.0f;
252 pksrec.baseSub.resize(npol,9);
253 pksrec.baseSub = 0.0f;
254 pksrec.xCalFctr = 0.0;
255
256 status = writer_->write(pksrec);
257 if ( status ) {
258 writer_->close();
259 throw(AipsError("STWriter: Failed to export Scantable."));
260 }
261 ++count;
262 //++pksrec.IFno;
263 ++ifit;
264 }
265 ++pksrec.cycleNo;
266 ++cycit;
267 }
268 //++pksrec.beamNo;
269 ++beamit;
270 }
271 ++pksrec.scanNo;
272 ++scanit;
273 }
274 ostringstream oss;
275 oss << "STWriter: wrote " << count << " rows to " << filename;
276 pushLog(String(oss));
277 writer_->close();
278 //if MS2 delete POINTING table exists and copy the one in the keyword
279 if ( format_ == "MS2" ) {
280 replacePtTab(table, filename);
281 }
282 return 0;
283}
284
285Vector<Float> STWriter::tsysFromTable(const Table& tab)
286{
287 ROArrayColumn<Float> tsysCol(tab, "TSYS");
288 Vector<Float> out(tab.nrow());
289 Vector<Float> tmp;
290 for (uInt i=0; i<tab.nrow(); ++i) {
291 tmp.resize();
292 tmp = tsysCol(i);
293 out[i] = tmp[0];
294 }
295 return out;
296}
297
298void STWriter::polConversion( Matrix< Float >& specs, Matrix< uChar >& flags,
299 Vector< Complex > & xpol, const Table & tab )
300{
301 String poltype = tab.keywordSet().asString("POLTYPE");
302// Full stokes is not supported. Just allow stokes I
303 if ( poltype == "stokes" && tab.nrow() != 1) {
304 String msg = "poltype = " + poltype + " not yet supported in output.";
305 throw(AipsError(msg));
306 }
307 ROArrayColumn<Float> specCol(tab, "SPECTRA");
308 ROArrayColumn<uChar> flagCol(tab, "FLAGTRA");
309 uInt nchan = specCol(0).nelements();
310 uInt ncol = (tab.nrow()==1 ? 1: 2 );
311 specs.resize(nchan, ncol);
312 flags.resize(nchan, ncol);
313 // the linears
314 for (uInt i=0; i<ncol; ++i) {
315 specs.column(i) = specCol(i);
316 flags.column(i) = flagCol(i);
317 }
318 // now the complex if exists
319 Bool hasxpol = False;
320 xpol.resize();
321 if ( tab.nrow() == 4 ) {
322 hasxpol = True;
323 xpol.resize(nchan);
324 Vector<Float> reals, imags;
325 reals = specCol(2); imags = specCol(3);
326 for (uInt k=0; k < nchan; ++k) {
327 xpol[k] = Complex(reals[k], imags[k]);
328 }
329 }
330}
331
332// For writing MS data, if there is the reference to
333// original pointing table it replace it by it.
334void STWriter::replacePtTab (const Table& tab, const std::string& fname)
335{
336 String oldPtTabName = fname;
337 oldPtTabName.append("/POINTING");
338 if ( tab.keywordSet().isDefined("POINTING") ) {
339 String PointingTab = tab.keywordSet().asString("POINTING");
340 if ( Table::isReadable(PointingTab) ) {
341 Table newPtTab(PointingTab, Table::Old);
342 newPtTab.copy(oldPtTabName, Table::New);
343 ostringstream oss;
344 oss << "STWriter: copied " <<PointingTab << " to " << fname;
345 pushLog(String(oss));
346 }
347 }
348}
349
350}
Note: See TracBrowser for help on using the repository browser.