ColdPlasmaHistory.h
1//-*-C++-*-
2/***************************************************************************
3 *
4 * Copyright (C) 2006-2025 by Willem van Straten
5 * Licensed under the Academic Free License version 2.1
6 *
7 ***************************************************************************/
8
9// psrchive/Base/Extensions/Pulsar/ColdPlasmaHistory.h
10
11#ifndef __Pulsar_ColdPlasmaHistory_h
12#define __Pulsar_ColdPlasmaHistory_h
13
14#include "Pulsar/IntegrationExtension.h"
15
16namespace Pulsar {
17
20 {
21 public:
22
24 void set_measure (double val) { measure = val; }
26 double get_measure () const { return measure; }
27
29 void set_corrected (bool flag) { corrected = flag; }
31 bool get_corrected () const { return corrected; }
32
34 void set_reference_wavelength (double metres) { reference_wavelength = metres; }
37
39 void set_reference_frequency (double MHz);
41 double get_reference_frequency () const;
42
43 protected:
44
46 double measure = 0.0;
47
50
52 bool corrected = false;
53 };
54
57 {
59 ColdPlasmaMeasure relative;
60
62 ColdPlasmaMeasure absolute;
63
64 public:
65
67 ColdPlasmaHistory (const char* name);
68
71
73 ColdPlasmaMeasure* get_relative() { return &relative; }
74 const ColdPlasmaMeasure* get_relative() const { return &relative; }
75
77 ColdPlasmaMeasure* get_absolute() { return &absolute; }
78 const ColdPlasmaMeasure* get_absolute() const { return &absolute; }
79 };
80
81}
82
83#endif
84
ColdPlasmaHistory(const char *name)
Default constructor.
Definition ColdPlasmaHistory.C:12
ColdPlasmaMeasure * get_absolute()
Get the correction history for the measure corrected with respect to infinite frequency.
Definition ColdPlasmaHistory.h:77
ColdPlasmaMeasure * get_relative()
Get the correction history for the measure corrected with respect to centre frequency.
Definition ColdPlasmaHistory.h:73
Stores parameters used to correct dispersion and Faraday rotation.
Definition ColdPlasmaHistory.h:20
void set_reference_wavelength(double metres)
Set the reference wavelength in metres.
Definition ColdPlasmaHistory.h:34
bool get_corrected() const
Return true when the measure has been corrected.
Definition ColdPlasmaHistory.h:31
double reference_wavelength
The reference wavelength in metres.
Definition ColdPlasmaHistory.h:49
void set_reference_frequency(double MHz)
Set the reference frequency in MHz.
Definition ColdPlasmaHistory.C:24
double measure
The corrected measure.
Definition ColdPlasmaHistory.h:46
void set_corrected(bool flag)
Set true when the measure has been corrected.
Definition ColdPlasmaHistory.h:29
void set_measure(double val)
Set the corrected measure.
Definition ColdPlasmaHistory.h:24
bool corrected
Set true when the measure has been corrected.
Definition ColdPlasmaHistory.h:52
double get_reference_wavelength() const
Get the reference wavelength.
Definition ColdPlasmaHistory.h:36
double get_measure() const
Get the corrected measure.
Definition ColdPlasmaHistory.h:26
double get_reference_frequency() const
Get the reference frequency.
Definition ColdPlasmaHistory.C:29
Definition IntegrationExtension.h:25
Defines the PSRCHIVE library.
Definition CalSource.h:17

Generated using doxygen 1.14.0