HOPS
HOPS class reference
Public Member Functions | Protected Member Functions | List of all members
hops::MHO_DCBlock Class Reference

Class MHO_DCBlock. More...

#include <MHO_DCBlock.hh>

Inheritance diagram for hops::MHO_DCBlock:
[legend]

Public Member Functions

 MHO_DCBlock ()
 
virtual ~MHO_DCBlock ()
 
- Public Member Functions inherited from hops::MHO_UnaryOperator< visibility_type >
 MHO_UnaryOperator ()
 
virtual ~MHO_UnaryOperator ()
 
virtual bool Execute () override
 Executes operation using provided arguments and return type. More...
 
virtual bool Execute () override=0
 Function Execute. More...
 
virtual bool Initialize () override
 Initializes the system using in-place or out-of-place arguments. More...
 
virtual bool Initialize () override=0
 Function Initialize. More...
 
 MHO_Operator ()
 
virtual void SetArgs (const visibility_type *in, visibility_type *out)
 Setter for args. More...
 
virtual void SetArgs (visibility_type *in)
 Setter for args. More...
 
- 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...
 

Protected Member Functions

virtual bool ExecuteInPlace (visibility_type *in) override
 Zero out DC spectral points for all channels in-place. More...
 
virtual bool ExecuteOutOfPlace (const visibility_type *in, visibility_type *out) override
 Copies input visibility data and executes in-place processing. More...
 
virtual bool InitializeInPlace (visibility_type *in) override
 Initializes in-place visibility_type pointer. More...
 
virtual bool InitializeOutOfPlace (const visibility_type *in, visibility_type *out) override
 Initializes out-of-place data processing for visibility_type objects. More...
 

Additional Inherited Members

- Protected Attributes inherited from hops::MHO_UnaryOperator< visibility_type >
bool fInPlace
 
std::tuple< visibility_type * > fInPlaceArgs
 
std::tuple< const visibility_type *, visibility_type * > fOutOfPlaceArgs
 

Detailed Description

Class MHO_DCBlock.

Tue Apr 2 09:41:24 AM EDT 2024.

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

Constructor & Destructor Documentation

◆ MHO_DCBlock()

hops::MHO_DCBlock::MHO_DCBlock ( )

◆ ~MHO_DCBlock()

hops::MHO_DCBlock::~MHO_DCBlock ( )
virtual

Member Function Documentation

◆ ExecuteInPlace()

bool hops::MHO_DCBlock::ExecuteInPlace ( visibility_type in)
overrideprotectedvirtual

Zero out DC spectral points for all channels in-place.

Parameters
inInput visibility data to process.
Returns
True if successful.
Note
This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

◆ ExecuteOutOfPlace()

bool hops::MHO_DCBlock::ExecuteOutOfPlace ( const visibility_type in,
visibility_type out 
)
overrideprotectedvirtual

Copies input visibility data and executes in-place processing.

Parameters
inInput visibility data to be copied.
out(visibility_type*)
Returns
Result of ExecuteInPlace operation on copied data.
Note
This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

◆ InitializeInPlace()

bool hops::MHO_DCBlock::InitializeInPlace ( visibility_type in)
overrideprotectedvirtual

Initializes in-place visibility_type pointer.

Parameters
inInput visibility_type pointer to initialize
Returns
True if initialization is successful
Note
This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

◆ InitializeOutOfPlace()

bool hops::MHO_DCBlock::InitializeOutOfPlace ( const visibility_type in,
visibility_type out 
)
overrideprotectedvirtual

Initializes out-of-place data processing for visibility_type objects.

Parameters
inConst input visibility_type pointer
outOutput visibility_type pointer
Returns
True if initialization is successful
Note
This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.


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