source: trunk/external-alma/components/SpectralComponents/SpectralElement.cc@ 3144

Last change on this file since 3144 was 3106, checked in by Takeshi Nakazato, 8 years ago

New Development: No

JIRA Issue: No

Ready for Test: Yes/No

Interface Changes: Yes/No

What Interface Changed: Please list interface changes

Test Programs: List test programs

Put in Release Notes: Yes/No

Module(s): Module Names change impacts.

Description: Describe your changes here...


Check-in asap modifications from Jim regarding casacore namespace conversion.

File size: 6.4 KB
Line 
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: aips2-request@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 21451 2014-06-10 07:48:08Z gervandiepen $
27
28#include <components/SpectralComponents/SpectralElement.h>
29
30#include <casa/BasicSL/Constants.h>
31#include <casa/BasicSL/String.h>
32#include <casa/Arrays/ArrayLogical.h>
33#include <casa/Exceptions/Error.h>
34#include <casa/Utilities/MUString.h>
35#include <scimath/Mathematics/AutoDiffMath.h>
36#include <scimath/Functionals/Function.h>
37
38//debug only
39#include <scimath/Functionals/CompiledFunction.h>
40#include <casa/Arrays/ArrayIO.h>
41
42#include <casa/iostream.h>
43
44using namespace casacore;
45namespace casa { //# NAMESPACE CASA - BEGIN
46
47SpectralElement::SpectralElement(SpectralElement::Types type, const Vector<Double>& parms)
48 : _type(type), _params(parms), _errors(parms.size(), 0),
49 _fixed(parms.size(), False) {}
50
51
52SpectralElement::SpectralElement(const SpectralElement &other)
53: _type(other._type), _params(other._params.copy()), _errors(other._errors.copy()),
54 _fixed(other._fixed.copy()),
55 _function(
56 SHARED_PTR<Function<Double, Double> >(
57 other._function->clone()
58 )
59 ) {}
60
61SpectralElement::~SpectralElement() {}
62
63SpectralElement &SpectralElement::operator=(
64 const SpectralElement &other
65) {
66 if (this != &other) {
67 _type = other._type;
68 uInt n = other._params.size();
69 _params.resize(n);
70 _params = other._params.copy();
71 _errors.resize(n);
72 _errors = other._errors.copy();
73 _fixed.resize(n);
74 _fixed = other._fixed.copy();
75 _function = SHARED_PTR<Function<Double, Double> >(
76 other._function->clone()
77 );
78 }
79 return *this;
80}
81
82Double SpectralElement::operator[](const uInt n) const {
83 if (n >= _params.size()) {
84 throw(AipsError("SpectralElement: Illegal index for parameter"));
85 }
86 return _params[n];
87}
88
89Bool SpectralElement::operator==(
90 const SpectralElement& other
91) const {
92 if (this == &other) {
93 return True;
94 }
95 return (
96 _type == other._type && allNear(_params, other._params, 1e-8)
97 && allNear(_errors, other._errors, 1e-8)
98 && allTrue(_fixed == other._fixed)
99 );
100}
101
102const String* SpectralElement::allTypes(
103 Int &nall, const SpectralElement::Types *&typ
104) {
105 static const String tname[SpectralElement::N_Types] = {
106 String("GAUSSIAN"),
107 String("POLYNOMIAL"),
108 String("COMPILED"),
109 String("GAUSSIAN MULTIPLET"),
110 String("LORENTZIAN"),
111 String("POWER LOGARITHMIC POLYNOMIAL"),
112 String("LOGARITHMIC TRANSFORMED POLYNOMIAL")
113
114 };
115
116 static const SpectralElement::Types oname[SpectralElement::N_Types] = {
117 SpectralElement::GAUSSIAN,
118 SpectralElement::POLYNOMIAL,
119 SpectralElement::COMPILED,
120 SpectralElement::GMULTIPLET,
121 SpectralElement::LORENTZIAN,
122 SpectralElement::POWERLOGPOLY,
123 SpectralElement::LOGTRANSPOLY
124
125 };
126
127 nall = SpectralElement::N_Types;
128 typ = oname;
129 return tname;
130}
131
132void SpectralElement::_set(const Vector<Double>& params) {
133 _params = params.copy();
134 for (uInt i=0; i<params.size(); i++) {
135 (*_function)[i] = params[i];
136 }
137}
138
139void SpectralElement::_setType(const SpectralElement::Types type) {
140 _type = type;
141}
142
143const String &SpectralElement::fromType(SpectralElement::Types tp) {
144 Int nall;
145 const SpectralElement::Types *typ;
146 const String *const tname = SpectralElement::allTypes(nall, typ);
147 return tname[tp];
148}
149
150Bool SpectralElement::toType(
151 SpectralElement::Types &tp, const String &typname
152) {
153 Int nall;
154 const SpectralElement::Types *typ;
155 const String *const tname = SpectralElement::allTypes(nall, typ);
156
157 // Make sure a value returned
158 tp = typ[0];
159 Int i = MUString::minimaxNC(typname, SpectralElement::N_Types, tname);
160 if (i >= nall) {
161 return False;
162 }
163 tp = typ[i];
164 return True;
165}
166
167void SpectralElement::_setFunction(
168 const SHARED_PTR<Function<Double, Double> >& f
169) {
170 _function = f;
171}
172
173Double SpectralElement::operator()(const Double x) const {
174 return (*_function)(x);
175}
176
177void SpectralElement::get(Vector<Double> &param) const {
178 param = _params.copy();
179}
180
181Vector<Double> SpectralElement::get() const {
182 return _params.copy();
183}
184
185void SpectralElement::getError(Vector<Double> &err) const {
186 err = _errors.copy();
187}
188
189Vector<Double> SpectralElement::getError() const {
190 return _errors.copy();
191}
192
193void SpectralElement::setError(const Vector<Double> &err) {
194 if (err.nelements() != _params.nelements()) {
195 throw(
196 AipsError(
197 "SpectralElement: setting incorrect "
198 "number of errors in the element"
199 )
200 );
201 }
202 _errors = err.copy();
203}
204
205void SpectralElement::fix(const Vector<Bool> &fix) {
206 if (fix.nelements() != _params.nelements()) {
207 throw(
208 AipsError(
209 "SpectralElement: setting incorrect number of fixed "
210 "in the element"
211 )
212 );
213 }
214 _fixed = fix.copy();
215 for (uInt i=0; i<_fixed.size(); i++) {
216 _function->mask(i) = fix[i];
217 }
218}
219
220const Vector<Bool>& SpectralElement::fixed() const {
221 return _fixed;
222}
223
224Bool SpectralElement::toRecord(RecordInterface &out) const {
225 out.define(RecordFieldId("type"), fromType(_type));
226 Vector<Double> ptmp(_params);
227 Vector<Double> etmp(_params);
228 out.define(RecordFieldId("parameters"), _params);
229 out.define(RecordFieldId("errors"), _errors);
230 out.define(RecordFieldId("fixed"), _fixed);
231 return True;
232}
233
234void SpectralElement::set(const Vector<Double>& params) {
235 if (params.size() != get().size()) {
236 throw AipsError(
237 "Input number of parameters does not match "
238 "the current number of parameters"
239 );
240 }
241 _set(params);
242}
243
244} //# NAMESPACE CASA - END
245
246
Note: See TracBrowser for help on using the repository browser.