OffspecInstrumentItem Class Reference

Description

Definition at line 185 of file InstrumentItems.h.

Inheritance diagram for OffspecInstrumentItem:

Collaboration diagram for OffspecInstrumentItem:

Public Member Functions
	OffspecInstrumentItem ()
virtual bool	alignedWith (const RealDataItem *item) const
	AXIS_PROPERTY (alphaAxis)
BackgroundItem *	backgroundItem () const
SelectionDescriptor< BackgroundItem * >	backgroundSelection () const
virtual BeamItem *	beamItem () const
ICoordSystem *	createCoordSystem () const override
InstrumentItem *	createCopy () const
	Creates an exact copy; also ID is the same! More...
std::unique_ptr< Instrument >	createInstrument () const
OffspecSimulation *	createOffspecSimulation (const MultiLayer &sample) const
ScatteringSimulation *	createScatteringSimulation (const MultiLayer &sample) const
QString	defaultName () const override
	The default user visible name when creating an instrument. More...
QString	description () const
GroupItem *	detectorGroup ()
DetectorItem *	detectorItem () const
SelectionDescriptor< DetectorItem * >	detectorSelection () const
	DOUBLE_PROPERTY (analyzerTotalTransmission, AnalyzerTotalTransmission)
QString	id () const
void	importMasks (const MaskContainerItem *maskContainer) override
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
void	serialize (Streamer &s) override
template<typename T >
T *	setBackgroundType ()
void	setDescription (const QString &description)
template<typename T >
T *	setDetectorType ()
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

Static Public Member Functions
static bool	isDetectorPropertyName (const QString &name)

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

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

Constructor & Destructor Documentation

OffspecInstrumentItem()

OffspecInstrumentItem::OffspecInstrumentItem

(

)

Definition at line 437 of file InstrumentItems.cpp.

{
    m_alphaAxis.initNbins("Nbins", "Number of points in scan");
    m_alphaAxis.initMin("Min", "Starting value", 0.0, Unit::degree, RealLimits::limited(-90, 90));
    m_alphaAxis.initMax("Max", "Ending value", 10.0, Unit::degree, RealLimits::limited(-90, 90));
 
    auto* beam_item = dynamic_cast<GISASBeamItem*>(beamItem());
    beam_item->setInclinationAngleGetter([=]() { return m_alphaAxis.min(); });
}

References InstrumentItem::beamItem(), degree, and GISASBeamItem::setInclinationAngleGetter().

Here is the call graph for this function:

Member Function Documentation

alignedWith()

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

virtualinherited

Reimplemented in SpecularInstrumentItem.

Definition at line 129 of file InstrumentItems.cpp.

{
    return shape() == item->shape();
}

References RealDataItem::shape(), and InstrumentItem::shape().

Referenced by LinkInstrumentManager::onInstrumentChanged(), and SimulationView::validateSimulationSetup().

Here is the call graph for this function:

AXIS_PROPERTY()

OffspecInstrumentItem::AXIS_PROPERTY

(

alphaAxis

)

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 SpecularInstrumentItem::createCoordSystem(), Instrument2DItem::createInstrument(), Instrument2DItem::createOffspecSimulation(), and Instrument2DItem::createScatteringSimulation().

beamItem()

BeamItem * InstrumentItem::beamItem ( ) const

virtualinherited

Reimplemented in DepthProbeInstrumentItem, and SpecularInstrumentItem.

Definition at line 114 of file InstrumentItems.cpp.

{
    return m_beamItem.get();
}

References InstrumentItem::m_beamItem.

Referenced by GISASInstrumentEditor::GISASInstrumentEditor(), OffspecBeamEditor::OffspecBeamEditor(), OffspecInstrumentItem(), Instrument2DItem::createInstrument(), Instrument2DItem::createOffspecSimulation(), Instrument2DItem::createScatteringSimulation(), InstrumentEditController::notifyInclinationAxisChanged(), and InstrumentEditController::notifyWavelengthDistributionChanged().

createCoordSystem()

ICoordSystem * OffspecInstrumentItem::createCoordSystem ( ) const

overridevirtual

Implements InstrumentItem.

Definition at line 483 of file InstrumentItems.cpp.

{
    IAxis* alphaAxis =
        new FixedBinAxis("alpha", m_alphaAxis.nbins(), m_alphaAxis.min() * Units::deg,
                         m_alphaAxis.max() * Units::deg);
    const auto instrument = createInstrument();
    return instrument->detector().offspecCoords(alphaAxis, instrument->beam().direction());
}

References Instrument2DItem::createInstrument().

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:

createInstrument()

std::unique_ptr< Instrument > Instrument2DItem::createInstrument ( ) const

inherited

Definition at line 361 of file InstrumentItems.cpp.

{
    auto beam = beamItem()->createBeam();
    auto detector = detectorItem()->createDetector();
    detector->setDetectorNormal(beam->direction().zReflected());
 
    return std::make_unique<Instrument>(*beam, *detector);
}

References InstrumentItem::beam(), InstrumentItem::beamItem(), BeamItem::createBeam(), DetectorItem::createDetector(), and Instrument2DItem::detectorItem().

Referenced by GISASInstrumentItem::createCoordSystem(), and createCoordSystem().

Here is the call graph for this function:

createOffspecSimulation()

OffspecSimulation * Instrument2DItem::createOffspecSimulation ( const MultiLayer &  sample ) const

inherited

Definition at line 382 of file InstrumentItems.cpp.

