CalibratorStokesInfo.h
1 //-*-C++-*-
2 /***************************************************************************
3  *
4  * Copyright (C) 2003 - 2016 by Willem van Straten
5  * Licensed under the Academic Free License version 2.1
6  *
7  ***************************************************************************/
8 
9 // psrchive/More/Polarimetry/Pulsar/CalibratorStokesInfo.h
10 
11 #ifndef __Pulsar_CalibratorStokesInfo_H
12 #define __Pulsar_CalibratorStokesInfo_H
13 
14 #include "Pulsar/Calibrator.h"
15 
16 namespace Pulsar {
17 
18  class CalibratorStokes;
19 
21  class CalibratorStokesInfo : public Calibrator::Info {
22 
23  public:
24 
27 
29  std::string get_title () const;
30 
32  unsigned get_nchan () const;
33 
35  unsigned get_nclass () const;
36 
38  std::string get_name (unsigned iclass) const;
39 
41  unsigned get_nparam (unsigned iclass) const;
42 
44  Estimate<float> get_param (unsigned ichan, unsigned iclass,
45  unsigned iparam) const;
46 
48  void set_together (bool flag) { together = flag; }
49 
51  void set_degree (bool flag) { degree = flag; }
52 
53  protected:
54 
57 
59  bool together;
60 
62  bool degree;
63 
64  };
65 
66 }
67 
68 #endif
CalibratorStokesInfo(const CalibratorStokes *calibrator)
Constructor.
Definition: CalibratorStokesInfo.C:14
unsigned get_nclass() const
Return the number of parameter classes.
Definition: CalibratorStokesInfo.C:33
Estimate< float > get_param(unsigned ichan, unsigned iclass, unsigned iparam) const
Return the estimate of the specified parameter.
Definition: CalibratorStokesInfo.C:71
std::string get_title() const
Return the title.
Definition: CalibratorStokesInfo.C:27
bool degree
Plot the degree of polarization in a fourth panel.
Definition: CalibratorStokesInfo.h:67
std::string get_name(unsigned iclass) const
Return the name of the specified class.
Definition: CalibratorStokesInfo.C:42
void set_together(bool flag)
Group all three calibrator Stokes parameters in one class.
Definition: CalibratorStokesInfo.h:53
unsigned get_nchan() const
Return the number of frequency channels.
Definition: CalibratorStokesInfo.C:22
Stores the Stokes parameters of the reference source.
Definition: CalibratorStokes.h:28
unsigned get_nparam(unsigned iclass) const
Return the number of parameters in the specified class.
Definition: CalibratorStokesInfo.C:61
void set_degree(bool flag)
Add an additional class for the calibrator degree of polarization.
Definition: CalibratorStokesInfo.h:56
bool together
Plot all of the Stokes parameters in one panel.
Definition: CalibratorStokesInfo.h:64
Reference::To< const CalibratorStokes > calibrator_stokes
The CalibratorStokes to be plotted.
Definition: CalibratorStokesInfo.h:61
Defines the PSRCHIVE library.
Definition: CalSource.h:17

Generated using doxygen 1.8.17