SpecularInstrumentItem Class Reference

Description

Definition at line 111 of file InstrumentItems.h.

Inheritance diagram for SpecularInstrumentItem:

Collaboration diagram for SpecularInstrumentItem:

Public Member Functions
	SpecularInstrumentItem ()
bool	alignedWith (const RealDataItem *item) const override
BackgroundItem *	backgroundItem () const
SelectionDescriptor< BackgroundItem * >	backgroundSelection () const
SpecularBeamItem *	beamItem () const override
ICoordSystem *	createCoordSystem () const override
InstrumentItem *	createCopy () const
	Creates an exact copy; also ID is the same! More...
QString	defaultName () const override
	The default user visible name when creating an instrument. More...
QString	description () const
	DOUBLE_PROPERTY (analyzerTotalTransmission, AnalyzerTotalTransmission)
QString	id () const
virtual void	importMasks (const MaskContainerItem *)
QString	instrumentName () const
QString	instrumentType () const override
	The type as how to show it on the UI. Do not use for type checking or similar! More...
template<typename T >
bool	is () const
virtual void	serialize (Streamer &s)
template<typename T >
T *	setBackgroundType ()
void	setDescription (const QString &description)
void	setId (const QString &id)
void	setInstrumentName (const QString &instrumentName)
void	setWithPolarizerAnalyzer (bool with)
std::vector< int >	shape () const override
void	updateToRealData (const RealDataItem *item) override
	VECTOR_PROPERTY (analyzerDirection, AnalyzerDirection)
	VECTOR_PROPERTY (polarization, Polarization)
bool	withPolarizerAnalyzer () const

Protected Member Functions
template<typename T >
T *	beam () const

Protected Attributes
SelectionProperty< BackgroundItem * >	m_backgroundItem
std::unique_ptr< BeamItem >	m_beamItem
QString	m_description
QString	m_id
QString	m_name
bool	m_withPolarizerAnalyzer

Constructor & Destructor Documentation

SpecularInstrumentItem()

SpecularInstrumentItem::SpecularInstrumentItem

(

)

Definition at line 169 of file InstrumentItems.cpp.

{
    m_beamItem.reset(new SpecularBeamItem(this));
}

References InstrumentItem::m_beamItem.

Member Function Documentation

alignedWith()

bool SpecularInstrumentItem::alignedWith ( const RealDataItem *  item ) const

overridevirtual

Reimplemented from InstrumentItem.

Definition at line 195 of file InstrumentItems.cpp.

{
    const QString native_units = item->nativeDataUnits();
    if (native_units == "nbins") {
        return beamItem()->inclinationAngleItem()->uniformAlphaAxisSelected()
               && shape() == item->shape();
    }
 
    if (!beamItem()->inclinationAngleItem()->pointwiseAlphaAxisSelected())
        return false;
 
    const auto* axisItem =
        dynamic_cast<const PointwiseAxisItem*>(beamItem()->inclinationAngleItem()->alphaAxis());
    ASSERT(axisItem);
 
    if (axisItem->getUnitsLabel() != native_units)
        return false;
 
    const auto* instrumentAxis = axisItem->axis();
    if (!instrumentAxis)
        return false;
 
    if (!item->hasNativeData())
        return false;
 
    const auto& native_axis = item->nativeDatafield()->axis(0);
    return *instrumentAxis == native_axis;
}

References SpecularBeamInclinationItem::alphaAxis(), beamItem(), RealDataItem::hasNativeData(), SpecularBeamItem::inclinationAngleItem(), RealDataItem::nativeDatafield(), RealDataItem::nativeDataUnits(), RealDataItem::shape(), shape(), and SpecularBeamInclinationItem::uniformAlphaAxisSelected().

Here is the call graph for this function:

backgroundItem()

BackgroundItem * InstrumentItem::backgroundItem ( ) const

inherited

Definition at line 119 of file InstrumentItems.cpp.

{
    return m_backgroundItem.get();
}

References SelectionProperty< T >::get(), and InstrumentItem::m_backgroundItem.

Here is the call graph for this function:

backgroundSelection()

SelectionDescriptor< BackgroundItem * > InstrumentItem::backgroundSelection ( ) const

inherited

Definition at line 124 of file InstrumentItems.cpp.

{
    return m_backgroundItem;
}

