File: wscleaninterface.cpp

package info (click to toggle)
wsclean 3.6-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 16,296 kB
  • sloc: cpp: 129,246; python: 22,066; sh: 360; ansic: 230; makefile: 185
file content (382 lines) | stat: -rw-r--r-- 14,648 bytes parent folder | download | duplicates (2)
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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
#include "wscleaninterface.h"

#include "../main/commandline.h"
#include "../main/wsclean.h"

#include <aocommon/banddata.h>
#include <aocommon/fits/fitsreader.h>
#include <aocommon/fits/fitswriter.h>
#include <aocommon/units/angle.h>

#include <string>

#include <casacore/ms/MeasurementSets/MeasurementSet.h>

using aocommon::units::Angle;

struct WSCleanUserData {
  std::string msPath;
  unsigned int width;
  unsigned int height;
  double pixelScaleX;
  double pixelScaleY;
  unsigned int doNormalize;
  std::string extraParameters;

  std::string dataColumn;
  size_t nACalls, nAtCalls;

  std::mutex mutex;
};

template <typename T>
std::string str(T i) {
  std::ostringstream s;
  s << i;
  return s.str();
}

void wsclean_main(const std::vector<std::string>& parms) {
  std::vector<const char*> argv(parms.size());
  for (size_t i = 0; i != parms.size(); ++i) {
    std::cout << parms[i] << ' ';
    argv[i] = const_cast<char*>(parms[i].c_str());
  }
  std::cout << '\n';

  wsclean::WSClean wsclean;
  if (wsclean::CommandLine::Parse(wsclean, parms.size(), argv.data(), false))
    wsclean::CommandLine::Run(wsclean);
}

void wsclean_initialize(void** userData, const imaging_parameters* parameters,
                        imaging_data* imgData) {
  WSCleanUserData* wscUserData = new WSCleanUserData();
  std::lock_guard<std::mutex> lock(wscUserData->mutex);

  wscUserData->msPath = parameters->msPath;
  wscUserData->width = parameters->imageWidth;
  wscUserData->height = parameters->imageHeight;
  wscUserData->pixelScaleX = parameters->pixelScaleX;
  wscUserData->pixelScaleY = parameters->pixelScaleY;
  wscUserData->extraParameters = parameters->extraParameters;
  wscUserData->nACalls = 0;
  wscUserData->nAtCalls = 0;
  wscUserData->doNormalize = parameters->doNormalize;
  (*userData) = static_cast<void*>(wscUserData);

  // Number of vis is nchannels x selected nrows; calculate both.
  // (Assuming Stokes I polarization for now)
  casacore::MeasurementSet ms(wscUserData->msPath);
  casacore::ScalarColumn<int> a1Col(ms, casacore::MeasurementSet::columnName(
                                            casacore::MSMainEnums::ANTENNA1));
  casacore::ScalarColumn<int> a2Col(ms, casacore::MeasurementSet::columnName(
                                            casacore::MSMainEnums::ANTENNA2));
  aocommon::BandData bandData(ms.spectralWindow());
  size_t nChannel = bandData.ChannelCount();
  size_t selectedRows = 0;
  for (size_t row = 0; row != ms.nrow(); ++row) {
    if (a1Col(row) != a2Col(row)) ++selectedRows;
  }

  imgData->dataSize = selectedRows * nChannel;
  imgData->lhs_data_type = imaging_data::DATA_TYPE_COMPLEX_DOUBLE;
  imgData->rhs_data_type = imaging_data::DATA_TYPE_DOUBLE;
  // data_info->deinitialize_function = wsclean_deinitialize;
  // data_info->read_function = wsclean_read;
  // data_info->write_function = wsclean_write;
  // data_info->operator_A_function = wsclean_operator_A;
  // data_info->operator_At_function = wsclean_operator_At;

  bool hasCorrected = ms.tableDesc().isColumn("CORRECTED_DATA");
  if (hasCorrected) {
    std::cout << "First measurement set has corrected data: tasks will be "
                 "applied on the corrected data column.\n";
    wscUserData->dataColumn = "CORRECTED_DATA";
  } else {
    std::cout << "No corrected data in first measurement set: tasks will be "
                 "applied on the data column.\n";
    wscUserData->dataColumn = "DATA";
  }
}

