JobItemUtils Namespace Reference

Contains set of convenience methods to set data to the IntensityDataItem from domain simulation. More...

Functions
ComboProperty	availableUnits (const IUnitConverter &converter)
Axes::Units	axesUnitsFromName (const QString &name)
	returns domain axes units type from their GUI name More...
void	createDefaultDetectorMap (DataItem *intensityItem, const InstrumentItem *instrumentItem)
QString	nameFromAxesUnits (Axes::Units units)
	returns axes units names from their domain counterpart More...
void	setIntensityItemAxesUnits (DataItem *intensityItem, const InstrumentItem *instrumentItem)
	Sets axes units suitable for given instrument. More...
void	setIntensityItemAxesUnits (DataItem *intensityItem, const IUnitConverter &converter)
void	setResults (DataItem *intensityItem, const ISimulation *simulation)
	Sets simulation results into the DataItem. More...
void	updateDataAxes (DataItem *intensityItem, const InstrumentItem *instrumentItem)
	updates axes of OutputData in IntensityData item More...

Detailed Description

Contains set of convenience methods to set data to the IntensityDataItem from domain simulation.

Used to modify OutputData's axes units as requested by IntensityDataItem.

Function Documentation

availableUnits()

ComboProperty JobItemUtils::availableUnits

(

const IUnitConverter &

converter

)

Definition at line 128 of file JobItemUtils.cpp.

{
    ComboProperty result;
    for (auto units : converter.availableUnits()) {
        auto unit_name = nameFromAxesUnits(units);
        if (unit_name != "")
            result << unit_name;
    }
 
    result.setValue(nameFromAxesUnits(converter.defaultUnits()));
    return result;
}

References IUnitConverter::availableUnits(), IUnitConverter::defaultUnits(), nameFromAxesUnits(), and ComboProperty::setValue().

Referenced by JobModelFunctions::initDataView(), and setIntensityItemAxesUnits().

Here is the call graph for this function:

axesUnitsFromName()

Axes::Units JobItemUtils::axesUnitsFromName

(

const QString &

name

)

returns domain axes units type from their GUI name

Correspondance of GUI axes units names to their domain counterpart.

Definition at line 82 of file JobItemUtils.cpp.

{
    return units_from_names.at(name);
}

References RealSpace::Particles::name().

Referenced by SpecularInstrumentItem::createUnitConverter(), setResults(), and updateDataAxes().

Here is the call graph for this function:

createDefaultDetectorMap()

void JobItemUtils::createDefaultDetectorMap	(	DataItem *	intensityItem,
		const InstrumentItem *	instrumentItem
	)

Definition at line 105 of file JobItemUtils.cpp.

{
    const auto converter = DomainObjectBuilder::createUnitConverter(instrumentItem);
    auto output_data = UnitConverterUtils::createOutputData(*converter, converter->defaultUnits());
    intensityItem->setOutputData(output_data.release());
    setIntensityItemAxesUnits(intensityItem, *converter);
    updateAxesTitle(intensityItem, *converter, converter->defaultUnits());
}

References UnitConverterUtils::createOutputData(), DomainObjectBuilder::createUnitConverter(), setIntensityItemAxesUnits(), DataItem::setOutputData(), and DataViewUtils::updateAxesTitle().

Referenced by DetectorMaskDelegate::createIntensityDataItem().

Here is the call graph for this function:

nameFromAxesUnits()

QString JobItemUtils::nameFromAxesUnits

(

Axes::Units

units

)

returns axes units names from their domain counterpart

Correspondance of domain detector axes types to their gui counterpart.

Definition at line 74 of file JobItemUtils.cpp.

{
    return names_from_units.find(units) != names_from_units.end() ? names_from_units.at(units)
                                                                  : QString();
}

Referenced by availableUnits(), QREDataLoader::createOutputDataFromParsingResult(), and ImportDataInfo::unitsLabel().

setIntensityItemAxesUnits() [1/2]

