SimDataPair Class Reference

Description

Holds pair of simulation/experimental data to fit.

Definition at line 30 of file SimDataPair.h.

Collaboration diagram for SimDataPair:

Public Member Functions
	SimDataPair (SimDataPair &&other)
	SimDataPair (simulation_builder_t builder, const Datafield &raw_data, std::unique_ptr< Datafield > &&raw_stdv, double user_weight=1.0)
	SimDataPair (simulation_builder_t builder, const Datafield &raw_data, std::unique_ptr< Datafield > &&raw_stdv, std::unique_ptr< Datafield > &&user_weights)
	~SimDataPair ()
SimulationResult	absoluteDifference () const
	Returns the absolute difference between simulated and experimental data cut to the ROI area. More...
bool	containsUncertainties () const
void	execSimulation (const mumufit::Parameters &params)
std::vector< double >	experimental_array () const
	Returns the flattened experimental data cut to the ROI area. More...
SimulationResult	experimentalData () const
	Returns the experimental data cut to the ROI area. More...
SimulationResult	relativeDifference () const
	Returns the relative difference between simulated and experimental data cut to the ROI area. More...
std::vector< double >	simulation_array () const
	Returns the flattened simulated intensities cut to the ROI area. More...
SimulationResult	simulationResult () const
	Returns the result of last computed simulation. More...
SimulationResult	uncertainties () const
	Returns the data uncertainties cut to the ROI area If no uncertainties present, returns zero-filled SimulationResult. More...
std::vector< double >	uncertainties_array () const
	Returns the flattened experimental uncertainties cut to the ROI area. If no uncertainties are available, Returns a zero-filled array sized to the ROI area. More...
std::vector< double >	user_weights_array () const
	Returns a flat array of user weights cut to the ROI area. More...
SimulationResult	userWeights () const
	Returns the user uncertainties cut to the ROI area. More...

Private Member Functions
void	validate () const

Private Attributes
SimulationResult	m_exp_data
	Experimental data cut to the ROI. Masked areas are nullified. More...
std::unique_ptr< Datafield >	m_raw_data
	Raw experimental data as obtained from the user. More...
std::unique_ptr< Datafield >	m_raw_uncertainties
	Data uncertainties as provided by the user. More...
std::unique_ptr< Datafield >	m_raw_user_weights
	User-defined weights. More...
SimulationResult	m_sim_data
	Current simulation results. Masked areas are nullified. More...
simulation_builder_t	m_simulation_builder
	ISimulation builder from the user to construct simulation for given set of parameters. More...
SimulationResult	m_uncertainties
	Weights from experimental data uncertainties. Masked areas are nullified. More...
SimulationResult	m_user_weights
	Manually defined (user) weights. Masked areas are nullified. More...

Constructor & Destructor Documentation

SimDataPair() [1/3]

SimDataPair::SimDataPair	(	simulation_builder_t	builder,
		const Datafield &	raw_data,
		std::unique_ptr< Datafield > &&	raw_stdv,
		double	user_weight = 1.0
	)

Definition at line 90 of file SimDataPair.cpp.

    : m_simulation_builder(std::move(builder))
    , m_raw_data(raw_data.clone())
    , m_raw_uncertainties(std::move(raw_stdv))
{
    m_raw_user_weights = initUserWeights(*m_raw_data, user_weight);
    validate();
}

References m_raw_data, m_raw_user_weights, and validate().

Here is the call graph for this function:

SimDataPair() [2/3]

SimDataPair::SimDataPair	(	simulation_builder_t	builder,
		const Datafield &	raw_data,
		std::unique_ptr< Datafield > &&	raw_stdv,
		std::unique_ptr< Datafield > &&	user_weights
	)

Definition at line 100 of file SimDataPair.cpp.

    : m_simulation_builder(std::move(builder))
    , m_raw_data(raw_data.clone())
    , m_raw_uncertainties(std::move(raw_stdv))
    , m_raw_user_weights(std::move(user_weights))
{
    if (!m_raw_user_weights)
        m_raw_user_weights = initUserWeights(*m_raw_data, 1.0);
    validate();
}

