Pulsar::FrequencyAppend Class Reference

Algorithms that combine Integration data. More...

#include <FrequencyAppend.h>

Inheritance diagram for Pulsar::FrequencyAppend:

Public Types
typedef Functor< void(Integration *) >	Weight

Public Member Functions
void	init (Archive *into)
	Initialize an archive for appending.
virtual void	check (Archive *into, const Archive *from)
	Throw an exception if there is a reason to not append.
Public Member Functions inherited from Pulsar::Append
	Append ()
	Default constructor.
void	append (Archive *into, const Archive *from)
	Copy the data in 'from' to 'into'.
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

Static Public Attributes
static Option< Weight >	weight_strategy
	The policy used to weight each profile during combine.
static Option< bool >	force_new_predictor
	Should a new predictor be always generated?

Protected Member Functions
virtual bool	stop (Archive *into, const Archive *from)
	Return true if there is a benign reason to stop.
virtual void	combine (Archive *into, Archive *from)
	Add the data in 'from' to 'into'.
virtual void	combine (Integration *into, Integration *from)
	Add the data in 'from' to 'into'.
virtual const Archive::Match *	get_mixable_policy (const Archive *into)
	Return the policy used to verify that data are mixable.
void	generate_new_predictor (Archive *into, Archive *from)
	Generate a new predictor spanning the time and frequency range of both into and from.
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Protected Attributes
bool	check_phase
Protected Attributes inherited from Pulsar::Append
bool	aligned
bool	equal_ephemerides
bool	equal_models
bool	insert_model

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 ()
Public Attributes inherited from Pulsar::Append
bool	must_match
bool	ignore_phase

Detailed Description

Algorithms that combine Integration data.

Member Function Documentation

check()

void Pulsar::FrequencyAppend::check ( Archive * into, const Archive * from )

virtual

Throw an exception if there is a reason to not append.

Reimplemented from Pulsar::Append.

References Pulsar::Append::check(), and Pulsar::IntegrationManager::get_nsubint().

combine()

void Pulsar::FrequencyAppend::combine ( Archive * into, Archive * from )

protectedvirtual

Add the data in 'from' to 'into'.

Implements Pulsar::Append.

References combine(), Pulsar::Archive::expert(), force_new_predictor, Pulsar::Archive::Extension::frequency_append(), generate_new_predictor(), Pulsar::Archive::get(), Pulsar::Archive::get_bandwidth(), Pulsar::Archive::get_centre_frequency(), Pulsar::Archive::get_dedispersed(), Pulsar::Archive::get_extension(), Pulsar::IntegrationManager::get_Integration(), Pulsar::Archive::get_model(), Pulsar::Archive::get_nchan(), Pulsar::Archive::get_nextension(), Pulsar::IntegrationManager::get_nsubint(), Pulsar::Predictor::get_observing_frequency(), Pulsar::Archive::has_model(), Pulsar::Archive::set_bandwidth(), Pulsar::Archive::set_centre_frequency(), Pulsar::Archive::Expert::set_nchan(), Pulsar::FITSHdrExtension::set_obsbw(), Pulsar::FITSHdrExtension::set_obsfreq(), Pulsar::FITSHdrExtension::set_obsnchan(), and Pulsar::IntegrationManager::verbose.

Referenced by combine().

get_mixable_policy()

const Pulsar::Archive::Match * Pulsar::FrequencyAppend::get_mixable_policy ( const Archive * into )

protectedvirtual

Return the policy used to verify that data are mixable.

Reimplemented from Pulsar::Append.

References Pulsar::Archive::Match::clone(), and Pulsar::Archive::get_mixable().

init()

void Pulsar::FrequencyAppend::init ( Archive * into )

virtual

Initialize an archive for appending.

Reimplemented from Pulsar::Append.

References Pulsar::IntegrationManager::get_Integration(), Pulsar::IntegrationManager::get_nsubint(), and weight_strategy.

Referenced by Pulsar::Interpreter::freq_append().

stop()

bool Pulsar::FrequencyAppend::stop ( Archive * into, const Archive * from )

protectedvirtual

Return true if there is a benign reason to stop.

Reimplemented from Pulsar::Append.

References Pulsar::Archive::get().

---

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

• FrequencyAppend.h
• FrequencyAppend.C