JobModelFunctions Namespace Reference

Contains set of functions to extend JobModel functionality. More...

Functions
void	copyRealDataItem (JobItem *jobItem, const RealDataItem *realDataItem)
	Copy RealDataItem to jobItem intended for fitting. More...
const JobItem *	findJobItem (const SessionItem *item)
	Determines parenting JobItem of a given SessionItem. More...
void	initDataView (JobItem *jobItem)
	Initializes Data1DViewItem and assigns it to the passed JobItem. More...
void	muteMagnetizationData (JobItem *jobItem)
void	setupJobItemForFit (JobItem *jobItem, const RealDataItem *realDataItem)
	Setups JobItem for fit. More...
void	setupJobItemInstrument (JobItem *jobItem, const InstrumentItem *from)
	Properly copies instrument into job item. More...
void	setupJobItemOutput (JobItem *jobItem)
	Setup items intended for storing results of the job. More...
void	setupJobItemSampleData (JobItem *jobItem, const MultiLayerItem *sampleItem)
	Properly copies sample and materials into JobItem. More...

Detailed Description

Contains set of functions to extend JobModel functionality.

Handles setup of JobItem in fitting context.

Function Documentation

copyRealDataItem()

void JobModelFunctions::copyRealDataItem	(	JobItem *	jobItem,
		const RealDataItem *	realDataItem
	)

Copy RealDataItem to jobItem intended for fitting.

Definition at line 190 of file JobModelFunctions.cpp.

{
    if (!realDataItem)
        return;
 
    SessionModel* model = jobItem->model();
 
    RealDataItem* realDataItemCopy = model->copyItem(realDataItem, jobItem, JobItem::T_REALDATA);
    ASSERT(realDataItemCopy);
 
    realDataItemCopy->dataItem()->setOutputData(realDataItem->dataItem()->getOutputData()->clone());
 
    // adapting the name to job name
    realDataItemCopy->dataItem()->setFileName(ItemFileNameUtils::jobReferenceFileName(*jobItem));
 
    // #baimport ++ copy members of realDataItem?
 
    if (!realDataItem->hasNativeData())
        return;
 
    realDataItemCopy->setNativeOutputData(realDataItem->nativeOutputData()->clone());
    realDataItemCopy->nativeData()->setFileName(ItemFileNameUtils::jobNativeDataFileName(*jobItem));
}

References ASSERT, OutputData< T >::clone(), SessionModel::copyItem(), RealDataItem::dataItem(), DataItem::getOutputData(), RealDataItem::hasNativeData(), ItemFileNameUtils::jobNativeDataFileName(), ItemFileNameUtils::jobReferenceFileName(), SessionItem::model(), RealDataItem::nativeData(), RealDataItem::nativeOutputData(), DataItem::setFileName(), RealDataItem::setNativeOutputData(), DataItem::setOutputData(), and JobItem::T_REALDATA.

Referenced by setupJobItemForFit().

Here is the call graph for this function:

findJobItem()

const JobItem * JobModelFunctions::findJobItem

(

const SessionItem *

item

)

Determines parenting JobItem of a given SessionItem.

Returns nullptr, if there is no parent of JobItem type

Definition at line 214 of file JobModelFunctions.cpp.

{
    while (item && item->modelType() != "JobItem")
        item = item->parent();
    return static_cast<const JobItem*>(item);
}

References SessionItem::modelType(), and SessionItem::parent().

Referenced by TransformToDomain::createDomainMaterial().

Here is the call graph for this function:

initDataView()

void JobModelFunctions::initDataView

(

JobItem *

jobItem

)

Initializes Data1DViewItem and assigns it to the passed JobItem.

Definition at line 64 of file JobModelFunctions.cpp.

