Loading...
Searching...
No Matches
MSDataDescIndex.h
Go to the documentation of this file.
//# MSDataDescIndex: index or lookup in a MeasurementSet DATA_DESC 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_MSDATADESCINDEX_H
#define MS_MSDATADESCINDEX_H
//# includes
#include <casacore/casa/aips.h>
#include <casacore/ms/MeasurementSets/MSDataDescription.h>
#include <casacore/ms/MeasurementSets/MSDataDescColumns.h>
#include <casacore/casa/Arrays/Vector.h>
#include <casacore/casa/BasicSL/String.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# forward declarations
// <summary>
// Class to handle lookup or indexing into a MS DATA_DESC subtable
// </summary>
// <use visibility=export>
//
// <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
// </reviewed>
// <prerequisite>
// <li> MeasurementSet
// <li> MSDataDescription
// </prerequisite>
//
// <etymology>
// From "MeasurementSet", "DATA_DESC subtable" and "index".
// </etymology>
//
// <synopsis>
// This class provides lookup and indexing into an MS DATA_DESC
// subtable. These services include returning rows numbers
// (which for the DATA_DESC subtable are DATA_DESC_ID's) associated
// with specific data in the subtable.
// </synopsis>
//
// <example>
// </example>
//
// <motivation>
// Collect together all subtable indexing and lookup for the
// DATA_DESC subtable, for encapsulation and efficiency.
// </motivation>
//
// <thrown>
// <li>
// <li>
// </thrown>
//
class MSDataDescIndex
{
public:
// Construct from an MS DATA_DESC subtable
MSDataDescIndex(const MSDataDescription& dataDescription);
// Null destructor
virtual ~MSDataDescIndex() {}
// Look up DATA_DESC_ID's for a given spectral window id
Vector<Int> matchSpwId(const Int& spwId);
Vector<Int> matchSpwId(const Vector<Int>& spwIds);
// Look up DATA_DESC_ID's for a given polarization id
Vector<Int> matchPolId(const Int& polId);
Vector<Int> matchPolId(const Vector<Int>& polIds);
// Look up DATA_DESC_ID's for a given spectral window and polarization id.
Vector<Int> matchSpwIdAndPolznId(const Int& spwId, const Int& polznId);
private:
// Disallow null constructor
MSDataDescIndex();
// DATA_DESC subtable column accessor
MSDataDescColumns msDataDescCols_p;
// Vector cache of DataDesc id's
Vector<Int> dataDescIds_p;
Int nrows_p;
};
} //# NAMESPACE CASACORE - END
#endif
casacore::MSDataDescColumns
Definition MSDataDescColumns.h:73
casacore::MSDataDescIndex::dataDescIds_p
Vector< Int > dataDescIds_p
Vector cache of DataDesc id's.
Definition MSDataDescIndex.h:107
casacore::MSDataDescIndex::matchPolId
Vector< Int > matchPolId(const Int &polId)
Look up DATA_DESC_ID's for a given polarization id.
casacore::MSDataDescIndex::matchPolId
Vector< Int > matchPolId(const Vector< Int > &polIds)
casacore::MSDataDescIndex::msDataDescCols_p
MSDataDescColumns msDataDescCols_p
DATA_DESC subtable column accessor.
Definition MSDataDescIndex.h:104
casacore::MSDataDescIndex::matchSpwId
Vector< Int > matchSpwId(const Vector< Int > &spwIds)
casacore::MSDataDescIndex::MSDataDescIndex
MSDataDescIndex(const MSDataDescription &dataDescription)
Construct from an MS DATA_DESC subtable.
casacore::MSDataDescIndex::matchSpwId
Vector< Int > matchSpwId(const Int &spwId)
Look up DATA_DESC_ID's for a given spectral window id.
casacore::MSDataDescIndex::MSDataDescIndex
MSDataDescIndex()
Disallow null constructor.
casacore::MSDataDescIndex::matchSpwIdAndPolznId
Vector< Int > matchSpwIdAndPolznId(const Int &spwId, const Int &polznId)
Look up DATA_DESC_ID's for a given spectral window and polarization id.
casacore::MSDataDescIndex::~MSDataDescIndex
virtual ~MSDataDescIndex()
Null destructor.
Definition MSDataDescIndex.h:86
casacore::MSDataDescIndex::nrows_p
Int nrows_p
Definition MSDataDescIndex.h:108
casacore::MSDataDescription
Definition MSDataDescription.h:78
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