Line data    Source code

       1             : //# SpectralList.cc: A set of SpectralElements
       2             : //# Copyright (C) 2001,2002
       3             : //# Associated Universities, Inc. Washington DC, USA.
       4             : //#
       5             : //# This library is free software; you can redistribute it and/or modify it
       6             : //# under the terms of the GNU Library General Public License as published by
       7             : //# the Free Software Foundation; either version 2 of the License, or (at your
       8             : //# option) any later version.
       9             : //#
      10             : //# This library is distributed in the hope that it will be useful, but WITHOUT
      11             : //# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
      12             : //# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
      13             : //# License for more details.
      14             : //#
      15             : //# You should have received a copy of the GNU Library General Public License
      16             : //# along with this library; if not, write to the Free Software Foundation,
      17             : //# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
      18             : //#
      19             : //# Correspondence concerning AIPS++ should be addressed as follows:
      20             : //#        Internet email: casa-feedback@nrao.edu.
      21             : //#        Postal address: AIPS++ Project Office
      22             : //#                        National Radio Astronomy Observatory
      23             : //#                        520 Edgemont Road
      24             : //#                        Charlottesville, VA 22903-2475 USA
      25             : //#
      26             : //# $Id: SpectralList.cc 21024 2011-03-01 11:46:18Z gervandiepen $
      27             : 
      28             : //# Includes
      29             : #include <components/SpectralComponents/SpectralList.h>
      30             : 
      31             : #include <casacore/casa/Exceptions/Error.h>
      32             : #include <casacore/casa/Containers/RecordInterface.h>
      33             : #include <casacore/casa/Containers/Record.h>
      34             : #include <components/SpectralComponents/GaussianSpectralElement.h>
      35             : #include <memory>
      36             : #include <components/SpectralComponents/SpectralElementFactory.h>
      37             : 
      38             : #include <iostream>
      39             : 
      40             : using namespace casacore;
      41             : namespace casa { //# NAMESPACE CASA - BEGIN
      42             : 
      43             : //# Constructors
      44           0 : SpectralList::SpectralList() :
      45           0 :   nmax_p(0), list_p(0) {}
      46             : 
      47           0 : SpectralList::SpectralList(uInt nmax) :
      48           0 :   nmax_p(nmax), list_p(0) {
      49           0 : }
      50             : 
      51           0 : SpectralList::SpectralList(const SpectralElement &in) :
      52           0 :   nmax_p(0), list_p(1) {
      53           0 :   list_p[0] = in.clone();
      54           0 : }
      55             : 
      56           0 : SpectralList::SpectralList(const SpectralList &other) :
      57           0 :   nmax_p(other.nmax_p), list_p(other.list_p.nelements()) {
      58           0 :   for (uInt i=0; i<list_p.nelements(); i++) {
      59           0 :     list_p[i] = other.list_p[i]->clone();
      60             :   }
      61           0 : }
      62             : 
      63           0 : SpectralList::~SpectralList() {
      64           0 :   clear();
      65           0 : }
      66             : 
      67           0 : SpectralList &SpectralList::operator=(const SpectralList &other) {
      68           0 :   if (this != &other) {
      69           0 :     clear();
      70           0 :     nmax_p = other.nmax_p;
      71           0 :     list_p.resize(other.list_p.nelements());
      72           0 :     for (uInt i=0; i<list_p.nelements(); i++) {
      73           0 :       list_p[i] = other.list_p[i]->clone();
      74             :     }
      75             :   }
      76           0 :   return *this;
      77             : }
      78             : 
      79           0 : Double SpectralList::operator()(const Double x) const {
      80           0 :   Double s(0);
      81           0 :   for (uInt i=0; i<list_p.nelements(); i++) s += (*list_p[i])(x);
      82           0 :   return s;
      83             : }
      84             : 
      85           0 : const SpectralElement* SpectralList::operator[](const uInt n) const {
      86           0 :   if (n >= list_p.nelements()) {
      87           0 :       throw(AipsError("SpectralList: Illegal index for element"));
      88             :   }
      89           0 :   return list_p[n];
      90             : }
      91             : 
      92           0 : SpectralElement* SpectralList::operator[](const uInt n) {
      93           0 :   if (n >= list_p.nelements()) {
      94           0 :       throw(AipsError("SpectralList: Illegal index for element"));
      95             :   }
      96           0 :   return list_p[n];
      97             : }
      98             : 
      99           0 : Bool SpectralList::add(const SpectralElement &in) {
     100           0 :   uInt i = list_p.nelements();
     101           0 :   if (nmax_p != 0 && i >= nmax_p) return false;
     102           0 :   list_p.resize(i+1);
     103           0 :   list_p[i] = in.clone();
     104           0 :   return true;
     105             : }
     106             : 
     107           0 : Bool SpectralList::add(const SpectralList &in) {
     108           0 :   for (uInt i=0; i<in.nelements(); i++) {
     109           0 :           if (! add(*in[i])) {
     110           0 :                   return false;
     111             :           }
     112             :   }
     113           0 :   return true;
     114             : }
     115             : 
     116           0 : void SpectralList::insert(const SpectralElement &in) {
     117           0 :         uInt n = list_p.nelements();
     118             :         uInt i;
     119           0 :         for (i=0; i<n; i++) {
     120           0 :                 if (compar(in, *list_p[i]) > 0) {
     121           0 :                         break;
     122             :                 }
     123             :         }
     124           0 :         if (i == n) add(in);
     125             :         else {
     126           0 :                 if (nmax_p != 0 && n >= nmax_p) {
     127           0 :                         delete list_p[n-1]; list_p[n-1] = 0;
     128             :                 } else {
     129           0 :                         list_p.resize(n+1);
     130           0 :                         list_p[n++] = 0;
     131             :                 }
     132           0 :                 for (uInt j=n-1; j>i; j--) list_p[j] = list_p[j-1];
     133           0 :                 if (in.getType() == SpectralElement::GAUSSIAN) {
     134           0 :                         const GaussianSpectralElement *gIn = dynamic_cast<const GaussianSpectralElement *>(&in);
     135           0 :                         list_p[i] = new GaussianSpectralElement(*gIn);
     136             :                 }
     137             :                 else {
     138             :                         // FIXME for other subclasses
     139           0 :                         list_p[i] = in.clone();
     140             :                 }
     141             :         }
     142           0 : }
     143             : 
     144           0 : void SpectralList::insert(const SpectralList &in) {
     145           0 :         for (uInt i=0; i<in.nelements(); i++) {
     146           0 :                 insert(*in[i]);
     147             :         }
     148           0 : }
     149             : 
     150           0 : Bool SpectralList::set(const SpectralElement &in, const uInt which) {
     151           0 :   uInt i = list_p.nelements();
     152           0 :   if (nmax_p != 0 && which >= nmax_p) return false;
     153           0 :   if (which > i) return false;
     154           0 :   if (which == i) add(in);
     155           0 :   delete list_p[which]; list_p[which] = 0;
     156           0 :   list_p[which] = in.clone();
     157           0 :   return true;
     158             : }
     159             : 
     160           0 : void SpectralList::clear() {
     161           0 :   for (uInt i=0; i<list_p.nelements(); i++) {
     162           0 :     delete list_p[i]; list_p[i] = 0;
     163             :   }
     164           0 :   list_p.resize(0, true);
     165           0 : }
     166             : 
     167           0 : void SpectralList::set(const uInt nmax) {
     168           0 :   if (nmax != 0 && nmax < list_p.nelements()) {
     169           0 :     for (uInt i=nmax; i<list_p.nelements(); i++) {
     170           0 :       delete list_p[i]; list_p[i] = 0;
     171             :     }
     172           0 :     list_p.resize(nmax, true);
     173             :   }
     174           0 :   nmax_p = nmax;
     175           0 : }
     176             : 
     177           0 : Bool SpectralList::fromRecord (String& errMsg, const RecordInterface& container)
     178             : {
     179           0 :    clear();
     180           0 :    for (uInt i=0; i<container.nfields(); i++) {
     181           0 :       if (container.dataType(i)==TpRecord) {
     182           0 :          const RecordInterface& rec = container.asRecord(i);
     183           0 :          std::unique_ptr<SpectralElement> specEl(SpectralElementFactory::fromRecord(rec));
     184           0 :          add(*specEl);
     185           0 :       } else {
     186           0 :          errMsg = String("Illegal record structure");
     187           0 :          return false;
     188             :       }
     189             :    }
     190           0 :    return true;
     191             : }
     192             : 
     193           0 : Bool SpectralList::toRecord(RecordInterface& container) const {
     194           0 :    String errMsg;
     195           0 :    for (uInt i=0; i<list_p.nelements(); i++) {
     196           0 :       Record elRec;
     197           0 :       list_p[i]->toRecord(elRec);
     198           0 :       container.defineRecord(i, elRec);
     199           0 :    }
     200           0 :    return true;
     201           0 : }
     202             :   
     203             : 
     204           0 : void SpectralList::sort() {
     205           0 :   uInt n = list_p.nelements();
     206           0 :   if (n < 2) return;
     207             :   SpectralElement *x;
     208           0 :   for (uInt i=0; i<n-1; i++) {
     209           0 :     for (uInt j=n-1; j>i; j--) {
     210           0 :       if (compar(*list_p[j-1], *list_p[j]) < 0) {
     211           0 :         x = list_p[j-1];
     212           0 :         list_p[j-1] = list_p[j];
     213           0 :         list_p[j] = x;
     214             :       }
     215             :     }
     216             :   }
     217             : }
     218             : 
     219           0 : Int SpectralList::compar(
     220             :         const SpectralElement &p1,
     221             :         const SpectralElement &p2
     222             : ) const {
     223           0 :         SpectralElement::Types p1Type = p1.getType();
     224           0 :         SpectralElement::Types p2Type = p2.getType();
     225           0 :         Double p1Amp = 0;
     226           0 :         Double p2Amp = 0;
     227           0 :         if (p1Type == SpectralElement::GAUSSIAN) {
     228           0 :                 const GaussianSpectralElement *g1 = dynamic_cast<const GaussianSpectralElement *>(&p1);
     229           0 :                 p1Amp = g1->getAmpl();
     230             :         }
     231           0 :         if (p2Type == SpectralElement::GAUSSIAN) {
     232           0 :                 const GaussianSpectralElement *g2 = dynamic_cast<const GaussianSpectralElement *>(&p2);
     233           0 :                 p2Amp = g2->getAmpl();
     234             :         }
     235           0 :         if (p1Amp > p2Amp) {
     236           0 :                 return 1;
     237             :         }
     238           0 :         else if (p1Amp < p2Amp) {
     239           0 :                 return -1;
     240             :         }
     241             :         else {
     242           0 :                 return 0;
     243             :         }
     244             : }
     245             : 
     246           0 : ostream &operator<<(ostream &os, const SpectralList &lst) {
     247           0 :   os << lst.nelements() << " in SpectralList:" << endl;
     248           0 :   for (uInt i=0; i<lst.nelements(); i++) os << *lst[i];
     249             : 
     250           0 :   return os;
     251             : }
     252             : 
     253             : } //# NAMESPACE CASA - END
     254             : 
     255             : 
     256             : //# Cater for Double and Float
     257             : #ifdef AIPS_NO_TEMPLATE_SRC
     258             : #include <components/SpectralComponents/SpectralList2.tcc>
     259             : 
     260             : using namespace casacore;
     261             : namespace casa { //# NAMESPACE CASA - BEGIN
     262             : template void SpectralList::residual<Double>(Vector<Double> &) const;
     263             : template void SpectralList::residual<Float>(Vector<Float> &) const;
     264             : template void SpectralList::evaluate<Double>(Vector<Double> &) const;
     265             : template void SpectralList::evaluate<Float>(Vector<Float> &) const;
     266             : template void SpectralList::residual<Double>(Vector<Double> &, 
     267             :                                      Vector<Double> const &) const; 
     268             : template void SpectralList::residual<Float>(Vector<Float> &,
     269             :                                      Vector<Float> const &) const; 
     270             : template void SpectralList::evaluate<Double>(Vector<Double> &, 
     271             :                                      Vector<Double> const &) const; 
     272             : template void SpectralList::evaluate<Float>(Vector<Float> &,
     273             :                                      Vector<Float> const &) const; 
     274             : } //# NAMESPACE CASA - END
     275             : #endif