References m_raw_data, m_raw_user_weights, and validate().

Here is the call graph for this function:

SimDataPair() [3/3]

SimDataPair::SimDataPair

(

SimDataPair &&

other

)

Definition at line 113 of file SimDataPair.cpp.

    : m_simulation_builder(std::move(other.m_simulation_builder))
    , m_sim_data(std::move(other.m_sim_data))
    , m_exp_data(std::move(other.m_exp_data))
    , m_uncertainties(std::move(other.m_uncertainties))
    , m_user_weights(std::move(other.m_user_weights))
    , m_raw_data(std::move(other.m_raw_data))
    , m_raw_uncertainties(std::move(other.m_raw_uncertainties))
    , m_raw_user_weights(std::move(other.m_raw_user_weights))
{
    validate();
}

References validate().

Here is the call graph for this function:

~SimDataPair()

SimDataPair::~SimDataPair ( )

default

Member Function Documentation

absoluteDifference()

SimulationResult SimDataPair::absoluteDifference

(

)

const

Returns the absolute difference between simulated and experimental data cut to the ROI area.

Definition at line 207 of file SimDataPair.cpp.

{
    if (m_sim_data.empty() || m_exp_data.empty())
        throwInitializationException("absoluteDifference");
 
    SimulationResult result = m_sim_data;
    for (size_t i = 0, size = result.size(); i < size; ++i)
        result[i] = Numeric::GetAbsoluteDifference(result[i], m_exp_data[i]);
 
    return result;
}

References SimulationResult::empty(), Numeric::GetAbsoluteDifference(), m_exp_data, m_sim_data, and SimulationResult::size().

Referenced by FitObjective::absoluteDifference().

Here is the call graph for this function:

containsUncertainties()

bool SimDataPair::containsUncertainties

(

)

const

Definition at line 159 of file SimDataPair.cpp.

{
    return static_cast<bool>(m_raw_uncertainties);
}

References m_raw_uncertainties.

Referenced by FitObjective::allPairsHaveUncertainties(), ObjectiveMetric::compute(), FitObjective::containsUncertainties(), and execSimulation().

execSimulation()

void SimDataPair::execSimulation

(

const mumufit::Parameters &

params

)

Definition at line 128 of file SimDataPair.cpp.

{
    std::unique_ptr<ISimulation> simulation = m_simulation_builder(params);
    ASSERT(simulation);
    m_sim_data = simulation->simulate();
 
    if (!m_exp_data.empty() && !m_uncertainties.empty() && !m_user_weights.empty())
        return;
 
    if (m_sim_data.empty())
        throwInitializationException("initResultArrays");
 
    auto* const sim2d = dynamic_cast<ISimulation2D*>(simulation.get());
    if (sim2d) {
        m_exp_data = convertData(*sim2d, *m_raw_data);
        m_user_weights = convertData(*sim2d, *m_raw_user_weights);
    } else {
        const ICoordSystem& converter = m_sim_data.converter();
        m_exp_data = SimulationResult(*m_raw_data, converter);
        m_user_weights = SimulationResult(*m_raw_user_weights, converter);
    }
 
    if (sim2d && containsUncertainties())
        m_uncertainties = convertData(*sim2d, *m_raw_uncertainties);
    else {
        const ICoordSystem& converter = m_sim_data.converter();
        auto dummy_array = std::make_unique<Datafield>(converter.defaultAxes());
        m_uncertainties = SimulationResult(*dummy_array, converter);
    }
}

References ASSERT, containsUncertainties(), SimulationResult::converter(), ICoordSystem::defaultAxes(), SimulationResult::empty(), m_exp_data, m_raw_data, m_raw_uncertainties, m_raw_user_weights, m_sim_data, m_simulation_builder, m_uncertainties, and m_user_weights.

Here is the call graph for this function:

experimental_array()

std::vector< double > SimDataPair::experimental_array

