Description

Definition at line 127 of file InstrumentItems.h.

Inheritance diagram for DepthProbeInstrumentItem:

Collaboration diagram for DepthProbeInstrumentItem:

Public Member Functions
	DepthProbeInstrumentItem ()

virtual bool	alignedWith (const RealDataItem *item) const

	AXIS_PROPERTY (zAxis)

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

DepthProbeSimulation *	createSimulation (const MultiLayer &sample) const

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

void	serialize (Streamer &s) override

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

◆ DepthProbeInstrumentItem()

DepthProbeInstrumentItem::DepthProbeInstrumentItem ( )

Definition at line 254 of file InstrumentItems.cpp.

 {
     m_beamItem.reset(new SpecularBeamItem(this));
  
     auto* axisItem = beamItem()->inclinationAxis();
     axisItem->setLowerBound(0.0);
     axisItem->setUpperBound(1.0);
     axisItem->setBinCount(500);
  
     m_zAxis.initNbins("Nbins", "Number of points in scan across sample bulk");
     m_zAxis.initMin("Min", "Starting value below sample horizon", -100.0, Unit::nanometer,
                     RealLimits::limitless());
     m_zAxis.initMax("Max", "Ending value above sample horizon", 100.0, Unit::nanometer,
                     RealLimits::limitless());
 }

References beamItem(), SpecularBeamItem::inclinationAxis(), InstrumentItem::m_beamItem, nanometer, and BasicAxisItem::setLowerBound().

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

DepthProbeInstrumentItem::AXIS_PROPERTY ( zAxis )

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

SpecularBeamItem * DepthProbeInstrumentItem::beamItem ( ) const

overridevirtual

Reimplemented from InstrumentItem.

Definition at line 277 of file InstrumentItems.cpp.

 {
     return beam<SpecularBeamItem>();
 }

Referenced by DepthProbeInstrumentEditor::DepthProbeInstrumentEditor(), DepthProbeInstrumentItem(), and createSimulation().

◆ createCoordSystem()

ICoordSystem * DepthProbeInstrumentItem::createCoordSystem ( ) const

overridevirtual

Implements InstrumentItem.

Definition at line 323 of file InstrumentItems.cpp.

 {
     // TODO set pol filters ?
     return nullptr; // TODO NOW RESTORE createSimulation()->createCoordSystem();
 }

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

◆ createSimulation()

DepthProbeSimulation * DepthProbeInstrumentItem::createSimulation ( const MultiLayer & sample ) const

Definition at line 302 of file InstrumentItems.cpp.

 {
     auto* simulation = new DepthProbeSimulation(sample);
  
     auto* const axis_item = beamItem()->inclinationAxis();
     auto axis = axis_item->createAxis(Units::deg);
  
     simulation->setBeamParameters(beamItem()->wavelength(), static_cast<int>(axis->size()),
                                   axis->min(), axis->max());
  
     simulation->setZSpan(m_zAxis.nbins(), m_zAxis.min(), m_zAxis.max());
  
     setBeamDistribution(ParameterDistribution::BeamWavelength, *beamItem()->wavelengthItem(),
                         *simulation);
  
     setBeamDistribution(ParameterDistribution::BeamInclinationAngle,
                         *beamItem()->inclinationAngleItem(), *simulation);
  
     return simulation;
 }

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

Here is the call graph for this function:

◆ defaultName()

QString DepthProbeInstrumentItem::defaultName ( ) const

overridevirtual

The default user visible name when creating an instrument.

Implements InstrumentItem.

Definition at line 292 of file InstrumentItems.cpp.

 {
     return "DepthProbe";
 }

◆ 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.

78 {}

◆ 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 DepthProbeInstrumentItem::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 297 of file InstrumentItems.cpp.

 {
     return "Depth probe";
 }

◆ 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 DepthProbeInstrumentItem::serialize ( Streamer & s )

overridevirtual

Reimplemented from InstrumentItem.

Definition at line 270 of file InstrumentItems.cpp.

 {
     s.assertVersion(0);
     Serialize::rwBaseClass<InstrumentItem>(s, "InstrumentItem", this);
     m_zAxis.rwAxisProperty(s, "zAxis");
 }

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:

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

overridevirtual

Implements InstrumentItem.

Definition at line 282 of file InstrumentItems.cpp.

 {
     return std::vector<int>(); // no certain shape to avoid linking to real data
 }

◆ updateToRealData()

void DepthProbeInstrumentItem::updateToRealData ( const RealDataItem * item )

overridevirtual

Implements InstrumentItem.

Definition at line 287 of file InstrumentItems.cpp.

 {
     throw std::runtime_error("DepthProbeInstrumentItem::updateToRealData()");
 }

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

Description

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ DepthProbeInstrumentItem()

Member Function Documentation

◆ alignedWith()

◆ AXIS_PROPERTY()

◆ backgroundItem()

◆ backgroundSelection()

◆ beam()

◆ beamItem()

◆ createCoordSystem()

◆ createCopy()

◆ createSimulation()

◆ defaultName()

◆ description()

◆ DOUBLE_PROPERTY()

◆ id()

◆ importMasks()

◆ instrumentName()

◆ instrumentType()

◆ is()

◆ serialize()

◆ setBackgroundType()

◆ setDescription()

◆ setId()

◆ setInstrumentName()

◆ setWithPolarizerAnalyzer()

◆ shape()

◆ updateToRealData()

◆ VECTOR_PROPERTY() [1/2]

◆ VECTOR_PROPERTY() [2/2]

◆ withPolarizerAnalyzer()

Member Data Documentation

◆ m_backgroundItem

◆ m_beamItem

◆ m_description

◆ m_id

◆ m_name

◆ m_withPolarizerAnalyzer