Loading...
Searching...
No Matches
MSObsIndex.h
Go to the documentation of this file.
//# MSObsIndex: index or lookup in an MS OBSERVATION subtable
//# Copyright (C) 2000,2001,2002
//# 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_MSOBSINDEX_H
#define MS_MSOBSINDEX_H
//# includes
#include <casacore/casa/aips.h>
#include <casacore/ms/MeasurementSets/MSObservation.h>
#include <casacore/ms/MeasurementSets/MSObsColumns.h>
#include <casacore/casa/Arrays/Vector.h>
#include <casacore/casa/Arrays/Matrix.h>
#include <casacore/casa/BasicSL/String.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# forward declarations
// <summary>
// Class to handle lookup or indexing into an MS OBSERVATION subtable
// </summary>
// <use visibility=export>
//
// <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
// </reviewed>
// <prerequisite>
// <li> MeasurementSet
// <li> MSObservation
// </prerequisite>
//
// <etymology>
// From "MeasurementSet", "OBSERVATION subtable" and "index".
// </etymology>
//
// <synopsis>
// This class provides lookup and indexing into an MS OBSERVATION
// subtable. These services include returning rows numbers (which
// for the OBSERVATION subtable are OBSERVATION_ID's) associated
// with specific data in the subtable.
// </synopsis>
//
// <example>
// </example>
//
// <motivation>
// Collect together all subtable indexing and lookup for the
// OBSERVATION subtable, for encapsulation and efficiency.
// </motivation>
//
// <thrown>
// <li>
// <li>
// </thrown>
//
class MSObservationIndex
{
public:
// Construct from an MS OBSERVATION subtable
MSObservationIndex(const MSObservation& observationTable);
// Null destructor
virtual ~MSObservationIndex() {}
// Look up OBSERVATION_ID's for a given project code
Vector<Int> matchProjectCode(const String& projectCode);
private:
// Disallow null constructor
MSObservationIndex();
// OBSERVATION subtable column accessor
MSObservationColumns msObservationCols_p;
// Vector cache of observation id's
Vector<Int> observationIds_p;
Int nrows_p;
};
} //# NAMESPACE CASACORE - END
#endif
casacore::MSObservationColumns
Definition MSObsColumns.h:79
casacore::MSObservationIndex::observationIds_p
Vector< Int > observationIds_p
Vector cache of observation id's.
Definition MSObsIndex.h:100
casacore::MSObservationIndex::MSObservationIndex
MSObservationIndex()
Disallow null constructor.
casacore::MSObservationIndex::matchProjectCode
Vector< Int > matchProjectCode(const String &projectCode)
Look up OBSERVATION_ID's for a given project code.
casacore::MSObservationIndex::MSObservationIndex
MSObservationIndex(const MSObservation &observationTable)
Construct from an MS OBSERVATION subtable.
casacore::MSObservationIndex::nrows_p
Int nrows_p
Definition MSObsIndex.h:101
casacore::MSObservationIndex::~MSObservationIndex
virtual ~MSObservationIndex()
Null destructor.
Definition MSObsIndex.h:87
casacore::MSObservationIndex::msObservationCols_p
MSObservationColumns msObservationCols_p
OBSERVATION subtable column accessor.
Definition MSObsIndex.h:97
casacore::MSObservation
Definition MSObservation.h:77
casacore::String
String: the storage and methods of handling collections of characters.
Definition String.h:223
casacore::Vector
Definition Vector.h:82
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28
casacore::Int
int Int
Definition aipstype.h:48