Pulsar::MatrixTemplateMatching Class Reference

Estimates phase shift in Fourier domain using matrix template matching. More...

#include <MatrixTemplateMatching.h>

Inheritance diagram for Pulsar::MatrixTemplateMatching:

Public Member Functions
void	set_maximum_harmonic (unsigned max)
	Set the maximum number of harmonics to include in fit.
void	set_choose_maximum_harmonic (bool flag=true)
	Allow software to choose the maximum harmonic.
void	preprocess (Archive *archive)
	Prepare the data for use.
void	set_observation (const Archive *)
	Set the observation from which the arrival times will be derived.
void	set_standard (const Archive *)
	Set the standard/template to which observation will be matched.
void	set_unload_matrix_model (bool flag=true)
	unload the best-fit Jones matrix model parameters for each sub-integration
Public Member Functions inherited from Pulsar::ArrivalTime
	ArrivalTime ()
	Default constructor.
	~ArrivalTime ()
	Destructor.
void	set_shift_estimator (ShiftEstimator *)
	Set the algorithm used to estimate the phase shift.
ShiftEstimator *	get_shift_estimator () const
	Get the algorithm used to estimate the phase shift.
void	set_mean_estimator (MeanArrivalTime *)
	Set the algorithm used to estimate the average arrival time.
MeanArrivalTime *	get_mean_estimator () const
	Get the algorithm used to estimate the phase shift.
void	set_format (Tempo::toa::Format)
	Set the format of the output time-of-arrival estimates.
void	set_format (const std::string &)
	Set the format as a string.
void	set_format_flags (const std::string &)
	Set additional format flags.
void	set_attributes (const std::vector< std::string > &)
	Set additional attributes.
void	set_extra_text (const std::string &)
	Set additional TOA text (only used in tempo2 format)
void	set_skip_bad (bool flag)
	Skip data with zero weight.
void	set_positive_shifts (bool flag)
	Output only arrival times that are greater than reference time.
double	get_reference_frequency (const Integration *subint, unsigned ichan) const
	Get the reference frequency for the specified channel.
void	get_toas (std::vector< Tempo::toa > &)
	Add to the vector of time-of-arrival estimates.
std::string	get_value (const std::string &key, const Tempo::toa &)
	Get auxilliary information.
void	set_residual (Archive *res)
	Set the archive that will store residual profiles.
Archive *	get_residual ()
	Get the archive of residual profiles.
void	set_flux_estimator (Flux *)
	Set method for computing flux density of profiles.
Flux *	get_flux_estimator () const
	Get flux density esimtaor.
Public Member Functions inherited from Reference::Able
	Able (const Able &)
Able &	operator= (const Able &)
unsigned	get_reference_count () const
Public Member Functions inherited from Reference::HeapTracked
	HeapTracked (const HeapTracked &)
HeapTracked &	operator= (const HeapTracked &)
bool	__is_on_heap () const

Protected Member Functions
void	get_toas (unsigned subint, std::vector< Tempo::toa > &toas)
	get the arrival times for the specified sub-integration
Protected Member Functions inherited from Pulsar::ArrivalTime
std::string	get_tempo2_aux_txt (const Tempo::toa &)
std::string	get_ipta_aux_txt (const Tempo::toa &)
virtual void	dress_toas (unsigned subint, std::vector< Tempo::toa > &toas)
	add any additional information as requested
Tempo::toa	get_toa (Estimate< double > &shift, const Pulsar::Integration *, unsigned ichan)
Tempo::toa	get_toa (Estimate< double > &shift, double reference_frequency, const Pulsar::Integration *, unsigned ichan=0)
void	get_subband_toas (const Integration *subint, std::vector< Tempo::toa > &toas)
	Adds to the vector of toas.
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Protected Attributes
Reference::To< PulsarCalibrator >	engine
	The PulsarCalibrator class takes care of many details.
bool	unload_matrix_model = false
	unload the best-fit Jones matrix model parameters for each sub-integration
Protected Attributes inherited from Pulsar::ArrivalTime
Reference::To< const Archive >	observation
	The observation to be fit to the standard.
Reference::To< const Archive >	standard
	The standard to which observations are fit.
Reference::To< const Backend >	backend
	Any backend delay correction, if known.
Reference::To< Archive >	residual
	The residual pulse profiles (transformed observation minus standard)
Reference::To< ShiftEstimator >	shift_estimator
Reference::To< Flux >	flux_estimator
Reference::To< MeanArrivalTime >	mean_arrival_time
Tempo::toa::Format	format
	the output TOA format
std::string	format_flags
	additional format-specific flags
std::string	extra_text
	additional TOA line text
std::vector< std::string >	attributes
	for formats that support it, a list of attributes to add
unsigned	toa_subint
unsigned	toa_chan
bool	skip_bad
	when true, skip data with zero weight
bool	positive_shifts {false}
	when true, output arrival times that are always later than phase bin zero
Dispersion	dispersion

Additional Inherited Members
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 Protected Attributes inherited from Pulsar::ArrivalTime
static Option< std::string >	default_format
	default TOA output format

Detailed Description

Estimates phase shift in Fourier domain using matrix template matching.

Member Function Documentation

get_toas()

void Pulsar::MatrixTemplateMatching::get_toas ( unsigned subint, std::vector< Tempo::toa > & toas )

protectedvirtual

get the arrival times for the specified sub-integration

Reimplemented from Pulsar::ArrivalTime.

References engine, MEAL::Evaluable< typename T >::evaluate(), Pulsar::Integration::get_nchan(), Pulsar::PolnProfileFit::get_reduced_chisq(), Pulsar::PolnProfileFit::get_transformation(), Pulsar::Integration::new_PolnProfile(), Pulsar::ArrivalTime::observation, Pulsar::phase(), Pulsar::ArrivalTime::residual, Pulsar::SystemCalibrator::Unloader::set_program(), Pulsar::ArrivalTime::standard, and unload_matrix_model.

preprocess()

void Pulsar::MatrixTemplateMatching::preprocess ( Archive * archive )

virtual

Prepare the data for use.

Reimplemented from Pulsar::ArrivalTime.

References engine, and Signal::Stokes.

set_observation()

void Pulsar::MatrixTemplateMatching::set_observation ( const Archive * archive )

virtual

Set the observation from which the arrival times will be derived.

Reimplemented from Pulsar::ArrivalTime.

References engine, and Pulsar::ArrivalTime::observation.

set_standard()

void Pulsar::MatrixTemplateMatching::set_standard ( const Archive * archive )

virtual

Set the standard/template to which observation will be matched.

Reimplemented from Pulsar::ArrivalTime.

References engine, and Pulsar::ArrivalTime::standard.

---

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

• MatrixTemplateMatching.h
• MatrixTemplateMatching.C