This class reads option values for a Statistical Inverse Problem from an input file. More...

#include <StatisticalInverseProblemOptions.h>

Collaboration diagram for QUESO::StatisticalInverseProblemOptions:

Public Member Functions
Constructor/Destructor methods
	StatisticalInverseProblemOptions (const BaseEnvironment &env, const char *prefix)
	Constructor: reads options from the input file. More...

	StatisticalInverseProblemOptions (const BaseEnvironment &env, const char *prefix, const SipOptionsValues &alternativeOptionsValues)
	Constructor: with alternative option values. More...

	~StatisticalInverseProblemOptions ()
	Destructor. More...

I/O methods
void	scanOptionsValues ()
	It scans the option values from the options input file. More...

void	print (std::ostream &os) const
	It prints the option values. More...

Public Attributes
SipOptionsValues	m_ov

std::string	m_prefix

Private Member Functions
void	defineMyOptions (boost::program_options::options_description &optionsDesc) const
	Define my SIP options as the default options. More...

void	getMyOptionValues (boost::program_options::options_description &optionsDesc)
	Gets the option values of the SIP. More...

Private Attributes
const BaseEnvironment &	m_env

boost::program_options::options_description *	m_optionsDesc

std::string	m_option_help

std::string	m_option_computeSolution

std::string	m_option_dataOutputFileName

std::string	m_option_dataOutputAllowedSet

std::string	m_option_seedWithMAPEstimator

std::string	m_option_useOptimizerMonitor

Detailed Description

This class reads option values for a Statistical Inverse Problem from an input file.

This class reads the option values for the Statistical Inverse Problem (SIP) from an input file provided by the user. The class expects the prefix '<prefix>_ip_'. For instance, if 'prefix' is 'foo_775_', then the constructor will read all options that begin with 'foo_775_ip_'. If the options request data to be written in the output file (MATLAB .m format only, for now), the user can run 'grep zeros <OUTPUT FILE NAME>' after the solution procedure ends in order to check which MATLAB variables are defined and set. The names of the variables are self explanatory.

Definition at line 148 of file StatisticalInverseProblemOptions.h.

Constructor & Destructor Documentation

QUESO::StatisticalInverseProblemOptions::StatisticalInverseProblemOptions	(	const BaseEnvironment &	env,
		const char *	prefix
	)

Constructor: reads options from the input file.

Definition at line 192 of file StatisticalInverseProblemOptions.C.

References m_env, QUESO::BaseEnvironment::optionsInputFileName(), queso_deprecated, and queso_require_not_equal_to_msg.

 :
   m_ov                         (),
   m_prefix                     ((std::string)(prefix) + "ip_"),
   m_env                        (env),
 #ifndef DISABLE_BOOST_PROGRAM_OPTIONS
   m_optionsDesc                (new boost::program_options::options_description("Statistical Inverse Problem options")),
 #endif  // DISABLE_BOOST_PROGRAM_OPTIONS
   m_option_help                (m_prefix + "help"                ),
   m_option_computeSolution     (m_prefix + "computeSolution"     ),
   m_option_dataOutputFileName  (m_prefix + "dataOutputFileName"  ),
   m_option_dataOutputAllowedSet(m_prefix + "dataOutputAllowedSet"),
 #ifdef UQ_SIP_READS_SOLVER_OPTION
   m_option_solver              (m_prefix + "solver"              )
 #endif
   m_option_seedWithMAPEstimator(m_prefix + "seedWithMAPEstimator"),
   m_option_useOptimizerMonitor(m_prefix + "useOptimizerMonitor")
 {
   queso_deprecated();
   queso_require_not_equal_to_msg(m_env.optionsInputFileName(), std::string(""), std::string("this constructor is incompatible with the absence of an options input file"));
 }

QUESO::StatisticalInverseProblemOptions::StatisticalInverseProblemOptions	(	const BaseEnvironment &	env,
		const char *	prefix,
		const SipOptionsValues &	alternativeOptionsValues
	)

Constructor: with alternative option values.

In this constructor, the input options are given by alternativeOptionsValues, rather than the options input file

Definition at line 217 of file StatisticalInverseProblemOptions.C.

