hops::MHO_PyGenericOperator Class Reference

this class allows a user to inject a python function of the form: func(fringe_data_interface) into the control flow of the fringe fitter. It is basically allowed full access to any data or parameters encompassed by the fringe_data object (container store, parameter store, plot data). The only exception is that re-sizing of arrays is not allowed. More...

#include <MHO_PyGenericOperator.hh>

Inheritance diagram for hops::MHO_PyGenericOperator:

Public Member Functions
	MHO_PyGenericOperator ()
virtual	~MHO_PyGenericOperator ()
virtual bool	Execute () override
	Function Execute. More...
virtual bool	Initialize () override
	Function Initialize. More...
void	SetFringeData (MHO_FringeData *fdata)
void	SetFunctionName (std::string function_name)
void	SetModuleName (std::string module_name)
Public Member Functions inherited from hops::MHO_Operator
	MHO_Operator ()
virtual	~MHO_Operator ()
std::string	GetName () const
	Getter for operator name. More...
virtual double	Priority () const
	Get the the priority field value. More...
void	SetName (std::string name)
	Setter for operator name. More...
virtual void	SetPriority (const double &priority)
	Setter for operator priority (determines order of execution within a operator category) More...

Detailed Description

this class allows a user to inject a python function of the form: func(fringe_data_interface) into the control flow of the fringe fitter. It is basically allowed full access to any data or parameters encompassed by the fringe_data object (container store, parameter store, plot data). The only exception is that re-sizing of arrays is not allowed.

Author

J. Barrett - barre.nosp@m.ttj@.nosp@m.mit.e.nosp@m.du

Date

Mon Sep 18 13:51:51 2023 -0400

Constructor & Destructor Documentation

MHO_PyGenericOperator()

hops::MHO_PyGenericOperator::MHO_PyGenericOperator ( )

inline

~MHO_PyGenericOperator()

virtual hops::MHO_PyGenericOperator::~MHO_PyGenericOperator ( )

inlinevirtual

Member Function Documentation

Execute()

virtual bool hops::MHO_PyGenericOperator::Execute ( )

inlineoverridevirtual

Function Execute.

Returns

Return value (bool)

Note

This is a virtual function.

Implements hops::MHO_Operator.

Initialize()

virtual bool hops::MHO_PyGenericOperator::Initialize ( )

inlineoverridevirtual

Function Initialize.

Returns

Return value (bool)

Note

This is a virtual function.

Implements hops::MHO_Operator.

SetFringeData()

void hops::MHO_PyGenericOperator::SetFringeData ( MHO_FringeData *  fdata )

inline

SetFunctionName()

void hops::MHO_PyGenericOperator::SetFunctionName ( std::string  function_name )

inline

SetModuleName()

void hops::MHO_PyGenericOperator::SetModuleName ( std::string  module_name )

inline

---

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

• MHO_PyGenericOperator.hh