Pulsar::DataExtension Class Reference

#include <DataExtension.h>

Inheritance diagram for Pulsar::DataExtension:

Public Member Functions
	DataExtension (const char *name)
	Construct with a name.
virtual unsigned	get_nbin () const =0
	Get the number of phase bins in the extra data.
virtual void	resize (unsigned nbin)=0
	Resize the data area.
virtual void	set_weight (float wt)=0
	set the weight of the profile
virtual void	scale (double scale)=0
	multiplies each bin of the profile by scale
virtual void	offset (double offset)=0
	offsets each bin of the profile by offset
virtual void	rotate_phase (double phase)=0
	rotates the profile by phase (in turns)
virtual void	zero ()=0
	set all amplitudes to zero
virtual void	bscrunch (unsigned nscrunch)=0
	integrate neighbouring phase bins in profile
virtual void	bscrunch_to_nbin (unsigned nbin)=0
	integrate neighbouring phase bins in profile
virtual void	fold (unsigned nfold)=0
	integrate neighbouring sections of the profile
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 Extension *	clone () const =0
	Return a new copy-constructed instance identical to this instance.
virtual TextInterface::Parser *	get_interface ()
	Return a text interface that can be used to access this instance.
virtual void	integrate (const Profile *subint)
	Integrate information from another Profile.
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 &)
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 Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const
Protected Attributes inherited from Pulsar::Profile::Extension
std::string	extension_name
	Extension name - useful when debugging.

Detailed Description

Profile Extension with extra phase-resolved data

Member Function Documentation

bscrunch()

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

pure virtual

integrate neighbouring phase bins in profile

Implemented in Pulsar::FourthMoments, and Pulsar::MoreProfiles.

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

bscrunch_to_nbin()

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

pure virtual

integrate neighbouring phase bins in profile

Implemented in Pulsar::FourthMoments, and Pulsar::MoreProfiles.

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

fold()

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

pure virtual

integrate neighbouring sections of the profile

Implemented in Pulsar::FourthMoments, and Pulsar::MoreProfiles.

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

get_nbin()

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

pure virtual

Get the number of phase bins in the extra data.

Implemented in Pulsar::MoreProfiles.

offset()

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

pure virtual

offsets each bin of the profile by offset

Implemented in Pulsar::FourthMoments, and Pulsar::MoreProfiles.

References offset().

Referenced by offset(), and Pulsar::Profile::offset().

pscrunch()

virtual void Pulsar::DataExtension::pscrunch ( )

inlinevirtual

some extensions may have to respond to pscrunching

Reimplemented in Pulsar::FourthMoments.

Referenced by Pulsar::Profile::pscrunch().

resize()

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

pure virtual

Resize the data area.

Implemented in Pulsar::MoreProfiles.

Referenced by Pulsar::Profile::resize().

rotate_phase()

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

pure virtual

rotates the profile by phase (in turns)

Implemented in Pulsar::MoreProfiles.

References Pulsar::phase().

Referenced by Pulsar::Profile::rotate_phase().

scale()

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

pure virtual

multiplies each bin of the profile by scale

Implemented in Pulsar::FourthMoments, and Pulsar::MoreProfiles.

References scale().

Referenced by scale(), and Pulsar::Profile::scale().

set_weight()

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

pure virtual

set the weight of the profile

Implemented in Pulsar::MoreProfiles.

Referenced by Pulsar::Profile::set_weight().

zero()

virtual void Pulsar::DataExtension::zero ( )

pure virtual

set all amplitudes to zero

Implemented in Pulsar::MoreProfiles.

Referenced by Pulsar::Profile::zero().

---

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

• DataExtension.h