void wsclean_deinitialize(void* userData) {
  WSCleanUserData* wscUserData = static_cast<WSCleanUserData*>(userData);
  std::lock_guard<std::mutex> lock(wscUserData->mutex);
  if (wscUserData->nAtCalls != 0) std::remove("tmp-operator-At-0-image.fits");

  delete wscUserData;
}

void wsclean_read(void* userData, DCOMPLEX* data, double* weights) {
  WSCleanUserData* wscUserData = static_cast<WSCleanUserData*>(userData);
  std::lock_guard<std::mutex> lock(wscUserData->mutex);

  casacore::MeasurementSet ms(wscUserData->msPath);
  aocommon::BandData bandData(ms.spectralWindow());
  size_t nChannels = bandData.ChannelCount();

  casacore::ScalarColumn<int> a1Col(ms, casacore::MeasurementSet::columnName(
                                            casacore::MSMainEnums::ANTENNA1));
  casacore::ScalarColumn<int> a2Col(ms, casacore::MeasurementSet::columnName(
                                            casacore::MSMainEnums::ANTENNA2));

  casacore::ArrayColumn<casacore::Complex> dataCol(ms, wscUserData->dataColumn);
  casacore::ArrayColumn<float> weightCol(
      ms, casacore::MeasurementSet::columnName(
              casacore::MSMainEnums::WEIGHT_SPECTRUM));
  casacore::ArrayColumn<bool> flagCol(
      ms, casacore::MeasurementSet::columnName(casacore::MSMainEnums::FLAG));

  DCOMPLEX* dataPtr = data;
  double* weightPtr = weights;
  casacore::IPosition shape = dataCol.shape(0);
  size_t polarizationCount = shape[0];
  casacore::Array<casacore::Complex> dataArr(shape);
  casacore::Array<bool> flagArr(shape);
  casacore::Array<float> weightArr(shape);
  for (size_t row = 0; row != ms.nrow(); ++row) {
    if (a1Col(row) != a2Col(row)) {
      dataCol.get(row, dataArr);
      flagCol.get(row, flagArr);
      weightCol.get(row, weightArr);

      casacore::Array<casacore::Complex>::const_contiter di = dataArr.cbegin();
      casacore::Array<bool>::const_contiter fi = flagArr.cbegin();
      casacore::Array<float>::const_contiter wi = weightArr.cbegin();

      for (size_t ch = 0; ch != nChannels; ++ch) {
        // TODO this only works for XX/YY and LL/RR pol, but not if
        // MS contains IQUV
        std::complex<double> val =
            0.5 * (std::complex<double>(*di) +
                   std::complex<double>(*(di + polarizationCount - 1)));
        double weight = 0.5 * (double(*wi) + (*wi + polarizationCount - 1));
        bool flag = *fi || *(fi + polarizationCount - 1);
        if (!std::isfinite(val.real()) || !std::isfinite(val.imag())) {
          val = 0.0;
          weight = 0.0;
        }

        dataPtr[ch] = val;
        weightPtr[ch] = flag ? 0.0 : weight;

        di += polarizationCount;
        fi += polarizationCount;
        wi += polarizationCount;
      }
      dataPtr += nChannels;
      weightPtr += nChannels;
    }
  }
}

void wsclean_write(void* userData, const char* filename, const double* image) {
  WSCleanUserData* wscUserData = static_cast<WSCleanUserData*>(userData);
  std::lock_guard<std::mutex> lock(wscUserData->mutex);

  std::cout << "wsclean_write() : Writing " << filename << "...\n";
  aocommon::FitsWriter writer;
  writer.SetImageDimensions(wscUserData->width, wscUserData->height,
                            wscUserData->pixelScaleX, wscUserData->pixelScaleY);
  if (wscUserData->nAtCalls != 0) {
    aocommon::FitsReader reader("tmp-operator-At-0-image.fits");
    writer = aocommon::FitsWriter(reader);
  }
  writer.Write(filename, image);
}