References InstrumentItem::m_backgroundItem.

Referenced by EnvironmentEditor::EnvironmentEditor(), and EnvironmentEditor::createBackgroundWidgets().

beam()

template<typename T >

T * InstrumentItem::beam

protectedinherited

Definition at line 145 of file InstrumentItems.cpp.

{
    return dynamic_cast<T*>(m_beamItem.get());
}

References InstrumentItem::m_beamItem.

Referenced by createCoordSystem(), Instrument2DItem::createInstrument(), Instrument2DItem::createOffspecSimulation(), and Instrument2DItem::createScatteringSimulation().

beamItem()

SpecularBeamItem * SpecularInstrumentItem::beamItem ( ) const

overridevirtual

Reimplemented from InstrumentItem.

Definition at line 174 of file InstrumentItems.cpp.

{
    return beam<SpecularBeamItem>();
}

Referenced by SpecularInstrumentEditor::SpecularInstrumentEditor(), alignedWith(), createCoordSystem(), shape(), and updateToRealData().

createCoordSystem()

ICoordSystem * SpecularInstrumentItem::createCoordSystem ( ) const

overridevirtual

Implements InstrumentItem.

Definition at line 224 of file InstrumentItems.cpp.

{
    std::unique_ptr<Beam> beam = beamItem()->createBeam();
    auto* axis_item = beamItem()->inclinationAxis();
    if (auto* pointwise_axis = dynamic_cast<PointwiseAxisItem*>(axis_item)) {
        if (!pointwise_axis->axis()) // workaround for loading project
            return nullptr;
        Coords native_units = GUI::Util::CoordName::coordFromName(pointwise_axis->getUnitsLabel());
        return new AngularReflectometryCoordinates(beam->wavelength(), *pointwise_axis->axis(),
                                                   native_units);
    }
 
    return new AngularReflectometryCoordinates(beam->wavelength(), *axis_item->createAxis(1.0),
                                               Coords::DEGREES);
}

References InstrumentItem::beam(), beamItem(), GUI::Util::CoordName::coordFromName(), BeamItem::createBeam(), and SpecularBeamItem::inclinationAxis().

Referenced by PointwiseAxisItem::createAxis(), and PointwiseAxisItem::updateIndicators().

Here is the call graph for this function:

createCopy()

InstrumentItem * InstrumentItem::createCopy ( ) const

inherited

Creates an exact copy; also ID is the same!

Definition at line 76 of file InstrumentItems.cpp.

{
    const auto type = InstrumentItemCatalog::type(this);
    auto* copy = InstrumentItemCatalog::create(type);
    GUI::Util::copyContents(this, copy);
    return copy;
}

References GUI::Util::copyContents(), InstrumentItemCatalog::create(), and InstrumentItemCatalog::type().

Referenced by JobItem::copyInstrumentIntoJob(), and InstrumentCollection::insertCopy().

Here is the call graph for this function:

defaultName()

QString SpecularInstrumentItem::defaultName ( ) const

overridevirtual

The default user visible name when creating an instrument.

Implements InstrumentItem.

Definition at line 245 of file InstrumentItems.cpp.

{
    return "Specular";
}

description()

QString InstrumentItem::description ( ) const

inherited

Definition at line 104 of file InstrumentItems.cpp.

{
    return m_description;
}

References InstrumentItem::m_description.

Referenced by InstrumentItem::setDescription().

DOUBLE_PROPERTY()

InstrumentItem::DOUBLE_PROPERTY ( analyzerTotalTransmission  , AnalyzerTotalTransmission    )

inherited

id()

QString InstrumentItem::id ( ) const

inherited

Definition at line 84 of file InstrumentItems.cpp.

{
    return m_id;
}

References InstrumentItem::m_id.

Referenced by RealDataItem::linkToInstrument(), LinkInstrumentManager::onInstrumentChanged(), and InstrumentItem::setId().

importMasks()

virtual void InstrumentItem::importMasks ( const MaskContainerItem *  )

inlinevirtualinherited

Reimplemented in Instrument2DItem.

Definition at line 78 of file InstrumentItems.h.

{}

instrumentName()

QString InstrumentItem::instrumentName ( ) const

inherited

Definition at line 99 of file InstrumentItems.cpp.

{
    return m_name;
}

References InstrumentItem::m_name.