{
    ASSERT(job_item && job_item->isValidForFitting());
    ASSERT(job_item->instrumentItem() && job_item->instrumentItem()->is<SpecularInstrumentItem>());
    ASSERT(!job_item->getItem(JobItem::T_DATAVIEW));
 
    SessionModel* model = job_item->model();
    auto view_item = model->insertItem<Data1DViewItem>(job_item, -1, JobItem::T_DATAVIEW);
 
    auto property_container =
        model->insertItem<DataPropertyContainer>(view_item, -1, Data1DViewItem::T_DATA_PROPERTIES);
 
    property_container->addItem(job_item->realDataItem()->dataItem());
    property_container->addItem(job_item->dataItem());
 
    // also triggers Data1DViewItem::setAxesRangeToData and DataViewUtils::updateAxesTitle by
    // setting new value of P_AXES_UNITS.
    auto converter = DomainObjectBuilder::createUnitConverter(job_item->instrumentItem());
    view_item->setItemValue(Data1DViewItem::P_AXES_UNITS,
                            JobItemUtils::availableUnits(*converter).variant());
}

References ASSERT, JobItemUtils::availableUnits(), DomainObjectBuilder::createUnitConverter(), JobItem::dataItem(), RealDataItem::dataItem(), SessionItem::getItem(), SessionModel::insertItem(), JobItem::instrumentItem(), SessionItem::is(), JobItem::isValidForFitting(), SessionItem::model(), Data1DViewItem::P_AXES_UNITS, JobItem::realDataItem(), SessionItem::setItemValue(), Data1DViewItem::T_DATA_PROPERTIES, JobItem::T_DATAVIEW, and ComboProperty::variant().

Referenced by setupJobItemForFit().

Here is the call graph for this function:

muteMagnetizationData()

void JobModelFunctions::muteMagnetizationData

(

JobItem *

jobItem

)

Definition at line 179 of file JobModelFunctions.cpp.

{
    auto container =
        static_cast<MaterialItemContainer*>(jobItem->getItem(JobItem::T_MATERIAL_CONTAINER));
    for (auto item : container->getItems(MaterialItemContainer::T_MATERIALS))
        item->getItem(MaterialItem::P_MAGNETIZATION)->setVisible(false);
 
    auto sample = static_cast<MultiLayerItem*>(jobItem->getItem(JobItem::T_SAMPLE));
    sample->getItem(MultiLayerItem::P_EXTERNAL_FIELD)->setVisible(false);
}

References SessionItem::getItem(), MultiLayerItem::P_EXTERNAL_FIELD, MaterialItem::P_MAGNETIZATION, SessionItem::setVisible(), JobItem::T_MATERIAL_CONTAINER, MaterialItemContainer::T_MATERIALS, and JobItem::T_SAMPLE.

Referenced by JobModel::addJob().

Here is the call graph for this function:

setupJobItemForFit()

void JobModelFunctions::setupJobItemForFit	(	JobItem *	jobItem,
		const RealDataItem *	realDataItem
	)

Setups JobItem for fit.

Definition at line 160 of file JobModelFunctions.cpp.

{
    if (!jobItem->instrumentItem())
        throw GUIHelpers::Error("JobModelFunctions::processInstrumentLink() -> Error. "
                                "No instrument.");
 
    copyRealDataItem(jobItem, realDataItem);
    processInstrumentLink(jobItem);
    copyMasksToInstrument(jobItem);
 
    // TODO: remove if when other simulation types are ready for roi & masks
    if (jobItem->instrumentItem()->is<GISASInstrumentItem>())
        cropRealData(jobItem);
    if (jobItem->instrumentItem()->is<SpecularInstrumentItem>())
        initDataView(jobItem);
 
    createFitContainers(jobItem);
}

References copyRealDataItem(), initDataView(), JobItem::instrumentItem(), and SessionItem::is().

Referenced by JobModel::addJob().

Here is the call graph for this function:

setupJobItemInstrument()

void JobModelFunctions::setupJobItemInstrument	(	JobItem *	jobItem,
		const InstrumentItem *	from
	)

Properly copies instrument into job item.

Definition at line 112 of file JobModelFunctions.cpp.

