gui2::Utils Namespace Reference

Collection of utility functions for running quick simulations. More...

Functions
DAREFLCORE_EXPORT std::string	AddHtmlBackgroundTag (const std::string &line, const std::string &color)
	Returns string representing original 'line' wrapped in 'div' tag. More...
DAREFLCORE_EXPORT std::string	AddHtmlColorTag (const std::string &line, const std::string &color)
	Returns string representing original 'line' wrapped in html color tag. More...
DAREFLCORE_EXPORT std::string	AddHtmlColorTagToParts (const std::string &line, const std::vector< std::string > &parts, const std::string &color_parts, const std::string &color_rest)
	Returns string representing original 'line', where 'parts' are surrounded with color tag. More...
DAREFLCORE_EXPORT std::string	AddHtmlDivTag (const std::string &line)
	Returns string representing original 'line' wrapped in 'div' tag. More...
DAREFLCORE_EXPORT std::vector< Slice >	createBornAgainSlices (const multislice_t &multislice)
DAREFLCORE_EXPORT GraphImportData	CreateData (const std::vector< std::vector< std::string >> &text_data, const ColumnInfo &axis, const ColumnInfo &intensity)
	Creates structure from text data. More...
DAREFLCORE_EXPORT std::vector< double >	CreateDiffVector (const std::vector< double > &a, const std::vector< double > &b)
	Returns vector representing elementwise 2*(a-b)/(a+b) difference over two vectors. More...
DAREFLCORE_EXPORT std::vector< std::pair< ColumnInfo, ColumnInfo > >	CreateGraphInfoPairs (const std::vector< ColumnInfo > &column_info)
	Pack ColumnInfo into pairs representing {AxisType, IntensityType}. More...
DAREFLCORE_EXPORT std::vector< ModelView::ExternalProperty >	CreateGraphProperties (ExperimentalDataModel *model)
	Returns vector of properties representing GraphItem content of the model. More...
DAREFLCORE_EXPORT accept_int_t	CreateLineNumberPatternValidator (const std::string &pattern)
	Creates a callback to define if given line number satisfies line number pattern. More...
DAREFLCORE_EXPORT accept_string_t	CreateLinePrefixValidator (const std::string &prefix_to_exclude)
	Creates a callback to define if given line has a valid content for further parsing. More...
DAREFLCORE_EXPORT multislice_t	CreateMultiSlice (const MultiLayerItem &multilayer)
	Creates multi-slice presentation of internal multilayer structure. More...
DAREFLCORE_EXPORT ModelView::ExternalProperty	CreateProperty (const ModelView::GraphItem *graph)
	Returns property representing given graph. More...
DAREFLCORE_EXPORT line_splitter_t	CreateSeparatorBasedSplitter (const std::string &separator)
	Creates line splitter based on separator. More...
DAREFLCORE_EXPORT std::vector< std::pair< int, int > >	ExpandLineNumberPattern (const std::string &pattern)
	Expands string representing line number pattern to inclusive pairs of line numbers. More...
DAREFLCORE_EXPORT std::pair< std::vector< double >, std::vector< double > >	ExtractTwoColumns (const std::vector< std::vector< std::string >> &text_data, size_t col1, size_t col2)
	Extracts double values from two columns of a string array. More...
DAREFLCORE_EXPORT ModelView::ExternalProperty	FindProperty (const std::vector< ModelView::ExternalProperty > &properties, const std::string &id)
	Finds the property with the same id in given vector and returns it. More...
DAREFLCORE_EXPORT std::vector< std::string >	LoadASCIIFile (const std::string &file_name)
	Loads ASCII file, returns it in the form of vector of strings. More...
DAREFLCORE_EXPORT void	SetDifference (const ModelView::Data1DItem *data1, const ModelView::Data1DItem *data2, ModelView::Data1DItem *target)
	Make target item represent difference of two Data1DItems. Target will get an axis as in data1. More...

Detailed Description

