/usr/include/casacore/ms/MSSel/MSSelector.h is in casacore-dev 2.2.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | //# MSSelector.h: this defines MSSelector, which specifies MS selections
//# Copyright (C) 1997,1998,1999,2000,2001
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//# Internet email: aips2-request@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
//#
//#
//# $Id$
#ifndef MS_MSSELECTOR_H
#define MS_MSSELECTOR_H
#include <casacore/casa/aips.h>
#include <casacore/casa/Arrays/Vector.h>
#include <casacore/casa/Arrays/Slice.h>
#include <casacore/casa/Arrays/Slicer.h>
#include <casacore/ms/MeasurementSets/MeasurementSet.h>
#include <casacore/ms/MeasurementSets/StokesConverter.h>
#include <casacore/ms/MSOper/MSDerivedValues.h>
#include <casacore/ms/MSSel/MSSelectionKeywords.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
template <class T> class ArrayColumn;
class Record;
class MSIter;
// <summary>
// MSSelector specifies selections on a MeasurementSet
// </summary>
// <use visibility=export>
// <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
// </reviewed>
// <prerequisite>
// <li> MeasurementSet
// <li> Record
// </prerequisite>
//
// <etymology>
// MSSelector's main function is selection of data from a MeasurementSet
// </etymology>
//
// <synopsis>
// This class is used to select and retrieve data from a MeasurementSet.
// It allows selections on e.g., time, field, spectral window (all row based),
// but also on channel and polarization (within a row). It can optionally
// do polarization conversion, spectral averaging and time averaging on the
// data retrieved and allows modified data to be written back to the Table.
// This class also provides the DO interface to the MS Iterator.
// The ms DO uses this class to allow these operations to be done from glish.
//
// <example> <srcblock>
// MSSelector msSelector(myMS);
// // select data desc Id 1
// msSelector.initSelection(1);
// Vector<String> items(3);
// // fill in some fields
// items(0)="field_id";
// items(1)="time";
// items(2)="num_chan";
// // get the range of values for the items specified
// MSRange msRange(msSelector.selectedTable(),msSelector.spectralWindow());
// Record range=msRange.range(items);
// //.. change the ranges as needed
// // now select with the new range
// msSelector.select(range);
// Int nchan=10, start=3, width=1, incr=2;
// msSelector.selectChannel(nchan,start,width,incr)
// // get out some data
// Vector<String> dataItems(3);
// dataItems(0)="data";
// dataItems(1)="antenna1";
// dataItems(2)="antenna2";
// Record dataRec=msSelector.getData(items);
// </srcblock></example>
// </synopsis>
//
// <motivation>
// Selection from an MS is needed in various places. It makes sense to
// provide a uniform interface for MS selection.
// </motivation>
//
// <thrown>
// <li>
// </thrown>
//
// <todo asof="1998/12/11">
// <li> provide access to all other columns in the MS?
// </todo>
class MSSelector
{
friend class MSRange;
public:
MSSelector();
// construct from an MS, the MS will supply the range of the various
// parameters that can be selected on.
explicit MSSelector(MeasurementSet& ms);
// Copy constructor, this will initialize the MS with other's MS
MSSelector(const MSSelector& other);
// Assignment, this will initialize the MS with other's MS
MSSelector& operator=(const MSSelector& other);
~MSSelector();
// Change or Set the MS this MSSelector refers to.
void setMS(MeasurementSet& ms);
// initialize the selection by specifying, optionally,
// the DATA_DESC_IDs.
// If you don't specify the dataDescIds and the data shape is constant
// all data is selected, if the shape does change, only the first
// dataDescId is selected. If you specify a number of dataDescIds
// and they all have the same shape, they are all selected, otherwise
// only the first is selected. The function returns false if
// the selection was limited due to changing data shape.
// Use the reset argument to return to the completely unselected ms.
Bool initSelection(const Vector<Int>& dataDescIds, Bool reset=False);
// As above without the data desc id argument
Bool initSelection(Bool reset=False);
// Return the data desc IDs selected
Vector<Int> dataDescId() const;
// Set the mapping from input channels in the DATA column to
// output channels. nChan is the number of output channels,
// start is the first channel to use, width specifies how wide a
// block of channels to average, increment specifies the start of
// the next block relative to the start of the current block.
// Note: averaging uncalibrated data should be avoided (no bandpass applied)
Bool selectChannel(Int nChan, Int start, Int width, Int incr);
// Specify the output polarization.
// Missing input polarizations are assumed to be zero.
// This selection/conversion assumes that parallactic angle rotation
// is taken care of elsewhere (i.e., results may only be correct for
// CORRECTED_DATA and MODEL_DATA conversions, not for the observed DATA)
Bool selectPolarization(const Vector<String>& wantedPol);
// Select the MS based on the selections present in the input record.
// The format of this record is the same as that returned by range.
// Not all possible items can be selected on, some are quietly ignored.
// Correct for one-based indexing if oneBased is True.
Bool select(const Record& items, Bool oneBased=False);
// Select the MS based on the TaQL selection string
Bool select(const String& msSelect);
// Return the data for the items requested, all returned values
// will be arrays, the last dimension of these is the table row number.
// The data arrays are normally 3D with axes: polarization, frequency, row.
// If ifrAxis is set to True, the data arrays returned will be 4D, with
// the data being split out along an extra interferometer axis, the
// axes will be: polarization, frequency, interferometer and time.
// Missing interferometers will be marked flagged.
// The order of the interferometers is that specified by the last
// select call.
// Add a (flagged) gap in the data at every antenna1 change if ifrAxisGap>0.
// Use inc > 1 to return data from every inc'th row.
// Use average=True to vector average the data along the row or time axis
// taking the weights column into account (use selectChannel to average
// channels together as well). Note that different interferometers will be
// averaged together if ifrAxis is False.
// Correct for one-based indexing if oneBased is True.
Record getData(const Vector<String>& items, Bool ifrAxis,
Int ifrAxisGap=0, Int inc=1,
Bool average=False, Bool oneBased=False);
// Put the data for the items provided. Note that only fields corresponding
// to actual table columns can be put (i.e., no AMPLITUDEs, IFR_NUMBERs etc)
// The data will need to have the correct shape for the column and a last
// dimension matching the number of selected rows (or last two dimensions
// matching times and interferometers, for data retrieved with ifraxis=T)
// Channel selection is supported, but the width parameter has to be 1.
Bool putData(const Record& items);
// Set up an iterator, iterating over the specified columns, with
// optional time interval and maximum number of rows to return at once
// (the default of zero returns all rows). To keep MSIter from adding
// the default sort columns, specify addDefaultSortColumns=False
Bool iterInit(const Vector<String>& columns,
Double interval, Int maxRows=0,
Bool addDefaultSortColumns=True);
// Step the iterator, sets the selection to the current table iteration.
// Returns false if there is no more data
// and sets the selection back to the state before iteration started.
Bool iterNext();
// (Re)Set the iterator to the first iteration, call this after iterInit.
Bool iterOrigin();
// End the iteration (before reaching the last iteration)
// and set the selection back to the state before iteration started.
Bool iterEnd();
// Number of rows in selected table
Int nrow() const;
// Return the selected table
Table selectedTable() const;
// Return the selection status of the table
Bool selected() const;
protected:
// average and convert data
void getAveragedData(Array<Complex>& avData, const Array<Bool>& flag,
const ArrayColumn<Complex>& col) const;
// average and convert float data
void getAveragedData(Array<Float>& avData, const Array<Bool>& flag,
const ArrayColumn<Float>& col) const;
// average and convert data, with row Slicer
void getAveragedData(Array<Complex>& avData, const Array<Bool>& flag,
const ArrayColumn<Complex>& col,
const Slicer & rowSlicer) const;
// average and convert float data, with row Slicer
void getAveragedData(Array<Float>& avData, const Array<Bool>& flag,
const ArrayColumn<Float>& col,
const Slicer & rowSlicer) const;
// "average" flag, at present all output which has a flagged input is flagged
Array<Bool> getAveragedFlag(Array<Bool>& avFlag,
const ArrayColumn<Bool>& col) const;
// "average" flag, at present all output which has a flagged input is flagged,
// with row Slicer
Array<Bool> getAveragedFlag(Array<Bool>& avFlag,
const ArrayColumn<Bool>& col,
const Slicer& rowSlicer) const;
// "unaverage" flag, distribute the flags back to the channels that went
// into the average
void putAveragedFlag(const Array<Bool>& avFlag,
ArrayColumn<Bool>& col);
// get the weight, set sigma=True when retrieving sigma's
Array<Float> getWeight(const ArrayColumn<Float>& wtCol,
Bool sigma=False) const;
// make the data slicer, pass in the first and the number of correlations
// to select
void makeSlicer(Int start, Int nCorr) const;
// reorder from 2d to 1d (removing ifr axis)
void reorderFlagRow(Array<Bool>& flagRow);
// reorder from 2d to 1d (removing ifr axis)
void reorderWeight(Array<Float>& weight);
// time average the input data, return new flags
void timeAverage(Array<Bool>& dataFlags, Array<Complex>& data,
const Array<Bool>& flags, const Array<Float>& weights);
// check if the data description selection has been done & do default
// selection if not. Return False if the selection fails.
Bool checkSelection();
private:
// The function types
enum {Amp,Phase,Real,Imag,Data,nFuncType};
// The data types
enum {Observed,Corrected,Model,Ratio,Residual,ObsResidual,ObsFloat,nDataType};
MeasurementSet ms_p; // the original ms
MeasurementSet selms_p; // the selected ms
MeasurementSet savems_p; // the saved preselection
MSIter* msIter_p;
Bool initSel_p;
Vector<Int> dataDescId_p, lastDataDescId_p;
Vector<uInt> spwId_p, polId_p;
Vector<Int> chanSel_p;
Bool useSlicer_p;
mutable Bool haveSlicer_p;
mutable Slicer slicer_p;
Slice chanSlice_p,polSlice_p;
Vector<Int> polIndex_p;
Int wantedOne_p;
Bool convert_p, subSet_p;
StokesConverter stokesConverter_p;
Vector<String> polSelection_p;
Vector<Int> ifrSelection_p,ifrAxis_p;
Matrix<Double> chanFreq_p,bandwidth_p;
MSDerivedValues msd_p;
Matrix<Int> rowIndex_p; // mapping of rows to time and ifr slots
Vector<uInt> selRows_p; // range of rows from selms_p returned by getData
Int startRow_p, maxRow_p; // start and length of range of rows
Bool useIfrDefault_p;
};
inline Int MSSelector::nrow() const { return selms_p.nrow();}
inline Vector<Int> MSSelector::dataDescId() const { return dataDescId_p;}
inline Table MSSelector::selectedTable() const {return selms_p;}
inline Bool MSSelector::selected() const {return initSel_p;}
} //# NAMESPACE CASACORE - END
#endif
|