void JobItemUtils::setIntensityItemAxesUnits	(	DataItem *	intensityItem,
		const InstrumentItem *	instrumentItem
	)

Sets axes units suitable for given instrument.

Definition at line 89 of file JobItemUtils.cpp.

{
    const auto converter = DomainObjectBuilder::createUnitConverter(instrumentItem);
    if (!converter)
        return;
    setIntensityItemAxesUnits(intensityItem, *converter);
}

References DomainObjectBuilder::createUnitConverter().

Referenced by createDefaultDetectorMap(), setResults(), and RealDataItem::updateToInstrument().

Here is the call graph for this function:

setIntensityItemAxesUnits() [2/2]

void JobItemUtils::setIntensityItemAxesUnits	(	DataItem *	intensityItem,
		const IUnitConverter &	converter
	)

Definition at line 98 of file JobItemUtils.cpp.

{
    ComboProperty combo = availableUnits(converter);
    intensityItem->setItemValue(DataItem::P_AXES_UNITS, combo.variant());
}

References availableUnits(), DataItem::P_AXES_UNITS, SessionItem::setItemValue(), and ComboProperty::variant().

Here is the call graph for this function:

setResults()

void JobItemUtils::setResults	(	DataItem *	intensityItem,
		const ISimulation *	simulation
	)

Sets simulation results into the DataItem.

Definition at line 115 of file JobItemUtils.cpp.

{
    const auto sim_result = simulation->result();
    if (intensityItem->getOutputData() == nullptr) {
        const auto& converter = sim_result.converter();
        JobItemUtils::setIntensityItemAxesUnits(intensityItem, converter);
        updateAxesTitle(intensityItem, converter, converter.defaultUnits());
    }
    auto selected_units = JobItemUtils::axesUnitsFromName(intensityItem->selectedAxesUnits());
    auto data = sim_result.data(selected_units);
    intensityItem->setOutputData(data.release());
}

References axesUnitsFromName(), SimulationResult::converter(), DataItem::getOutputData(), ISimulation::result(), DataItem::selectedAxesUnits(), setIntensityItemAxesUnits(), DataItem::setOutputData(), and DataViewUtils::updateAxesTitle().

Referenced by JobItem::setResults().

Here is the call graph for this function:

updateDataAxes()

void JobItemUtils::updateDataAxes	(	DataItem *	intensityItem,
		const InstrumentItem *	instrumentItem
	)

updates axes of OutputData in IntensityData item

Updates axes of OutputData in IntensityData item to correspond with ::P_AXES_UNITS selection.

InstrumentItem is used to get domain's detector map for given units.

Definition at line 47 of file JobItemUtils.cpp.

{
    ASSERT(intensityItem);
 
    if (!instrumentItem) {
        // special case when reading old project files: project failed on load instrument
        // but we want to try to recover the rest.
        qInfo() << "JobItemUtils::updateDataAxes() -> Error. Absent instrument.";
        return;
    }
 
    if (!intensityItem->getOutputData())
        return;
 
    Axes::Units requested_units = axesUnitsFromName(intensityItem->selectedAxesUnits());
 
    const auto converter = DomainObjectBuilder::createUnitConverter(instrumentItem);
    auto newData = UnitConverterUtils::createOutputData(*converter.get(), requested_units);
    newData->setRawDataVector(intensityItem->getOutputData()->getRawDataVector());
 
    intensityItem->setOutputData(newData.release());
    intensityItem->setAxesRangeToData();
    updateAxesTitle(intensityItem, *converter, requested_units);
}

References ASSERT, axesUnitsFromName(), UnitConverterUtils::createOutputData(), DomainObjectBuilder::createUnitConverter(), DataItem::getOutputData(), OutputData< T >::getRawDataVector(), DataItem::selectedAxesUnits(), DataItem::setAxesRangeToData(), DataItem::setOutputData(), and DataViewUtils::updateAxesTitle().

Referenced by IntensityDataItem::updateAxesUnits(), and SpecularDataItem::updateAxesUnits().

Here is the call graph for this function: