HOPS
HOPS class reference
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
hops::MHO_FringeFitter Class Referenceabstract

Class MHO_FringeFitter. More...

#include <MHO_FringeFitter.hh>

Inheritance diagram for hops::MHO_FringeFitter:
[legend]

Public Member Functions

 MHO_FringeFitter (MHO_FringeData *data)
 
 MHO_FringeFitter (MHO_FringeData *data)
 
virtual ~MHO_FringeFitter ()
 
virtual ~MHO_FringeFitter ()
 
virtual void Accept (MHO_FringeFitterVisitor *visitor)=0
 Function Accept: accept a visitor...pure virtual, must be implemented in derived class. More...
 
virtual void Accept (MHO_FringeFitterVisitor *visitor)=0
 Function Accept: accept a visitor...pure virtual, must be implemented in derived class. More...
 
virtual void Configure ()=0
 Function Configure. More...
 
virtual void Configure ()=0
 Function Configure. More...
 
virtual void Finalize ()=0
 Function Finalize. More...
 
virtual void Finalize ()=0
 Function Finalize. More...
 
MHO_ContainerStoreGetContainerStore ()
 Getter for container store. More...
 
MHO_ContainerStoreGetContainerStore ()
 Getter for container store. More...
 
MHO_FringeDataGetFringeData ()
 Getter for fringe data. More...
 
MHO_FringeDataGetFringeData ()
 Getter for fringe data. More...
 
MHO_OperatorBuilderManagerGetOperatorBuildManager ()
 Getter for ther operator build manager - only valid after 'Configure' is called. More...
 
MHO_OperatorBuilderManagerGetOperatorBuildManager ()
 Getter for ther operator build manager - only valid after 'Configure' is called. More...
 
MHO_OperatorToolboxGetOperatorToolbox ()
 Getter for operator toolbox. More...
 
MHO_OperatorToolboxGetOperatorToolbox ()
 Getter for operator toolbox. More...
 
MHO_ParameterStoreGetParameterStore ()
 Getter for parameter store. More...
 
MHO_ParameterStoreGetParameterStore ()
 Getter for parameter store. More...
 
MHO_ScanDataStoreGetScanDataStore ()
 Getter for scan data store. More...
 
MHO_ScanDataStoreGetScanDataStore ()
 Getter for scan data store. More...
 
mho_json GetVex ()
 Getter for vex (ovex) data as JSON object. More...
 
mho_json GetVex ()
 Getter for vex (ovex) data as JSON object. More...
 
virtual void Initialize ()=0
 Function Initialize. More...
 
virtual void Initialize ()=0
 Function Initialize. More...
 
virtual bool IsFinished ()=0
 Function IsFinished. More...
 
virtual bool IsFinished ()=0
 Function IsFinished. More...
 
virtual void PostRun ()=0
 Function PostRun. More...
 
virtual void PostRun ()=0
 Function PostRun. More...
 
virtual void PreRun ()=0
 Function PreRun. More...
 
virtual void PreRun ()=0
 Function PreRun. More...
 
virtual void Run ()=0
 Function Run. More...
 
virtual void Run ()=0
 Function Run. More...
 

Protected Member Functions

virtual void Cache ()
 
virtual void Cache ()
 
virtual void Refresh ()
 
virtual void Refresh ()
 

Protected Attributes

MHO_ContainerStorefContainerStore
 
MHO_FringeDatafFringeData
 
MHO_OperatorBuilderManagerfOperatorBuildManager
 
MHO_OperatorToolbox fOperatorToolbox
 
MHO_ParameterStorefParameterStore
 
MHO_ScanDataStorefScanStore
 

Detailed Description

Class MHO_FringeFitter.

Abstract base class for a basic fringe fitter.

Author
J. Barrettj - barre.nosp@m.ttj@.nosp@m.mit.e.nosp@m.du
Date
Tue Sep 19 16:26:35 2023 -0400

Constructor & Destructor Documentation

◆ MHO_FringeFitter() [1/2]

hops::MHO_FringeFitter::MHO_FringeFitter ( MHO_FringeData data)
inline

◆ ~MHO_FringeFitter() [1/2]

virtual hops::MHO_FringeFitter::~MHO_FringeFitter ( )
inlinevirtual

◆ MHO_FringeFitter() [2/2]

hops::MHO_FringeFitter::MHO_FringeFitter ( MHO_FringeData data)
inline

◆ ~MHO_FringeFitter() [2/2]

virtual hops::MHO_FringeFitter::~MHO_FringeFitter ( )
inlinevirtual

Member Function Documentation

◆ Accept() [1/2]

virtual void hops::MHO_FringeFitter::Accept ( MHO_FringeFitterVisitor visitor)
pure virtual