Collection of utility functions for running quick simulations.

Function Documentation

AddHtmlBackgroundTag()

std::string gui2::Utils::AddHtmlBackgroundTag	(	const std::string &	line,
		const std::string &	color
	)

Returns string representing original 'line' wrapped in 'div' tag.

Definition at line 136 of file dataloader_utils.cpp.

{
    const std::string open_tag = "<span style=\"background-color:" + color + "\">";
    const std::string close_tag = "</span>";
    std::string result;
    return open_tag + line + close_tag;
}

Referenced by AddHtmlColorTagToParts().

AddHtmlColorTag()

std::string gui2::Utils::AddHtmlColorTag	(	const std::string &	line,
		const std::string &	color
	)

Returns string representing original 'line' wrapped in html color tag.

Definition at line 128 of file dataloader_utils.cpp.

{
    const std::string open_tag = "<font color=\"" + color + "\">";
    const std::string close_tag = "</font>";
    std::string result;
    return open_tag + line + close_tag;
}

Referenced by AddHtmlColorTagToParts().

AddHtmlColorTagToParts()

std::string gui2::Utils::AddHtmlColorTagToParts	(	const std::string &	line,
		const std::vector< std::string > &	parts,
		const std::string &	color_parts,
		const std::string &	color_rest
	)

Returns string representing original 'line', where 'parts' are surrounded with color tag.

Definition at line 144 of file dataloader_utils.cpp.

{
    std::string result;
    std::string_view view(line);
 
    if (parts.empty())
        return AddHtmlDivTag(AddHtmlColorTag(line, color_rest));
 
    for (auto part : parts) {
        auto it = view.find_first_of(part);
        if (it > 0)
            result.append(AddHtmlBackgroundTag(std::string(view.substr(0, it)), color_rest));
        result.append(AddHtmlColorTag(part, color_parts));
        view.remove_prefix(it + part.size());
    }
    return AddHtmlDivTag(result);
}

References AddHtmlBackgroundTag(), AddHtmlColorTag(), and AddHtmlDivTag().

Referenced by gui2::LoaderPreviewPanel::showData().

Here is the call graph for this function:

AddHtmlDivTag()

std::string gui2::Utils::AddHtmlDivTag

(

const std::string &

line

)

Returns string representing original 'line' wrapped in 'div' tag.

Definition at line 120 of file dataloader_utils.cpp.

{
    const std::string open_div = "<div>";
    const std::string close_div = "</div>";
    std::string result;
    return open_div + line + close_div;
}

Referenced by AddHtmlColorTagToParts().

createBornAgainSlices()

std::vector< Slice > gui2::Utils::createBornAgainSlices

(

const multislice_t &

multislice

)

Definition at line 74 of file quicksimutils.cpp.

{
    std::vector<Slice> result;
    result.reserve(multislice.size());
 
    for (auto& slice : multislice) {
        auto material = MaterialBySLD("", slice.material.real(), slice.material.imag());
        auto roughness = LayerRoughness(slice.sigma, 0., 0.);
 
        result.emplace_back(slice.thickness, material, roughness);
    }
 
    return result;
}

References MaterialBySLD().

Referenced by gui2::MaterialProfile::CalculateProfile(), gui2::MaterialProfile::DefaultMaterialProfileLimits(), and gui2::SpecularToySimulation::runSimulation().

Here is the call graph for this function:

CreateData()

GraphImportData gui2::Utils::CreateData	(	const std::vector< std::vector< std::string >> &	text_data,
		const ColumnInfo &	axis,
		const ColumnInfo &	intensity
	)

Creates structure from text data.

Definition at line 201 of file dataloader_utils.cpp.

{
    GraphImportData result;
 
    auto [axis_values, intensity_values] =
        Utils::ExtractTwoColumns(text_data, axis.column, intensity.column);
 
    std::transform(intensity_values.begin(), intensity_values.end(), intensity_values.begin(),
                   [&intensity](auto x) { return x * intensity.multiplier; });
 
    result.bin_centers = axis_values;
    result.axis_units = axis.units;
 
    result.bin_values = intensity_values;
    result.signal_units = intensity.units;
 
    return result;
}

