/usr/include/casacore/ms/MeasurementSets/MeasurementSet.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 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 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 | //# MeasurementSet.h: A Table to hold astronomical data (a set of Measurements)
//# Copyright (C) 1996,1997,1999,2000,2001,2003
//# 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_MEASUREMENTSET_H
#define MS_MEASUREMENTSET_H
#include <casacore/casa/aips.h>
#include <casacore/ms/MeasurementSets/MSTable.h>
#include <casacore/ms/MeasurementSets/MSMainEnums.h>
#include <casacore/ms/MeasurementSets/MSAntenna.h>
#include <casacore/ms/MeasurementSets/MSDataDescription.h>
#include <casacore/ms/MeasurementSets/MSDoppler.h>
#include <casacore/ms/MeasurementSets/MSFeed.h>
#include <casacore/ms/MeasurementSets/MSField.h>
#include <casacore/ms/MeasurementSets/MSFlagCmd.h>
#include <casacore/ms/MeasurementSets/MSFreqOffset.h>
#include <casacore/ms/MeasurementSets/MSHistory.h>
#include <casacore/ms/MeasurementSets/MSObservation.h>
#include <casacore/ms/MeasurementSets/MSPointing.h>
#include <casacore/ms/MeasurementSets/MSPolarization.h>
#include <casacore/ms/MeasurementSets/MSProcessor.h>
#include <casacore/ms/MeasurementSets/MSSource.h>
#include <casacore/ms/MeasurementSets/MSSpectralWindow.h>
#include <casacore/ms/MeasurementSets/MSState.h>
#include <casacore/ms/MeasurementSets/MSSysCal.h>
#include <casacore/ms/MeasurementSets/MSWeather.h>
#include <set>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
class MrsEligibility { // Memory Resident Subtable (Mrs) Eligibility (no pun intended)
public:
typedef MSMainEnums::PredefinedKeywords SubtableId;
friend MrsEligibility operator- (const MrsEligibility & a, SubtableId subtableId);
friend MrsEligibility operator+ (const MrsEligibility & a, SubtableId subtableId);
friend MrsEligibility operator- (const MrsEligibility & a, const MrsEligibility & b);
friend MrsEligibility operator+ (const MrsEligibility & a, const MrsEligibility & b);
// Returns true if the specified subtable is in the set of subtables
// eligible for memory residency.
Bool isEligible (SubtableId subtableId) const;
// Factory methods to create MrsEligibility sets. The two variable argument methods
// require that the list be terminated by using the id MSMainEnums::UNDEFINED_KEYWORD.
//
static MrsEligibility allEligible ();
static MrsEligibility defaultEligible ();
static MrsEligibility noneEligible ();
static MrsEligibility eligibleSubtables (SubtableId subtableId, ...);
static MrsEligibility allButTheseSubtables (SubtableId ineligibleSubtableId, ...);
private:
typedef std::set<MSMainEnums::PredefinedKeywords> Eligible;
Eligible eligible_p;
static const MrsEligibility allSubtables_p;
static Bool isSubtable (SubtableId subtableId);
};
// Creates a new MrsEligibilitySet by adding or removing the specified subtable or
// the specified set of subtables.
MrsEligibility operator- (const MrsEligibility & a, MrsEligibility::SubtableId subtableId);
MrsEligibility operator+ (const MrsEligibility & a, MrsEligibility::SubtableId subtableId);
MrsEligibility operator- (const MrsEligibility & a, const MrsEligibility & b);
MrsEligibility operator+ (const MrsEligibility & a, const MrsEligibility & b);
//# Forward Declarations, more could be if they weren't part of the
//# static classes
class SetupNewTable;
template <class T> class Block;
class MDirection;
class MEpoch;
class MFrequency;
class MPosition;
class Record;
//# forward declared so that the following typedef is up-front
class MeasurementSet;
// MeasurementSet is too cumbersome for a number of common uses,
// so we give a typedef here.
typedef MeasurementSet MS;
// <summary>
// A Table intended to hold astronomical data (a set of Measurements).
// </summary>
// <use visibility=export>
// <reviewed reviewer="Bob Garwood" date="1997/02/01" tests="tMeasurementSet.cc" demos="">
// <prerequisite>
// <li> <linkto module="Tables:description">Tables</linkto> module
// <li> <linkto class="MSTable">MSTable</linkto>
// </prerequisite>
//
// <etymology>
// The MeasurementSet is where all data are ultimately to be found
// in Casacore. Since, this is a collection of
// measurements (either actual or simulated), the term MeasurementSet
// seems appropriate.
// </etymology>
//
// <synopsis>
// A MeasurementSet is a Table. Most operations on a MeasurementSet are
// Table operations. See the <linkto module="Tables:description">Tables</linkto>
// module for a list of those operations. The member functions provided by this
// class are primarily convenience functions to help users follow the
// agreed upon column and keyword naming conventions. They are useful when
// creating a Table following the MeasurementSet conventions from
// scratch as well as when creating the column objects to access those
// columns.
//
// The standard way of accessing
// table columns is through Strings. Mistakes in typing the column
// name will not be caught at compile time (and may not be caught at
// run time). We have therefore decided to use an enumeration
// to specify columns so that many mistakes will be caught at compile
// time. This requires functions to map to and from this enumeration
// to the strings that are ultimately used.
//
// Upon destruction, the table is checked to see that the
// MeasurementSet remains valid, i.e., all required columns are present
// An exception is thrown if not all required columns are present
// Nevertheless, the table will be flushed to disk if it is writable -
// preserving its state.
//
// A MeasurementSet has a number of required subtables. These are stored
// as keywords in the Table. Access to these subtables is provided via
// member functions (e.g. antenna() for the ANTENNA table). All subtables
// have associated MeasurementSet-like classes defined for them (MSAntenna
// for the ANTENNA table) which provide analogous column and keyword mapping
// as provided here.
//
// While the class name, MeasurementSet, is descriptive, it is often
// too long for many common uses. The typedef MS is provided as
// a convenient shorthand for MeasurementSet. The example below uses this
// typedef.
//
// Due to the inheritance scheme, it was necessary to separate the enumerations
// used by MeasurementSet into a separate class,
// <linkto class=MSMainEnums>MSMainEnums</linkto>.
//
// </synopsis>
//
// <example>
// This example illustrates a simple use of the MeasurementSet class.
// <srcblock>
// // create the table descriptor
// TableDesc simpleDesc = MS::requiredTableDesc();
// // set up a new table
// SetupNewTable newTab("simpleTab", simpleDesc, Table::New);
// // create the MeasurementSet
// MeasurementSet simpleMS(newTab);
// // now we need to define all required subtables
// // the following call does this for us if we don't need to
// // specify details of Storage Managers for columns.
// simpleMS.createDefaultSubtables(Table::New);
// // fill MeasurementSet via its Table interface
// // For example, construct one of the columns
// TableColumn feed(simpleMS, MS::columnName(MS::FEED1));
// uInt rownr = 0;
// // add a row
// simpleMS.addRow();
// // set the values in that row, e.g. the feed column
// feed.putScalar(rownr,1);
// // Access a subtable
// ArrayColumn<Double> antpos(simpleMS.antenna(),
// MSAntenna::columnName(MSAntenna::POSITION));
// simpleMS.antenna().addRow();
// Array<Double> position(3);
// position(0)=1.; position(1)=2.; position(2)=3.;
// antpos.put(0,position);
// // etc.
// </srcblock>
//
// </example>
//
// <motivation>
// The Table module is more than adequate as a container of data.
// However, in order for applications to be useful with data from
// different sources, some conventions need to be adopted in the use
// of Tables to store data. The MeasurementSet is
// where those conventions are defined and, to some extent, enforced.
//
// There are a number of reasons why MeasurementSet is more
// than just a Table.
// <ul>
// <li> To provide one location where the column and keyword names, data
// types, and table comment strings are found.
// <li> To provide one location where the required table descriptor for
// the MeasurementSet is found.
// <li> To provide a means of verifying the validity of a MeasurementSet
// at construction and destruction.
// <li> To allow application programmers to catch name or data type
// mistakes at compile time rather than at run time.
// </ul>
//
// </motivation>
//
// <todo asof="1996/2/22">
// <li> referenceCopy() should be more flexible with the storage managers used
// for the columns which are not merely references.
// <li> When ForwardColumnEngine is fixed so that it can deal with
// tables already in the cache, modify the test program. It may also
// be necessary to modify referenceCopy().
// </todo>
class MeasurementSet : public MSTable<MSMainEnums::PredefinedColumns,
MSMainEnums::PredefinedKeywords>,
public MSMainEnums
{
public:
// This constructs an empty MeasurementSet, only useful to assign to
// (it is not a valid MS yet).
MeasurementSet ();
// These constructors mirror the Table ones with additional checking
// on validity (verifying that the MS will have the required columns
// and keywords)
// An exception is thrown if the constructed Table is not a valid MS
// <thrown>
// <li> AipsError
// </thrown>
// <group name=tableLikeConstructors>
MeasurementSet (const String &tableName, TableOption = Table::Old);
MeasurementSet (const String &tableName, const TableLock& lockOptions,
TableOption = Table::Old);
MeasurementSet (const String &tableName, const TableLock& lockOptions,
bool doNotLockSubtables, TableOption = Table::Old);
// Allows keeping subtables unlocked/read-locked independent of lock
// mode of main table.
MeasurementSet (const String &tableName, const String &tableDescName,
TableOption = Table::Old);
MeasurementSet (const String &tableName, const String &tableDescName,
const TableLock& lockOptions, TableOption = Table::Old);
MeasurementSet (SetupNewTable &newTab, uInt nrrow = 0,
Bool initialize = False);
MeasurementSet (SetupNewTable &newTab, const TableLock& lockOptions,
uInt nrrow = 0, Bool initialize = False);
MeasurementSet (const Table &table, const MeasurementSet * otherMs = NULL);
MeasurementSet (const MeasurementSet &other);
// </group>
// As with tables, the destructor writes the table if necessary.
// Additional checking is done here to verify that all required
// columns are still present.
// If it is NOT valid, it will write the table and then throw an exception.
// <thrown>
// <li> AipsError
// </thrown>
virtual ~MeasurementSet();
// Assignment operator, reference semantics
MeasurementSet& operator=(const MeasurementSet&);
// Make a special copy of this MS which references all columns from
// this MS except those mentioned; those are empty and writable.
// Each forwarded column has the same writable status as the underlying
// column. The mentioned columns all use the AipsIO storage manager.
// The main use of this is for the synthesis package where corrected and
// model visibilities are stored as new DATA columns in an MS which
// references the raw MS for the other columns. Except for these special
// cases, the use of this function will be rare.
MeasurementSet referenceCopy(const String& newTableName,
const Block<String>& writableColumns) const;
// Converts the MS to make the specified set of subtables memory resident.
void
setMemoryResidentSubtables (const MrsEligibility & mrsEligibility);
// Return the name of each of the subtables. This should be used by the
// filler to create the subtables in the correct location.
// <group>
String antennaTableName() const;
String dataDescriptionTableName() const;
String dopplerTableName() const;
String feedTableName() const;
String fieldTableName() const;
String flagCmdTableName() const;
String freqOffsetTableName() const;
String historyTableName() const;
String observationTableName() const;
String pointingTableName() const;
String polarizationTableName() const;
String processorTableName() const;
String sourceTableName() const;
String spectralWindowTableName() const;
String stateTableName() const;
String sysCalTableName() const;
String weatherTableName() const;
// </group>
// Access functions for the subtables, using the MS-like interface for each
// <group>
MSAntenna& antenna() {return antenna_p;}
MSDataDescription& dataDescription() {return dataDesc_p;}
MSDoppler& doppler() {return doppler_p;}
MSFeed& feed() {return feed_p;}
MSField& field() {return field_p;}
MSFlagCmd& flagCmd() {return flagCmd_p;}
MSFreqOffset& freqOffset() {return freqOffset_p;}
MSHistory& history() {return history_p;}
MSObservation& observation() {return observation_p;}
MSPointing& pointing() {return pointing_p;}
MSPolarization& polarization() {return polarization_p;}
MSProcessor& processor() {return processor_p;}
MSSource& source() {return source_p;}
MSSpectralWindow& spectralWindow() {return spectralWindow_p;}
MSState& state() {return state_p;}
MSSysCal& sysCal() {return sysCal_p;}
MSWeather& weather() {return weather_p;}
const MSAntenna& antenna() const {return antenna_p;}
const MSDataDescription& dataDescription() const {return dataDesc_p;}
const MSDoppler& doppler() const {return doppler_p;}
const MSFeed& feed() const {return feed_p;}
const MSField& field() const {return field_p;}
const MSFlagCmd& flagCmd() const {return flagCmd_p;}
const MSFreqOffset& freqOffset() const {return freqOffset_p;}
const MSHistory& history() const {return history_p;}
const MSObservation& observation() const {return observation_p;}
const MSPointing& pointing() const {return pointing_p;}
const MSPolarization& polarization() const {return polarization_p;}
const MSProcessor& processor() const {return processor_p;}
const MSSource& source() const {return source_p;}
const MSSpectralWindow& spectralWindow() const {return spectralWindow_p;}
const MSState& state() const {return state_p;}
const MSSysCal& sysCal() const {return sysCal_p;}
const MSWeather& weather() const {return weather_p;}
// </group>
MrsEligibility getMrsEligibility () const;
// Initialize the references to the subtables. You need to call
// this only if you assign new subtables to the table keywords.
// This also checks for validity of the table and its subtables.
// Set clear to True to clear the subtable references (used in assignment)
void initRefs(Bool clear=False);
// Create default subtables: fills the required subtable keywords with
// tables of the correct type, mainly for testing and as an example of
// how to do this for specific fillers. In practice these tables will
// often have more things specified, like dimensions of arrays and
// storage managers for the various columns.
void createDefaultSubtables(Table::TableOption option=Table::Scratch);
// Initialize the statics appropriately. This does not need to be
// called by users, it is called by the implementation class
// MSTableImpl.
static void init();
// Create DATA column from existing FLOAT_DATA column. Noop if DATA already
// exists or neither exists (returns False in that case).
Bool makeComplexData();
// Validate Measure references - check that all Measure columns have their
// reference value set, report the ones that don't.
Bool validateMeasureRefs();
// Flush all the tables and subtables associated with this
// MeasurementSet. This function calls the Table::flush() function on the
// main table and all the standard subtables including optional
// subtables. See the Table class for a description of the sync argument.
void flush(Bool sync=False);
// Return a record of the indices that the msselection selection selected
Record msseltoindex(const String& spw="", const String& field="",
const String& baseline="", const String& time="",
const String& scan="", const String& uvrange="",
const String& observation="", const String& poln="",
const String& taql="");
protected:
// Clears all of the subtable components of this object (i.e., set to
// value of subtable's default constructor).
void clearSubtables ();
// Assigns one subtable to another if the original subtable (otherSubtable)
// is not null and is also memory resident
void copySubtable (const Table & otherSubtable, Table & subTable);
// Copies (assigns) all of the non-null subtables from the other MS into this one.
void copySubtables (const MeasurementSet & other);
// Returns true if the named subtable is eligible for memory residency.
Bool isEligibleForMemoryResidency (const String & subtableName) const;
// Opens all of the eligible subtables in memory resident form
void openMrSubtables ();
// The top level name for MRS related CASARC settings
static String getMrsAipsRcBase ()
{
return "MemoryResidentSubtables";
}
private:
// temporary function to add the CATEGORY keyword to the FLAG_CATEGORY
// column if it isn't there yet. 2000/08/22
// remove this and the calls next MS update
void addCat();
// check that the MS is the latest version (2.0)
void checkVersion();
// Opens a single subtable as memory resident (if permitted).
template <typename Subtable>
void
openMrSubtable (Subtable & subtable, const String & subtableName);
// Opens a single subtable if not present in MS object but defined in on-disk MS
template <typename Subtable>
void
openSubtable (Subtable & subtable, const String & subtableName, Bool useLock);
// keep references to the subtables
MSAntenna antenna_p;
MSDataDescription dataDesc_p;
MSDoppler doppler_p; //optional
MSFeed feed_p;
MSField field_p;
MSFlagCmd flagCmd_p;
MSFreqOffset freqOffset_p; //optional
MSHistory history_p;
MSObservation observation_p;
MSPointing pointing_p;
MSPolarization polarization_p;
MSProcessor processor_p;
MSSource source_p; //optional
MSSpectralWindow spectralWindow_p;
MSState state_p;
MSSysCal sysCal_p; //optional
MSWeather weather_p; //optional
bool doNotLockSubtables_p; // used to prevent subtable locking to allow parallel interprocess sharing
int mrsDebugLevel_p; // logging level currently enabled
Bool hasBeenDestroyed_p; // required by the need to throw an exception in the destructor
TableLock mainLock_p;
Bool memoryResidentSubtables_p; // true if memory resident subtables are enabled
MrsEligibility mrsEligibility_p; // subtables which can be made memory resident
};
} //# NAMESPACE CASACORE - END
#endif
|