References m_env, m_prefix, QUESO::BaseEnvironment::optionsInputFileName(), queso_deprecated, queso_require_equal_to_msg, and QUESO::BaseEnvironment::subDisplayFile().

 :
   m_ov                         (alternativeOptionsValues),
   m_prefix                     ((std::string)(prefix) + "ip_"),
   m_env                        (env),
 #ifndef DISABLE_BOOST_PROGRAM_OPTIONS
   m_optionsDesc                (NULL),
 #endif  // DISABLE_BOOST_PROGRAM_OPTIONS
   m_option_help                (m_prefix + "help"                ),
   m_option_computeSolution     (m_prefix + "computeSolution"     ),
   m_option_dataOutputFileName  (m_prefix + "dataOutputFileName"  ),
   m_option_dataOutputAllowedSet(m_prefix + "dataOutputAllowedSet"),
 #ifdef UQ_SIP_READS_SOLVER_OPTION
   m_option_solver              (m_prefix + "solver"              )
 #endif
   m_option_seedWithMAPEstimator(m_prefix + "seedWithMAPEstimator"),
   m_option_useOptimizerMonitor(m_prefix + "useOptimizerMonitor")
 {
   queso_deprecated();
 
   queso_require_equal_to_msg(m_env.optionsInputFileName(), std::string(""), std::string("this constructor is incompatible with the existence of an options input file"));
 
   if (m_env.subDisplayFile() != NULL) {
     *m_env.subDisplayFile() << "In StatisticalInverseProblemOptions::constructor(2)"
                             << ": after setting values of options with prefix '" << m_prefix
                             << "', state of object is:"
                             << "\n" << *this
                             << std::endl;
   }
 }

QUESO::StatisticalInverseProblemOptions::~StatisticalInverseProblemOptions ( )

Destructor.

Definition at line 251 of file StatisticalInverseProblemOptions.C.

References m_optionsDesc, and queso_deprecated.

 {
   queso_deprecated();
 #ifndef DISABLE_BOOST_PROGRAM_OPTIONS
   if (m_optionsDesc) delete m_optionsDesc;
 #endif  // DISABLE_BOOST_PROGRAM_OPTIONS
 }

Member Function Documentation

void QUESO::StatisticalInverseProblemOptions::defineMyOptions ( boost::program_options::options_description & optionsDesc ) const

private

Define my SIP options as the default options.

Definition at line 306 of file StatisticalInverseProblemOptions.C.

References m_option_computeSolution, m_option_dataOutputAllowedSet, m_option_dataOutputFileName, m_option_help, m_option_seedWithMAPEstimator, m_option_useOptimizerMonitor, queso_deprecated, UQ_SIP_COMPUTE_SOLUTION_ODV, UQ_SIP_DATA_OUTPUT_ALLOWED_SET_ODV, UQ_SIP_DATA_OUTPUT_FILE_NAME_ODV, UQ_SIP_SEEDWITHMAPESTIMATOR, and UQ_SIP_USEOPTIMIZERMONITOR.

Referenced by scanOptionsValues().

 {
   queso_deprecated();
 
   optionsDesc.add_options()
     (m_option_help.c_str(),                                                                                              "produce help message for statistical inverse problem")
     (m_option_computeSolution.c_str(),      boost::program_options::value<bool       >()->default_value(UQ_SIP_COMPUTE_SOLUTION_ODV       ), "compute solution process"                            )
     (m_option_dataOutputFileName.c_str(),   boost::program_options::value<std::string>()->default_value(UQ_SIP_DATA_OUTPUT_FILE_NAME_ODV  ), "name of data output file"                            )
     (m_option_dataOutputAllowedSet.c_str(), boost::program_options::value<std::string>()->default_value(UQ_SIP_DATA_OUTPUT_ALLOWED_SET_ODV), "subEnvs that will write to data output file"         )
 #ifdef UQ_SIP_READS_SOLVER_OPTION
     (m_option_solver.c_str(),               boost::program_options::value<std::string>()->default_value(UQ_SIP_SOLVER_ODV                 ), "algorithm for calibration"                           )
 #endif
     (m_option_seedWithMAPEstimator.c_str(), boost::program_options::value<bool>()->default_value(UQ_SIP_SEEDWITHMAPESTIMATOR), "toggle optimisation of posterior pdf before sampling")
     (m_option_useOptimizerMonitor.c_str(), boost::program_options::value<bool>()->default_value(UQ_SIP_USEOPTIMIZERMONITOR), "toggle printing of optimisation progress when seed with MAP estimator")
   ;
 }

void QUESO::StatisticalInverseProblemOptions::getMyOptionValues ( boost::program_options::options_description & optionsDesc )

private

Gets the option values of the SIP.

Definition at line 327 of file StatisticalInverseProblemOptions.C.

References QUESO::BaseEnvironment::allOptionsMap(), QUESO::SipOptionsValues::m_computeSolution, QUESO::SipOptionsValues::m_dataOutputAllowedSet, QUESO::SipOptionsValues::m_dataOutputFileName, m_env, m_option_computeSolution, m_option_dataOutputAllowedSet, m_option_dataOutputFileName, m_option_help, m_option_seedWithMAPEstimator, m_option_useOptimizerMonitor, m_ov, QUESO::SipOptionsValues::m_seedWithMAPEstimator, QUESO::SipOptionsValues::m_useOptimizerMonitor, QUESO::MiscReadDoublesFromString(), queso_deprecated, and QUESO::BaseEnvironment::subDisplayFile().

