MSSpwParse.h

Go to the documentation of this file.

// # MSSpwParse.h: Classes to hold results from spw grammar parser
// # Copyright (C) 1994,1995,1997,1998,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: casa-feedback@nrao.edu.
// #        Postal address: AIPS++ Project Office
// #                        National Radio Astronomy Observatory
// #                        520 Edgemont Road
// #                        Charlottesville, VA 22903-2475 USA
 
#ifndef MS_MSSPWPARSE_H
#define MS_MSSPWPARSE_H
 
// # Includes
#include <casacore/casa/aips.h>
#include <casacore/ms/MSSel/MSParse.h>
#include <casacore/casa/Arrays/Matrix.h>
#include <casacore/ms/MSSel/MSSelectionErrorHandler.h>
 
namespace casacore {  // # NAMESPACE CASACORE - BEGIN
 
// # Forward Declarations
 
// <summary>
// Class to hold values from field grammar parser
// </summary>
 
// <use visibility=local>
 
// <reviewed reviewer="" date="" tests="">
// </reviewed>
 
// <prerequisite>
// # Classes you should understand before using this one.
// </prerequisite>
 
// <etymology>
// MSSpwParse is the class used to parse a spectral window selection command.
// </etymology>
 
// <synopsis> MSSpwParse is used by the parser of spectral window
// (Spw) sub-expression statements.  The parser is written in Bison
// and Flex in files MSSpwGram.y and .l.  The statements in there use
// the routines in this file to act upon a reduced rule.  Since
// multiple tables can be given (with a shorthand), the table names
// are stored in a list. The variable names can be qualified by the
// table name and will be looked up in the appropriate table.
//
// The class MSSpwParse only contains information about a table
// used in the table command. Global variables (like a list and a vector)
// are used in MSSpwParse.cc to hold further information.
//
// Global functions are used to operate on the information.
// The main function is the global function msSpwCommand.
// It executes the given STaQL command and returns the resulting ms.
// This is, in fact, the only function to be used by a user.
// </synopsis>
 
// <motivation>
// It is necessary to be able to give a ms command in ASCII.
// This can be used in a CLI or in the table browser to get a subset
// of a table or to sort a table.
// </motivation>
 
// # <todo asof="$DATE:$">
// # A List of bugs, limitations, extensions or planned refinements.
// # </todo>
 
class MSSpwParse : public MSParse {
 public:
  // Default constructor
  MSSpwParse();
  //  ~MSSpwParse() {if (node_p) delete node_p;node_p=0x0;};
 
  // Associate the ms and the shorthand.
  MSSpwParse(const MeasurementSet* ms);
  MSSpwParse(const MSSpectralWindow& spwSubTable, const MSDataDescription& ddSubTable,
             const TableExprNode& columnAsTEN);
  ~MSSpwParse() { columnAsTEN_p = TableExprNode(); };
 
  const TableExprNode* selectSpwIdsFromIDList(const Vector<Int>& spwIds, const Bool addTen = True,
                                              const Bool addIDs = True);
  const TableExprNode* selectSpwIdsFromFreqList(const Vector<Float>& spwIds, const Float factor);
  void selectChannelsFromIDList(Vector<Int>& spwIds, Vector<Int>& chanIDList, Int nFSpec);
 
  void selectChannelsFromDefaultList(Vector<Int>& spwIds, Vector<Int>& chanDefaultList);
  const TableExprNode* endOfCeremony(const TableExprNode& ten);
 
  //    const TableExprNode *selectSpwOrSource(const String& fieldName);
 
  // Get table expression node object.
  static const TableExprNode* node();
  static MSSpwParse* thisMSSParser;
  static std::shared_ptr<MSSelectionErrorHandler> thisMSSpwErrorHandler;
  static Vector<Int> selectedDDIDs() { return ddidList; }
  static Vector<Int> selectedIDs() { return idList; }
  static Matrix<Int> selectedChanIDs() { return chanList; }
  static void reset() {
    idList.resize(0);
    chanList.resize(0, 0);
    ddidList.resize(0);
  };
  static void cleanupNode() {
    if (node_p) delete node_p;
    node_p = 0x0;
  }
  static void cleanupErrorHandler() { thisMSSpwErrorHandler.reset(); }
  static void cleanup() {
    cleanupNode();
    cleanupErrorHandler();
  }
 
  MSSpectralWindow& subTable() { return spwSubTable_p; }
 
 private:
  static TableExprNode* node_p;
  static Vector<Int> idList, ddidList;
  static Matrix<Int> chanList;
  MSSpectralWindow spwSubTable_p;
  MSDataDescription ddSubTable_p;
  static TableExprNode columnAsTEN_p;
};
 
}  // namespace casacore
 
#endif