Pulsar::Smooth Class Reference

Profile smoothing algorithms. More...

#include <Smooth.h>

Inheritance diagram for Pulsar::Smooth:

Public Member Functions
	Smooth ()
	Default constructor.
virtual	~Smooth ()
	Destructor.
virtual Smooth *	clone () const =0
	Return a copy constructed instance of self.
virtual TextInterface::Parser *	get_interface ()=0
	Return a text interface that can be used to configure this instance.
void	set_width (const Phase::Value &w)
	Set the width of the smoothing function.
Phase::Value	get_width () const
	Get the width of the smoothing function.
void	set_turns (float)
	Set the width of the smoothing window in turns.
float	get_turns () const
	Get the width of the smoothing window in turns.
void	set_bins (float)
	Set the width of the smoothing window in phase bins.
float	get_bins () const
	Get the width of the smoothing window in phase bins.
Public Member Functions inherited from Pulsar::Transformation< Profile >
virtual void	transform (Profile *)=0
	Defined by derived classes.
void	operator() (Profile *container)
	Functor interface.
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 Smooth *	factory (const std::string &name_and_options)
	Construct a new Smooth instance from a string.
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
float	get_bins (const Profile *)
	Get the width of the smoothing window in phase bins.
float	get_turns (const Profile *)
	Get the width of the smoothing window in turns.
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Protected Attributes
Phase::Value	width
	The width of the smoothing.

Detailed Description

Profile smoothing algorithms.

Member Function Documentation

clone()

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

pure virtual

Return a copy constructed instance of self.

Implemented in Pulsar::SmoothMean, Pulsar::SmoothMedian, and Pulsar::SmoothSinc.

References Smooth().

get_bins()

float Pulsar::Smooth::get_bins

(

)

const

Get the width of the smoothing window in phase bins.

Get the number of phase bins in the bins used to smooth.

References width.

Referenced by Pulsar::SmoothMean::transform(), and Pulsar::SmoothMedian::transform().

get_interface()

virtual TextInterface::Parser * Pulsar::Smooth::get_interface ( )

pure virtual

Return a text interface that can be used to configure this instance.

Implemented in Pulsar::SmoothMean, Pulsar::SmoothMedian, and Pulsar::SmoothSinc.

set_bins()

void Pulsar::Smooth::set_bins

(

float

_bins

)

Set the width of the smoothing window in phase bins.

Set the number of phase bins in the bins used to smooth.

References width.

---

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

• Smooth.h
• Smooth.C