Pulsar::RotatingVectorModelShift Class Reference

Estimates phase shift using phi0 from the best-fit rotating vector model. More...

#include <RotatingVectorModelShift.h>

Inheritance diagram for Pulsar::RotatingVectorModelShift:
Pulsar::PolnProfileShiftEstimator Pulsar::ShiftEstimator Pulsar::Algorithm Reference::Able Reference::HeapTracked

Public Member Functions

 RotatingVectorModelShift ()
 Default constructor.
 
 RotatingVectorModelShift (const RotatingVectorModelShift &)
 Copy constructor.
 
const RotatingVectorModelShiftoperator= (const RotatingVectorModelShift &)
 Assignment operator.
 
 ~RotatingVectorModelShift ()
 Destructor.
 
RotatingVectorModelShiftclone () const
 Return a copy constructed instance of self.
 
Estimate< double > get_shift () const
 Return the shift estimate.
 
void preprocess (Archive *)
 Prepare the data for use. More...
 
TextInterface::Parserget_interface ()
 Return a text interface that can be used to configure this instance.
 
- Public Member Functions inherited from Pulsar::PolnProfileShiftEstimator
void set_observation (const PolnProfile *p)
 Set the PolnProfile from which the shift will be estimated.
 
const PolnProfileget_observation () const
 Get the PolnProfile from which the shift will be estimated.
 
- Public Member Functions inherited from Pulsar::ShiftEstimator
virtual double get_reduced_chisq () const
 Return the statistical goodness of fit.
 
virtual double get_snr () const
 Return the profile S/N ratio.
 
virtual std::string get_name () const
 Return a name that can be subsituted for the template/standard.
 
- Public Member Functions inherited from Reference::Able
 Able (const Able &)
 
Ableoperator= (const Able &)
 
unsigned get_reference_count () const
 
- Public Member Functions inherited from Reference::HeapTracked
 HeapTracked (const HeapTracked &)
 
HeapTrackedoperator= (const HeapTracked &)
 
bool __is_on_heap () const
 

Protected Attributes

Reference::To< ComplexRVMFitrvmfit
 The ComplexRVM class used to perform the fit.
 
- Protected Attributes inherited from Pulsar::PolnProfileShiftEstimator
Reference::To< const PolnProfileobservation
 

Additional Inherited Members

- Static Public Member Functions inherited from Pulsar::ShiftEstimator
static ShiftEstimatorfactory (const std::string &name_and_parse)
 Construct a new ShiftEstimator from a string.
 
- Static Public Member Functions inherited from Reference::Able
static size_t get_instance_count ()
 
- Static Public Member Functions inherited from Reference::HeapTracked
static void * operator new (size_t size, void *ptr=0)
 
static void operator delete (void *location, void *ptr)
 
static void operator delete (void *location)
 
static size_t get_heap_queue_size ()
 
- Static Public Attributes inherited from Pulsar::ShiftEstimator
static bool verbose = false
 
- Protected Member Functions inherited from Reference::Able
Handle__reference (bool active) const
 
void __dereference (bool auto_delete=true) const
 

Detailed Description

Estimates phase shift using phi0 from the best-fit rotating vector model.

Member Function Documentation

◆ preprocess()

void RotatingVectorModelShift::preprocess ( Archive archive)
virtual

Prepare the data for use.

Correct Faraday rotation to infinite frequency / zero wavelength

Reimplemented from Pulsar::ShiftEstimator.

References Pulsar::FaradayRotation::execute(), Pulsar::ColdPlasma< Corrector, History >::set_measure(), Pulsar::ColdPlasma< Corrector, History >::set_reference_wavelength(), and Signal::Stokes.


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

Generated using doxygen 1.8.17