{
    auto model = jobItem->model();
    auto copiedInstrument = model->copyItem(from, jobItem, JobItem::T_INSTRUMENT);
    copiedInstrument->setItemName(from->modelType());
    copiedInstrument->setId(GUIHelpers::createUuid());
    jobItem->getItem(JobItem::P_INSTRUMENT_NAME)->setValue(from->itemName());
 
    auto spec_to = dynamic_cast<SpecularInstrumentItem*>(copiedInstrument);
    if (!spec_to)
        return;
 
    // updating filename
    const auto filename = ItemFileNameUtils::instrumentDataFileName(*spec_to);
    spec_to->beamItem()->updateFileName(filename);
 
    // copying axis data
    auto spec_from = static_cast<const SpecularInstrumentItem*>(from);
    auto axis_origin = getPointwiseAxisItem(spec_from);
    const QString current_axis_type = spec_from->beamItem()->inclinationAxisGroup()->currentType();
    if (current_axis_type == "PointwiseAxis")
        spec_to->beamItem()->updateToData(*axis_origin->axis(), axis_origin->getUnitsLabel());
    else if (axis_origin->containsNonXMLData())
        getPointwiseAxisItem(spec_to)->init(*axis_origin->axis(), axis_origin->getUnitsLabel());
}

References SessionModel::copyItem(), GUIHelpers::createUuid(), FileSystemUtils::filename(), SessionItem::getItem(), ItemFileNameUtils::instrumentDataFileName(), SessionItem::itemName(), SessionItem::model(), SessionItem::modelType(), JobItem::P_INSTRUMENT_NAME, SessionItem::setValue(), and JobItem::T_INSTRUMENT.

Referenced by JobModel::addJob().

Here is the call graph for this function:

setupJobItemOutput()

void JobModelFunctions::setupJobItemOutput

(

JobItem *

jobItem

)

Setup items intended for storing results of the job.

Definition at line 140 of file JobModelFunctions.cpp.

{
    const bool isSpecularInstrument = jobItem->instrumentItem()->is<SpecularInstrumentItem>();
    const bool isIntensityInstrument = jobItem->instrumentItem()->is<GISASInstrumentItem>()
                                       || jobItem->instrumentItem()->is<OffSpecularInstrumentItem>()
                                       || jobItem->instrumentItem()->is<DepthProbeInstrumentItem>();
 
    ASSERT(isSpecularInstrument || isIntensityInstrument);
 
    if (isSpecularInstrument)
        jobItem->model()->insertItem<SpecularDataItem>(jobItem, -1, JobItem::T_OUTPUT);
    else if (isIntensityInstrument)
        jobItem->model()->insertItem<IntensityDataItem>(jobItem, -1, JobItem::T_OUTPUT);
    else
        throw GUIHelpers::Error("JobModelFunctions::setupJobItemOutput() -> Error. "
                                "Unsupported instrument type");
}

References ASSERT, SessionModel::insertItem(), JobItem::instrumentItem(), SessionItem::is(), SessionItem::model(), and JobItem::T_OUTPUT.

Referenced by JobModel::addJob().

Here is the call graph for this function:

setupJobItemSampleData()

void JobModelFunctions::setupJobItemSampleData	(	JobItem *	jobItem,
		const MultiLayerItem *	sampleItem
	)

Properly copies sample and materials into JobItem.

Definition at line 86 of file JobModelFunctions.cpp.

{
    auto model = jobItem->model();
    auto multilayer = model->copyItem(sampleItem, jobItem, JobItem::T_SAMPLE);
    multilayer->setItemName("MultiLayer");
 
    // copying materials
    auto container = jobItem->model()->insertItem<MaterialItemContainer>(
        jobItem, -1, JobItem::T_MATERIAL_CONTAINER);
 
    std::map<MaterialItem*, QString> materials;
    for (auto property_item : multilayer->materialPropertyItems()) {
        auto material_property = property_item->value().value<ExternalProperty>();
        auto material = MaterialItemUtils::findMaterial(material_property);
 
        auto iter = materials.find(material);
        if (iter == materials.end()) {
            auto material_copy = container->insertCopy(material);
            materials.insert({material, material_copy->identifier()});
            material_property.setIdentifier(material_copy->identifier());
        } else
            material_property.setIdentifier(iter->second);
        property_item->setValue(material_property.variant());
    }
}

References SessionModel::copyItem(), MaterialItemUtils::findMaterial(), ExternalProperty::identifier(), SessionModel::insertItem(), SessionItem::model(), JobItem::T_MATERIAL_CONTAINER, JobItem::T_SAMPLE, and SessionItem::value().

Referenced by JobModel::addJob().

Here is the call graph for this function: