Finds the phase window in which the smoothed Profile is an extremum. More...

#include <BaselineWindow.h>

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

Public Member Functions

 BaselineWindow ()
 Default constructor.
 BaselineWindow (const BaselineWindow &)
 Copy constructor.
void set_smooth (Smooth *)
 Set the smoothing function.
Smoothget_smooth () const
 Get the smoothing function.
void set_find_minimum (bool f=true)
 Set to find the minimum mean.
bool get_find_minimum () const
void set_find_maximum (bool f=true)
 Set to find the maximum mean.
bool get_find_maximum () const
void set_find_mean (float mean)
 Set to find the mean closest to the specified value.
float get_find_mean () const
void set_range (int bin_start, int bin_end)
 Set the start and end bins of the search.
void set_search_range (const Phase::Range &)
 Set the range to be searched.
Phase::Range get_search_range () const
 Get the range to be search.
Phase::Range get_found_range () const
 Get the range found during execution.
float find_phase (const std::vector< float > &amps)
 Return the phase at which minimum or maximum mean is found.
float find_phase (unsigned nbin, const float *amps)
 Return the phase at which minimum or maximum mean is found.
TextInterface::Parserget_interface ()
 Return a text interface that can be used to configure this instance.
BaselineWindowclone () 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

Protected Attributes

Reference::To< Smoothsmooth
 The smoothing function.
bool find_max
 Set true when algorithm finds max.
bool find_mean
 Set true when algorithm finds mean.
float mean
 Mean value to be found.
Phase::Range search_range
 The first bin in the selected range.
Phase::Range found_range
bool range_specified
 Set true when range is specified.
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.

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 ()

Detailed Description

Finds the phase window in which the smoothed Profile is an extremum.

Member Function Documentation

◆ calculate()

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

◆ clone()

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

Return a copy constructed instance of self.

Implements Pulsar::BaselineEstimator.

References BaselineWindow().

◆ get_interface()

TextInterface::Parser * Pulsar::BaselineWindow::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 files:

Generated using doxygen 1.14.0