Loading...
Searching...
No Matches
MSReader.h
Go to the documentation of this file.
//# MSReader.h: read from a MS, coordinating all of the subtables
//# Copyright (C) 2000
//# 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: casa-feedback@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
#ifndef MS_MSREADER_H
#define MS_MSREADER_H
#include <casacore/casa/aips.h>
#include <casacore/casa/Arrays/Vector.h>
#include <casacore/casa/Containers/Block.h>
#include <casacore/casa/Containers/Record.h>
#include <casacore/ms/MeasurementSets/MeasurementSet.h>
#include <casacore/ms/MeasurementSets/MSColumns.h>
#include <casacore/ms/MSSel/MSDopplerIndex.h>
#include <casacore/ms/MSSel/MSFeedIndex.h>
#include <casacore/ms/MSSel/MSFreqOffIndex.h>
#include <casacore/ms/MSSel/MSPointingIndex.h>
#include <casacore/ms/MSSel/MSSourceIndex.h>
#include <casacore/ms/MSSel/MSSysCalIndex.h>
#include <casacore/ms/MSSel/MSTableIndex.h>
#include <casacore/ms/MSSel/MSWeatherIndex.h>
#include <casacore/ms/MSOper/MSValidIds.h>
#include <casacore/tables/Tables/TableRow.h>
#include <casacore/casa/Quanta/Unit.h>
#include <casacore/casa/BasicSL/String.h>
#include <map>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
// <summary>
// Read from an MS, coordinating all of the subtables in the process
// </summary>
// <use visibility=local>
// <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
// </reviewed>
class MSReader
{
public:
// Attach to the indicated MeasurementSet
MSReader(const MeasurementSet &ms);
~MSReader() {;}
// Go to the indicated row in the MAIN table of the MS and point
// at all of the appropriate rows in each of the subtables as
// a result of going to this row.
void gotoRow(rownr_t which);
const Vector<String> &tables() const {return itsTableNames;}
// Return the current row in the named table. Use rowNumber to
// check to see that the most recent gotoRow actually found a matching
// row.
const RecordInterface &tableRow(const String &name) const;
// Return the current row number in the named table. This returns
// -1 if that table has no row as a result of the most recent gotoRow.
Int64 rowNumber(const String &name) const;
// Return a reference to the MS
const MeasurementSet &ms() const {return itsMS;}
// Return a reference to the named subtable
const Table &table(const String &name) const;
// this isn't what we need, right now just return an empty record
const Record &units(const String &) const { return emptyRecord;}
private:
MeasurementSet itsMS;
MSColumns itsMSCols;
// This possibly saves some time, Units of seconds
Unit itsSecUnit;
MSValidIds itsIds;
// this maps table name to an index used throughout this class
std::map<String, Int> itsTabId;
// the indexes for the NS subtables
Block<MSTableIndex> itsIndexes;
// specific indexes
MSDopplerIndex itsDopplerIndex;
MSFeedIndex itsFeed1Index;
MSFeedIndex itsFeed2Index;
MSFreqOffIndex itsFreqOffIndex;
MSPointingIndex itsPointing1Index;
MSPointingIndex itsPointing2Index;
MSSourceIndex itsSourceIndex;
MSSysCalIndex itsSyscal1Index;
MSSysCalIndex itsSyscal2Index;
MSWeatherIndex itsWeather1Index;
MSWeatherIndex itsWeather2Index;
// table IDs for the standard tables
Int itsMainId, itsAnt1Id, itsAnt2Id, itsDDId, itsDopplerId, itsFeed1Id, itsFeed2Id, itsFieldId,
itsFlagCmdId, itsFreqOffsetId, itsObsId, itsPointing1Id, itsPointing2Id, itsPolId, itsProcId,
itsSourceId, itsSpwId, itsStateId, itsSyscal1Id, itsSyscal2Id, itsWeather1Id, itsWeather2Id;
// the table rows
Block<ROTableRow> itsTabRows;
// What row number for each table is the most recent gotoRow call. Set to
// -1 if there was no matching row as a result of that call.
Block<Int64> itsRowNumbers;
// this empty record is returned by tableRow when the name argument does not exist
Record emptyRecord;
// this empty table is returned by table when the name argument does not exist
Table emptyTable;
Vector<String> itsTableNames;
// undefined and unavailable
MSReader();
MSReader(const MSReader &);
MSReader& operator=(const MSReader &);
};
} //# NAMESPACE CASACORE - END
#endif
casacore::Block
Definition Block.h:140
casacore::MSColumns
Definition MSColumns.h:115
casacore::MSDopplerIndex
Definition MSDopplerIndex.h:71
casacore::MSFeedIndex
Definition MSFeedIndex.h:72
casacore::MSFreqOffIndex
Definition MSFreqOffIndex.h:71
casacore::MSPointingIndex
Definition MSPointingIndex.h:71
casacore::MSReader::tables
const Vector< String > & tables() const
Definition MSReader.h:72
casacore::MSReader::itsPointing2Index
MSPointingIndex itsPointing2Index
Definition MSReader.h:112
casacore::MSReader::itsSyscal1Index
MSSysCalIndex itsSyscal1Index
Definition MSReader.h:114
casacore::MSReader::MSReader
MSReader()
undefined and unavailable
casacore::MSReader::tableRow
const RecordInterface & tableRow(const String &name) const
Return the current row in the named table.
casacore::MSReader::emptyTable
Table emptyTable
this empty table is returned by table when the name argument does not exist
Definition MSReader.h:134
casacore::MSReader::itsFlagCmdId
Int itsFlagCmdId
Definition MSReader.h:121
casacore::MSReader::itsFeed1Id
Int itsFeed1Id
Definition MSReader.h:120
casacore::MSReader::itsDDId
Int itsDDId
Definition MSReader.h:120
casacore::MSReader::itsAnt1Id
Int itsAnt1Id
Definition MSReader.h:120
casacore::MSReader::itsSyscal2Index
MSSysCalIndex itsSyscal2Index
Definition MSReader.h:115
casacore::MSReader::itsWeather2Index
MSWeatherIndex itsWeather2Index
Definition MSReader.h:117
casacore::MSReader::itsTableNames
Vector< String > itsTableNames
Definition MSReader.h:136
casacore::MSReader::itsSecUnit
Unit itsSecUnit
This possibly saves some time, Units of seconds.
Definition MSReader.h:96
casacore::MSReader::table
const Table & table(const String &name) const
Return a reference to the named subtable.
casacore::MSReader::itsWeather1Index
MSWeatherIndex itsWeather1Index
Definition MSReader.h:116
casacore::MSReader::MSReader
MSReader(const MeasurementSet &ms)
Attach to the indicated MeasurementSet.
casacore::MSReader::itsFeed1Index
MSFeedIndex itsFeed1Index
Definition MSReader.h:108
casacore::MSReader::itsFreqOffsetId
Int itsFreqOffsetId
Definition MSReader.h:121
casacore::MSReader::itsWeather2Id
Int itsWeather2Id
Definition MSReader.h:122
casacore::MSReader::itsSyscal1Id
Int itsSyscal1Id
Definition MSReader.h:122
casacore::MSReader::itsPointing1Id
Int itsPointing1Id
Definition MSReader.h:121
casacore::MSReader::itsFieldId
Int itsFieldId
Definition MSReader.h:120
casacore::MSReader::itsPointing1Index
MSPointingIndex itsPointing1Index
Definition MSReader.h:111
casacore::MSReader::itsStateId
Int itsStateId
Definition MSReader.h:122
casacore::MSReader::itsTabRows
Block< ROTableRow > itsTabRows
the table rows
Definition MSReader.h:124
casacore::MSReader::MSReader
MSReader(const MSReader &)
casacore::MSReader::rowNumber
Int64 rowNumber(const String &name) const
Return the current row number in the named table.
casacore::MSReader::itsPolId
Int itsPolId
Definition MSReader.h:121
casacore::MSReader::itsRowNumbers
Block< Int64 > itsRowNumbers
What row number for each table is the most recent gotoRow call.
Definition MSReader.h:128
casacore::MSReader::itsProcId
Int itsProcId
Definition MSReader.h:121
casacore::MSReader::itsObsId
Int itsObsId
Definition MSReader.h:121
casacore::MSReader::itsFeed2Index
MSFeedIndex itsFeed2Index
Definition MSReader.h:109
casacore::MSReader::itsDopplerId
Int itsDopplerId
Definition MSReader.h:120
casacore::MSReader::gotoRow
void gotoRow(rownr_t which)
Go to the indicated row in the MAIN table of the MS and point at all of the appropriate rows in each ...
casacore::MSReader::itsSyscal2Id
Int itsSyscal2Id
Definition MSReader.h:122
casacore::MSReader::itsSourceIndex
MSSourceIndex itsSourceIndex
Definition MSReader.h:113
casacore::MSReader::itsDopplerIndex
MSDopplerIndex itsDopplerIndex
specific indexes
Definition MSReader.h:107
casacore::MSReader::itsIds
MSValidIds itsIds
Definition MSReader.h:98
casacore::MSReader::itsWeather1Id
Int itsWeather1Id
Definition MSReader.h:122
casacore::MSReader::itsMainId
Int itsMainId
table IDs for the standard tables
Definition MSReader.h:120
casacore::MSReader::itsMSCols
MSColumns itsMSCols
Definition MSReader.h:93
casacore::MSReader::units
const Record & units(const String &) const
this isn't what we need, right now just return an empty record
Definition MSReader.h:90
casacore::MSReader::emptyRecord
Record emptyRecord
this empty record is returned by tableRow when the name argument does not exist
Definition MSReader.h:131
casacore::MSReader::itsMS
MeasurementSet itsMS
Definition MSReader.h:92
casacore::MSReader::itsIndexes
Block< MSTableIndex > itsIndexes
the indexes for the NS subtables
Definition MSReader.h:104
casacore::MSReader::itsFreqOffIndex
MSFreqOffIndex itsFreqOffIndex
Definition MSReader.h:110
casacore::MSReader::itsPointing2Id
Int itsPointing2Id
Definition MSReader.h:121
casacore::MSReader::operator=
MSReader & operator=(const MSReader &)
casacore::MSReader::~MSReader
~MSReader()
Definition MSReader.h:65
casacore::MSReader::itsSpwId
Int itsSpwId
Definition MSReader.h:122
casacore::MSReader::itsFeed2Id
Int itsFeed2Id
Definition MSReader.h:120
casacore::MSReader::ms
const MeasurementSet & ms() const
Return a reference to the MS.
Definition MSReader.h:84
casacore::MSReader::itsTabId
std::map< String, Int > itsTabId
this maps table name to an index used throughout this class
Definition MSReader.h:101
casacore::MSReader::itsAnt2Id
Int itsAnt2Id
Definition MSReader.h:120
casacore::MSReader::itsSourceId
Int itsSourceId
Definition MSReader.h:122
casacore::MSSourceIndex
Definition MSSourceIndex.h:72
casacore::MSSysCalIndex
Definition MSSysCalIndex.h:71
casacore::MSValidIds
Definition MSValidIds.h:67
casacore::MSWeatherIndex
Definition MSWeatherIndex.h:71
casacore::MeasurementSet
Definition MeasurementSet.h:278
casacore::String
String: the storage and methods of handling collections of characters.
Definition String.h:223
casacore::Table
Definition Table.h:157
casacore::Unit
Definition Unit.h:187
casacore::Vector
Definition Vector.h:82
casacore::Record
Record()
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28
casacore::Int64
long long Int64
Define the extra non-standard types used by Casacore (like proposed uSize, Size).
Definition aipsxtype.h:36
casacore::name
String name() const
Return the name of the field.
Definition RecordField.h:163
casacore::RecordInterface
RecordInterface()
The default constructor creates an empty record with a variable structure.
casacore::Int
int Int
Definition aipstype.h:48
casacore::rownr_t
uInt64 rownr_t
Define the type of a row number in a table.
Definition aipsxtype.h:44