source: trunk/src/SDMath.h @ 272

//#---------------------------------------------------------------------------
//# SDMath.h: A collection of single dish mathematical operations
//#---------------------------------------------------------------------------
//# Copyright (C) 2004
//# ATNF
//#
//# This program is free software; you can redistribute it and/or modify it
//# under the terms of the GNU General Public License as published by the Free
//# Software Foundation; either version 2 of the License, or (at your option)
//# any later version.
//#
//# This program 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 General
//# Public License for more details.
//#
//# You should have received a copy of the GNU General Public License along
//# with this program; if not, write to the Free Software Foundation, Inc.,
//# 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning this software should be addressed as follows:
//#        Internet email: Malte.Marquarding@csiro.au
//#        Postal address: Malte Marquarding,
//#                        Australia Telescope National Facility,
//#                        P.O. Box 76,
//#                        Epping, NSW, 2121,
//#                        AUSTRALIA
//#
//# $Id:
//#---------------------------------------------------------------------------
#ifndef SDMATH_H
#define SDMATH_H

#include <string>
#include <vector>
#include <casa/aips.h>
#include <casa/Utilities/CountedPtr.h>
#include "SDDefs.h"

class casa::Table;
class casa::MEpoch;


namespace asap {

class SDMemTable;

class SDMath {

 public:

// Default constructor 
   SDMath();

// Copy Constructor (copy semantics)
   SDMath (const SDMath& other);

// Assignment  (copy semantics)
   SDMath &operator=(const SDMath& other);

// Destructor
   ~SDMath();

// Binary Table operators. op=ADD, SUB, MUL, DIV, QUOTIENT
   casa::CountedPtr<SDMemTable> binaryOperate (const casa::CountedPtr<SDMemTable>& left,
                                               const casa::CountedPtr<SDMemTable>& right,
                                               const casa::String& op, casa::Bool preserve) const;

// Average in time
   casa::CountedPtr<SDMemTable>  average(const casa::Block<casa::CountedPtr<SDMemTable> >& in,
                                         const casa::Vector<casa::Bool>& mask,
                                         casa::Bool scanAverage, 
                                         const casa::String& weightStr,
                                         casa::Bool alignVelocity=casa::False) const;

// Statistics. If row<0, all rows are done otherwise, just the 
// specified row.
   std::vector<float> statistic(const casa::CountedPtr<SDMemTable>& in, 
                                const casa::Vector<casa::Bool>& mask, 
                                const casa::String& which, casa::Int row) const;

// Bin up spectra
   SDMemTable* bin(const SDMemTable& in, casa::Int width) const;

// Smooth
   SDMemTable* smooth (const SDMemTable& in, const casa::String& kernel,
                       casa::Float width, casa::Bool doAll) const;

// Flux conversion between Jansky and Kelvin
   SDMemTable* convertFlux (const SDMemTable& in, casa::Float area, 
                            casa::Float eta, casa::Bool doAll) const;

// Gain-elevation correction
   SDMemTable* gainElevation (const SDMemTable& in, const casa::Vector<casa::Float>& coeffs,
                              const casa::String& fileName,
                              const casa::String& method, casa::Bool doAll) const;

// Velocity Alignment
   SDMemTable* velocityAlignment (const SDMemTable& in, const casa::String& refTime) const;

// Opacity correction
   SDMemTable* opacity (const SDMemTable& in, casa::Float tau, casa::Bool doAll) const;

// Simple unary mathematical operations.  what=0 (mul) or 1 (add)
   SDMemTable* unaryOperate(const SDMemTable& in, casa::Float offset, 
                            casa::Bool doAll, casa::uInt what) const;

// Average polarizations
   SDMemTable* averagePol(const SDMemTable& in, const casa::Vector<casa::Bool>& mask) const;

 private:

// Weighting type for time averaging

  enum WeightType {NONE,VAR,TSYS};

// Function to use accumulate data during time averaging

  void accumulate (casa::Double& timeSum, casa::Double& intSum, casa::Int& nAccum,
                   casa::MaskedArray<casa::Float>& sum, casa::Array<casa::Float>& sumSq,
                   casa::Array<casa::Float>& nPts, casa::Array<casa::Float>& tSysSum,
                   const casa::Array<casa::Float>& tSys,  const casa::Array<casa::Float>& nInc,
                   const casa::Vector<casa::Bool>& mask, casa::Double time, casa::Double interval,
                   const casa::Block<casa::CountedPtr<SDMemTable> >& in,
                   casa::uInt iTab, casa::uInt iRow, casa::uInt axis, casa::uInt nAxesSub,
                   casa::Bool useMask, WeightType wtType) const;

// Function to fill Scan Container when averaging in time

  void fillSDC (SDContainer& sc, const casa::Array<casa::Bool>& mask,
                const casa::Array<casa::Float>& data,
                const casa::Array<casa::Float>& tSys,
                casa::Int scanID, casa::Double timeStamp,
                casa::Double interval, const casa::String& sourceName,
                const casa::Vector<casa::uInt>& freqID) const;

// Put the data and mask into the SDContainer
   void putDataInSDC (SDContainer& sc, const casa::Array<casa::Float>& data,
                      const casa::Array<casa::Bool>& mask) const;

// Function to normalize data when averaging in time

  void normalize (casa::MaskedArray<casa::Float>& data,
                  const casa::Array<casa::Float>& sumSq,
                  const casa::Array<casa::Float>& nPts,
                  WeightType wtType, casa::Int axis, casa::Int nAxes) const;

// Function to get the current cursor location
   void getCursorLocation (casa::IPosition& start, casa::IPosition& end,
                           const SDMemTable& in) const;

// Convert weight string to enum value

   void convertWeightString (WeightType& wt, const casa::String& weightStr) const;

// Convert interpolation type string
   void convertInterpString(casa::Int& type, const casa::String& interp) const;

// Correct data from an ascii Table
   void correctFromAsciiTable(SDMemTable* pTabOut, const SDMemTable& in, 
                              const casa::String& fileName,
                              const casa::String& col0, const casa::String& col1,
                              const casa::String& methodStr, casa::Bool doAll,
                              const casa::Vector<casa::Float>& xOut) const;

// Correct data from a Table
   void correctFromTable(SDMemTable* pTabOut, const SDMemTable& in, const casa::Table& tTable,
                         const casa::String& col0, const casa::String& col1,
                         const casa::String& methodStr, casa::Bool doAll,
                         const casa::Vector<casa::Float>& xOut) const;

// Correct data from a Vector
   void correctFromVector (SDMemTable* pTabOut, const SDMemTable& in,
                           casa::Bool doAll, const casa::Vector<casa::Float>& factor) const;

// Read ascii file into a Table

   casa::Table readAsciiFile (const casa::String& fileName) const;

// Generate source table
   void generateSourceTable (casa::Vector<casa::String>& srcTab,
                             casa::Vector<casa::uInt>& srcIdx,
                             casa::Vector<casa::uInt>& firstRow,
                             const casa::Vector<casa::String>& srcNames) const;

// Align in Velocity
   SDMemTable* velocityAlign (const SDMemTable& in,
                              casa::MFrequency::Types velSystem,
                              const casa::String& velUnit,
                              casa::MDoppler::Types doppler,
                              const casa::String& timeRef) const;

// Convert time String to Epoch
   casa::MEpoch epochFromString (const casa::String& str, casa::MEpoch::Types timeRef) const;

// Format EPoch
   casa::String formatEpoch(const casa::MEpoch& epoch)  const;
};

} // namespace

#endif