DetectorItem Class Reference

Description

Definition at line 29 of file DetectorItems.h.

Inheritance diagram for DetectorItem:

Collaboration diagram for DetectorItem:

Public Member Functions
virtual	~DetectorItem ()=default
virtual double	axesToCoreUnitsFactor () const
	Scales the values provided by axes (to perform deg->rad conversion on the way to domain). More...
std::unique_ptr< IDetector >	createDetector () const
void	importMasks (const MaskContainerItem *maskContainer)
MaskItems &	maskItems ()
ResolutionFunctionItem *	resolutionFunction () const
SelectionDescriptor< ResolutionFunctionItem * >	resolutionFunctionSelection () const
virtual void	serialize (Streamer &s)=0
template<typename T >
T *	setResolutionFunctionType ()
virtual void	setXSize (size_t nx)=0
	sets the size of x-axis of the detector More...
virtual void	setYSize (size_t ny)=0
	sets the size of y-axis of the detector More...
virtual int	xSize () const =0
	Returns the size of x-axis of the detector. More...
virtual int	ySize () const =0
	Returns the size of y-axis of the detector. More...

Protected Member Functions
	DetectorItem ()
void	addMasksToCore (IDetector *detector) const
virtual std::unique_ptr< IDetector >	createDomainDetector () const =0
std::unique_ptr< IResolutionFunction2D >	createResolutionFunction () const

Protected Attributes
MaskItems	m_maskItems
	for creation of domain detector; only filled and relevant in jobs More...
SelectionProperty< ResolutionFunctionItem * >	m_resolutionFunction

Constructor & Destructor Documentation

~DetectorItem()

virtual DetectorItem::~DetectorItem ( )

virtualdefault

DetectorItem()

DetectorItem::DetectorItem ( )

protected

Definition at line 24 of file DetectorItems.cpp.

{}

Member Function Documentation

addMasksToCore()

void DetectorItem::addMasksToCore ( IDetector *  detector ) const

protected

Definition at line 62 of file DetectorItems.cpp.

{
    const double scale = axesToCoreUnitsFactor();
    const auto maskItems = m_maskItems.maskItems();
    for (auto maskIter = maskItems.rbegin(); maskIter != maskItems.rend(); maskIter++) {
        if (auto* roiItem = dynamic_cast<RegionOfInterestItem*>(*maskIter)) {
            const double xlow = scale * roiItem->xLow();
            const double ylow = scale * roiItem->yLow();
            const double xup = scale * roiItem->xUp();
            const double yup = scale * roiItem->yUp();
            detector->setRegionOfInterest(xlow, ylow, xup, yup);
        } else {
            std::unique_ptr<IShape2D> shape((*maskIter)->createShape(scale));
            detector->addMask(*shape, (*maskIter)->maskValue());
        }
    }
}

References axesToCoreUnitsFactor(), m_maskItems, maskItems(), and MaskItems::maskItems().

Referenced by createDetector().

Here is the call graph for this function:

axesToCoreUnitsFactor()

virtual double DetectorItem::axesToCoreUnitsFactor ( ) const

inlinevirtual

Scales the values provided by axes (to perform deg->rad conversion on the way to domain).

Reimplemented in SphericalDetectorItem.

Definition at line 57 of file DetectorItems.h.

{ return 1.0; }

Referenced by addMasksToCore(), and createResolutionFunction().

createDetector()

std::unique_ptr< IDetector > DetectorItem::createDetector

(

)

const

Definition at line 26 of file DetectorItems.cpp.

{
    auto result = createDomainDetector();
    addMasksToCore(result.get());
 
    if (auto resFunc = createResolutionFunction())
        result->setResolutionFunction(*resFunc);
 
    return result;
}

References addMasksToCore(), createDomainDetector(), and createResolutionFunction().

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

Here is the call graph for this function:

createDomainDetector()

virtual std::unique_ptr<IDetector> DetectorItem::createDomainDetector ( ) const

protectedpure virtual