References gui2::GraphImportData::axis_units, gui2::GraphImportData::bin_centers, gui2::GraphImportData::bin_values, gui2::ColumnInfo::column, ExtractTwoColumns(), gui2::GraphImportData::signal_units, and gui2::ColumnInfo::units.

Referenced by gui2::DataLoaderDialog::onParseAllRequest().

Here is the call graph for this function:

CreateDiffVector()

std::vector< double > gui2::Utils::CreateDiffVector	(	const std::vector< double > &	a,
		const std::vector< double > &	b
	)

Returns vector representing elementwise 2*(a-b)/(a+b) difference over two vectors.

Resulting vector will have size equal to min(a.size(), b.size())

Definition at line 66 of file modelutils.cpp.

{
    size_t length = std::min(a.size(), b.size());
    std::vector<double> result(length, 0.0);
    for (size_t i = 0; i < length; ++i) {
        double denom = a[i] + b[i];
        result[i] = denom != 0.0 ? 2 * (a[i] - b[i]) / (a[i] + b[i]) : 0.0;
    }
    return result;
}

Referenced by SetDifference().

CreateGraphInfoPairs()

std::vector< std::pair< ColumnInfo, ColumnInfo > > gui2::Utils::CreateGraphInfoPairs

(

const std::vector< ColumnInfo > &

column_info

)

Pack ColumnInfo into pairs representing {AxisType, IntensityType}.

For the moment we expect that only one column with AxisType exists. Number of intensity columns can be arbitrary.

Definition at line 185 of file dataloader_utils.cpp.

{
    std::vector<std::pair<ColumnInfo, ColumnInfo>> result;
 
    auto axis_columns = columnsForType(column_info, Constants::AxisType);
    auto intensity_columns = columnsForType(column_info, Constants::IntensityType);
 
    if (axis_columns.size() != 1)
        throw std::runtime_error("There must be exactly one column with AxisType selected.");
 
    for (const auto& intensity_info : intensity_columns)
        result.push_back(std::make_pair(axis_columns.back(), intensity_info));
 
    return result;
}

References gui2::Constants::AxisType, and gui2::Constants::IntensityType.

Referenced by gui2::DataLoaderDialog::onParseAllRequest().

CreateGraphProperties()

std::vector< ModelView::ExternalProperty > gui2::Utils::CreateGraphProperties

(

ExperimentalDataModel *

model

)

Returns vector of properties representing GraphItem content of the model.

Definition at line 46 of file modelutils.cpp.

{
    std::vector<ModelView::ExternalProperty> result;
    for (auto graph : ModelView::Utils::FindItems<ModelView::GraphItem>(model))
        result.push_back(Utils::CreateProperty(graph));
    return result;
}

References CreateProperty().

Referenced by gui2::ExperimentalDataController::update_all().

Here is the call graph for this function:

CreateLineNumberPatternValidator()

accept_int_t gui2::Utils::CreateLineNumberPatternValidator

(

const std::string &

pattern

)

Creates a callback to define if given line number satisfies line number pattern.

"1, 4-6" will accept numbers {1, 4, 5, 6} and will refuse all others.

Definition at line 79 of file dataloader_utils.cpp.

{
    std::vector<std::pair<int, int>> expanded_pattern = Utils::ExpandLineNumberPattern(pattern);
    auto result = [expanded_pattern](int line_number) {
        for (auto pair : expanded_pattern) {
            if (line_number >= pair.first && line_number <= pair.second)
                return true;
        }
        return false;
    };
    return result;
}

References ExpandLineNumberPattern().

Referenced by gui2::DefaultParser::DefaultParser().

Here is the call graph for this function:

CreateLinePrefixValidator()

