MSSelUtil.h

Go to the documentation of this file.

// # MSSelUtil.h: this defines MSSelUtil, a helper class for MSSelector
// # Copyright (C) 1998,1999,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: casa-feedback@nrao.edu.
// #        Postal address: AIPS++ Project Office
// #                        National Radio Astronomy Observatory
// #                        520 Edgemont Road
// #                        Charlottesville, VA 22903-2475 USA
 
#ifndef MS_MSSELUTIL_H
#define MS_MSSELUTIL_H
 
#include <casacore/casa/aips.h>
#include <casacore/casa/Arrays/Matrix.h>
#include <casacore/casa/BasicSL/Complex.h>
 
namespace casacore {  // # NAMESPACE CASACORE - BEGIN
 
// <summary>
// Helper class for MSFlagger with templated static function
// </summary>
// <use visibility=local>
// <synopsis>
// Helper class for MSFlagger/DOms with templated static function to difference
// data in one of two directions.
// </synopsis>
 
template <class T>
class MSSelUtil {
 public:
  // Compute the absolute difference of the data, subtracting
  // either the previous value (window==2) or the average over
  // the window (window>2). If doMedian==True is specified, the
  // median difference over the window is returned for window>2.
  // Takes flagging into account.
  // diffAxis==2,3: row or time, diffAxis==1: channel
  // Handles 3d and 4d data arrays.
  static Array<Float> diffData(const Array<T>& data, const Array<Bool>& flag,
                               const Array<Bool>& flagRow, Int diffAxis, Int window,
                               Bool doMedian = False);
};
 
}  // namespace casacore
 
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/ms/MSSel/MSSelUtil.tcc>
#endif  // # CASACORE_NO_AUTO_TEMPLATES
#endif