MSFeedColumns.h

Go to the documentation of this file.

// # MSFeedColumns.h: provides easy access to MSFeed columns
// # Copyright (C) 1996,1999,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_MSFEEDCOLUMNS_H
#define MS_MSFEEDCOLUMNS_H
 
#include <casacore/casa/aips.h>
#include <casacore/casa/BasicSL/Complex.h>
#include <casacore/measures/Measures/MDirection.h>
#include <casacore/measures/Measures/MEpoch.h>
#include <casacore/measures/Measures/MPosition.h>
#include <casacore/measures/Measures/MCDirection.h>
#include <casacore/measures/Measures/MCEpoch.h>
#include <casacore/measures/Measures/MCPosition.h>
#include <casacore/measures/TableMeasures/ArrayMeasColumn.h>
#include <casacore/measures/TableMeasures/ArrayQuantColumn.h>
#include <casacore/measures/TableMeasures/ScalarMeasColumn.h>
#include <casacore/measures/TableMeasures/ScalarQuantColumn.h>
#include <casacore/tables/Tables/ArrayColumn.h>
#include <casacore/tables/Tables/ScalarColumn.h>
#include <casacore/casa/BasicSL/String.h>
 
namespace casacore {  // # NAMESPACE CASACORE - BEGIN
 
class MSFeed;
 
// <summary>
// A class to provide easy access to MSFeed columns
// </summary>
 
// <use visibility=export>
 
// <reviewed reviewer="Bob Garwood" date="1997/02/01" tests="" demos="">
// </reviewed>
 
// <prerequisite>
//   <li> MSFeed
//   <li> ArrayColumn
//   <li> ScalarColumn
// </prerequisite>
//
// <etymology>
// MSFeedColumns stands for MeasurementSet Feed Table columns.
// </etymology>
//
// <synopsis>
// This class provides access to the columns in the MSFeed Table,
// it does the declaration of all the Scalar and ArrayColumns with the
// correct types, so the application programmer doesn't have to
// worry about getting those right. There is an access function
// for every predefined column. Access to non-predefined columns will still
// have to be done with explicit declarations.
// See <linkto class=MSColumns> MSColumns</linkto> for an example.
// </synopsis>
//
// <motivation>
// See <linkto class=MSColumns> MSColumns</linkto> for the motivation.
// </motivation>
 
class MSFeedColumns {
 public:
  // Create a columns object that accesses the data in the specified Table
  MSFeedColumns(const MSFeed& msFeed);
 
  // The desctructor does nothing special
  ~MSFeedColumns();
 
  // Access to required columns
  // <group>
  ScalarColumn<Int>& antennaId() { return antennaId_p; }
  ScalarColumn<Int>& beamId() { return beamId_p; }
  ArrayColumn<Double>& beamOffset() { return beamOffset_p; }
  ArrayQuantColumn<Double>& beamOffsetQuant() { return beamOffsetQuant_p; }
  ArrayMeasColumn<MDirection>& beamOffsetMeas() { return beamOffsetMeas_p; }
  ScalarColumn<Int>& feedId() { return feedId_p; }
  ScalarColumn<Double>& interval() { return interval_p; }
  ScalarQuantColumn<Double>& intervalQuant() { return intervalQuant_p; }
  ScalarColumn<Int>& numReceptors() { return numReceptors_p; }
  ArrayColumn<Complex>& polResponse() { return polResponse_p; }
  ArrayColumn<String>& polarizationType() { return polarizationType_p; }
  ArrayColumn<Double>& position() { return position_p; }
  ArrayQuantColumn<Double>& positionQuant() { return positionQuant_p; }
  ScalarMeasColumn<MPosition>& positionMeas() { return positionMeas_p; }
  ArrayColumn<Double>& receptorAngle() { return receptorAngle_p; }
  ArrayQuantColumn<Double>& receptorAngleQuant() { return receptorAngleQuant_p; }
  ScalarColumn<Int>& spectralWindowId() { return spectralWindowId_p; }
  ScalarColumn<Double>& time() { return time_p; }
  ScalarQuantColumn<Double>& timeQuant() { return timeQuant_p; }
  ScalarMeasColumn<MEpoch>& timeMeas() { return timeMeas_p; }
  // </group>
 
  // Const access to required columns
  // <group>
  const ScalarColumn<Int>& antennaId() const { return antennaId_p; }
  const ScalarColumn<Int>& beamId() const { return beamId_p; }
  const ArrayColumn<Double>& beamOffset() const { return beamOffset_p; }
  const ArrayQuantColumn<Double>& beamOffsetQuant() const { return beamOffsetQuant_p; }
  const ArrayMeasColumn<MDirection>& beamOffsetMeas() const { return beamOffsetMeas_p; }
  const ScalarColumn<Int>& feedId() const { return feedId_p; }
  const ScalarColumn<Double>& interval() const { return interval_p; }
  const ScalarQuantColumn<Double>& intervalQuant() const { return intervalQuant_p; }
  const ScalarColumn<Int>& numReceptors() const { return numReceptors_p; }
  const ArrayColumn<Complex>& polResponse() const { return polResponse_p; }
  const ArrayColumn<String>& polarizationType() const { return polarizationType_p; }
  const ArrayColumn<Double>& position() const { return position_p; }
  const ArrayQuantColumn<Double>& positionQuant() const { return positionQuant_p; }
  const ScalarMeasColumn<MPosition>& positionMeas() const { return positionMeas_p; }
  const ArrayColumn<Double>& receptorAngle() const { return receptorAngle_p; }
  const ArrayQuantColumn<Double>& receptorAngleQuant() const { return receptorAngleQuant_p; }
  const ScalarColumn<Int>& spectralWindowId() const { return spectralWindowId_p; }
  const ScalarColumn<Double>& time() const { return time_p; }
  const ScalarQuantColumn<Double>& timeQuant() const { return timeQuant_p; }
  const ScalarMeasColumn<MEpoch>& timeMeas() const { return timeMeas_p; }
  // </group>
 