void getCommandLine(std::vector<std::string>& commandline,
                    const WSCleanUserData& userData) {
  commandline.push_back("wsclean");
  commandline.push_back("-size");
  commandline.push_back(str(userData.width));
  commandline.push_back(str(userData.height));
  commandline.push_back("-scale");
  commandline.push_back(Angle::ToNiceString(userData.pixelScaleX));
  commandline.push_back("-quiet");
  // commandline.push_back("-v");
  if (!userData.extraParameters.empty()) {
    size_t pos = 0;
    size_t nextPos = userData.extraParameters.find(' ', 0);
    while (nextPos != std::string::npos) {
      commandline.push_back(
          userData.extraParameters.substr(pos, nextPos - pos));
      pos = nextPos + 1;
      nextPos = userData.extraParameters.find(' ', pos);
    }
    commandline.push_back(userData.extraParameters.substr(pos));
  }
  if (userData.pixelScaleX != userData.pixelScaleY)
    throw std::runtime_error(
        "pixelscaleX should be equal to pixelscaleY for WSClean");
}

// Go from image to visibilities
// dataIn :  double[] of size width*height
// dataOut : complex double[] of size nvis: nchannels x nbaselines x ntimesteps
void wsclean_operator_A(void* userData, DCOMPLEX* dataOut,
                        const double* dataIn) {
  WSCleanUserData* wscUserData = static_cast<WSCleanUserData*>(userData);
  std::lock_guard<std::mutex> lock(wscUserData->mutex);

  std::cout << "------ wsclean_operator_A(), image: " << wscUserData->width
            << " x " << wscUserData->height
            << ", pixelscale=" << Angle::ToNiceString(wscUserData->pixelScaleX)
            << "," << Angle::ToNiceString(wscUserData->pixelScaleY) << '\n';

  // Remove non-finite values
  // TODO skipped now -- can't change input array without making a copy
  size_t nonFiniteValues = 0;
  for (size_t i = 0; i != wscUserData->width * wscUserData->height; ++i) {
    if (!std::isfinite(dataIn[i])) {
      // dataIn[i] = 0.0;
      ++nonFiniteValues;
    }
  }
  if (nonFiniteValues != 0)
    std::cout << "Warning: input image contains " << nonFiniteValues
              << " non-finite values!\n";

  std::ostringstream filenameStr;
  filenameStr << "tmp-operator-A-" << wscUserData->nACalls;

  // Write dataIn to a fits file
  aocommon::FitsWriter writer;
  writer.SetImageDimensions(wscUserData->width, wscUserData->height,
                            wscUserData->pixelScaleX, wscUserData->pixelScaleY);
  writer.Write(filenameStr.str() + "-model.fits", dataIn);

  // Run WSClean -predict (creates/fills new column MODEL_DATA)
  std::vector<std::string> commandline;
  getCommandLine(commandline, *wscUserData);
  commandline.push_back("-name");
  commandline.push_back(filenameStr.str());
  commandline.push_back("-predict");
  commandline.push_back(wscUserData->msPath);
  wsclean_main(commandline);
  std::remove((filenameStr.str() + "-model.fits").c_str());

  // Read MODEL_DATA into dataOut
  casacore::MeasurementSet ms(wscUserData->msPath);
  aocommon::BandData bandData(ms.spectralWindow());
  size_t nChannels = bandData.ChannelCount();

  casacore::ScalarColumn<int> a1Col(ms, casacore::MeasurementSet::columnName(
                                            casacore::MSMainEnums::ANTENNA1));
  casacore::ScalarColumn<int> a2Col(ms, casacore::MeasurementSet::columnName(
                                            casacore::MSMainEnums::ANTENNA2));

  casacore::ArrayColumn<casacore::Complex> dataCol(
      ms,
      casacore::MeasurementSet::columnName(casacore::MSMainEnums::MODEL_DATA));

  DCOMPLEX* dataPtr = (DCOMPLEX*)dataOut;
  casacore::IPosition shape = dataCol.shape(0);

  size_t polarizationCount = shape[0];
  casacore::Array<casacore::Complex> dataArr(shape);
  for (size_t row = 0; row != ms.nrow(); ++row) {
    if (a1Col(row) != a2Col(row)) {
      dataCol.get(row, dataArr);
      casacore::Array<casacore::Complex>::contiter di = dataArr.cbegin();

      for (size_t ch = 0; ch != nChannels; ++ch) {
        dataPtr[ch] =
            0.5 * (std::complex<double>(*di) +
                   std::complex<double>(*(di + polarizationCount - 1)));
        // This *might* change the weighting; but if a value is not finite, it
        // should already have received zero weight during the initial read out.
        if (!std::isfinite(dataPtr[ch].real()) ||
            !std::isfinite(dataPtr[ch].imag()))
          dataPtr[ch] = 0.0;
        di += polarizationCount;
      }

      dataPtr += nChannels;
    }
  }
  ++(wscUserData->nACalls);
  std::cout << "------ end of wsclean_operator_A()\n";
}

