DP3
Public Types | Public Member Functions | List of all members
dp3::model::Patch Class Reference

A set of sources for which direction dependent effects are assumed to be equal. More...

#include <Patch.h>

Public Types

using const_iterator = std::vector< std::shared_ptr< const base::ModelComponent > >::const_iterator
 
using iterator = std::vector< std::shared_ptr< base::ModelComponent > >::iterator
 

Public Member Functions

template<typename T >
 Patch (const std::string &name, T first, T last)
 
iterator begin ()
 
double Brightness () const
 
std::shared_ptr< base::ModelComponentcomponent (size_t i)
 
std::shared_ptr< const base::ModelComponentcomponent (size_t i) const
 
void ComputeDirection ()
 Compute the direction as the average of the positions of the components. More...
 
const base::DirectionDirection () const
 
iterator end ()
 
size_t Index () const
 
const std::string & Name () const
 
size_t NComponents () const
 
void SetBrightness (double brightness)
 
void SetDirection (const base::Direction &pos)
 
void SetIndex (size_t index)
 

Detailed Description

A set of sources for which direction dependent effects are assumed to be equal.

Member Typedef Documentation

◆ const_iterator

using dp3::model::Patch::const_iterator = std::vector<std::shared_ptr<const base::ModelComponent> >::const_iterator

◆ iterator

using dp3::model::Patch::iterator = std::vector<std::shared_ptr<base::ModelComponent> >::iterator

Constructor & Destructor Documentation

◆ Patch()

template<typename T >
dp3::model::Patch::Patch ( const std::string &  name,
first,
last 
)
inline

Member Function Documentation

◆ begin()

iterator dp3::model::Patch::begin ( )
inline

◆ Brightness()

double dp3::model::Patch::Brightness ( ) const
inline

◆ component() [1/2]

std::shared_ptr<base::ModelComponent> dp3::model::Patch::component ( size_t  i)
inline

◆ component() [2/2]

std::shared_ptr<const base::ModelComponent> dp3::model::Patch::component ( size_t  i) const
inline

◆ ComputeDirection()

void dp3::model::Patch::ComputeDirection ( )

Compute the direction as the average of the positions of the components.

◆ Direction()

const base::Direction& dp3::model::Patch::Direction ( ) const
inline

◆ end()

iterator dp3::model::Patch::end ( )
inline

◆ Index()

size_t dp3::model::Patch::Index ( ) const
inline

Index is used by OnePredict to be able to know what beam values belong to what patch. It is the index of this patch in the full list of patches being predicted.

◆ Name()

const std::string& dp3::model::Patch::Name ( ) const
inline

◆ NComponents()

size_t dp3::model::Patch::NComponents ( ) const
inline

◆ SetBrightness()

void dp3::model::Patch::SetBrightness ( double  brightness)
inline

◆ SetDirection()

void dp3::model::Patch::SetDirection ( const base::Direction pos)
inline

◆ SetIndex()

void dp3::model::Patch::SetIndex ( size_t  index)
inline

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