  // Access to optional columns
  // <group>
  ScalarColumn<Double>& focusLength() { return focusLength_p; }
  ScalarQuantColumn<Double>& focusLengthQuant() { return focusLengthQuant_p; }
  ScalarColumn<Int>& phasedFeedId() { return phasedFeedId_p; }
  // </group>
 
  // Const access to optional columns
  // <group>
  const ScalarColumn<Double>& focusLength() const { return focusLength_p; }
  const ScalarQuantColumn<Double>& focusLengthQuant() const { return focusLengthQuant_p; }
  const ScalarColumn<Int>& phasedFeedId() const { return phasedFeedId_p; }
  // </group>
 
  // set the epoch type for the TIME column.
  // <note role=tip>
  // In principle this function can only be used if the table is empty,
  // otherwise already written values may thereafter have an incorrect
  // reference, offset, or unit.  However, it is possible that part of the
  // table gets written before these values are known.  In that case the
  // reference, offset, or units can be set by using a False
  // <src>tableMustBeEmpty</src> argument.
  // </note>
  void setEpochRef(MEpoch::Types ref, Bool tableMustBeEmpty = True);
 
  // set the direction type for the BEAM_OFFSET column. This can only be done
  // when the table has no rows. Trying to do so at other times will throw an
  // exception.
  void setDirectionRef(MDirection::Types ref);
 
  // set the position type for the POSITION column. This can only be done when
  // the table has no rows. Trying to do so at other times will throw an
  // exception.
  void setPositionRef(MPosition::Types ref);
 
  // Convenience function that returns the number of rows in any of the columns
  rownr_t nrow() const { return antennaId_p.nrow(); }
 
  // Returns the last row that contains a feed with the specified values.
  // If no matching row can be found, but a match is possible if the validity
  // time interval is widened, return that row and the suggestion for the
  // new time information.
  // If no change to time is necessary, newTimeQ and newIntervalQ are zero.
  // Returns -1 if no match could be found.
  // Ignore the Feed table rows contained in vector ignoreRows.
  // focusLengthQ is only compared if this optional column is present and
  // if the value of focusLengthQ is not dimensionless.
  Int64 matchFeed(Quantum<Double>& newTimeQ, Quantum<Double>& newIntervalQ, Int antId, Int feedId,
                  Int spwId, const Quantum<Double>& timeQ, const Quantum<Double>& intervalQ,
                  Int numReceptor, const Array<Quantum<Double>>& beamOffsetQ,
                  const Array<String>& polType, const Array<Complex>& polResp,
                  const Array<Quantum<Double>>& positionQ,
                  const Array<Quantum<Double>>& receptorAngleQ, const RowNumbers& ignoreRows,
                  const Quantum<Double>& focusLengthQ = Quantum<Double>());
 
 protected:
  // # default constructor creates a object that is not usable. Use the attach
  // # function correct this.
  MSFeedColumns();
 
  // # attach this object to the supplied table.
  void attach(const MSFeed& msFeed);
 
 private:
  // # Make the assignment operator and the copy constructor private to prevent
  // # any compiler generated one from being used.
  MSFeedColumns(const MSFeedColumns&);
  MSFeedColumns& operator=(const MSFeedColumns&);
 
  // # Check if any optional columns exist and if so attach them.
  void attachOptionalCols(const MSFeed& msFeed);
 
  // # required columns
  ScalarColumn<Int> antennaId_p;
  ScalarColumn<Int> beamId_p;
  ArrayColumn<Double> beamOffset_p;
  ScalarColumn<Int> feedId_p;
  ScalarColumn<Double> interval_p;
  ScalarColumn<Int> numReceptors_p;
  ArrayColumn<Complex> polResponse_p;
  ArrayColumn<String> polarizationType_p;
  ArrayColumn<Double> position_p;
  ArrayColumn<Double> receptorAngle_p;
  ScalarColumn<Int> spectralWindowId_p;
  ScalarColumn<Double> time_p;
  // # optional columns
  ScalarColumn<Double> focusLength_p;
  ScalarColumn<Int> phasedFeedId_p;
 
  // # Access to Measure columns
  ArrayMeasColumn<MDirection> beamOffsetMeas_p;
  ScalarMeasColumn<MPosition> positionMeas_p;
  ScalarMeasColumn<MEpoch> timeMeas_p;
 
  // # Access to Quantum columns
  ArrayQuantColumn<Double> beamOffsetQuant_p;
  ScalarQuantColumn<Double> intervalQuant_p;
  ArrayQuantColumn<Double> positionQuant_p;
  ArrayQuantColumn<Double> receptorAngleQuant_p;
  ScalarQuantColumn<Double> timeQuant_p;
  // # optional Quantum columns
  ScalarQuantColumn<Double> focusLengthQuant_p;
};
 
// # Define the RO version for backward compatibility.
typedef MSFeedColumns ROMSFeedColumns;
 
}  // namespace casacore
 
#endif