Implemented in SphericalDetectorItem, and RectangularDetectorItem.

Referenced by createDetector().

createResolutionFunction()

std::unique_ptr< IResolutionFunction2D > DetectorItem::createResolutionFunction ( ) const

protected

Definition at line 57 of file DetectorItems.cpp.

{
    return m_resolutionFunction->createResolutionFunction(axesToCoreUnitsFactor());
}

References axesToCoreUnitsFactor(), ResolutionFunctionItem::createResolutionFunction(), and m_resolutionFunction.

Referenced by createDetector().

Here is the call graph for this function:

importMasks()

void DetectorItem::importMasks

(

const MaskContainerItem *

maskContainer

)

Definition at line 37 of file DetectorItems.cpp.

{
    m_maskItems.copy(maskContainer);
}

References MaskItems::copy(), and m_maskItems.

Referenced by Instrument2DItem::importMasks().

Here is the call graph for this function:

maskItems()

MaskItems & DetectorItem::maskItems

(

)

Definition at line 42 of file DetectorItems.cpp.

{
    return m_maskItems;
}

References m_maskItems.

Referenced by addMasksToCore().

resolutionFunction()

ResolutionFunctionItem * DetectorItem::resolutionFunction

(

)

const

Definition at line 47 of file DetectorItems.cpp.

{
    return m_resolutionFunction.get();
}

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

Here is the call graph for this function:

resolutionFunctionSelection()

SelectionDescriptor< ResolutionFunctionItem * > DetectorItem::resolutionFunctionSelection

(

)

const

Definition at line 52 of file DetectorItems.cpp.

{
    return m_resolutionFunction;
}

References m_resolutionFunction.

Referenced by ResolutionFunctionEditor::ResolutionFunctionEditor(), ParameterTreeBuilder::addDetector(), and ResolutionFunctionEditor::createResolutionWidgets().

serialize()

virtual void DetectorItem::serialize ( Streamer &  s )

pure virtual

Implemented in SphericalDetectorItem, and RectangularDetectorItem.

setResolutionFunctionType()

template<typename T >

T * DetectorItem::setResolutionFunctionType

Definition at line 73 of file DetectorItems.h.

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

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

Here is the call graph for this function:

setXSize()

virtual void DetectorItem::setXSize ( size_t  nx )

pure virtual

sets the size of x-axis of the detector

Implemented in SphericalDetectorItem, and RectangularDetectorItem.

Referenced by GISASInstrumentItem::updateToRealData().

setYSize()

virtual void DetectorItem::setYSize ( size_t  ny )

pure virtual

sets the size of y-axis of the detector

Implemented in SphericalDetectorItem, and RectangularDetectorItem.

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

xSize()

virtual int DetectorItem::xSize ( ) const

pure virtual

Returns the size of x-axis of the detector.

Implemented in SphericalDetectorItem, and RectangularDetectorItem.

ySize()

virtual int DetectorItem::ySize ( ) const

pure virtual

Returns the size of y-axis of the detector.

Implemented in SphericalDetectorItem, and RectangularDetectorItem.

Referenced by OffspecInstrumentItem::shape().

Member Data Documentation

m_maskItems

MaskItems DetectorItem::m_maskItems

protected

for creation of domain detector; only filled and relevant in jobs

Definition at line 68 of file DetectorItems.h.

Referenced by addMasksToCore(), importMasks(), maskItems(), RectangularDetectorItem::serialize(), and SphericalDetectorItem::serialize().

m_resolutionFunction

SelectionProperty<ResolutionFunctionItem*> DetectorItem::m_resolutionFunction

protected

Definition at line 69 of file DetectorItems.h.

Referenced by RectangularDetectorItem::RectangularDetectorItem(), SphericalDetectorItem::SphericalDetectorItem(), createResolutionFunction(), resolutionFunction(), resolutionFunctionSelection(), RectangularDetectorItem::serialize(), SphericalDetectorItem::serialize(), and setResolutionFunctionType().

---

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

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