Pulsar::BaselineStatic Class Reference

Finds a Profile baseline using an interative bounding method. More...

#include <BaselineStatic.h>

Inheritance diagram for Pulsar::BaselineStatic:
Pulsar::BaselineEstimator Pulsar::ProfileWeightFunction Pulsar::PhaseWeightFunction Pulsar::Algorithm Reference::Able Reference::HeapTracked

Public Member Functions

 BaselineStatic ()
 Default constructor.
 ~BaselineStatic ()
 Destructor.
TextInterface::Parserget_interface ()
 Return a text interface that can be used to configure this instance.
BaselineStaticclone () const
 Return a copy constructed instance of self.
Public Member Functions inherited from Pulsar::BaselineEstimator
 BaselineEstimator ()
 Default constructor.
PhaseWeightbaseline (const Profile *)
 Returns a new PhaseWeight instance.
PhaseWeightoperator() (const Profile *)
 Returns a new PhaseWeight instance.
PhaseWeightoperate (const Profile *)
 Convenience interface.
void set_median_cut (float threshold)
 Cut samples from baseline with median difference over threshold.
Public Member Functions inherited from Pulsar::ProfileWeightFunction
 ProfileWeightFunction ()
 Default constructor.
 ProfileWeightFunction (const ProfileWeightFunction &)
 Copy constructor.
virtual void set_Profile (const Profile *)
 Set the Profile from which the PhaseWeight will be derived.
void set_include (PhaseWeight *include)
 Include only the specified phase bins for consideration.
void set_exclude (PhaseWeight *include)
 Exclude the specified phase bins from consideration.
bool consider (unsigned ibin) const
 Return true if the specified phase bin should be considered.
virtual void get_weight (PhaseWeight *weight)
 Returns a PhaseWeight with the Profile attribute set.
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 Member Functions

void calculate (PhaseWeight *weight)
 Calculate the PhaseWeight.
Protected Member Functions inherited from Reference::Able
Handle__reference (bool active) const
void __dereference (bool auto_delete=true) const

Additional Inherited Members

Static Public Member Functions inherited from Pulsar::ProfileWeightFunction
static ProfileWeightFunctionfactory (const std::string &name_and_parse)
 Construct a new ProfileWeightFunction 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 Attributes inherited from Pulsar::BaselineEstimator
float median_cut
Protected Attributes inherited from Pulsar::ProfileWeightFunction
Reference::To< const Profile, false > profile
 The Profile from which the PhaseWeight will be derived.
Reference::To< PhaseWeightinclude
 Included phase bins.
Reference::To< PhaseWeightexclude
 Excluded phase bins.

Detailed Description

Finds a Profile baseline using an interative bounding method.

Member Function Documentation

◆ calculate()

void Pulsar::BaselineStatic::calculate ( PhaseWeight * weight)
protectedvirtual

Calculate the PhaseWeight.

Implements Pulsar::ProfileWeightFunction.

◆ clone()

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

Return a copy constructed instance of self.

Implements Pulsar::BaselineEstimator.

References BaselineStatic().

◆ get_interface()

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

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

Implements Pulsar::PhaseWeightFunction.


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

Generated using doxygen 1.14.0