// Go from visibilities to image
void wsclean_operator_At(void* userData, double* dataOut,
                         const DCOMPLEX* dataIn) {
  WSCleanUserData* wscUserData = static_cast<WSCleanUserData*>(userData);
  std::lock_guard<std::mutex> lock(wscUserData->mutex);

  // Write dataIn to the MODEL_DATA column
  std::cout << "------ wsclean_operator_At(), image: " << wscUserData->width
            << " x " << wscUserData->height
            << ", pixelscale=" << Angle::ToNiceString(wscUserData->pixelScaleX)
            << "," << Angle::ToNiceString(wscUserData->pixelScaleY) << '\n';
  casacore::MeasurementSet ms(wscUserData->msPath, casacore::Table::Update);
  aocommon::BandData bandData(ms.spectralWindow());
  size_t nChannels = bandData.ChannelCount();

  casacore::ScalarColumn<int> a1Col(ms, casacore::MeasurementSet::columnName(
                                            casacore::MSMainEnums::ANTENNA1));
  casacore::ScalarColumn<int> a2Col(ms, casacore::MeasurementSet::columnName(
                                            casacore::MSMainEnums::ANTENNA2));

  casacore::ArrayColumn<casacore::Complex> dataCol(
      ms,
      casacore::MeasurementSet::columnName(casacore::MSMainEnums::MODEL_DATA));

  DCOMPLEX* dataPtr = (DCOMPLEX*)dataIn;
  casacore::IPosition shape = dataCol.shape(0);
  size_t polarizationCount = shape[0];
  casacore::Array<casacore::Complex> dataArr(shape);
  for (size_t row = 0; row != ms.nrow(); ++row) {
    if (a1Col(row) != a2Col(row)) {
      dataCol.get(row, dataArr);
      casacore::Array<casacore::Complex>::contiter di = dataArr.cbegin();

      for (size_t ch = 0; ch != nChannels; ++ch) {
        *di = std::complex<float>(dataPtr[ch]);
        *(di + polarizationCount - 1) = std::complex<float>(dataPtr[ch]);
        di += polarizationCount;
      }

      dataCol.put(row, dataArr);
      dataPtr += nChannels;
    }
  }

  std::ostringstream prefixName;
  prefixName << "tmp-operator-At-" << wscUserData->nAtCalls;

  // Run WSClean to create dirty image
  std::vector<std::string> commandline;
  getCommandLine(commandline, *wscUserData);
  commandline.push_back("-name");
  commandline.push_back(prefixName.str());
  commandline.push_back("-data-column");
  commandline.push_back("MODEL_DATA");
  commandline.push_back("-no-dirty");
  commandline.push_back(wscUserData->msPath);
  wsclean_main(commandline);

  // Read dirty image and store in dataOut
  aocommon::FitsReader reader(prefixName.str() + "-image.fits");
  reader.Read(dataOut);
  if (wscUserData->doNormalize == 0) {
    size_t n = wscUserData->width * wscUserData->height;
    double normf;
    if (reader.ReadDoubleKeyIfExists("WSCNORMF", normf)) {
      for (size_t i = 0; i != n; ++i) dataOut[i] *= normf;
    } else {
      std::cout << "WSCNORMF keyword not found in fits file.\n";
    }
  }
  // Image 0 is saved until the end to retrieve keywords from...
  if (wscUserData->nAtCalls != 0)
    std::remove((prefixName.str() + "-image.fits").c_str());
  ++(wscUserData->nAtCalls);
  std::cout << "------ end of wsclean_operator_At()\n";
}

double wsclean_parse_angle(const char* angle) {
  return Angle::Parse(angle, "angle", Angle::kDegrees);
}