Function Accept: accept a visitor...pure virtual, must be implemented in derived class.

Parameters
visitor(MHO_FringeFitterVisitor*)
Note
This is a (pure) virtual function.

Implemented in hops::MHO_IonosphericFringeFitterOpenMP, hops::MHO_SpectralLineFringeFitter, hops::MHO_IonosphericFringeFitter, and hops::MHO_BasicFringeFitter.

◆ Accept() [2/2]

virtual void hops::MHO_FringeFitter::Accept ( MHO_FringeFitterVisitor visitor)
pure virtual

Function Accept: accept a visitor...pure virtual, must be implemented in derived class.

Parameters
visitor(MHO_FringeFitterVisitor*)
Note
This is a (pure) virtual function.

Implemented in hops::MHO_IonosphericFringeFitterOpenMP, hops::MHO_SpectralLineFringeFitter, hops::MHO_IonosphericFringeFitter, and hops::MHO_BasicFringeFitter.

◆ Cache() [1/2]

virtual void hops::MHO_FringeFitter::Cache ( )
inlineprotectedvirtual

◆ Cache() [2/2]

virtual void hops::MHO_FringeFitter::Cache ( )
inlineprotectedvirtual

◆ Configure() [1/2]

virtual void hops::MHO_FringeFitter::Configure ( )
pure virtual

Function Configure.

Note
This is a virtual function.

Implemented in hops::MHO_SpectralLineFringeFitter, and hops::MHO_BasicFringeFitter.

◆ Configure() [2/2]

virtual void hops::MHO_FringeFitter::Configure ( )
pure virtual

Function Configure.

Note
This is a virtual function.

Implemented in hops::MHO_SpectralLineFringeFitter, and hops::MHO_BasicFringeFitter.

◆ Finalize() [1/2]

virtual void hops::MHO_FringeFitter::Finalize ( )
pure virtual

◆ Finalize() [2/2]

virtual void hops::MHO_FringeFitter::Finalize ( )
pure virtual

◆ GetContainerStore() [1/2]

MHO_ContainerStore* hops::MHO_FringeFitter::GetContainerStore ( )
inline

Getter for container store.

Returns
MHO_ContainerStore*

◆ GetContainerStore() [2/2]

MHO_ContainerStore* hops::MHO_FringeFitter::GetContainerStore ( )
inline

Getter for container store.

Returns
MHO_ContainerStore*

◆ GetFringeData() [1/2]

MHO_FringeData* hops::MHO_FringeFitter::GetFringeData ( )
inline

Getter for fringe data.

Returns
MHO_FringeData* - Pointer to the fringe data.

◆ GetFringeData() [2/2]

MHO_FringeData* hops::MHO_FringeFitter::GetFringeData ( )
inline

Getter for fringe data.

Returns
MHO_FringeData* - Pointer to the fringe data.

◆ GetOperatorBuildManager() [1/2]

MHO_OperatorBuilderManager* hops::MHO_FringeFitter::GetOperatorBuildManager ( )
inline

Getter for ther operator build manager - only valid after 'Configure' is called.

Returns
MHO_OperatorBuilderManager*

◆ GetOperatorBuildManager() [2/2]

MHO_OperatorBuilderManager* hops::MHO_FringeFitter::GetOperatorBuildManager ( )
inline

Getter for ther operator build manager - only valid after 'Configure' is called.

Returns
MHO_OperatorBuilderManager*

◆ GetOperatorToolbox() [1/2]

MHO_OperatorToolbox* hops::MHO_FringeFitter::GetOperatorToolbox ( )
inline

Getter for operator toolbox.

Returns
Pointer to MHO_OperatorToolbox

◆ GetOperatorToolbox() [2/2]

MHO_OperatorToolbox* hops::MHO_FringeFitter::GetOperatorToolbox ( )
inline

Getter for operator toolbox.

Returns
Pointer to MHO_OperatorToolbox

◆ GetParameterStore() [1/2]

MHO_ParameterStore* hops::MHO_FringeFitter::GetParameterStore ( )
inline

Getter for parameter store.

Returns
Pointer to the MHO_ParameterStore object

◆ GetParameterStore() [2/2]

MHO_ParameterStore* hops::MHO_FringeFitter::GetParameterStore ( )
inline

Getter for parameter store.

Returns
Pointer to the MHO_ParameterStore object

◆ GetScanDataStore() [1/2]

MHO_ScanDataStore* hops::MHO_FringeFitter::GetScanDataStore ( )
inline

Getter for scan data store.

Returns
MHO_ScanDataStore* - Pointer to the scan data store.

◆ GetScanDataStore() [2/2]

