Pulsar::VariableFaradayRotation Class Reference

Encapsulates known interstellar and ionospheric Faraday rotation. More...

#include <VariableFaradayRotation.h>

Inheritance diagram for Pulsar::VariableFaradayRotation:
Pulsar::KnownVariableTransformation Pulsar::VariableTransformationManager Reference::Able Reference::HeapTracked

Public Member Functions

LabelledJones< double > get_value () override
 Get the transformation.
void set_ionospheric_rotation_measure (double)
 Set the ionospheric Faraday rotation measure.
void set_interstellar_rotation_measure (double)
 Set the interstellar Faraday rotation measure.
const Calibration::Faradayget_interstellar_rotation () const
 Get the transformation used to compute interstellar Faraday rotation.
const Calibration::Faradayget_ionospheric_rotation () const
 Get the transformation used to compute ionospheric Faraday rotation.
bool required () const
 Return true if the transformation is required.
std::string get_description () const
 Return the description.
Public Member Functions inherited from Pulsar::KnownVariableTransformation
void set_nchan (unsigned nchan) override
 Set the number of frequency channels with a unique Transformation.
Transformation * get_transformation (unsigned ichan) override
 Return the Transformation for the specified channel.
MEAL::Argument::Valuenew_value () override
 Return a newly constructed Argument::Value for the current archive / subint / chan.
Public Member Functions inherited from Pulsar::VariableTransformationManager
 VariableTransformationManager ()
 Default constructor.
virtual void set_archive (const Archive *_archive)
 Set the Archive for which a tranformation will be computed.
virtual void set_subint (unsigned _subint)
 Set the sub-integration for which a tranformation will be computed.
virtual void set_chan (unsigned _chan)
 Set the frequency channel for which a tranformation will be computed.
virtual void update ()
 Update the tranformation for the current archive / subint / chan.
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

Additional Inherited Members

Public Types inherited from Pulsar::KnownVariableTransformation
typedef MEAL::Axis< LabelledJones< double > > KnownArgument
typedef MEAL::Value< MEAL::Complex2KnownTransformation
Public Types inherited from Pulsar::VariableTransformationManager
typedef MEAL::Variable< MEAL::Complex2Transformation
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 ()
Protected Member Functions inherited from Reference::Able
Handle__reference (bool active) const
void __dereference (bool auto_delete=true) const
Protected Attributes inherited from Pulsar::KnownVariableTransformation
std::vector< Transformation > xform
Protected Attributes inherited from Pulsar::VariableTransformationManager
Reference::To< const Archive, false > archive
unsigned subint
unsigned chan
std::string description
bool built

Detailed Description

Encapsulates known interstellar and ionospheric Faraday rotation.

Member Function Documentation

◆ get_description()

std::string VariableFaradayRotation::get_description ( ) const
virtual

Return the description.

Reimplemented from Pulsar::VariableTransformationManager.

◆ get_value()

LabelledJones< double > VariableFaradayRotation::get_value ( )
overridevirtual

Get the transformation.

Implements Pulsar::KnownVariableTransformation.

References Pulsar::IntegrationManager::verbose.

◆ required()

bool VariableFaradayRotation::required ( ) const
virtual

Return true if the transformation is required.

Reimplemented from Pulsar::VariableTransformationManager.


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

Generated using doxygen 1.14.0