MSTransform.h

Go to the documentation of this file.

//# MSTransform.h: this defines MSTransform
//# Copyright (C) 2000,2001
//# 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 MSTRANSFORM_H
#define MSTRANSFORM_H

#include <iostream>
#include <vector>

#include <casacore/casa/Logging/LogIO.h>
#include <casacore/casa/Arrays/Vector.h>
#include <casacore/casa/Containers/Record.h>
#include <casacore/casa/Quanta/Quantum.h>
#include <mstransform/MSTransform/MSTransformManager.h>

namespace casa { //# NAMESPACE CASA - BEGIN

// <summary>
// MSTransform: Apply transformations to data on the fly
// </summary>

// <use visibility=global>

// <reviewed reviewer="" date="" tests="" demos="">
// </reviewed>

// <prerequisite>
//   <li> <linkto class="MSTransformManager:description">MSTransformManager</linkto>
// </prerequisite>
//
// <synopsis>
// MSTransform .......
// </synopsis>
//
// <example>
// The following is a typical way of using this class and its methods ...
//
// <srcblock>
// MSTransform *mst = new MSTransform();
// </srcblock>
//
// Create a casacore::Record with the desired parameters. The parameters are: data selection parameters and any parameters
// for the transformations.
//
// <srcblock>
// casacore::Record params = Recod();
// params.define("spw", "0,1,2");
// params.define("combinespws",true);
// mst->configure(params);
// </srcblock>
//
// Open the casacore::MS, select the data and setup the output MS.
//
// <srcblock>
// mst->open();
// </srcblock>
//
// Run the tool and afterwards, destroy any instance of it by calling the destructor.
//
// <srcblock>
// mst->run();
//
// mst->done();
// </srcblock>
// </example>
//
// <motivation>
// To avoid multiple read/writes of the data....
// </motivation>
//


class MSTransform
{
protected:

        casacore::LogIO log_p;

        // variables used to initialize the MSTransformManager
        casacore::String msname_p;
        casacore::String outputms_p;


        // members to parse to selectData
        casacore::String spw_p;
        casacore::String scan_p;
        casacore::String field_p;
        casacore::String antenna_p;
        casacore::String timerange_p;
        casacore::String correlation_p;
        casacore::String intent_p;
        casacore::String feed_p;
        casacore::String array_p;
        casacore::String uvrange_p;
        casacore::String observation_p;
        casacore::Record config_p;
        casacore::String datacolumn_p;

        // Tells if tool is already configured at least once
        casacore::Bool isconfigured_p;


        // variables for initAgents
        MSTransformManager *mdh_p;

public:  
        // default constructor
        MSTransform();

        // destructor
        ~MSTransform();

        // reset everything
        void done();

        // set the defaults of the parameters
//      casacore::Record & defaultOptions();


        // configure the tool and parse the parameters
        bool configure(casacore::Record config);

        // Open the casacore::MS and select the data
        bool open();

        // Run the tool and write the flags to the MS
        casacore::Record run();


private:

        MSTransform(const MSTransform &) : mdh_p(nullptr) {};

        MSTransform& operator=(const MSTransform &)  {return *this;};

//      casacore::String validateDataColumn(casacore::String datacol);

        // Sink used to store history
        casacore::LogSink logSink_p;


};


} //# NAMESPACE CASA - END

#endif