{
    auto beam = beamItem()->createBeam();
    beam->setPolarization(m_polarization);
    auto detector = detectorItem()->createDetector();
    detector->setAnalyzer(m_analyzerDirection, m_analyzerEfficiency, m_analyzerTotalTransmission);
    detector->setDetectorNormal(beam->direction().zReflected());
 
    auto* result = new OffspecSimulation(*beam, sample, *detector);
    return result;
}

References InstrumentItem::beam(), InstrumentItem::beamItem(), BeamItem::createBeam(), DetectorItem::createDetector(), and Instrument2DItem::detectorItem().

Here is the call graph for this function:

createScatteringSimulation()

ScatteringSimulation * Instrument2DItem::createScatteringSimulation ( const MultiLayer &  sample ) const

inherited

Definition at line 370 of file InstrumentItems.cpp.

{
    auto beam = beamItem()->createBeam();
    beam->setPolarization(m_polarization);
    auto detector = detectorItem()->createDetector();
    detector->setAnalyzer(m_analyzerDirection, m_analyzerEfficiency, m_analyzerTotalTransmission);
    detector->setDetectorNormal(beam->direction().zReflected());
 
    auto* result = new ScatteringSimulation(*beam, sample, *detector);
    return result;
}

References InstrumentItem::beam(), InstrumentItem::beamItem(), BeamItem::createBeam(), DetectorItem::createDetector(), and Instrument2DItem::detectorItem().

Here is the call graph for this function:

defaultName()

QString OffspecInstrumentItem::defaultName ( ) const

overridevirtual

The default user visible name when creating an instrument.

Implements InstrumentItem.

Definition at line 473 of file InstrumentItems.cpp.

{
    return "Offspec";
}

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().

detectorGroup()

GroupItem* Instrument2DItem::detectorGroup ( )

inherited

detectorItem()

DetectorItem * Instrument2DItem::detectorItem ( ) const

inherited

Definition at line 346 of file InstrumentItems.cpp.

{
    return m_detectorItem.get();
}

References SelectionProperty< T >::get(), and Instrument2DItem::m_detectorItem.

Referenced by Instrument2DItem::createInstrument(), Instrument2DItem::createOffspecSimulation(), Instrument2DItem::createScatteringSimulation(), Instrument2DItem::importMasks(), GISASInstrumentItem::shape(), shape(), GISASInstrumentItem::updateToRealData(), and updateToRealData().

Here is the call graph for this function:

detectorSelection()

SelectionDescriptor< DetectorItem * > Instrument2DItem::detectorSelection ( ) const

inherited

Definition at line 351 of file InstrumentItems.cpp.

{
    return m_detectorItem;
}

References Instrument2DItem::m_detectorItem.

Referenced by DetectorEditor::DetectorEditor(), and DetectorEditor::createDetectorWidgets().

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()

void Instrument2DItem::importMasks ( const MaskContainerItem *  maskContainer )

overridevirtualinherited

Reimplemented from InstrumentItem.

Definition at line 356 of file InstrumentItems.cpp.

{
    detectorItem()->importMasks(maskContainer);
}

References Instrument2DItem::detectorItem(), and DetectorItem::importMasks().

Here is the call graph for this function:

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 OffspecInstrumentItem::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 478 of file InstrumentItems.cpp.

{
    return "Off 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().

isDetectorPropertyName()

static bool Instrument2DItem::isDetectorPropertyName ( const QString &  name )

staticinherited

serialize()

void OffspecInstrumentItem::serialize ( Streamer &  s )

overridevirtual

Reimplemented from Instrument2DItem.

Definition at line 447 of file InstrumentItems.cpp.

{
    s.assertVersion(0);
    Serialize::rwBaseClass<Instrument2DItem>(s, "Instrument2DItem", this);
    m_alphaAxis.rwAxisProperty(s, "alphaAxis");
}

References Streamer::assertVersion().

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:

setDetectorType()

template<typename T >

T * Instrument2DItem::setDetectorType

inherited

Definition at line 212 of file InstrumentItems.h.

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

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 > OffspecInstrumentItem::shape ( ) const

overridevirtual

Implements InstrumentItem.

Definition at line 454 of file InstrumentItems.cpp.

{
    return {(int)m_alphaAxis.nbins(), detectorItem()->ySize()};
}

References Instrument2DItem::detectorItem(), and DetectorItem::ySize().

Referenced by updateToRealData().

Here is the call graph for this function:

updateToRealData()

void OffspecInstrumentItem::updateToRealData ( const RealDataItem *  item )

overridevirtual

Implements InstrumentItem.

Definition at line 459 of file InstrumentItems.cpp.

{
    if (!dataItem)
        return;
 
    const auto data_shape = dataItem->shape();
    if (shape().size() != data_shape.size())
        throw Error("Error in OffspecInstrumentItem::updateToRealData: The type of "
                    "instrument is incompatible with passed data shape.");
 
    m_alphaAxis.setNbins(data_shape[0]);
    detectorItem()->setYSize(data_shape[1]);
}

References Instrument2DItem::detectorItem(), Error, DetectorItem::setYSize(), RealDataItem::shape(), and shape().

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::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_detectorItem

SelectionProperty<DetectorItem*> Instrument2DItem::m_detectorItem

protectedinherited

Definition at line 170 of file InstrumentItems.h.

Referenced by Instrument2DItem::Instrument2DItem(), Instrument2DItem::detectorItem(), Instrument2DItem::detectorSelection(), and Instrument2DItem::serialize().

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