PlotMSAveraging.h

Go to the documentation of this file.

//# PlotMSAveraging.h: Averaging parameters.
//# Copyright (C) 2009
//# 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: aips2-request@nrao.edu.
//#        Postal address: AIPS++ Project Office
//#                        National Radio Astronomy Observatory
//#                        520 Edgemont Road
//#                        Charlottesville, VA 22903-2475 USA
//#
//# $Id: $
#ifndef PLOTMSAVERAGING_H_
#define PLOTMSAVERAGING_H_

#include <plotms/PlotMS/PlotMSConstants.h>

#include <map>

namespace casa {

// Specifies averaging parameters for an MS.
class PlotMSAveraging {
public:
    // Static //
    
    // Enum and methods to define the different fields for an MS averaging.
    // All fields have a bool flag for on/off, and some of them also have a
    // double value (see fieldHasValue()).  Fields are off by default, with a
    // default double value of 0 if applicable.  Some fields are in mutually
    // exclusive groups (see fieldMutuallyExclusiveGroup()).
    // **If these are changed, also update: convenience methods below,
    // xmlcasa/implement/plotms/plotms*, xmlcasa/tasks/plotms.xml,
    // xmlcasa/scripts/task_plotms.py.**
    // <group>
    PMS_ENUM1(Field, fields, fieldStrings, field,
              CHANNEL, TIME, SCAN, FIELD, BASELINE, ANTENNA, SPW, 
              SCALARAVE)
    PMS_ENUM2(Field, fields, fieldStrings, field,
              "channel", "time", "scan", "field", "baseline", 
              "antenna", "spw",
              "scalar")
    // </group>
              
    // Returns whether the given field has a double value associated with it or
    // not.
    static bool fieldHasValue(Field f);
    
    // Returns the list of fields, NOT including the given, with which the
    // given field is mutually exclusive.  In a mutually exclusive group, only
    // one field can be turned on at a given time (although they can all be
    // off at the same time).
    static const vector<Field>& fieldMutuallyExclusiveGroup(Field f);
    
    // Returns true if the given field is in a mutually exclusive group, false
    // otherwise.  See fieldMutuallyExclusiveGroup().
    static bool fieldIsInMutuallyExclusiveGroup(Field f) {
        return fieldMutuallyExclusiveGroup(f).size() > 0; }
    
    
    // Non-Static //
    
    // Constructor, which uses default values.
    PlotMSAveraging();
    
    // Destructor.
    ~PlotMSAveraging();
    
    
    // Converts this object to/from a record.  Each field will have a key that
    // is its enum name, with a bool value for its flag value.  Fields that
    // also have double values will have an additional key that is its enum
    // name + "Value" (i.e. "channelValue" for CHANNEL) with a double value.
    // <group>
    void fromRecord(const RecordInterface& record);
    Record toRecord(bool useStrings = false) const;
    // </group>
    
    // Gets/Sets the on/off flag for the given field.
    // <group>
    bool getFlag(Field f) const;
    void getFlag(Field f, bool& flag) const { flag = getFlag(f); }
    void setFlag(Field f, bool on);
    // </group>
    
    // Gets/Sets the double value for the given field, if applicable.
    // <group>
    double getValue(Field f) const;
    void getValue(Field f, double& value) const { value = getValue(f); }
    void setValue(Field f, double value);
    // </group>
    
    // Gets/Sets the value for the given field as a String.  Blank means a
    // false value (or a field that does not have a double value); otherwise
    // the double value in String form is used.
    // <group>
    String getValueStr(Field f) const;
    void getValue(Field f, String& value) const { value = getValueStr(f); }
    void setValue(Field f, const String& value);
    // </group>


    // If any explicit averaging is turned ON, return True
    bool anyAveraging() const { return (channel() || time() || 
                                  baseline() || antenna() ||spw()); }
    
    // Convenience methods for returning the standard field values.
    // <group>
    bool channel() const { return getFlag(CHANNEL); }
    double channelValue() const { return getValue(CHANNEL); }
    String channelStr() const { return getValueStr(CHANNEL); }
    bool time() const { return getFlag(TIME); }
    double timeValue() const { return getValue(TIME); }
    String timeStr() const { return getValueStr(TIME); }
    bool scan() const { return getFlag(SCAN); }
    bool field() const { return getFlag(FIELD); }
    bool baseline() const { return getFlag(BASELINE); }
    bool antenna() const { return getFlag(ANTENNA); }
    bool spw() const { return getFlag(SPW); }
    bool scalarAve() const { return getFlag(SCALARAVE); }
    // </group>
    
    // Convenience methods for setting the standard field values.
    // <group>
    void setChannel(const String& value) { setValue(CHANNEL, value); }
    void setChannel(bool flag) { setFlag(CHANNEL, flag); }
    void setChannelValue(double value) { setValue(CHANNEL, value); }
    void setTime(const String& value) { setValue(TIME, value); }
    void setTime(bool flag) { setFlag(TIME, flag); }
    void setTimeValue(double value) { setValue(TIME, value); }
    void setScan(bool flag) { setFlag(SCAN, flag); }
    void setField(bool flag) { setFlag(FIELD, flag); }
    void setBaseline(bool flag) { setFlag(BASELINE, flag); }
    void setAntenna(bool flag) { setFlag(ANTENNA, flag); }
    void setSpw(bool flag) { setFlag(SPW, flag); }
    void setScalarAve(bool flag) { setFlag(SCALARAVE,flag); }
    // </group>
    
    
    // Equality operators.
    // <group>
    bool operator==(const PlotMSAveraging& other) const;
    bool operator!=(const PlotMSAveraging& other) const {
        return !(operator==(other)); }
    // </group>
    
    // Print out a summary of the averaging state:
    String summary() const;

    //Print out an abbreviated summary of the averaging state.
    String toStringShort() const;

private:
    // Averaging field flags.
    std::map<Field, bool> itsFlags_;
    
    // Averaging field double values.
    std::map<Field, double> itsValues_;

    
    // Sets the default values.
    void setDefaults();
    
    
    // String constant for what to append to the enum name in the record to
    // get the key for the double value.
    static const String RKEY_VALUE;
};

}

#endif /* PLOTMSAVERAGING_H_ */