Refines an RM estimate using two halves of the band. More...

#include <DeltaRM.h>

Public Member Functions

 DeltaRM ()
 Default constructor.
 
 ~DeltaRM ()
 Destructor.
 
void set_rotation_measure (const Estimate< double > &rm)
 Set the rotation measure (initial guess)
 
Estimate< double > get_rotation_measure () const
 Get the rotation measure.
 
unsigned get_used_bins ()
 Get the number of phase bins used in last call to refine.
 
void set_data (Archive *)
 Set the archive from which to derive the refined rotation measure.
 
void refine ()
 Refine the rotation measure estimate.
 
void set_threshold (float t)
 Set the cutoff threshold in units of the baseline noise.
 
float get_threshold () const
 
void set_onpulse (PhaseWeight *w)
 Set the on-pulse mask.
 
void set_include (const std::vector< unsigned > &bins)
 Set the phase bins to be included in the computation. More...
 
void set_exclude (const std::vector< unsigned > &bins)
 Set the phase bins to be excluded from the computation. More...
 
void set_policy (FrequencyIntegrate::Divided *)
 Set the policy used to integrate frequency channels.
 

Protected Attributes

float threshold
 
unsigned used_bins
 
std::vector< unsigned > include_bins
 Include only the specified phase bins.
 
std::vector< unsigned > exclude_bins
 Exclude the specified phase bins.
 
Estimate< double > rotation_measure
 The rotation measure.
 
Reference::To< Archivedata
 The archive from which the rotation measure will be refined.
 
Reference::To< PhaseWeightonpulse_weights
 Weights applied to each phase bin (defines on-pulse region)
 
Reference::To< FrequencyIntegrate::Divided > policy
 Policy used to integrate frequency channels.
 

Detailed Description

Refines an RM estimate using two halves of the band.

Member Function Documentation

◆ set_exclude()

void Pulsar::DeltaRM::set_exclude ( const std::vector< unsigned > &  bins)

Set the phase bins to be excluded from the computation.

Set the phase bins to be excluded exclude the mean.

◆ set_include()

void Pulsar::DeltaRM::set_include ( const std::vector< unsigned > &  bins)

Set the phase bins to be included in the computation.

Set the phase bins to be included in the mean.


The documentation for this class was generated from the following files:

Generated using doxygen 1.8.17