Gyoto
GyotoSpectrometer.h
Go to the documentation of this file.
1
8/*
9 Copyright 2011-2016 Thibaut Paumard
10
11 This file is part of Gyoto.
12
13 Gyoto is free software: you can redistribute it and/or modify
14 it under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 Gyoto is distributed in the hope that it will be useful,
19 but WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 GNU General Public License for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with Gyoto. If not, see <http://www.gnu.org/licenses/>.
25 */
26
27#ifndef __GyotoSpectrometer_H_
28#define __GyotoSpectrometer_H_
29
30#include <GyotoDefs.h>
31#include <GyotoSmartPointer.h>
32#include <GyotoObject.h>
33#include <GyotoRegister.h>
34#include <GyotoHooks.h>
35#include <string>
36
50namespace Gyoto{
51 namespace Register { class Entry; }
52 class FactoryMessenger;
53 namespace Spectrometer {
71 class Generic;
72
85 typedef char const * kind_t;
86
96 Subcontractor_t(Gyoto::FactoryMessenger*, std::vector<std::string> const &);
98
120 std::vector<std::string> &plugins,
121 int errmode = 0);
122
133 (FactoryMessenger* fmp, std::vector<std::string> const &plugins) {
134 SmartPointer<T> spectro = new T();
135 spectro -> plugins(plugins);
136#ifdef GYOTO_USE_XERCES
137 if (fmp) spectro -> setParameters(fmp);
138#endif
139 return spectro;
140 }
141
150
157
177 void Register(std::string name, Gyoto::Spectrometer::Subcontractor_t* scp);
178
179 }
180}
181
183: public Gyoto::SmartPointee,
184 public Gyoto::Object,
186{
188 protected:
198 public:
201
217 double* boundaries_;
218
225
231 double* midpoints_;
232
238 double* widths_;
239
240 public:
242
249
270 Generic(kind_t kindid);
271
277 Generic(const Generic& ) ;
278
292 virtual Generic * clone() const =0;
293
299 virtual ~Generic();
300
315 virtual kind_t kindid() const ;
316
337 virtual void kindid(kind_t) ;
338
339 virtual size_t nSamples() const ;
340 virtual size_t getNBoundaries() const ;
341 virtual double const * getMidpoints() const ;
347 virtual void getMidpoints( double data[], std::string unit);
353 virtual void getChannelBoundaries( double data[], std::string unit);
354 virtual double const * getChannelBoundaries() const ;
355 virtual size_t const * getChannelIndices() const ;
356 virtual double const * getWidths() const ;
367 virtual void getWidths( double data[], std::string unit);
368
369};
370
371
372#endif
#define size_t
If not defined in <sys/types.h>.
Definition: GyotoConfig.h:390
Gyoto ubiquitous macros and typedefs.
Tellers tell Listeners when they mutate.
Introspectable objects.
#define GYOTO_OBJECT
Declare class::properties and class::getProperties()
Definition: GyotoObject.h:84
Gyoto registers.
Reference-counting pointers.
Factory / SmartPointee::Subcontractor_t interface.
Definition: GyotoFactoryMessenger.h:92
Listen to me and I'll warn you when I change.
Definition: GyotoHooks.h:82
Object with properties.
Definition: GyotoObject.h:152
Entry in a register (or a full register)
Definition: GyotoRegister.h:117
Can be pointed to by a SmartPointer.
Definition: GyotoSmartPointer.h:81
Base class for spectrometers.
Definition: GyotoSpectrometer.h:186
virtual size_t const * getChannelIndices() const
Get Generic::chanind_.
virtual double const * getMidpoints() const
Get Generic::midpoints_.
virtual size_t getNBoundaries() const
Get Generic::nboundaries_.
double * midpoints_
Effective frequency (in Hz) of each spectral channel.
Definition: GyotoSpectrometer.h:231
double * boundaries_
Frequency (in Hz) at the boundaries of the spectral channels.
Definition: GyotoSpectrometer.h:217
virtual double const * getWidths() const
Get Generic::widths_.
virtual size_t nSamples() const
Get Generic::nsamples_.
size_t nsamples_
Number of spectral elements.
Definition: GyotoSpectrometer.h:199
virtual double const * getChannelBoundaries() const
Get Generic::boundaries_.
size_t nboundaries_
Size of the boundaries_ array.
Definition: GyotoSpectrometer.h:200
size_t * chanind_
Indices in boundaries_.
Definition: GyotoSpectrometer.h:224
kind_t kindid_
Spectrometer kind ID.
Definition: GyotoSpectrometer.h:197
virtual Generic * clone() const =0
Clone an instance.
virtual kind_t kindid() const
Get kindid_.
double * widths_
Width of each channel.
Definition: GyotoSpectrometer.h:238
Gyoto::Register::Entry * Register_
The Spectrometer register.
SmartPointer< Gyoto::Spectrometer::Generic > Subcontractor_t(Gyoto::FactoryMessenger *, std::vector< std::string > const &)
A function to build instances of a specific Astrobj::Generic sub-class.
Definition: GyotoSpectrometer.h:96
char const * kind_t
Type for Spectrometer kind.
Definition: GyotoSpectrometer.h:85
Gyoto::Spectrometer::Subcontractor_t * getSubcontractor(std::string name, std::vector< std::string > &plugins, int errmode=0)
Query the Spectrometer register.
SmartPointer< Spectrometer::Generic > Subcontractor(FactoryMessenger *fmp, std::vector< std::string > const &plugins)
A template for Subcontractor_t functions.
Definition: GyotoSpectrometer.h:133
void Register(std::string name, Gyoto::Spectrometer::Subcontractor_t *scp)
Register a new Spectrometer kind.
void initRegister()
Initialize the Spectrometer register This must be called once. It initializes Register_ and registers...
Namespace for the Gyoto library.
Definition: GyotoAstrobj.h:43