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
|
#include "wscfitswriter.h"
#include <wscversion.h>
#include "imagefilename.h"
#include <aocommon/fits/fitsreader.h>
#include <schaapcommon/math/restoreimage.h>
#include "../math/renderer.h"
#include "../model/bbsmodel.h"
#include "../gridding/msgridder.h"
namespace wsclean {
WSCFitsWriter::WSCFitsWriter(
const ImagingTableEntry& entry, bool isImaginary, const Settings& settings,
const std::optional<radler::Radler>& deconvolution,
const ObservationInfo& observationInfo, double l_shift, double m_shift,
size_t majorIterationNr, const std::string& commandLine,
const OutputChannelInfo& channelInfo, bool isModel, double startTime) {
_filenamePrefix = ImageFilename::GetPrefix(
settings, entry.polarization, entry.outputChannelIndex,
entry.outputIntervalIndex, isImaginary);
setGridderConfiguration(settings, observationInfo, l_shift, m_shift,
startTime);
setSettingsKeywords(settings, commandLine);
setChannelKeywords(entry, entry.polarization, channelInfo);
setDeconvolutionKeywords(settings);
if (deconvolution.has_value() && deconvolution->IsInitialized()) {
setDeconvolutionResultKeywords(deconvolution->IterationNumber(),
majorIterationNr);
}
if (isModel) _writer.SetUnit(aocommon::FitsWriter::JanskyPerPixel);
}
WSCFitsWriter::WSCFitsWriter(
const ImagingTableEntry& entry, aocommon::PolarizationEnum polarization,
bool isImaginary, const Settings& settings,
const std::optional<radler::Radler>& deconvolution,
const ObservationInfo& observationInfo, double l_shift, double m_shift,
size_t majorIterationNr, const std::string& commandLine,
const OutputChannelInfo& channelInfo, bool isModel, double startTime) {
_filenamePrefix =
ImageFilename::GetPrefix(settings, polarization, entry.outputChannelIndex,
entry.outputIntervalIndex, isImaginary);
setGridderConfiguration(settings, observationInfo, l_shift, m_shift,
startTime);
setSettingsKeywords(settings, commandLine);
setChannelKeywords(entry, polarization, channelInfo);
setDeconvolutionKeywords(settings);
if (deconvolution.has_value() && deconvolution->IsInitialized()) {
setDeconvolutionResultKeywords(deconvolution->IterationNumber(),
majorIterationNr);
}
if (isModel) _writer.SetUnit(aocommon::FitsWriter::JanskyPerPixel);
}
WSCFitsWriter::WSCFitsWriter(aocommon::FitsReader& templateReader)
: _writer(templateReader) {
copyWSCleanKeywords(templateReader);
}
WSCFitsWriter::WSCFitsWriter(const aocommon::FitsWriter& writer)
: _writer(writer) {}
void WSCFitsWriter::setSettingsKeywords(const Settings& settings,
const std::string& commandLine) {
_writer.SetOrigin("WSClean", "W-stacking imager written by Andre Offringa");
_writer.AddHistory(commandLine);
_writer.SetExtraKeyword("WSCVERSI", WSCLEAN_VERSION_STR);
_writer.SetExtraKeyword("WSCVDATE", WSCLEAN_VERSION_DATE);
if (settings.endChannel != 0) {
_writer.SetExtraKeyword("WSCCHANS", settings.startChannel);
_writer.SetExtraKeyword("WSCCHANE", settings.endChannel);
}
if (settings.endTimestep != 0) {
_writer.SetExtraKeyword("WSCTIMES", settings.startTimestep);
_writer.SetExtraKeyword("WSCTIMEE", settings.endTimestep);
}
_writer.SetExtraKeyword("WSCFIELD", settings.fieldIds[0]);
}
void WSCFitsWriter::setGridderConfiguration(
const Settings& settings, const ObservationInfo& observationInfo,
double l_shift, double m_shift, double startTime) {
_writer.SetImageDimensions(
settings.trimmedImageWidth, settings.trimmedImageHeight,
observationInfo.phaseCentreRA, observationInfo.phaseCentreDec,
settings.pixelScaleX, settings.pixelScaleY);
_writer.SetDate(startTime);
_writer.SetPhaseCentreShift(l_shift, m_shift);
_writer.SetTelescopeName(observationInfo.telescopeName);
_writer.SetObserver(observationInfo.observer);
_writer.SetObjectName(observationInfo.fieldName);
_writer.SetExtraKeyword("WSCDATAC", settings.dataColumnName);
_writer.SetExtraKeyword("WSCWEIGH", settings.weightMode.ToString());
_writer.SetExtraKeyword("WSCGKRNL", settings.antialiasingKernelSize);
}
void WSCFitsWriter::setDeconvolutionKeywords(const Settings& settings) {
_writer.SetExtraKeyword("WSCNITER", settings.deconvolutionIterationCount);
if (settings.absoluteDeconvolutionThreshold)
_writer.SetExtraKeyword("WSCTHRES",
*settings.absoluteDeconvolutionThreshold);
_writer.SetExtraKeyword("WSCGAIN", settings.deconvolutionGain);
_writer.SetExtraKeyword("WSCMGAIN", settings.deconvolutionMGain);
_writer.SetExtraKeyword("WSCNEGCM", settings.allowNegativeComponents);
_writer.SetExtraKeyword("WSCNEGST", settings.stopOnNegativeComponents);
}
void WSCFitsWriter::setDeconvolutionResultKeywords(size_t minorIterationNr,
size_t majorIterationNr) {
_writer.SetExtraKeyword("WSCMINOR", minorIterationNr);
_writer.SetExtraKeyword("WSCMAJOR", majorIterationNr);
}
void WSCFitsWriter::setChannelKeywords(const ImagingTableEntry& entry,
aocommon::PolarizationEnum polarization,
const OutputChannelInfo& channelInfo) {
const double bandStart = entry.bandStartFrequency,
bandEnd = entry.bandEndFrequency,
centreFrequency = 0.5 * (bandStart + bandEnd),
bandwidth = bandEnd - bandStart;
_writer.SetFrequency(centreFrequency, bandwidth);
_writer.SetExtraKeyword("WSCIMGWG", channelInfo.weight);
/* This is the normalization factor that was applied. The factor is useful
* to undo the normalization for e.g. conversion to Kelvins. */
_writer.SetExtraKeyword("WSCNORMF", channelInfo.normalizationFactor);
_writer.SetExtraKeyword("WSCNWLAY", channelInfo.wGridSize);
_writer.SetExtraKeyword("WSCNVIS", channelInfo.visibilityCount);
_writer.SetExtraKeyword("WSCENVIS", channelInfo.effectiveVisibilityCount);
_writer.SetExtraKeyword("WSCVWSUM", channelInfo.visibilityWeightSum);
_writer.SetBeamInfo(channelInfo.beamMaj, channelInfo.beamMin,
channelInfo.beamPA);
_writer.SetPolarization(polarization);
}
void WSCFitsWriter::copyWSCleanKeywords(aocommon::FitsReader& reader) {
const size_t N_STRKEYWORDS = 4, N_DBLKEYWORDS = 20;
const char* strKeywords[N_STRKEYWORDS] = {"WSCVERSI", "WSCVDATE", "WSCDATAC",
"WSCWEIGH"};
const char* dblKeywords[N_DBLKEYWORDS] = {
"WSCIMGWG", "WSCNWLAY", "WSCGKRNL", "WSCCHANS", "WSCCHANE",
"WSCTIMES", "WSCTIMEE", "WSCFIELD", "WSCNITER", "WSCNORMF",
"WSCTHRES", "WSCGAIN", "WSCMGAIN", "WSCNEGCM", "WSCNEGST",
"WSCMINOR", "WSCMAJOR", "WSCNVIS", "WSCENVIS", "WSCVWSUM"};
for (size_t i = 0; i != N_STRKEYWORDS; ++i)
_writer.CopyStringKeywordIfExists(reader, strKeywords[i]);
for (size_t i = 0; i != N_DBLKEYWORDS; ++i)
_writer.CopyDoubleKeywordIfExists(reader, dblKeywords[i]);
}
void WSCFitsWriter::WriteImage(const std::string& suffix,
const aocommon::Image& image) {
std::string name = _filenamePrefix + '-' + suffix;
WriteFullNameImage(name, image);
}
void WSCFitsWriter::WriteFullNameImage(const std::string& fullname,
const aocommon::Image& image) {
if (image.Width() != _writer.Width() || image.Height() != _writer.Height()) {
aocommon::FitsWriter writer(_writer);
writer.SetImageDimensions(image.Width(), image.Height(), _writer.RA(),
_writer.Dec(), _writer.PixelSizeX(),
_writer.PixelSizeY());
if (_writer.LShift() || _writer.MShift()) {
writer.SetPhaseCentreShift(_writer.LShift(), _writer.MShift());
}
writer.Write(fullname, image.Data());
} else {
_writer.Write(fullname, image.Data());
}
}
void WSCFitsWriter::WriteFullNameImage(
const std::string& fullname, const aocommon::Image& image,
const schaapcommon::facets::Facet& facet) {
aocommon::FitsWriter writer(_writer);
writer.SetImageDimensions(image.Width(), image.Height(), _writer.RA(),
_writer.Dec(), _writer.PixelSizeX(),
_writer.PixelSizeY());
int centreShiftX =
facet.GetTrimmedBoundingBox().Centre().x - _writer.Width() / 2;
int centreShiftY =
facet.GetTrimmedBoundingBox().Centre().y - _writer.Height() / 2;
double l_shift = _writer.LShift() - centreShiftX * _writer.PixelSizeX();
double m_shift = _writer.MShift() + centreShiftY * _writer.PixelSizeY();
writer.SetPhaseCentreShift(l_shift, m_shift);
writer.Write(fullname, image.Data());
}
void WSCFitsWriter::WriteFullNameImage(
const std::string& fullname,
const schaapcommon::facets::FacetImage& facetimage) {
aocommon::FitsWriter writer(_writer);
writer.SetImageDimensions(facetimage.Width(), facetimage.Height(),
_writer.RA(), _writer.Dec(), _writer.PixelSizeX(),
_writer.PixelSizeY());
if (!facetimage.GetFacet()) {
throw std::runtime_error(
"WSCFitsWriter::WriteFullNameImage can not write a FacetImage when its "
"facet is not set.");
}
schaapcommon::facets::PixelPosition centre_pixel =
facetimage.GetFacet()->GetUntrimmedBoundingBox().Centre();
int centreShiftX = centre_pixel.x - _writer.Width() / 2;
int centreShiftY = centre_pixel.y - _writer.Height() / 2;
double l_shift = _writer.LShift() - centreShiftX * _writer.PixelSizeX();
double m_shift = _writer.MShift() + centreShiftY * _writer.PixelSizeY();
writer.SetPhaseCentreShift(l_shift, m_shift);
writer.Write(fullname, facetimage.Data(0));
}
template <typename NumT>
void WSCFitsWriter::WriteUV(const std::string& suffix, const NumT* image) {
std::string name = _filenamePrefix + '-' + suffix;
aocommon::FitsWriter::Unit unit = _writer.GetUnit();
_writer.SetIsUV(true);
_writer.SetUnit(aocommon::FitsWriter::Jansky);
_writer.Write(name, image);
_writer.SetIsUV(false);
_writer.SetUnit(unit);
}
template void WSCFitsWriter::WriteUV(const std::string& suffix,
const double* image);
template void WSCFitsWriter::WriteUV(const std::string& suffix,
const float* image);
void WSCFitsWriter::Restore(const Settings& settings) {
aocommon::FitsReader imgReader(settings.restoreInput),
modReader(settings.restoreModel);
if (imgReader.ImageWidth() != modReader.ImageWidth() ||
imgReader.ImageHeight() != modReader.ImageHeight())
throw std::runtime_error(
"Image and model images have different dimensions!");
aocommon::UVector<float> image(imgReader.ImageWidth() *
imgReader.ImageHeight()),
model(modReader.ImageWidth() * modReader.ImageHeight());
imgReader.Read(image.data());
modReader.Read(model.data());
double beamMaj, beamMin, beamPA;
if (settings.manualBeamMajorSize != 0.0) {
beamMaj = settings.manualBeamMajorSize;
beamMin = settings.manualBeamMinorSize;
beamPA = settings.manualBeamPA;
} else {
beamMaj = imgReader.BeamMajorAxisRad();
beamMin = imgReader.BeamMinorAxisRad();
beamPA = imgReader.BeamPositionAngle();
}
long double pixel_size_x = imgReader.PixelSizeX();
long double pixel_size_y = imgReader.PixelSizeY();
if (pixel_size_x == 0.0 || pixel_size_y == 0.0) {
pixel_size_x = settings.pixelScaleX;
pixel_size_y = settings.pixelScaleY;
if (pixel_size_x == 0.0 || pixel_size_y == 0.0) {
throw std::runtime_error(
"Input fits file specifies no pixel size and no -scale was given: "
"can't restore with no pixel size");
}
}
schaapcommon::math::RestoreImage(image.data(), model.data(),
imgReader.ImageWidth(),
imgReader.ImageHeight(), beamMaj, beamMin,
beamPA, pixel_size_x, pixel_size_y);
aocommon::FitsWriter writer(WSCFitsWriter(imgReader).Writer());
writer.SetBeamInfo(beamMaj, beamMin, beamPA);
writer.Write(settings.restoreOutput, image.data());
}
void WSCFitsWriter::RestoreList(const Settings& settings) {
const Model model = BBSModel::Read(settings.restoreModel);
aocommon::FitsReader imgReader(settings.restoreInput);
aocommon::Image image(imgReader.ImageWidth(), imgReader.ImageHeight());
imgReader.Read(image.Data());
double beamMaj, beamMin, beamPA;
if (settings.manualBeamMajorSize != 0.0) {
beamMaj = settings.manualBeamMajorSize;
beamMin = settings.manualBeamMinorSize;
beamPA = settings.manualBeamPA;
} else {
beamMaj = imgReader.BeamMajorAxisRad();
beamMin = imgReader.BeamMinorAxisRad();
beamPA = imgReader.BeamPositionAngle();
}
double frequency = imgReader.Frequency();
double bandwidth = imgReader.Bandwidth();
renderer::ImageCoordinateSettings imageSettings(imgReader);
renderer::RestoreWithEllipticalBeam(
image, imageSettings, model, beamMaj, beamMin, beamPA,
frequency - bandwidth * 0.5, frequency + bandwidth * 0.5,
aocommon::Polarization::StokesI);
aocommon::FitsWriter writer(WSCFitsWriter(imgReader).Writer());
writer.SetBeamInfo(beamMaj, beamMin, beamPA);
writer.Write(settings.restoreOutput, image.Data());
}
} // namespace wsclean
|
