BpSettings.h

Go to the documentation of this file.

/*
Copyright (C) 2024 Scott Grauer-Gray
 
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
 
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
*/
 
#ifndef BP_SETTINGS_H_
#define BP_SETTINGS_H_
 
#include <vector>
#include <string>
#include <string_view>
#include "RunSettingsParams/InputSignature.h"
#include "RunEval/RunData.h"
#include "BpConstsEnumsAliases.h"
#include "BpRunUtils.h"
 
template <typename T>
concept Params_t =
  requires(T t) {
    { t.AsRunData() } -> std::same_as<RunData>;
  };
 
namespace beliefprop {
 
//constants for headers corresponding to belief propagation settings in evaluation
constexpr std::string_view kNumDispValsHeader{"Num Possible Disparity Values"};
constexpr std::string_view kNumBpLevelsHeader{"Num BP Levels",};
constexpr std::string_view kNumBpItersHeader{"Num BP Iterations"};
constexpr std::string_view kDiscCostCapHeader{"DISC_K_BP"};
constexpr std::string_view kDataCostCapHeader{"DataKBp"};
constexpr std::string_view kBpSettingsLambdaHeader{"LambdaBp"};
constexpr std::string_view kBpSettingsSigmaHeader{"SigmaBp"};
 
constexpr unsigned int kDefaultLevelsBp{5};
 
constexpr unsigned int kDefaultItersBp{7};
 
constexpr float kDefaultSigmaBp{0.0};
 
constexpr float kDefaultLambdaBp{0.1};
 
constexpr float kDefaultDataKBp{15.0};
 
struct BpSettings
{
  //initally set to default values
  unsigned int num_levels{kDefaultLevelsBp};
  unsigned int num_iterations{kDefaultItersBp};
  float smoothing_sigma{kDefaultSigmaBp};
  float lambda_bp{kDefaultLambdaBp};
  float data_k_bp{kDefaultDataKBp};
 
  float disc_k_bp{beliefprop::kHighValBp<float>};
 
  unsigned int num_disp_vals{0};
 
  RunData AsRunData() const {
    RunData curr_run_data;
    curr_run_data.AddDataWHeader(std::string(kNumDispValsHeader), num_disp_vals);
    curr_run_data.AddDataWHeader(std::string(kNumBpLevelsHeader), num_levels);
    curr_run_data.AddDataWHeader(std::string(kNumBpItersHeader), num_iterations);
    curr_run_data.AddDataWHeader(std::string(kDiscCostCapHeader), (double)disc_k_bp);
    curr_run_data.AddDataWHeader(std::string(kDataCostCapHeader), (double)data_k_bp);
    curr_run_data.AddDataWHeader(std::string(kBpSettingsLambdaHeader), (double)lambda_bp);
    curr_run_data.AddDataWHeader(std::string(kBpSettingsSigmaHeader), (double)smoothing_sigma);
 
    return curr_run_data;
  }
};
 
}
 
#endif //BP_SETTINGS_H_