Pulsar::PhaseResolvedHistogram Class Reference

#include <PhaseResolvedHistogram.h>

Inheritance diagram for Pulsar::PhaseResolvedHistogram:
Pulsar::MoreProfiles Pulsar::DataExtension Pulsar::Profile::Extension Reference::Able Reference::HeapTracked

Public Member Functions

 PhaseResolvedHistogram (const char *name="PhaseResolvedHistogram")
 Construct with a name.
PhaseResolvedHistogramclone () const
 Clone operator.
void average (const MoreProfiles *)
 average information from another MoreProfiles
void set_range (double min, double max)
 Set the minimum and maximum values spanned by the histogram.
virtual Profileat (double value)
 get the Profile that corresponds to the specified value
Public Member Functions inherited from Pulsar::MoreProfiles
 MoreProfiles (const char *name)
 Construct with a name.
 MoreProfiles (const MoreProfiles &)
 Copy constructor.
unsigned get_nbin () const
 Return the number of phase bins.
void resize (unsigned nbin)
 Resize the data area.
void set_weight (float wt)
 set the weight of the profile
void scale (double scale)
 multiplies each bin of the profile by scale
void offset (double offset)
 offsets each bin of the profile by offset
void rotate_phase (double phase)
 rotates the profile by phase (in turns)
void zero ()
 set all amplitudes to zero
void bscrunch (unsigned nscrunch)
 integrate neighbouring phase bins in profile
void bscrunch_to_nbin (unsigned nbin)
 integrate neighbouring phase bins in profile
void fold (unsigned nfold)
 integrate neighbouring sections of the profile
void integrate (const Profile *)
 integrate information from another Profile
virtual void resize (unsigned nprofile, unsigned nbin)
 resize the profile vector
virtual unsigned get_size () const
 get the size of the profile vector
virtual Profileget_Profile (unsigned i)
 get the ith Profile
virtual const Profileget_Profile (unsigned i) const
 get the ith const Profile
Public Member Functions inherited from Pulsar::DataExtension
 DataExtension (const char *name)
 Construct with a name.
virtual void pscrunch ()
 some extensions may have to respond to pscrunching
Public Member Functions inherited from Pulsar::Profile::Extension
 Extension (const char *name)
 Construct with a name.
virtual ~Extension ()
 Destructor.
virtual TextInterface::Parserget_interface ()
 Return a text interface that can be used to access this instance.
std::string get_extension_name () const
 Return the name of the Extension.
virtual std::string get_short_name () const
 Return an abbreviated name that can be typed relatively quickly.
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

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::MoreProfiles
std::vector< Reference::To< Profile > > profile
 vector of Profile instances
Protected Attributes inherited from Pulsar::Profile::Extension
std::string extension_name
 Extension name - useful when debugging.

Detailed Description

Phase-resolved histogram of some quantity

Member Function Documentation

◆ average()

void Pulsar::PhaseResolvedHistogram::average ( const MoreProfiles * more)
virtual

◆ clone()

Pulsar::PhaseResolvedHistogram * Pulsar::PhaseResolvedHistogram::clone ( ) const
virtual

Clone operator.

Implements Pulsar::Profile::Extension.

References PhaseResolvedHistogram().


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

Generated using doxygen 1.14.0