Pulsar::MoreProfiles Class Reference

#include <MoreProfiles.h>

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

Public Member Functions

 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 average (const MoreProfiles *)
 average information from another MoreProfiles
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 Extensionclone () const =0
 Return a new copy-constructed instance identical to this instance.
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

Protected Attributes

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.

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

Detailed Description

Extra pulse profiles to represent other dimensions

Member Function Documentation

◆ average()

void Pulsar::MoreProfiles::average ( const MoreProfiles * that)
virtual

average information from another MoreProfiles

integrate data from another MoreProfiles

Reimplemented in Pulsar::FourthMoments, and Pulsar::PhaseResolvedHistogram.

References average(), MoreProfiles(), and profile.

Referenced by Pulsar::FourthMoments::average(), average(), Pulsar::PhaseResolvedHistogram::average(), and integrate().

◆ bscrunch()

void Pulsar::MoreProfiles::bscrunch ( unsigned nscrunch)
virtual

integrate neighbouring phase bins in profile

Implements Pulsar::DataExtension.

References Pulsar::Profile::bscrunch(), and profile.

Referenced by Pulsar::FourthMoments::bscrunch().

◆ bscrunch_to_nbin()

void Pulsar::MoreProfiles::bscrunch_to_nbin ( unsigned nbin)
virtual

integrate neighbouring phase bins in profile

Implements Pulsar::DataExtension.

References Pulsar::Profile::bscrunch_to_nbin(), and profile.

Referenced by Pulsar::FourthMoments::bscrunch_to_nbin().

◆ fold()

void Pulsar::MoreProfiles::fold ( unsigned nfold)
virtual

integrate neighbouring sections of the profile

Implements Pulsar::DataExtension.

References Pulsar::Profile::fold(), and profile.

Referenced by Pulsar::FourthMoments::fold().

◆ get_nbin()

unsigned Pulsar::MoreProfiles::get_nbin ( ) const
virtual

Return the number of phase bins.

Implements Pulsar::DataExtension.

References profile.

◆ get_Profile() [1/2]

Pulsar::Profile * Pulsar::MoreProfiles::get_Profile ( unsigned i)
virtual

get the ith Profile

get the ith profile

References profile.

Referenced by Pulsar::RemoveBaseline::Each::transform().

◆ get_Profile() [2/2]

const Pulsar::Profile * Pulsar::MoreProfiles::get_Profile ( unsigned i) const
virtual

get the ith const Profile

get the ith profile

References profile.

◆ integrate()

void Pulsar::MoreProfiles::integrate ( const Profile * p)
virtual

integrate information from another Profile

Reimplemented from Pulsar::Profile::Extension.

References average(), and MoreProfiles().

◆ offset()

void Pulsar::MoreProfiles::offset ( double offset)
virtual

offsets each bin of the profile by offset

Implements Pulsar::DataExtension.

References offset(), Pulsar::Profile::offset(), and profile.

Referenced by offset().

◆ resize()

void Pulsar::MoreProfiles::resize ( unsigned nbin)
virtual

Resize the data area.

Implements Pulsar::DataExtension.

References profile, and Pulsar::Profile::resize().

Referenced by Pulsar::FITSArchive::load_Integration().

◆ rotate_phase()

void Pulsar::MoreProfiles::rotate_phase ( double phase)
virtual

rotates the profile by phase (in turns)

Implements Pulsar::DataExtension.

References Pulsar::phase(), profile, and Pulsar::Profile::rotate_phase().

◆ scale()

void Pulsar::MoreProfiles::scale ( double scale)
virtual

◆ set_weight()

void Pulsar::MoreProfiles::set_weight ( float wt)
virtual

set the weight of the profile

Implements Pulsar::DataExtension.

References profile, and Pulsar::Profile::set_weight().

◆ zero()

void Pulsar::MoreProfiles::zero ( )
virtual

set all amplitudes to zero

Implements Pulsar::DataExtension.

References profile, and Pulsar::Profile::zero().


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

Generated using doxygen 1.14.0