accept_string_t gui2::Utils::CreateLinePrefixValidator

(

const std::string &

prefix_to_exclude

)

Creates a callback to define if given line has a valid content for further parsing.

Empty lines and lines starting from a given prefix will be excluded.

Definition at line 92 of file dataloader_utils.cpp.

{
    auto result = [prefix_to_exclude](const std::string& line) {
        // line contains spaces only
        if (line.empty() || line.find_first_not_of(' ') == std::string::npos)
            return false;
        // line starts from pattern
        return line.find_first_of(prefix_to_exclude) == 0 ? false : true;
    };
    return result;
}

Referenced by gui2::DefaultParser::DefaultParser().

CreateMultiSlice()

multislice_t gui2::Utils::CreateMultiSlice

(

const MultiLayerItem &

multilayer

)

Creates multi-slice presentation of internal multilayer structure.

Definition at line 67 of file quicksimutils.cpp.

{
    multislice_t result;
    AddToMultiSlice(result, multilayer);
    return result;
}

Referenced by gui2::QuickSimController::process_multilayer().

CreateProperty()

ModelView::ExternalProperty gui2::Utils::CreateProperty

(

const ModelView::GraphItem *

graph

)

Returns property representing given graph.

Used to link with the graph from various editors.

Definition at line 39 of file modelutils.cpp.

{
    std::string name = graph->parent()->displayName() + "/" + graph->displayName();
    auto colorName = QString::fromStdString(graph->colorName());
    return ModelView::ExternalProperty(name, QColor(colorName), graph->identifier());
}

References ModelView::GraphItem::colorName(), ModelView::SessionItem::displayName(), ModelView::CompoundItem::displayName(), ModelView::SessionItem::identifier(), RealSpace::Particles::name(), and ModelView::SessionItem::parent().

Referenced by CreateGraphProperties(), and gui2::ExperimentalScanItem::setGraphItem().

Here is the call graph for this function:

CreateSeparatorBasedSplitter()

line_splitter_t gui2::Utils::CreateSeparatorBasedSplitter

(

const std::string &

separator

)

Creates line splitter based on separator.

Definition at line 104 of file dataloader_utils.cpp.

{
    if (separator.empty())
        throw std::runtime_error("Error, empty separator.");
 
    bool is_space_only_separator = separator.find_first_not_of(' ') == std::string::npos;
    auto result = [separator, is_space_only_separator](const std::string& line) {
        std::vector<std::string> values;
        std::string trimmed = ModelView::Utils::TrimWhitespace(line);
        if (is_space_only_separator)
            trimmed = ModelView::Utils::RemoveRepeatedSpaces(trimmed);
        return ModelView::Utils::SplitString(trimmed, separator);
    };
    return result;
}

References ModelView ::Utils::RemoveRepeatedSpaces(), ModelView ::Utils::SplitString(), and ModelView ::Utils::TrimWhitespace().

Referenced by gui2::DefaultParser::DefaultParser().

Here is the call graph for this function:

ExpandLineNumberPattern()

std::vector< std::pair< int, int > > gui2::Utils::ExpandLineNumberPattern

(

const std::string &

pattern

)

Expands string representing line number pattern to inclusive pairs of line numbers.

"1" will be expanded to { {1, 1} }, "1, 3-5" will be expanded to { {1, 1}, {3, 5} }

Definition at line 58 of file dataloader_utils.cpp.

{
    std::vector<std::pair<int, int>> result;
 
    // splitting "1, 2-3" first on comma-separated tokens
    for (const auto& token : ModelView::Utils::SplitString(pattern, ",")) {
        auto parts = ModelView::Utils::SplitString(token, "-");
        // splitting on dash-separared tokens
        if (!parts.empty()) {
            // if no "-" is present, make from "1" a pair {1, 1}
            // if "-" is present, make from "1-2" a pair {1,2}
            auto conv0 = ModelView::Utils::StringToInteger(parts[0]);
            auto conv1 = parts.size() > 1 ? ModelView::Utils::StringToInteger(parts[1]) : conv0;
            if (isRepresentRange(conv0, conv1))
                result.push_back({conv0.value(), conv1.value()});
        }
    }
 
    return result;
}