(

)

const

Returns the flattened experimental data cut to the ROI area.

Definition at line 219 of file SimDataPair.cpp.

{
    if (m_exp_data.empty())
        throwInitializationException("experimental_array");
    return m_exp_data.datafield()->flatVector();
}

References SimulationResult::datafield(), SimulationResult::empty(), Datafield::flatVector(), and m_exp_data.

Referenced by ObjectiveMetric::compute(), and FitObjective::experimental_array().

Here is the call graph for this function:

experimentalData()

SimulationResult SimDataPair::experimentalData

(

)

const

Returns the experimental data cut to the ROI area.

Definition at line 171 of file SimDataPair.cpp.

{
    if (m_exp_data.empty())
        throwInitializationException("experimentalData");
    return m_exp_data;
}

References SimulationResult::empty(), and m_exp_data.

Referenced by RQ4Metric::compute(), and FitObjective::experimentalData().

Here is the call graph for this function:

relativeDifference()

SimulationResult SimDataPair::relativeDifference

(

)

const

Returns the relative difference between simulated and experimental data cut to the ROI area.

Returns relative difference between simulation and experimental data.

Definition at line 195 of file SimDataPair.cpp.

{
    if (m_sim_data.empty() || m_exp_data.empty())
        throwInitializationException("relativeDifference");
 
    SimulationResult result = m_sim_data;
    for (size_t i = 0, size = result.size(); i < size; ++i)
        result[i] = Numeric::relativeDifference(result[i], m_exp_data[i]);
 
    return result;
}

References SimulationResult::empty(), m_exp_data, m_sim_data, Numeric::relativeDifference(), and SimulationResult::size().

Referenced by FitObjective::relativeDifference().

Here is the call graph for this function:

simulation_array()

std::vector< double > SimDataPair::simulation_array

(

)

const

Returns the flattened simulated intensities cut to the ROI area.

Definition at line 226 of file SimDataPair.cpp.

{
    if (m_sim_data.empty())
        throwInitializationException("simulation_array");
    return m_sim_data.datafield()->flatVector();
}

References SimulationResult::datafield(), SimulationResult::empty(), Datafield::flatVector(), and m_sim_data.

Referenced by ObjectiveMetric::compute(), and FitObjective::simulation_array().

Here is the call graph for this function:

simulationResult()

SimulationResult SimDataPair::simulationResult

(

)

const

Returns the result of last computed simulation.

Definition at line 164 of file SimDataPair.cpp.

{
    if (m_sim_data.empty())
        throwInitializationException("simulationResult");
    return m_sim_data;
}

References SimulationResult::empty(), and m_sim_data.

Referenced by RQ4Metric::compute(), and FitObjective::simulationResult().

Here is the call graph for this function:

uncertainties()

SimulationResult SimDataPair::uncertainties

(

)

const

Returns the data uncertainties cut to the ROI area If no uncertainties present, returns zero-filled SimulationResult.

Definition at line 178 of file SimDataPair.cpp.

{
    if (m_uncertainties.empty())
        throwInitializationException("uncertainties");
    return m_uncertainties;
}

References SimulationResult::empty(), and m_uncertainties.

Referenced by FitObjective::uncertaintyData().

Here is the call graph for this function:

uncertainties_array()

std::vector< double > SimDataPair::uncertainties_array

(

)

const

Returns the flattened experimental uncertainties cut to the ROI area. If no uncertainties are available, Returns a zero-filled array sized to the ROI area.

Definition at line 233 of file SimDataPair.cpp.

{
    if (m_uncertainties.empty())
        throwInitializationException("uncertainties_array");
    return m_uncertainties.datafield()->flatVector();
}

References SimulationResult::datafield(), SimulationResult::empty(), Datafield::flatVector(), and m_uncertainties.

Referenced by ObjectiveMetric::compute(), and FitObjective::uncertainties().

Here is the call graph for this function:

user_weights_array()

std::vector< double > SimDataPair::user_weights_array

(

)

const

