Pulsar::ThresholdMatch Class Reference

Criterion used to determine if two archives match. More...

#include <ThresholdMatch.h>

Inheritance diagram for Pulsar::ThresholdMatch:

Public Member Functions
	ThresholdMatch ()
	Default constructor.
void	set_maximum_relative_bandwidth (double delta_bw)
	Set the maximum relative bandwidth by which archives may differ.
bool	get_bandwidth_match (const Archive *a, const Archive *b) const
	Return true if the bandwidths match.
Public Member Functions inherited from Pulsar::Archive::Match
	Match ()
	Default constructor.
virtual	~Match ()
	Empty destructor.
virtual Match *	clone () const
	Clone operator.
virtual bool	match (const Archive *a, const Archive *b) const
	Check that the selected attributes match.
std::string	get_reason () const
	Get the mismatch messages from the last call to the match method.
void	set_check_mixable (bool flag=true)
	Set to check that two archives may be combined.
bool	get_check_mixable () const
void	set_check_standard (bool flag=true)
	Set to check that a standard and observation may be compared.
bool	get_check_standard () const
void	set_check_calibrator (bool flag=true)
	Set to check that a calibrator may be applied to an observation.
bool	get_check_calibrator () const
void	set_check_processing (bool flag=true)
	Set to check that two archives have been processed identically.
bool	get_check_processing () const
void	set_check_state (bool flag=true)
	Set to check the state attribute.
bool	get_check_state () const
void	set_check_type (bool flag=true)
	Set to check the type attribute.
bool	get_check_type () const
void	set_check_source (bool flag=true)
	Set to check the source attribute.
bool	get_check_source () const
void	set_check_scale (bool flag=true)
	Set to check the scale attribute.
bool	get_check_scale () const
void	set_check_faraday_corrected (bool flag=true)
	Set to check the faraday_corrected attribute.
bool	get_check_faraday_corrected () const
void	set_check_dedispersed (bool flag=true)
	Set to check the dedispersed attribute.
bool	get_check_dedispersed () const
void	set_check_nbin (bool flag=true)
	Set to check the nbin attribute.
bool	get_check_nbin () const
void	set_check_nchan (bool flag=true)
	Set to check the nchan attribute.
bool	get_check_nchan () const
void	set_check_npol (bool flag=true)
	Set to check the npol attribute.
bool	get_check_npol () const
void	set_check_receiver (bool flag=true)
	Set to check the receiver attribute.
bool	get_check_receiver () const
void	set_check_centre_frequency (bool flag=true)
	Set to check the centre_frequency attribute.
bool	get_check_centre_frequency () const
void	set_check_bandwidth (bool flag=true)
	Set to check the bandwidth attribute.
bool	get_check_bandwidth () const
void	set_check_bandwidth_sign (bool flag=true)
	Set to check the sign of the bandwidth attribute.
bool	get_check_bandwidth_sign () const
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 Member Functions
static void	set_BPP (Archive *)
	Setup for BPP-derived backends.
Static Public Member Functions inherited from Pulsar::Archive::Match
template<typename T>
static Match *	factory (T method)
	Return a matching strategy based on the specified method.
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 Attributes
double	maximum_relative_bandwidth
Protected Attributes inherited from Pulsar::Archive::Match
std::string	reason
	The mismatch messages from the last call to the match method.
bool	check_state
bool	check_type
bool	check_source
bool	check_scale
bool	check_faraday_corrected
bool	check_dedispersed
bool	check_nbin
bool	check_nchan
bool	check_npol
bool	check_receiver
bool	check_centre_frequency
bool	check_bandwidth
bool	check_bandwidth_sign

Additional Inherited Members
Static Public Attributes inherited from Pulsar::Archive::Match
static Option< double >	max_frequency_difference
	The maximum amount by which the centre frequency may differ, in MHz.
static Option< bool >	opposite_sideband
	Allow opposite sidebands to match.
static std::string	separator = "\n\t"
	String used to separate mismatch messages.
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Detailed Description

Criterion used to determine if two archives match.

Member Function Documentation

get_bandwidth_match()

bool Pulsar::ThresholdMatch::get_bandwidth_match ( const Archive * a, const Archive * b ) const

virtual

Return true if the bandwidths match.

Reimplemented from Pulsar::Archive::Match.

References Pulsar::Archive::get_bandwidth(), Pulsar::Archive::Match::reason, and Pulsar::Archive::Match::separator.

---

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

• ThresholdMatch.h
• ThresholdMatch.C