References ModelView ::Utils::SplitString(), and ModelView ::Utils::StringToInteger().

Referenced by CreateLineNumberPatternValidator().

Here is the call graph for this function:

ExtractTwoColumns()

std::pair< std::vector< double >, std::vector< double > > gui2::Utils::ExtractTwoColumns	(	const std::vector< std::vector< std::string >> &	text_data,
		size_t	col1,
		size_t	col2
	)

Extracts double values from two columns of a string array.

The row must be valid: string value must represent single double for both target columns, rows should have enough columns. If a row is invalid, it will be skipped, so resulting arrays have always the same length.

Definition at line 166 of file dataloader_utils.cpp.

{
    std::vector<double> vec1, vec2;
    for (const auto& row : text_data) {
        if (col1 < row.size() && col2 < row.size()) {
            auto val1 = ModelView::Utils::StringToDouble(row[col1]);
            auto val2 = ModelView::Utils::StringToDouble(row[col2]);
            if (val1.has_value() && val2.has_value()) {
                vec1.push_back(val1.value());
                vec2.push_back(val2.value());
            }
        }
    }
 
    return std::make_pair(std::move(vec1), std::move(vec2));
}

References ModelView ::Utils::StringToDouble().

Referenced by CreateData().

Here is the call graph for this function:

FindProperty()

ModelView::ExternalProperty gui2::Utils::FindProperty	(	const std::vector< ModelView::ExternalProperty > &	properties,
		const std::string &	id
	)

Finds the property with the same id in given vector and returns it.

Definition at line 56 of file modelutils.cpp.

{
    for (const auto& prop : properties)
        if (prop.identifier() == id)
            return prop;
 
    return ModelView::ExternalProperty::undefined();
}

References ModelView::ExternalProperty::undefined().

Referenced by gui2::ExperimentalDataController::update_all().

Here is the call graph for this function:

LoadASCIIFile()

std::vector< std::string > gui2::Utils::LoadASCIIFile

(

const std::string &

file_name

)

Loads ASCII file, returns it in the form of vector of strings.

Definition at line 46 of file dataloader_utils.cpp.

{
    std::vector<std::string> result;
 
    std::ifstream file(file_name);
    if (!file.is_open())
        throw std::ios_base::failure("Unable to open file '" + file_name + "'");
    for (std::string line; getline(file, line);)
        result.emplace_back(line);
    return result;
}

Referenced by gui2::DataHandler::loadFile().

SetDifference()

void gui2::Utils::SetDifference	(	const ModelView::Data1DItem *	data1,
		const ModelView::Data1DItem *	data2,
		ModelView::Data1DItem *	target
	)

Make target item represent difference of two Data1DItems. Target will get an axis as in data1.

Definition at line 78 of file modelutils.cpp.

{
    if (!areCompatibleAxes(*data1, *data2) || !areCompatibleAxes(*data1, *target))
        return;
 
    // We expect same number of points to caclulate the difference graph.
    if (data1->binCenters().size() != data2->binCenters().size())
        return;
 
    if (data1->binCenters() != target->binCenters()) {
        target->item<ModelView::PointwiseAxisItem>(ModelView::Data1DItem::T_AXIS)
            ->setParameters(data1->binCenters());
    }
    target->setValues(CreateDiffVector(data1->binValues(), data2->binValues()));
}

References ModelView::Data1DItem::binCenters(), ModelView::Data1DItem::binValues(), CreateDiffVector(), ModelView::SessionItem::item(), ModelView::Data1DItem::setValues(), and ModelView::Data1DItem::T_AXIS.

Referenced by gui2::JobItem::updateDifferenceData().

Here is the call graph for this function: