SourceXtractorPlusPlus  0.15
Please provide a description of the project.
Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
SourceXtractor::WeightImageConfig Class Reference

#include <WeightImageConfig.h>

Inheritance diagram for SourceXtractor::WeightImageConfig:
[legend]
Collaboration diagram for SourceXtractor::WeightImageConfig:
[legend]

Public Types

enum  WeightType {
  WeightType::WEIGHT_TYPE_NONE, WeightType::WEIGHT_TYPE_FROM_BACKGROUND, WeightType::WEIGHT_TYPE_RMS, WeightType::WEIGHT_TYPE_VARIANCE,
  WeightType::WEIGHT_TYPE_WEIGHT
}
 
- Public Types inherited from Euclid::Configuration::Configuration
enum  State { State::CONSTRUCTED, State::PRE_INITIALIZED, State::INITIALIZED, State::FINAL }
 
typedef std::vector< boost::program_options::option_description > OptionDescriptionList
 
typedef std::map< std::string, boost::program_options::variable_value > UserValues
 

Public Member Functions

virtual ~WeightImageConfig ()=default
 
 WeightImageConfig (long manager_id)
 
std::map< std::string, Configuration::OptionDescriptionListgetProgramOptions () override
 
void initialize (const UserValues &args) override
 
std::shared_ptr< WeightImagegetWeightImage () const
 
WeightType getWeightType () const
 
bool isWeightAbsolute () const
 
WeightImage::PixelType getWeightThreshold () const
 
bool symmetryUsage () const
 
- Public Member Functions inherited from Euclid::Configuration::Configuration
 Configuration (long manager_id)
 
virtual ~Configuration ()=default
 
virtual void preInitialize (const UserValues &args)
 
virtual void postInitialize (const UserValues &args)
 
const std::set< std::type_index > & getDependencies ()
 
StategetCurrentState ()
 
State getCurrentState () const
 

Static Public Member Functions

static std::shared_ptr< WeightImageconvertWeightMap (std::shared_ptr< WeightImage > weight_image, WeightType weight_type, WeightImage::PixelType scaling=1)
 

Private Attributes

std::shared_ptr< WeightImagem_weight_image
 
WeightType m_weight_type
 
bool m_absolute_weight
 
WeightImage::PixelType m_weight_scaling
 
WeightImage::PixelType m_weight_threshold
 
bool m_symmetry_usage
 

Additional Inherited Members

- Protected Member Functions inherited from Euclid::Configuration::Configuration
void declareDependency ()
 
T & getDependency ()
 
const T & getDependency () const
 

Detailed Description

Definition at line 32 of file WeightImageConfig.h.

Member Enumeration Documentation

◆ WeightType

Enumerator
WEIGHT_TYPE_NONE 
WEIGHT_TYPE_FROM_BACKGROUND 
WEIGHT_TYPE_RMS 
WEIGHT_TYPE_VARIANCE 
WEIGHT_TYPE_WEIGHT 

Definition at line 36 of file WeightImageConfig.h.

Constructor & Destructor Documentation

◆ ~WeightImageConfig()

virtual SourceXtractor::WeightImageConfig::~WeightImageConfig ( )
virtualdefault

◆ WeightImageConfig()

SourceXtractor::WeightImageConfig::WeightImageConfig ( long  manager_id)

Definition at line 50 of file WeightImageConfig.cpp.

Member Function Documentation

◆ convertWeightMap()

std::shared_ptr< WeightImage > SourceXtractor::WeightImageConfig::convertWeightMap ( std::shared_ptr< WeightImage weight_image,
WeightType  weight_type,
WeightImage::PixelType  scaling = 1 
)
static

Definition at line 222 of file WeightImageConfig.cpp.

References SourceXtractor::BufferedImage< T >::create(), WEIGHT_TYPE_FROM_BACKGROUND, and WEIGHT_TYPE_NONE.

Referenced by initialize().

Here is the call graph for this function:

◆ getProgramOptions()

std::map< std::string, Configuration::OptionDescriptionList > SourceXtractor::WeightImageConfig::getProgramOptions ( )
overridevirtual

Reimplemented from Euclid::Configuration::Configuration.

Definition at line 61 of file WeightImageConfig.cpp.

References std::string::c_str(), SourceXtractor::WEIGHT_ABSOLUTE, SourceXtractor::WEIGHT_IMAGE, SourceXtractor::WEIGHT_SCALING, SourceXtractor::WEIGHT_SYMMETRYUSAGE, SourceXtractor::WEIGHT_THRESHOLD, and SourceXtractor::WEIGHT_TYPE.

Here is the call graph for this function:

◆ getWeightImage()

std::shared_ptr<WeightImage> SourceXtractor::WeightImageConfig::getWeightImage ( ) const
inline

Definition at line 50 of file WeightImageConfig.h.

References m_weight_image.

Referenced by BenchBackgroundModel::mainMethod().

◆ getWeightThreshold()

WeightImage::PixelType SourceXtractor::WeightImageConfig::getWeightThreshold ( ) const
inline

Definition at line 62 of file WeightImageConfig.h.

References m_weight_threshold.

Referenced by BenchBackgroundModel::mainMethod().

◆ getWeightType()

WeightType SourceXtractor::WeightImageConfig::getWeightType ( ) const
inline

Definition at line 54 of file WeightImageConfig.h.

References m_weight_type.

Referenced by BenchBackgroundModel::getBackgroundAnalyzer().

◆ initialize()

void SourceXtractor::WeightImageConfig::initialize ( const UserValues args)
overridevirtual

◆ isWeightAbsolute()

bool SourceXtractor::WeightImageConfig::isWeightAbsolute ( ) const
inline

Definition at line 58 of file WeightImageConfig.h.

References m_absolute_weight.

◆ symmetryUsage()

bool SourceXtractor::WeightImageConfig::symmetryUsage ( ) const
inline

Definition at line 66 of file WeightImageConfig.h.

References m_symmetry_usage.

Member Data Documentation

◆ m_absolute_weight

bool SourceXtractor::WeightImageConfig::m_absolute_weight
private

Definition at line 76 of file WeightImageConfig.h.

Referenced by initialize(), and isWeightAbsolute().

◆ m_symmetry_usage

bool SourceXtractor::WeightImageConfig::m_symmetry_usage
private

Definition at line 79 of file WeightImageConfig.h.

Referenced by initialize(), and symmetryUsage().

◆ m_weight_image

std::shared_ptr<WeightImage> SourceXtractor::WeightImageConfig::m_weight_image
private

Definition at line 74 of file WeightImageConfig.h.

Referenced by getWeightImage(), and initialize().

◆ m_weight_scaling

WeightImage::PixelType SourceXtractor::WeightImageConfig::m_weight_scaling
private

Definition at line 77 of file WeightImageConfig.h.

Referenced by initialize().

◆ m_weight_threshold

WeightImage::PixelType SourceXtractor::WeightImageConfig::m_weight_threshold
private

Definition at line 78 of file WeightImageConfig.h.

Referenced by getWeightThreshold(), and initialize().

◆ m_weight_type

WeightType SourceXtractor::WeightImageConfig::m_weight_type
private

Definition at line 75 of file WeightImageConfig.h.

Referenced by getWeightType(), and initialize().


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