Pulsar::PhaseWeightModifier Class Referenceabstract

PhaseWeight algorithms that receive an input PhaseWeight. More...

#include <PhaseWeightModifier.h>

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

Public Member Functions

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 Pulsar::PhaseWeightFunction
virtual PhaseWeightFunctionclone () const =0
 Return a copy constructed instance of self.
 
- 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

virtual void calculate (PhaseWeight *)=0
 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

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

PhaseWeight algorithms that receive an input PhaseWeight.

Member Function Documentation

◆ get_weight()

void Pulsar::PhaseWeightModifier::get_weight ( PhaseWeight weight)
virtual

Returns a PhaseWeight.

Returns a PhaseWeight with the Weight attribute set.

Implements Pulsar::PhaseWeightFunction.


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

Generated using doxygen 1.8.17