ATMSpectralGrid.h

Go to the documentation of this file.

#ifndef _ATM_SPECTRALGRID_H
#define _ATM_SPECTRALGRID_H
/*******************************************************************************
 * ALMA - Atacama Large Millimiter Array
 * (c) Instituto de Estructura de la Materia, 2009
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
 *
 * "@(#) $Id: ATMSpectralGrid.h Exp $"
 *
 * who       when      what
 * --------  --------  ----------------------------------------------
 * pardo     24/03/09  created
 */

#ifndef __cplusplus
#error "This is a C++ include file and cannot be used from plain C"
#endif

#include "ATMCommon.h"
#include "ATMEnumerations.h"
#include "ATMFrequency.h"
#include <string>
#include <vector>

ATM_NAMESPACE_BEGIN
class SpectralGrid
{
public:
  SpectralGrid(const Frequency &oneFreq);

  SpectralGrid(unsigned int numChan,
               unsigned int refChan,
               const Frequency &refFreq,
               const Frequency &chanSep);

  SpectralGrid(unsigned int numChan,
               double refFreq,
               double* chanFreq,
               const std::string &freqUnits);
  SpectralGrid(double refFreq, const std::vector<double> &chanFreq, const std::string &freqUnits);
  SpectralGrid(const std::vector<double> &chanFreq, const std::string &freqUnits);
  SpectralGrid(const std::vector<Frequency> &chanFreq);

  SpectralGrid(unsigned int numChan,
               unsigned int refChan,
               const Frequency &refFreq,
               const Frequency &chanSep,
               const Frequency &intermediateFreq,
               const SidebandSide &sbSide,
               const SidebandType &sbType);

  SpectralGrid(unsigned int numChan,
               unsigned int refChan,
               double* chanFreq,
               const std::string &freqUnits);

  SpectralGrid();

  SpectralGrid(const SpectralGrid &);

  ~SpectralGrid();

  unsigned int add(unsigned int numChan,
                   unsigned int refChan,
                   const Frequency &refFreq,
                   const Frequency &chanSep);

  unsigned int add(unsigned int numChan,
                   unsigned int refChan,
                   double* chanFreq,
                   const std::string &freqUnits);

  unsigned int add(unsigned int numChan,
                   double refFreq,
                   double* chanFreq,
                   const std::string &freqUnits);
  unsigned int add(unsigned int numChan,
                   double refFreq,
                   const std::vector<double> &chanFreq,
                   const std::string &freqUnits);
  unsigned int add(const std::vector<Frequency> &chanFreq)
  {
    unsigned int spwid;
    std::vector<double> v;
    for(unsigned int i = 0; i < chanFreq.size(); i++) {
      v.push_back(chanFreq[i].get("GHz"));
    }
    spwid = add(chanFreq.size(), chanFreq[0].get("GHz"), v, "GHz");
    return spwid;
  }
  void add(unsigned int numChan,
           unsigned int refChan,
           const Frequency &refFreq,
           const Frequency &chanSep,
           const Frequency &intermediateFreq,
           const SidebandSide &sbSide,
           const SidebandType &sbType);


  unsigned int getNumSpectralWindow() const;

  unsigned int getNumChan() const;
  unsigned int getNumChan(unsigned int spwId) const;

  unsigned int getRefChan() const;
  unsigned int getRefChan(unsigned int spwId) const;

  // Frequency getRefFreq();
  Frequency getRefFreq() const;

  Frequency getRefFreq(unsigned int spwId) const;

  Frequency getChanSep() const;

  Frequency getChanSep(unsigned int spwId) const;

  Frequency getChanFreq(unsigned int chanNum) const;
  Frequency getChanWidth(unsigned int chanNum) const;

  Frequency getChanFreq(unsigned int spwId, unsigned int chanNum) const;
  Frequency getChanWidth(unsigned int spwId, unsigned int chanNum) const;


  std::vector<double> getSbChanFreq(unsigned int spwId,
                               unsigned int chanNum,
                               const std::string &freqUnits) const;

  std::vector<double> getSpectralWindow(unsigned int spwId) const;

  double getChanNum(double freq) const;
  double getChanNum(unsigned int spwId, double freq) const;

  Frequency getBandwidth() const;

  Frequency getBandwidth(unsigned int spwId) const;

  Frequency getMinFreq() const;

  Frequency getMinFreq(unsigned int spwId) const;

  Frequency getMaxFreq() const;
  Frequency getMaxFreq(unsigned int spwId) const;

  bool isRegular() const;
  bool isRegular(unsigned int spwId) const;

  std::string getSidebandSide(unsigned int spwId) const;

  std::vector<std::string> getAssocNature(unsigned int spwId) const;

  std::vector<unsigned int> getAssocSpwId(unsigned int spwId) const;

  std::vector<unsigned int> getAssocSpwIds(const std::vector<unsigned int> &spwIds) const;

  std::string getSidebandType(unsigned int spwId) const;

  std::string getSideband(unsigned int spwId) const;

  double getLoFrequency() const;
  double getLoFrequency(unsigned int spwId) const;


  bool operator ==(const SpectralGrid&) const;

protected:
  std::string freqUnits_; 
  std::vector<double> v_chanFreq_; 

  std::vector<unsigned int> v_numChan_; 
  std::vector<unsigned int> v_refChan_; 
  std::vector<double> v_refFreq_; 
  std::vector<double> v_chanSep_; 
  std::vector<double> v_maxFreq_; 
  std::vector<double> v_minFreq_; 
  std::vector<double> v_intermediateFrequency_; //<! intermediate frequency of the band for every spectral window
  std::vector<double> v_loFreq_; //<! LO frequency

  std::vector<SidebandSide> v_sidebandSide_; //<!  NOSB=0, LSB=1, USB=2
  std::vector<SidebandType> v_sidebandType_; //<!  DSB=0, SSB=1, TWOSB=2
  std::vector<std::vector<unsigned int> > vv_assocSpwId_; //<!  associated spectral window Id(s)
  std::vector<std::vector<std::string> > vv_assocNature_; //<!  corresponding associated nature

  std::vector<unsigned int> v_transfertId_;

private:

  void appendChanFreq(unsigned int numChan, double* chanFreq);
  void appendChanFreq(unsigned int numChan, const std::vector<double> &chanFreq);
  bool wrongSpwId(unsigned int spwId) const;
};

inline bool SpectralGrid::operator ==(const SpectralGrid & a) const
{
  bool equals = false;

  if(freqUnits_ != a.freqUnits_) return equals;
  if(v_refChan_ != a.v_refChan_) return equals;
  if(v_chanSep_ != a.v_chanSep_) return equals;
  if(v_numChan_ != a.v_numChan_) return equals;
  if(v_maxFreq_ != a.v_maxFreq_) return equals;
  if(v_minFreq_ != a.v_minFreq_) return equals;
  if(!equals)

  if(v_chanFreq_ != a.v_chanFreq_) return equals;

  equals = true;
  return equals;
}; // class SpectralGrid

ATM_NAMESPACE_END

#endif