Pulsar::SmoothMean Class Reference

Smooths a Profile using the mean over a boxcar. More...

#include <SmoothMean.h>

Inheritance diagram for Pulsar::SmoothMean:

Public Member Functions
SmoothMean *	clone () const
	Return a copy constructed instance of self.
TextInterface::Parser *	get_interface ()
	Return a text-based interface to class properties.
void	transform (Profile *)
	Defined by derived classes.
Public Member Functions inherited from Pulsar::Smooth
	Smooth ()
	Default constructor.
virtual	~Smooth ()
	Destructor.
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 >
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

Additional Inherited Members
Static Public Member Functions inherited from Pulsar::Smooth
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 inherited from Pulsar::Smooth
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 inherited from Pulsar::Smooth
Phase::Value	width
	The width of the smoothing.

Detailed Description

Smooths a Profile using the mean over a boxcar.

This method smooths the profile by setting each amplitude equal to the mean calculated over the region centred at that point and with width specified by bins or turns.

Member Function Documentation

clone()

Pulsar::SmoothMean * Pulsar::SmoothMean::clone ( ) const

virtual

Return a copy constructed instance of self.

Implements Pulsar::Smooth.

get_interface()

TextInterface::Parser * Pulsar::SmoothMean::get_interface ( )

virtual

Return a text-based interface to class properties.

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

Implements Pulsar::Smooth.

transform()

void Pulsar::SmoothMean::transform ( Profile * )

virtual

Defined by derived classes.

Implements Pulsar::Transformation< Profile >.

References Pulsar::ProfileAmps::get_amps(), Pulsar::Smooth::get_bins(), Pulsar::ProfileAmps::get_nbin(), and Pulsar::ProfileAmps::set_amps().

---

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

• SmoothMean.h
• SmoothMean.C