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

Class MHO_VisibilityChannelizer. More...

#include <MHO_VisibilityChannelizer.hh>

Inheritance diagram for hops::MHO_VisibilityChannelizer:
[legend]

Public Member Functions

 MHO_VisibilityChannelizer ()
 
virtual ~MHO_VisibilityChannelizer ()
 
- Public Member Functions inherited from hops::MHO_TransformingOperator< uch_visibility_store_type, visibility_store_type >
 MHO_TransformingOperator ()
 
virtual ~MHO_TransformingOperator ()
 
virtual bool Execute () override
 Executes transformation using provided arguments. More...
 
virtual bool Initialize () override
 Initializes the system by calling InitializeImpl with arguments from fArgs. More...
 
virtual void SetArgs (const uch_visibility_store_type *in, visibility_store_type *out)
 Setter for args (operation transforms the original type into another) 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 ExecuteImpl (const uch_visibility_store_type *in, visibility_store_type *out)
 Reorganizes visibility data into channelized format and updates channel labels. More...
 
virtual bool InitializeImpl (const uch_visibility_store_type *in, visibility_store_type *out)
 Reorganizes input visibility data into output array by channel and resizes it accordingly. More...
 

Additional Inherited Members

- Protected Attributes inherited from hops::MHO_TransformingOperator< uch_visibility_store_type, visibility_store_type >
std::tuple< const uch_visibility_store_type *, visibility_store_type * > fArgs
 

Detailed Description

Class MHO_VisibilityChannelizer.

collects unchannelized (3d) visibility data and groups by channel (but all channels must be of equal size) into 4d object

Author
J. Barrett - barre.nosp@m.ttj@.nosp@m.mit.e.nosp@m.du
Date
Thu Nov 5 13:11:33 2020 -0500

Constructor & Destructor Documentation

◆ MHO_VisibilityChannelizer()

hops::MHO_VisibilityChannelizer::MHO_VisibilityChannelizer ( )

◆ ~MHO_VisibilityChannelizer()

hops::MHO_VisibilityChannelizer::~MHO_VisibilityChannelizer ( )
virtual

Member Function Documentation

◆ ExecuteImpl()

bool hops::MHO_VisibilityChannelizer::ExecuteImpl ( const uch_visibility_store_type in,
visibility_store_type out 
)
protectedvirtual

Reorganizes visibility data into channelized format and updates channel labels.

Parameters
inInput visibility store data (rank = 3)
outOutput channelized visibility store data
Returns
True if execution is successful, false otherwise
Note
This is a virtual function.

Implements hops::MHO_TransformingOperator< uch_visibility_store_type, visibility_store_type >.

◆ InitializeImpl()

bool hops::MHO_VisibilityChannelizer::InitializeImpl ( const uch_visibility_store_type in,
visibility_store_type out 
)
protectedvirtual

Reorganizes input visibility data into output array by channel and resizes it accordingly.

Parameters
inInput visibility store data (rank = 3)
outOutput visibility store data (rank = 4)
Returns
True if initialization is successful, false otherwise
Note
This is a virtual function.

Implements hops::MHO_TransformingOperator< uch_visibility_store_type, visibility_store_type >.


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