SphericalDetectorItem Class Reference

Description

Definition at line 21 of file SphericalDetectorItem.h.

Inheritance diagram for SphericalDetectorItem:

Collaboration diagram for SphericalDetectorItem:

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

Protected Member Functions
void	addMasksToCore (IDetector *detector) const
std::unique_ptr< IDetector >	createDomainDetector () const override
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

SphericalDetectorItem()

SphericalDetectorItem::SphericalDetectorItem

(

)

Definition at line 29 of file SphericalDetectorItem.cpp.

{
    m_resolutionFunction.initWithInitializer<ResolutionFunctionItemCatalog>(
        "Resolution function", "Detector resolution function", "resolutionFunction",
        initResolutionFunction);
 
    m_phiAxis.initNbins("Nbins", "Number of phi-axis bins");
    m_phiAxis.initMin("Min", "Lower edge of first phi-bin", -1.0, Unit::degree,
                      RealLimits::limited(-90, 90));
    m_phiAxis.initMax("Max", "Upper edge of last phi-bin", 1.0, Unit::degree,
                      RealLimits::limited(-90, 90));
 
    m_alphaAxis.initNbins("Nbins", "Number of alpha-axis bins");
    m_alphaAxis.initMin("Min", "Lower edge of first alpha-bin", 0.0, Unit::degree,
                        RealLimits::limited(-90, 90));
    m_alphaAxis.initMax("Max", "Upper edge of last alpha-bin", 2.0, Unit::degree,
                        RealLimits::limited(-90, 90));
}

References degree, SelectionProperty< T >::initWithInitializer(), and DetectorItem::m_resolutionFunction.

Here is the call graph for this function:

Member Function Documentation

addMasksToCore()

void DetectorItem::addMasksToCore ( IDetector *  detector ) const

protectedinherited

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 DetectorItem::axesToCoreUnitsFactor(), DetectorItem::m_maskItems, DetectorItem::maskItems(), and MaskItems::maskItems().

Referenced by DetectorItem::createDetector().

Here is the call graph for this function:

axesToCoreUnitsFactor()

double SphericalDetectorItem::axesToCoreUnitsFactor ( ) const

overridevirtual

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

Reimplemented from DetectorItem.

Definition at line 96 of file SphericalDetectorItem.cpp.

{
    return Units::deg;
}

AXIS_PROPERTY() [1/2]

SphericalDetectorItem::AXIS_PROPERTY

(

alphaAxis

)

AXIS_PROPERTY() [2/2]

SphericalDetectorItem::AXIS_PROPERTY

(

phiAxis

)

createDetector()

std::unique_ptr< IDetector > DetectorItem::createDetector ( ) const

inherited

Definition at line 26 of file DetectorItems.cpp.

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

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

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

Here is the call graph for this function:

createDomainDetector()

std::unique_ptr< IDetector > SphericalDetectorItem::createDomainDetector ( ) const

overrideprotectedvirtual

Implements DetectorItem.

Definition at line 63 of file SphericalDetectorItem.cpp.

{
    const int n_x = m_phiAxis.nbins();
    const double x_min = Units::deg2rad(m_phiAxis.min());
    const double x_max = Units::deg2rad(m_phiAxis.max());
 
    const int n_y = m_alphaAxis.nbins();
    const double y_min = Units::deg2rad(m_alphaAxis.min());
    const double y_max = Units::deg2rad(m_alphaAxis.max());
 
    return std::make_unique<SphericalDetector>(n_x, x_min, x_max, n_y, y_min, y_max);
}

createResolutionFunction()

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

protectedinherited

Definition at line 57 of file DetectorItems.cpp.

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

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

Referenced by DetectorItem::createDetector().

Here is the call graph for this function:

importMasks()

void DetectorItem::importMasks ( const MaskContainerItem *  maskContainer )

inherited

Definition at line 37 of file DetectorItems.cpp.

{
    m_maskItems.copy(maskContainer);
}

References MaskItems::copy(), and DetectorItem::m_maskItems.

Referenced by Instrument2DItem::importMasks().

Here is the call graph for this function:

maskItems()

MaskItems & DetectorItem::maskItems ( )

inherited

Definition at line 42 of file DetectorItems.cpp.

{
    return m_maskItems;
}

References DetectorItem::m_maskItems.

Referenced by DetectorItem::addMasksToCore().

resolutionFunction()

ResolutionFunctionItem * DetectorItem::resolutionFunction ( ) const

inherited

Definition at line 47 of file DetectorItems.cpp.

{
    return m_resolutionFunction.get();
}

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

Here is the call graph for this function:

resolutionFunctionSelection()

SelectionDescriptor< ResolutionFunctionItem * > DetectorItem::resolutionFunctionSelection ( ) const

inherited

Definition at line 52 of file DetectorItems.cpp.

{
    return m_resolutionFunction;
}

References DetectorItem::m_resolutionFunction.

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

serialize()

void SphericalDetectorItem::serialize ( Streamer &  s )

overridevirtual

Implements DetectorItem.

Definition at line 48 of file SphericalDetectorItem.cpp.

{
    s.assertVersion(0);
    // base class members
    Serialize::rwClass(s, "masks", m_maskItems);
    Serialize::rwSelected<ResolutionFunctionItemCatalog>(s, m_resolutionFunction);
 
    // own members
    m_phiAxis.rwAxisProperty(s, "phiAxis");
    m_alphaAxis.rwAxisProperty(s, "alphaAxis");
 
    if (s.xmlReader())
        m_resolutionFunction->setUnit(Unit::degree);
}

References Streamer::assertVersion(), degree, DetectorItem::m_maskItems, DetectorItem::m_resolutionFunction, Serialize::rwClass(), ResolutionFunctionItem::setUnit(), and Streamer::xmlReader().

Here is the call graph for this function:

setResolutionFunctionType()

template<typename T >

T * DetectorItem::setResolutionFunctionType

inherited

Definition at line 73 of file DetectorItems.h.

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

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

Here is the call graph for this function:

setXSize()

void SphericalDetectorItem::setXSize ( size_t  nx )

overridevirtual

sets the size of x-axis of the detector

Implements DetectorItem.

Definition at line 86 of file SphericalDetectorItem.cpp.

{
    m_phiAxis.setNbins(nx);
}

setYSize()

void SphericalDetectorItem::setYSize ( size_t  ny )

overridevirtual

sets the size of y-axis of the detector

Implements DetectorItem.

Definition at line 91 of file SphericalDetectorItem.cpp.

{
    m_alphaAxis.setNbins(ny);
}

xSize()

int SphericalDetectorItem::xSize ( ) const

overridevirtual

Returns the size of x-axis of the detector.

Implements DetectorItem.

Definition at line 76 of file SphericalDetectorItem.cpp.

{
    return m_phiAxis.nbins();
}

ySize()

int SphericalDetectorItem::ySize ( ) const

overridevirtual

Returns the size of y-axis of the detector.

Implements DetectorItem.

Definition at line 81 of file SphericalDetectorItem.cpp.

{
    return m_alphaAxis.nbins();
}

Member Data Documentation

m_maskItems

MaskItems DetectorItem::m_maskItems

protectedinherited

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

Definition at line 68 of file DetectorItems.h.

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

m_resolutionFunction

SelectionProperty<ResolutionFunctionItem*> DetectorItem::m_resolutionFunction

protectedinherited

Definition at line 69 of file DetectorItems.h.

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

---

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

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