PolnStatistics.h
1 //-*-C++-*-
2 /***************************************************************************
3  *
4  * Copyright (C) 2011 by Willem van Straten
5  * Licensed under the Academic Free License version 2.1
6  *
7  ***************************************************************************/
8 
9 // psrchive/More/General/Pulsar/PolnStatistics.h
10 
11 #ifndef __Pulsar_PolnStatistics_h
12 #define __Pulsar_PolnStatistics_h
13 
14 #include "Pulsar/Statistics.h"
15 
16 namespace Pulsar
17 {
18  class PolnProfile;
19  class PolnProfileStats;
20 
22  class PolnStatistics : public Statistics::Plugin
23  {
24  public:
25 
26  PolnStatistics ();
27  ~PolnStatistics ();
28 
30  TextInterface::Parser* get_interface ();
31 
33  PolnProfileStats* get_stats ();
34 
35  protected:
36 
37  mutable Reference::To<PolnProfileStats> stats;
38  mutable Reference::To<const PolnProfile, false> profile;
39 
41  void setup_stats ();
42 
43  };
44 }
45 
46 #endif
Pulsar::Profile::offset
void offset(double offset)
offsets each bin of the profile by offset
Definition: Profile.C:301
Pulsar::get_Stokes
const PolnProfile * get_Stokes(const Archive *data, Index subint, Index chan)
Return a new PolnProfile with state == Signal::Stokes.
Definition: Index.C:158
Pulsar::get_Integration
const Integration * get_Integration(const Archive *data, Index subint)
Return the requested profile, cloning and integrating when needed.
Definition: Index.C:118
Pulsar::PhaseWeight
Stores a weight for each Profile phase bin.
Definition: PhaseWeight.h:29
Pulsar::Profile
Any quantity recorded as a function of pulse phase.
Definition: Profile.h:45
Reference::To::release
Type * release()
Pulsar::PolnProfileStats::set_stats
void set_stats(ProfileStats *s)
Set the ProfileStats estimator.
Definition: PolnProfileStats.h:60
Pulsar::PolnStatistics::setup_stats
void setup_stats()
Synchronize to the current state of the Statistics class.
Definition: PolnStatistics.C:72
Pulsar::PolnProfileStats::Interface
Archive statistics text interface.
Definition: PolnProfileStatsInterface.h:25
Pulsar::PolnStatistics
Interface to polarization statistics.
Definition: PolnStatistics.h:27
Pulsar::PolnStatistics::get_interface
TextInterface::Parser * get_interface()
Return a text interface.
Definition: PolnStatistics.C:67
Estimate::get_value
T get_value() const
Pulsar::PolnProfileStats
Computes polarimetric pulse profile statistics.
Definition: PolnProfileStats.h:27
Pulsar::PolnStatistics::get_stats
PolnProfileStats * get_stats()
Return pointer to polarization profile statistics instance.
Definition: PolnStatistics.C:21
Pulsar
Defines the PSRCHIVE library.
Definition: CalSource.h:17
Pulsar::PhaseWeight::set_Profile
void set_Profile(const Profile *profile) const
Set the Profile from which statistics are calculated.
Definition: PhaseWeight.C:303
Pulsar::PhaseWeight::get_mean
Estimate< double > get_mean() const
Get the weighted mean of the Profile amplitudes.
Definition: PhaseWeight.C:334
Generated using doxygen 1.8.17