Referenced by scanOptionsValues().

 {
   queso_deprecated();
 
   if (m_env.allOptionsMap().count(m_option_help)) {
     if (m_env.subDisplayFile()) {
       *m_env.subDisplayFile() << optionsDesc
                               << std::endl;
     }
   }
 
   if (m_env.allOptionsMap().count(m_option_computeSolution)) {
     m_ov.m_computeSolution = ((const boost::program_options::variable_value&) m_env.allOptionsMap()[m_option_computeSolution]).as<bool>();
   }
 
   if (m_env.allOptionsMap().count(m_option_dataOutputFileName)) {
     m_ov.m_dataOutputFileName = ((const boost::program_options::variable_value&) m_env.allOptionsMap()[m_option_dataOutputFileName]).as<std::string>();
   }
 
   if (m_env.allOptionsMap().count(m_option_dataOutputAllowedSet)) {
     m_ov.m_dataOutputAllowedSet.clear();
     std::vector<double> tmpAllow(0,0.);
     std::string inputString = m_env.allOptionsMap()[m_option_dataOutputAllowedSet].as<std::string>();
     MiscReadDoublesFromString(inputString,tmpAllow);
 
     if (tmpAllow.size() > 0) {
       for (unsigned int i = 0; i < tmpAllow.size(); ++i) {
         m_ov.m_dataOutputAllowedSet.insert((unsigned int) tmpAllow[i]);
       }
     }
   }
 
 #ifdef UQ_SIP_READS_SOLVER_OPTION
   if (m_env.allOptionsMap().count(m_option_solver)) {
     m_ov.m_solverString = ((const boost::program_options::variable_value&) m_env.allOptionsMap()[m_option_solver]).as<std::string>();
   }
 #endif
 
   if (m_env.allOptionsMap().count(m_option_seedWithMAPEstimator)) {
     m_ov.m_seedWithMAPEstimator = ((const boost::program_options::variable_value&) m_env.allOptionsMap()[m_option_seedWithMAPEstimator]).as<bool>();
   }
 
   if (m_env.allOptionsMap().count(m_option_useOptimizerMonitor)) {
     m_ov.m_useOptimizerMonitor = ((const boost::program_options::variable_value&) m_env.allOptionsMap()[m_option_useOptimizerMonitor]).as<bool>();
   }
 }

void QUESO::StatisticalInverseProblemOptions::print ( std::ostream & os ) const

It prints the option values.

Definition at line 284 of file StatisticalInverseProblemOptions.C.

References QUESO::SipOptionsValues::m_computeSolution, QUESO::SipOptionsValues::m_dataOutputAllowedSet, QUESO::SipOptionsValues::m_dataOutputFileName, m_option_computeSolution, m_option_dataOutputAllowedSet, m_option_dataOutputFileName, m_option_seedWithMAPEstimator, m_option_useOptimizerMonitor, m_ov, QUESO::SipOptionsValues::m_seedWithMAPEstimator, QUESO::SipOptionsValues::m_useOptimizerMonitor, and queso_deprecated.

Referenced by QUESO::operator<<().

 {
   queso_deprecated();
 
   os << "\n" << m_option_computeSolution      << " = " << m_ov.m_computeSolution
      << "\n" << m_option_dataOutputFileName   << " = " << m_ov.m_dataOutputFileName;
   os << "\n" << m_option_dataOutputAllowedSet << " = ";
   for (std::set<unsigned int>::iterator setIt = m_ov.m_dataOutputAllowedSet.begin(); setIt != m_ov.m_dataOutputAllowedSet.end(); ++setIt) {
     os << *setIt << " ";
   }
 #ifdef UQ_SIP_READS_SOLVER_OPTION
      << "\n" << m_option_solver << " = " << m_ov.m_solverString
 #endif
   os << "\n" << m_option_seedWithMAPEstimator << " = " << m_ov.m_seedWithMAPEstimator
      << "\n" << m_option_useOptimizerMonitor << " = " << m_ov.m_useOptimizerMonitor;
   os << std::endl;
 
   return;
 }

void QUESO::StatisticalInverseProblemOptions::scanOptionsValues ( )

It scans the option values from the options input file.

Definition at line 261 of file StatisticalInverseProblemOptions.C.

References defineMyOptions(), getMyOptionValues(), m_env, m_optionsDesc, m_prefix, queso_require_msg, QUESO::BaseEnvironment::scanInputFileForMyOptions(), and QUESO::BaseEnvironment::subDisplayFile().

 {
 #ifndef DISABLE_BOOST_PROGRAM_OPTIONS
   queso_require_msg(m_optionsDesc, "m_optionsDesc variable is NULL");
 
   defineMyOptions                (*m_optionsDesc);
   m_env.scanInputFileForMyOptions(*m_optionsDesc);
   getMyOptionValues              (*m_optionsDesc);
 #endif  // DISABLE_BOOST_PROGRAM_OPTIONS
 
   if (m_env.subDisplayFile() != NULL) {
     *m_env.subDisplayFile() << "In StatisticalInverseProblemOptions::scanOptionsValues()"
                             << ": after reading values of options with prefix '" << m_prefix
                             << "', state of  object is:"
                             << "\n" << *this
                             << std::endl;
   }
 
   return;
 }