Line data    Source code

       1             : //# SpectralElement.cc: Describes (a set of related) spectral lines
       2             : //# Copyright (C) 2001,2004
       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: SpectralElement.cc 21024 2011-03-01 11:46:18Z gervandiepen $
      27             : 
      28             : //# Includes
      29             : #include <components/SpectralComponents/PCFSpectralElement.h>
      30             : 
      31             : #include <casacore/casa/BasicSL/Constants.h>
      32             : #include <casacore/scimath/Functionals/Gaussian1D.h>
      33             : #include <iostream>
      34             : 
      35             : using namespace casacore;
      36             : namespace casa { //# NAMESPACE CASA - BEGIN
      37             : 
      38             : 
      39             : //# Constructors
      40           0 : PCFSpectralElement::PCFSpectralElement()
      41           0 : : SpectralElement() {
      42           0 :         _initFunction();
      43           0 : }
      44             : 
      45           0 : PCFSpectralElement::PCFSpectralElement(
      46             :         SpectralElement::Types type
      47           0 : ) : SpectralElement(type, Vector<Double>(3, 1)) {
      48           0 :         _initFunction();
      49           0 :         setCenter(0);
      50           0 : }
      51             : 
      52           0 : PCFSpectralElement::PCFSpectralElement(
      53             :         SpectralElement::Types type, const Vector<Double>& param
      54           0 : ) : SpectralElement(type, param) {
      55           0 :         if (param.size() != 3) {
      56           0 :                 throw AipsError(
      57             :                         "PCFSpectralElement: PCF function must have "
      58             :                         "3 parameters"
      59           0 :             );
      60             :         }
      61           0 :         if (param[0] == 0) {
      62           0 :                 throw AipsError(
      63             :                         "PCFSpectralElement: PCF amplitude cannot equal 0"
      64           0 :                 );
      65             :         }
      66           0 :         _initFunction();
      67             : 
      68           0 : }
      69             : 
      70           0 : PCFSpectralElement::PCFSpectralElement(
      71             :         SpectralElement::Types type, Double amp,
      72             :         Double center, Double width
      73           0 : ) : SpectralElement(type, Vector<Double>(3)) {
      74           0 :         _initFunction();
      75           0 :         setAmpl(amp);
      76           0 :         setCenter(center);
      77           0 :         setWidth(width);
      78           0 : }
      79             : 
      80           0 : PCFSpectralElement::PCFSpectralElement(const PCFSpectralElement& other)
      81           0 : : SpectralElement(other) {}
      82             : 
      83           0 : PCFSpectralElement::~PCFSpectralElement() {}
      84             : 
      85           0 : Double PCFSpectralElement::getAmpl() const {
      86           0 :   return get()[AMP];
      87             : }
      88             : 
      89           0 : Double PCFSpectralElement::getCenter() const {
      90           0 :   return get()[CENTER];
      91             : }
      92             : 
      93           0 : Double PCFSpectralElement::getWidth() const {
      94           0 :         return get()[WIDTH];
      95             : }
      96             : 
      97           0 : Double PCFSpectralElement::getAmplErr() const {
      98           0 :         return getError()[AMP];
      99             : }
     100             : 
     101           0 : Double PCFSpectralElement::getCenterErr() const {
     102           0 :         return getError()[CENTER];
     103             : }
     104             : 
     105           0 : Double PCFSpectralElement::getWidthErr() const {
     106           0 :         return getError()[WIDTH];
     107             : }
     108             : 
     109           0 : void PCFSpectralElement::setAmpl(const Double ampl) {
     110           0 :         if (ampl == 0) {
     111           0 :                 throw AipsError("PCF amplitude cannot equal 0");
     112             :         }
     113           0 :         Vector<Double> p = get();
     114           0 :         p(0) = ampl;
     115           0 :         _set(p);
     116           0 :         Vector<Double> err = getError();
     117           0 :         err[AMP] = 0;
     118           0 :         setError(err);
     119           0 : } 
     120             : 
     121           0 : void PCFSpectralElement::setCenter(const Double center) {
     122           0 :         Vector<Double> p = get();
     123           0 :         p[1] = center;
     124           0 :         _set(p);
     125           0 :         Vector<Double> err = getError();
     126           0 :         err[CENTER] = 0;
     127           0 :         setError(err);
     128           0 : }
     129             : 
     130           0 : void PCFSpectralElement::setWidth(const Double width) {
     131             : 
     132           0 :         Vector<Double> p = get();
     133           0 :         p[2] = width > 0 ? width : -width;
     134           0 :         _set(p);
     135           0 :         Vector<Double> err = getError();
     136           0 :         err[WIDTH] = 0;
     137           0 :         setError(err);
     138           0 : }
     139           0 : void PCFSpectralElement::fixAmpl(const Bool isFixed) {
     140           0 :         Vector<Bool> myFixed = fixed();
     141           0 :         myFixed[AMP] = isFixed;
     142           0 :         fix(myFixed);
     143           0 : }
     144             : 
     145           0 : void PCFSpectralElement::fixCenter(const Bool isFixed) {
     146           0 :         Vector<Bool> myFixed = fixed();
     147           0 :         myFixed[CENTER] = isFixed;
     148           0 :         fix(myFixed);
     149           0 : }
     150             : 
     151           0 : void PCFSpectralElement::fixWidth(const Bool isFixed) {
     152           0 :         Vector<Bool> myFixed = fixed();
     153           0 :         myFixed[WIDTH] = isFixed;
     154           0 :         fix(myFixed);
     155           0 : }
     156             : 
     157           0 : void PCFSpectralElement::fixByString(const String& s) {
     158           0 :         String fix(s);
     159           0 :         fix.downcase();
     160           0 :         if (fix.contains("p")) {
     161           0 :                 fixAmpl(true);
     162             :         }
     163           0 :         if (fix.contains("c")) {
     164           0 :                 fixCenter(true);
     165             :         }
     166           0 :         if (fix.contains("f")) {
     167           0 :                 fixWidth(true);
     168             :         }
     169           0 : }
     170             : 
     171           0 : Bool PCFSpectralElement::fixedAmpl() const {
     172           0 :         return fixed()[AMP];
     173             : }
     174             : 
     175           0 : Bool PCFSpectralElement::fixedCenter() const {
     176           0 :         return fixed()[CENTER];
     177             : }
     178             : 
     179           0 : Bool PCFSpectralElement::fixedWidth() const {
     180           0 :         return fixed()[WIDTH];
     181             : }
     182             : 
     183           0 : void PCFSpectralElement::set(const Vector<Double>& params) {
     184           0 :         if (params.nelements() != 3) {
     185           0 :                 throw AipsError(
     186             :                         "PCFSpectralElement: PCF must have "
     187             :                         "3 parameters"
     188           0 :                 );
     189             :         }
     190           0 :         if (params[AMP] == 0) {
     191           0 :                 throw AipsError("PCF amplitude cannot equal 0");
     192             :         }
     193           0 :         Vector<Double> p = params.copy();
     194           0 :         if (p[WIDTH] < 0) {
     195           0 :                 p[WIDTH] *= -1;
     196             :         }
     197           0 :         _set(p);
     198           0 : }
     199             : 
     200           0 : Double PCFSpectralElement::getIntegralErr() const {
     201           0 :         Double damp = getAmplErr()/getAmpl();
     202           0 :         Double dwidth = getWidthErr()/getWidth();
     203           0 :         return sqrt(damp*damp + dwidth*dwidth) * getIntegral();
     204             : }
     205             : 
     206           0 : void PCFSpectralElement::_initFunction() {
     207             :         // Just need something we can instantiate, subclasses should set their
     208             :         // own functions in their constructors
     209           0 :         _setFunction(
     210           0 :                 std::shared_ptr<Function<Double> >(
     211           0 :                         new Gaussian1D<Double>()
     212             :                 )
     213             :         );
     214           0 : }
     215             : 
     216             : 
     217             : 
     218             : } //# NAMESPACE CASA - END
     219             :