Public Member Functions | List of all members
Pulsar::CompareWithEachOther Class Reference

Summarizes a comparison of each Profile with every other Profile. More...

#include <CompareWithEachOther.h>

Inheritance diagram for Pulsar::CompareWithEachOther:
Pulsar::CompareWith Reference::Able Reference::HeapTracked

Public Member Functions

void set_summary (UnaryStatistic *)
 Used to summarize comparisons.
 
- Public Member Functions inherited from Pulsar::CompareWith
void set_statistic (BinaryStatistic *)
 
void set_data (HasArchive *)
 
void set_setup_data (const Archive *)
 Use to compute the covariance matrix before an fscrunch or tscrunch.
 
void set_bscrunch (const ScrunchFactor &f)
 Compute covariance matrix from bscrunched clone of data.
 
const ScrunchFactor get_bscrunch () const
 Get the phase bin scrunch factor.
 
bool get_setup ()
 Return true if call to set_setup_data sets anything up.
 
void set_transpose (bool)
 
void set_primary (unsigned n, void(HasArchive::*)(Index))
 
void set_compare (unsigned n, void(HasArchive::*)(Index))
 
void set_compare_all (bool flag=true)
 
void set_compute_mask (const std::vector< bool > &flags)
 Flags for subset of primary axis to be computed.
 
virtual void compute (ndArray< 2, double > &result)
 
void set_file (FILE *f)
 Set the file to which auxiliary data will be printed.
 
- 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
 

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 ()
 
- Protected Member Functions inherited from Pulsar::CompareWith
virtual void setup (unsigned start_primary, unsigned nprimary=1)
 Perform an eigenanalysis and set up the generalized chi squared.
 
void set (ndArray< 2, double > &result, unsigned iprimary, unsigned icompare, double value)
 
void check ()
 Check that necessary attributes have been set.
 
void compute_mean (unsigned start_primary, unsigned nprimary)
 Compute the mean of the profiles to be compared.
 
void get_amps (std::vector< double > &amps, const Profile *profile)
 Set amps to the normalized and bscrunched profile amplitudes.
 
void get_residual (std::vector< double > &amps, const std::vector< double > &mamps)
 Set amps to the residual after best fit of amps to mamps.
 
- Protected Member Functions inherited from Reference::Able
Handle * __reference (bool active) const
 
void __dereference (bool auto_delete=true) const
 
- Protected Attributes inherited from Pulsar::CompareWith
Reference::To< BinaryStatistic > statistic
 Used to perform comparison.
 
HasArchive * data
 Interface to the Archive.
 
void(HasArchive::* primary )(Index)
 Pointer to the method used to loop over the primary dimension.
 
unsigned nprimary
 
void(HasArchive::* compare )(Index)
 Pointer to the method used to loop over the compare dimension.
 
unsigned ncompare
 
bool compare_all
 Compare over both dimensions.
 
bool model_residual
 Compute the covariance matrix of the best-fit residual. More...
 
bool use_null_space
 
bool transpose
 Transpose indeces when computing results.
 
bool setup_completed
 Set true when setup has completed.
 
bool is_setup
 Set true when setup has completed during set_setup_data.
 
Reference::To< Profile > mean
 
Reference::To< TimeDomainCovariance > covar
 
ScrunchFactor bscrunch_factor
 Compute covariance matrix from bscrunched clone of data.
 
Reference::To< Profile > temp
 After call to get_residual, also stores residual profile amplitudes.
 
BinaryStatistics::ChiSquared chi
 Used to compute the residual.
 
std::vector< bool > compute_mask
 Flags for subset of sub-integrations to be computed.
 
FILE * fptr
 File to which auxiliary data will be printed.
 

Detailed Description

Summarizes a comparison of each Profile with every other Profile.

Uses a BinaryStatistic to compare a profile with every other Profile along the dimension defined by the compare method. Uses a UnaryStatistic to summarize the results. Loops over all profiles along the dimenion defined by the primary method.

The documentation for this class was generated from the following files:
Generated using doxygen 1.8.17