Smooths a mask by masking elements with masked neighbours. More...

#include <MaskSmooth.h>

Inheritance diagram for Pulsar::MaskSmooth:
Pulsar::PhaseWeightSmooth Pulsar::PhaseWeightModifier Pulsar::PhaseWeightFunction Pulsar::Algorithm Reference::Able Reference::HeapTracked

Public Member Functions

 MaskSmooth ()
 Default constructor.
 
MaskSmoothclone () const
 Return a copy constructed instance of self.
 
void set_turns (double)
 Set the smoothing window fraction in turns.
 
double get_turns () const
 Get the smoothing window fraction in turns. More...
 
void set_masked_fraction (double)
 Set the fraction of masked neighbours required.
 
double get_masked_fraction () const
 Get the fraction of masked neighbours required.
 
void set_bins (unsigned)
 Set the width of the smoothing window in phase bins.
 
unsigned get_bins () const
 Get the width of the smoothing window in phase bins.
 
void set_masked_bins (unsigned)
 Set the number of masked neighbours required.
 
unsigned get_masked_bins () const
 Get the number of masked neighbours required.
 
- Public Member Functions inherited from Pulsar::PhaseWeightModifier
virtual void set_weight (const PhaseWeight *)
 Set the PhaseWeight from which the PhaseWeight will be derived.
 
virtual void get_weight (PhaseWeight *weight)
 Returns a PhaseWeight. More...
 
void operator() (PhaseWeight *)
 Inplace operator.
 
TextInterface::Parserget_interface ()
 Return a text interface that can be used to configure this instance.
 
- 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 *)
 Derived classes implement the PhaseWeight calculation.
 
- Protected Member Functions inherited from Reference::Able
Handle__reference (bool active) const
 
void __dereference (bool auto_delete=true) const
 

Protected Attributes

double turns
 
double masked_fraction
 
unsigned bins
 
unsigned masked_bins
 
float mask_value
 
- Protected Attributes inherited from Pulsar::PhaseWeightModifier
Reference::To< const PhaseWeightinput_weight
 The PhaseWeight from which the PhaseWeight will be derived.
 

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

Detailed Description

Smooths a mask by masking elements with masked neighbours.

Member Function Documentation

◆ get_turns()

double Pulsar::MaskSmooth::get_turns ( ) const

Get the smoothing window fraction in turns.

Get the smoothing turns fraction.


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

Generated using doxygen 1.8.17