Instrument2DItem Class Reference

Description

Definition at line 149 of file InstrumentItems.h.

Inheritance diagram for Instrument2DItem:

Collaboration diagram for Instrument2DItem:

Public Member Functions
virtual bool	alignedWith (const RealDataItem *item) const
BackgroundItem *	backgroundItem () const
SelectionDescriptor< BackgroundItem * >	backgroundSelection () const
virtual BeamItem *	beamItem () const
virtual ICoordSystem *	createCoordSystem () const =0
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
virtual QString	defaultName () const =0
	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
virtual QString	instrumentType () const =0
	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)
virtual std::vector< int >	shape () const =0
virtual void	updateToRealData (const RealDataItem *item)=0
	VECTOR_PROPERTY (analyzerDirection, AnalyzerDirection)
	VECTOR_PROPERTY (polarization, Polarization)
bool	withPolarizerAnalyzer () const

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

Protected Member Functions
	Instrument2DItem ()
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

Instrument2DItem()

Instrument2DItem::Instrument2DItem ( )

protected

Definition at line 333 of file InstrumentItems.cpp.

{
    m_beamItem.reset(new GISASBeamItem());
    m_detectorItem.init<DetectorItemCatalog>("Detector", "", "detector");
}

References SelectionProperty< T >::init(), InstrumentItem::m_beamItem, and m_detectorItem.

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:

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(), createInstrument(), createOffspecSimulation(), and 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::OffspecInstrumentItem(), createInstrument(), createOffspecSimulation(), createScatteringSimulation(), InstrumentEditController::notifyInclinationAxisChanged(), and InstrumentEditController::notifyWavelengthDistributionChanged().

createCoordSystem()

virtual ICoordSystem* InstrumentItem::createCoordSystem ( ) const

pure virtualinherited

Implemented in OffspecInstrumentItem, GISASInstrumentItem, DepthProbeInstrumentItem, and SpecularInstrumentItem.

Referenced by GUI::Model::JobItemUtils::createDefaultDetectorMap(), GUI::Model::JobFunctions::initDataView(), GUI::Model::JobItemUtils::setIntensityItemCoords(), and GUI::Model::JobItemUtils::updateDataAxes().

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

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

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

Here is the call graph for this function:

createOffspecSimulation()

OffspecSimulation * Instrument2DItem::createOffspecSimulation

(

const MultiLayer &

sample

)

const

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

Here is the call graph for this function:

createScatteringSimulation()

ScatteringSimulation * Instrument2DItem::createScatteringSimulation

(

const MultiLayer &

sample

)

const

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

Here is the call graph for this function:

defaultName()

virtual QString InstrumentItem::defaultName ( ) const

pure virtualinherited

The default user visible name when creating an instrument.

Implemented in OffspecInstrumentItem, GISASInstrumentItem, DepthProbeInstrumentItem, and SpecularInstrumentItem.

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

(

)

detectorItem()

DetectorItem * Instrument2DItem::detectorItem

(

)

const

Definition at line 346 of file InstrumentItems.cpp.

{
    return m_detectorItem.get();
}

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

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

Here is the call graph for this function:

detectorSelection()

SelectionDescriptor< DetectorItem * > Instrument2DItem::detectorSelection

(

)

const

Definition at line 351 of file InstrumentItems.cpp.

{
    return m_detectorItem;
}

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

overridevirtual

Reimplemented from InstrumentItem.

Definition at line 356 of file InstrumentItems.cpp.

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

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

virtual QString InstrumentItem::instrumentType ( ) const

pure virtualinherited

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

Implemented in OffspecInstrumentItem, GISASInstrumentItem, DepthProbeInstrumentItem, and SpecularInstrumentItem.

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 )

static

serialize()

void Instrument2DItem::serialize ( Streamer &  s )

overridevirtual

Reimplemented from InstrumentItem.

Reimplemented in OffspecInstrumentItem.

Definition at line 339 of file InstrumentItems.cpp.

{
    s.assertVersion(0);
    Serialize::rwBaseClass<InstrumentItem>(s, "InstrumentItem", this);
    Serialize::rwSelected<DetectorItemCatalog>(s, m_detectorItem);
}

References Streamer::assertVersion(), and m_detectorItem.

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

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

virtual std::vector<int> InstrumentItem::shape ( ) const

pure virtualinherited

Implemented in OffspecInstrumentItem, GISASInstrumentItem, DepthProbeInstrumentItem, and SpecularInstrumentItem.

Referenced by InstrumentItem::alignedWith().

updateToRealData()

virtual void InstrumentItem::updateToRealData ( const RealDataItem *  item )

pure virtualinherited

Implemented in OffspecInstrumentItem, GISASInstrumentItem, DepthProbeInstrumentItem, and SpecularInstrumentItem.

Referenced by InstrumentsEditController::updateInstrumentToRealDataItem().

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

protected

Definition at line 170 of file InstrumentItems.h.

Referenced by Instrument2DItem(), detectorItem(), detectorSelection(), and 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