Referenced by InstrumentListModel::copyInstrument(), InstrumentListModel::data(), InstrumentLibraryEditor::execAdd(), InstrumentItem::setInstrumentName(), InstrumentsEditController::setInstrumentName(), and GUI::Model::JobFunctions::setupJobItemInstrument().

instrumentType()

QString SpecularInstrumentItem::instrumentType ( ) const

overridevirtual

The type as how to show it on the UI. Do not use for type checking or similar!

Implements InstrumentItem.

Definition at line 240 of file InstrumentItems.cpp.

{
    return "Specular";
}

is()

template<typename T >

bool InstrumentItem::is ( ) const

inlineinherited

Definition at line 61 of file InstrumentItems.h.

    {
        return dynamic_cast<const T*>(this) != nullptr;
    }

Referenced by JobResultsPresenter::defaultActivePresentationsOfInstrument(), JobResultsPresenter::defaultPresentationOfInstrument(), JobResultsPresenter::fitPresentationOfInstrument(), GUI::Model::JobFunctions::initDataView(), InstrumentsTreeModel::instrumentType(), JobItem::isSpecularJob(), GUI::Model::JobFunctions::setupJobItemForFit(), and GUI::Model::JobFunctions::setupJobItemOutput().

serialize()

void InstrumentItem::serialize ( Streamer &  s )

virtualinherited

Reimplemented in OffspecInstrumentItem, Instrument2DItem, and DepthProbeInstrumentItem.

Definition at line 150 of file InstrumentItems.cpp.

{
    s.assertVersion(0);
    Serialize::rwValue(s, "id", m_id);
    Serialize::rwValue(s, "name", m_name);
    Serialize::rwValue(s, "description", m_description);
    Serialize::rwValue(s, "pa", m_withPolarizerAnalyzer);
    Serialize::rwProperty(s, m_polarization);
    Serialize::rwProperty(s, m_analyzerDirection);
    Serialize::rwProperty(s, m_analyzerEfficiency);
    Serialize::rwProperty(s, m_analyzerTotalTransmission);
    Serialize::rwSelected<BackgroundItemCatalog>(s, m_backgroundItem);
    Serialize::rwClass(s, "beam", *m_beamItem);
}

References Streamer::assertVersion(), InstrumentItem::m_backgroundItem, InstrumentItem::m_beamItem, InstrumentItem::m_description, InstrumentItem::m_id, InstrumentItem::m_name, InstrumentItem::m_withPolarizerAnalyzer, Serialize::rwClass(), Serialize::rwProperty(), and Serialize::rwValue().

Here is the call graph for this function:

setBackgroundType()

template<typename T >

T * InstrumentItem::setBackgroundType

inherited

Definition at line 205 of file InstrumentItems.h.

{
    m_backgroundItem.set<T>();
    return dynamic_cast<T*>(m_backgroundItem.get());
}

References SelectionProperty< T >::get(), InstrumentItem::m_backgroundItem, and SelectionProperty< T >::set().

Here is the call graph for this function:

setDescription()

void InstrumentItem::setDescription ( const QString &  description )

inherited

Definition at line 109 of file InstrumentItems.cpp.

{
    m_description = description;
}

References InstrumentItem::description(), and InstrumentItem::m_description.

Referenced by InstrumentView::onInstrumentdescriptionEdited(), and InstrumentsTreeModel::setData().

Here is the call graph for this function:

setId()

void InstrumentItem::setId ( const QString &  id )

inherited

Definition at line 89 of file InstrumentItems.cpp.

{
    m_id = id;
}

References InstrumentItem::id(), and InstrumentItem::m_id.

Referenced by InstrumentCollection::insertCopy().

Here is the call graph for this function:

setInstrumentName()

void InstrumentItem::setInstrumentName ( const QString &  instrumentName )

inherited

Definition at line 94 of file InstrumentItems.cpp.

{
    m_name = instrumentName;
}

References InstrumentItem::instrumentName(), and InstrumentItem::m_name.

Referenced by InstrumentsEditController::addCopy(), InstrumentsTreeModel::setData(), InstrumentsEditController::setInstrumentName(), and GUI::Model::JobFunctions::setupJobItemInstrument().

Here is the call graph for this function:

setWithPolarizerAnalyzer()

