Simulation/Pulsar/SyntheticPolnProfile.h
1 //-*-C++-*-
2 /***************************************************************************
3  *
4  * Copyright (C) 2005 - 2016 by Willem van Straten
5  * Licensed under the Academic Free License version 2.1
6  *
7  ***************************************************************************/
8 
9 // psrchive/More/Simulation/Pulsar/SyntheticPolnProfile.h
10 
11 #ifndef __Pulsar_SyntheticPolnProfile_h
12 #define __Pulsar_SyntheticPolnProfile_h
13 
14 #include "MEAL/Univariate.h"
15 #include "MEAL/Scalar.h"
16 
17 namespace Pulsar {
18 
19  class PolnProfile;
20  class Profile;
21 
23 
24  class SyntheticPolnProfile : public Reference::Able {
25 
26  public:
27 
30 
33 
36 
39 
41  void set_degree (float);
42 
44  void set_noise_variance (float);
45 
47  void set_noise (float);
48 
50  void set_swims_variance (float);
51 
53  void set_swims (float);
54 
56  void set_baseline (float);
57 
60 
62  void set_position_angle (float);
63 
66 
69 
71  PolnProfile* get_PolnProfile (unsigned nbin) const;
72 
74  void get_PolnProfile (PolnProfile*) const;
75 
76  static void set_Profile (Profile* profile, MEAL::Univariate<MEAL::Scalar>* function);
77 
78  protected:
79 
82 
84  float noise_variance;
85 
87  float swims_variance;
88 
90  float baseline;
91 
94 
96  float constant_degree;
97 
100 
103 
106 
109 
110  };
111 
112 }
113 
114 #endif
float swims_variance
The peak variance of the SWIMS noise.
Definition: Simulation/Pulsar/SyntheticPolnProfile.h:92
~SyntheticPolnProfile()
Destructor.
Definition: SyntheticPolnProfile.C:29
Reference::To< MEAL::Univariate< MEAL::Scalar > > total_intensity
The functional form of the total intensity.
Definition: General/Pulsar/SyntheticPolnProfile.h:68
float constant_degree
The constant degree of polarization.
Definition: General/Pulsar/SyntheticPolnProfile.h:77
void set_linear(MEAL::Univariate< MEAL::Scalar > *)
Set the functional form of the linear polarization.
Definition: SyntheticPolnProfile.C:90
void set_noise(float)
Set the standard deviation of the noise.
Definition: SyntheticPolnProfile.C:55
void set_swims_variance(float)
Set the peak variance of the simulated SWIMS/jitter noise.
Definition: SyntheticPolnProfile.C:60
void set_noise_variance(float)
Set the variance of the noise.
Definition: SyntheticPolnProfile.C:50
Reference::To< MEAL::Univariate< MEAL::Scalar > > degree
The functional form of the degree of polarization.
Definition: General/Pulsar/SyntheticPolnProfile.h:74
PolnProfile * get_PolnProfile(unsigned nbin) const
Get the polarimetric profile.
Definition: SyntheticPolnProfile.C:117
Reference::To< MEAL::Univariate< MEAL::Scalar > > linear
The functional form of the linear polarization.
Definition: General/Pulsar/SyntheticPolnProfile.h:86
void set_swims(float)
Set the peak standard deviation of the simulated SWIMS/jitter noise.
Definition: SyntheticPolnProfile.C:65
Reference::To< MEAL::Univariate< MEAL::Scalar > > position_angle
The functional form of the position angle.
Definition: General/Pulsar/SyntheticPolnProfile.h:80
float constant_position_angle
The constant position angle.
Definition: General/Pulsar/SyntheticPolnProfile.h:83
void set_circular(MEAL::Univariate< MEAL::Scalar > *)
Set the functional form of the circular polarization.
Definition: SyntheticPolnProfile.C:95
float noise_variance
The variance of the noise.
Definition: General/Pulsar/SyntheticPolnProfile.h:71
SyntheticPolnProfile()
Default constructor.
Definition: SyntheticPolnProfile.C:19
void set_baseline(float)
The the off-pulse baseline mean.
Definition: SyntheticPolnProfile.C:71
void set_position_angle(MEAL::Univariate< MEAL::Scalar > *)
Set the functional form of the position angle.
Definition: SyntheticPolnProfile.C:78
void set_total_intensity(MEAL::Univariate< MEAL::Scalar > *)
Set the functional form of the total intensity.
Definition: SyntheticPolnProfile.C:34
Defines the PSRCHIVE library.
Definition: CalSource.h:17
void set_degree(MEAL::Univariate< MEAL::Scalar > *)
Set the functional form of the degree of polarization.
Definition: SyntheticPolnProfile.C:39
Reference::To< MEAL::Univariate< MEAL::Scalar > > circular
The functional form of the circular polarization.
Definition: General/Pulsar/SyntheticPolnProfile.h:89
float baseline
The off-pulse baseline mean intensity.
Definition: Simulation/Pulsar/SyntheticPolnProfile.h:95

Generated using doxygen 1.8.17