MHO_ScanDataStore* hops::MHO_FringeFitter::GetScanDataStore ( )
inline

Getter for scan data store.

Returns
MHO_ScanDataStore* - Pointer to the scan data store.

◆ GetVex() [1/2]

mho_json hops::MHO_FringeFitter::GetVex ( )
inline

Getter for vex (ovex) data as JSON object.

Returns
mho_json containing root file data

◆ GetVex() [2/2]

mho_json hops::MHO_FringeFitter::GetVex ( )
inline

Getter for vex (ovex) data as JSON object.

Returns
mho_json containing root file data

◆ Initialize() [1/2]

virtual void hops::MHO_FringeFitter::Initialize ( )
pure virtual

Function Initialize.

Note
This is a virtual function.

Implemented in hops::MHO_SpectralLineFringeFitter, and hops::MHO_BasicFringeFitter.

◆ Initialize() [2/2]

virtual void hops::MHO_FringeFitter::Initialize ( )
pure virtual

Function Initialize.

Note
This is a virtual function.

Implemented in hops::MHO_SpectralLineFringeFitter, and hops::MHO_BasicFringeFitter.

◆ IsFinished() [1/2]

virtual bool hops::MHO_FringeFitter::IsFinished ( )
pure virtual

Function IsFinished.

Returns
Return value (bool)
Note
This is a virtual function.

Implemented in hops::MHO_SpectralLineFringeFitter, and hops::MHO_BasicFringeFitter.

◆ IsFinished() [2/2]

virtual bool hops::MHO_FringeFitter::IsFinished ( )
pure virtual

Function IsFinished.

Returns
Return value (bool)
Note
This is a virtual function.

Implemented in hops::MHO_SpectralLineFringeFitter, and hops::MHO_BasicFringeFitter.

◆ PostRun() [1/2]

virtual void hops::MHO_FringeFitter::PostRun ( )
pure virtual

Function PostRun.

Note
This is a virtual function.

Implemented in hops::MHO_SpectralLineFringeFitter, and hops::MHO_BasicFringeFitter.

◆ PostRun() [2/2]

virtual void hops::MHO_FringeFitter::PostRun ( )
pure virtual

Function PostRun.

Note
This is a virtual function.

Implemented in hops::MHO_SpectralLineFringeFitter, and hops::MHO_BasicFringeFitter.

◆ PreRun() [1/2]

virtual void hops::MHO_FringeFitter::PreRun ( )
pure virtual

Function PreRun.

Note
This is a virtual function.

Implemented in hops::MHO_SpectralLineFringeFitter, and hops::MHO_BasicFringeFitter.

◆ PreRun() [2/2]

virtual void hops::MHO_FringeFitter::PreRun ( )
pure virtual

Function PreRun.

Note
This is a virtual function.

Implemented in hops::MHO_SpectralLineFringeFitter, and hops::MHO_BasicFringeFitter.

◆ Refresh() [1/2]

virtual void hops::MHO_FringeFitter::Refresh ( )
inlineprotectedvirtual

◆ Refresh() [2/2]

virtual void hops::MHO_FringeFitter::Refresh ( )
inlineprotectedvirtual

◆ Run() [1/2]

virtual void hops::MHO_FringeFitter::Run ( )
pure virtual

Function Run.

Returns
Return value (void Pre)
Note
This is a virtual function.

Implemented in hops::MHO_IonosphericFringeFitterOpenMP, hops::MHO_SpectralLineFringeFitter, hops::MHO_IonosphericFringeFitter, and hops::MHO_BasicFringeFitter.

◆ Run() [2/2]

virtual void hops::MHO_FringeFitter::Run ( )
pure virtual

Function Run.

Returns
Return value (void Pre)
Note
This is a virtual function.

Implemented in hops::MHO_IonosphericFringeFitterOpenMP, hops::MHO_SpectralLineFringeFitter, hops::MHO_IonosphericFringeFitter, and hops::MHO_BasicFringeFitter.

Member Data Documentation

◆ fContainerStore

MHO_ContainerStore * hops::MHO_FringeFitter::fContainerStore
protected

◆ fFringeData

MHO_FringeData * hops::MHO_FringeFitter::fFringeData
protected

◆ fOperatorBuildManager

MHO_OperatorBuilderManager * hops::MHO_FringeFitter::fOperatorBuildManager
protected

◆ fOperatorToolbox

MHO_OperatorToolbox hops::MHO_FringeFitter::fOperatorToolbox
protected

◆ fParameterStore

MHO_ParameterStore * hops::MHO_FringeFitter::fParameterStore
protected

◆ fScanStore

MHO_ScanDataStore * hops::MHO_FringeFitter::fScanStore
protected

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