void InstrumentItem::setWithPolarizerAnalyzer ( bool  with )

inherited

Definition at line 139 of file InstrumentItems.cpp.

{
    m_withPolarizerAnalyzer = with;
}

References InstrumentItem::m_withPolarizerAnalyzer.

Referenced by PolarizationAnalysisEditor::PolarizationAnalysisEditor().

shape()

std::vector< int > SpecularInstrumentItem::shape ( ) const

overridevirtual

Implements InstrumentItem.

Definition at line 179 of file InstrumentItems.cpp.

{
    auto* const axis_item = beamItem()->inclinationAxis();
    return {axis_item->binCount()};
}

References beamItem(), BasicAxisItem::binCount(), and SpecularBeamItem::inclinationAxis().

Referenced by alignedWith(), and updateToRealData().

Here is the call graph for this function:

updateToRealData()

void SpecularInstrumentItem::updateToRealData ( const RealDataItem *  item )

overridevirtual

Implements InstrumentItem.

Definition at line 185 of file InstrumentItems.cpp.

{
    if (shape().size() != item->shape().size())
        throw Error("Error in SpecularInstrumentItem::updateToRealData: The type "
                    "of instrument is incompatible with passed data shape.");
 
    const auto& data = item->nativeDatafield()->axis(0);
    beamItem()->updateToData(data, item->nativeDataUnits());
}

References beamItem(), Error, RealDataItem::nativeDatafield(), RealDataItem::nativeDataUnits(), RealDataItem::shape(), shape(), and SpecularBeamItem::updateToData().

Here is the call graph for this function:

VECTOR_PROPERTY() [1/2]

InstrumentItem::VECTOR_PROPERTY ( analyzerDirection  , AnalyzerDirection    )

inherited

VECTOR_PROPERTY() [2/2]

InstrumentItem::VECTOR_PROPERTY ( polarization  , Polarization    )

inherited

withPolarizerAnalyzer()

bool InstrumentItem::withPolarizerAnalyzer ( ) const

inherited

Definition at line 134 of file InstrumentItems.cpp.

{
    return m_withPolarizerAnalyzer;
}

References InstrumentItem::m_withPolarizerAnalyzer.

Referenced by PolarizationAnalysisEditor::PolarizationAnalysisEditor(), and ParameterTreeBuilder::addPolarization().

Member Data Documentation

m_backgroundItem

SelectionProperty<BackgroundItem*> InstrumentItem::m_backgroundItem

protectedinherited

Definition at line 106 of file InstrumentItems.h.

Referenced by InstrumentItem::InstrumentItem(), InstrumentItem::backgroundItem(), InstrumentItem::backgroundSelection(), InstrumentItem::serialize(), and InstrumentItem::setBackgroundType().

m_beamItem

std::unique_ptr<BeamItem> InstrumentItem::m_beamItem

protectedinherited

Definition at line 107 of file InstrumentItems.h.

Referenced by DepthProbeInstrumentItem::DepthProbeInstrumentItem(), Instrument2DItem::Instrument2DItem(), SpecularInstrumentItem(), InstrumentItem::beam(), InstrumentItem::beamItem(), and InstrumentItem::serialize().

m_description

QString InstrumentItem::m_description

protectedinherited

Definition at line 104 of file InstrumentItems.h.

Referenced by InstrumentItem::description(), InstrumentItem::serialize(), and InstrumentItem::setDescription().

m_id

QString InstrumentItem::m_id

protectedinherited

Definition at line 102 of file InstrumentItems.h.

Referenced by InstrumentItem::InstrumentItem(), InstrumentItem::id(), InstrumentItem::serialize(), and InstrumentItem::setId().

m_name

QString InstrumentItem::m_name

protectedinherited

Definition at line 103 of file InstrumentItems.h.

Referenced by InstrumentItem::instrumentName(), InstrumentItem::serialize(), and InstrumentItem::setInstrumentName().

m_withPolarizerAnalyzer

bool InstrumentItem::m_withPolarizerAnalyzer

protectedinherited

Definition at line 105 of file InstrumentItems.h.

Referenced by InstrumentItem::serialize(), InstrumentItem::setWithPolarizerAnalyzer(), and InstrumentItem::withPolarizerAnalyzer().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Device/InstrumentItems.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Device/InstrumentItems.cpp