Returns a flat array of user weights cut to the ROI area.

Definition at line 240 of file SimDataPair.cpp.

{
    if (m_user_weights.empty())
        throwInitializationException("user_weights_array");
    return m_user_weights.datafield()->flatVector();
}

References SimulationResult::datafield(), SimulationResult::empty(), Datafield::flatVector(), and m_user_weights.

Referenced by ObjectiveMetric::compute(), RQ4Metric::compute(), and FitObjective::weights_array().

Here is the call graph for this function:

userWeights()

SimulationResult SimDataPair::userWeights

(

)

const

Returns the user uncertainties cut to the ROI area.

Definition at line 186 of file SimDataPair.cpp.

{
    if (m_user_weights.empty())
        throwInitializationException("userWeights");
    return m_user_weights;
}

References SimulationResult::empty(), and m_user_weights.

Here is the call graph for this function:

validate()

void SimDataPair::validate ( ) const

private

Definition at line 247 of file SimDataPair.cpp.

{
    if (!m_simulation_builder)
        throw std::runtime_error("Error in SimDataPair: simulation builder is empty");
 
    if (!m_raw_data)
        throw std::runtime_error("Error in SimDataPair: passed experimental data array is empty");
 
    if (m_raw_uncertainties && !m_raw_uncertainties->hasSameShape(*m_raw_data))
        throw std::runtime_error(
            "Error in SimDataPair: experimental data and uncertainties have different shape.");
 
    if (!m_raw_user_weights || !m_raw_user_weights->hasSameShape(*m_raw_data))
        throw std::runtime_error(
            "Error in SimDataPair: user weights are not initialized or have invalid shape");
}

References m_raw_data, m_raw_uncertainties, m_raw_user_weights, and m_simulation_builder.

Referenced by SimDataPair().

Member Data Documentation

m_exp_data

SimulationResult SimDataPair::m_exp_data

private

Experimental data cut to the ROI. Masked areas are nullified.

Definition at line 90 of file SimDataPair.h.

Referenced by absoluteDifference(), execSimulation(), experimental_array(), experimentalData(), and relativeDifference().

m_raw_data

std::unique_ptr<Datafield> SimDataPair::m_raw_data

private

Raw experimental data as obtained from the user.

Definition at line 97 of file SimDataPair.h.

Referenced by SimDataPair(), execSimulation(), and validate().

m_raw_uncertainties

std::unique_ptr<Datafield> SimDataPair::m_raw_uncertainties

private

Data uncertainties as provided by the user.

Definition at line 99 of file SimDataPair.h.

Referenced by containsUncertainties(), execSimulation(), and validate().

m_raw_user_weights

std::unique_ptr<Datafield> SimDataPair::m_raw_user_weights

private

User-defined weights.

Definition at line 101 of file SimDataPair.h.

Referenced by SimDataPair(), execSimulation(), and validate().

m_sim_data

SimulationResult SimDataPair::m_sim_data

private

Current simulation results. Masked areas are nullified.

Definition at line 88 of file SimDataPair.h.

Referenced by absoluteDifference(), execSimulation(), relativeDifference(), simulation_array(), and simulationResult().

m_simulation_builder

simulation_builder_t SimDataPair::m_simulation_builder

private

ISimulation builder from the user to construct simulation for given set of parameters.

Definition at line 85 of file SimDataPair.h.

Referenced by execSimulation(), and validate().

m_uncertainties

SimulationResult SimDataPair::m_uncertainties

private

Weights from experimental data uncertainties. Masked areas are nullified.

Definition at line 92 of file SimDataPair.h.

Referenced by execSimulation(), uncertainties(), and uncertainties_array().

m_user_weights

SimulationResult SimDataPair::m_user_weights

private

Manually defined (user) weights. Masked areas are nullified.

Definition at line 94 of file SimDataPair.h.

Referenced by execSimulation(), user_weights_array(), and userWeights().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sim/Fitting/SimDataPair.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sim/Fitting/SimDataPair.cpp