Description

Definition at line 24 of file RectangularDetectorItem.h.

Inheritance diagram for RectangularDetectorItem:

Collaboration diagram for RectangularDetectorItem:

Public Member Functions
	RectangularDetectorItem ()

QVector< std::variant< VectorDescriptor, DoubleDescriptor > >	alignmentPropertiesForUI () const
	The properties of the currently active alignment. Sorted as expected on the UI. More...

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

RectangularDetector::EDetectorArrangement	detectorAlignment () const

SelectionDescriptor< RectangularDetector::EDetectorArrangement >	detectorAlignmentSelection () const

	DOUBLE_PROPERTY (distance, Distance)

	DOUBLE_PROPERTY (height, Height)

	DOUBLE_PROPERTY (u0, U0)

	DOUBLE_PROPERTY (v0, V0)

	DOUBLE_PROPERTY (width, Width)

void	importMasks (const MaskContainerItem *maskContainer)

MaskItems &	maskItems ()

ResolutionFunctionItem *	resolutionFunction () const

SelectionDescriptor< ResolutionFunctionItem * >	resolutionFunctionSelection () const

void	serialize (Streamer &s) override

void	setDetectorAlignment (RectangularDetector::EDetectorArrangement alignment)

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

	VECTOR_PROPERTY (directionVector, DirectionVector)

	VECTOR_PROPERTY (normalVector, NormalVector)

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< IResolutionFunction2D >	createResolutionFunction () const

Protected Attributes
MaskItems	m_maskItems
	for creation of domain detector; only filled and relevant in jobs More...

SelectionProperty< ResolutionFunctionItem * >	m_resolutionFunction

Private Member Functions
std::unique_ptr< IDetector >	createDomainDetector () const override

void	updateTooltips ()

Private Attributes
RectangularDetector::EDetectorArrangement	m_detectorAlignment

int	m_xSize

int	m_ySize

Static Private Attributes
static constexpr auto	P_DBEAM_U0 {"u0 (dbeam)"}

static constexpr auto	P_DBEAM_V0 {"v0 (dbeam)"}

static constexpr auto	P_DIRECTION {"Direction vector"}

static constexpr auto	P_DISTANCE {"Distance"}

static constexpr auto	P_NORMAL {"Normal vector"}

static constexpr auto	P_U0 {"u0"}

static constexpr auto	P_V0 {"v0"}

static constexpr auto	P_X_AXIS {"X axis"}

static constexpr auto	P_Y_AXIS {"Y axis"}

Constructor & Destructor Documentation

◆ RectangularDetectorItem()

RectangularDetectorItem::RectangularDetectorItem ( )

Definition at line 65 of file RectangularDetectorItem.cpp.

 {
     m_resolutionFunction.initWithInitializer<ResolutionFunctionItemCatalog>(
         "Resolution function", "Detector resolution function", "resolutionFunction",
         initResolutionFunction);
  
     m_xSize = 100;
     m_ySize = 100;
     m_width.init("Width (x-axis)", "Width of the detector", default_detector_width, "mm", 3,
                  RealLimits::positive(), "width");
     m_height.init("Height (y-axis)", "Height of the detector", default_detector_height, "mm", 3,
                   RealLimits::positive(), "height");
  
     m_normalVector.init(
         "Normal vector",
         "Normal of the detector plane with length equal to the sample detector distance",
         Unit::unitless, "normalVector");
     m_normalVector.r3().setX(default_detector_distance);
     m_directionVector.init("Direction vector",
                            "Detector axis direction vector w.r.t. the sample coordinate system",
                            Unit::unitless, "directionVector");
     m_directionVector.r3().setY(-1.0);
  
     m_u0.init("u0", "", default_detector_width / 2., "mm", 3, RealLimits::limitless(), "u0");
     m_v0.init("v0", "", 0.0, "mm", 3, RealLimits::limitless(), "v0");
     m_distance.init("Distance", "Distance from the sample origin to the detector plane",
                     default_detector_distance, "mm", "distance");
  
     m_detectorAlignment = RectangularDetector::PERPENDICULAR_TO_DIRECT_BEAM;
  
     updateTooltips();
 }

References SelectionProperty< T >::initWithInitializer(), m_detectorAlignment, DetectorItem::m_resolutionFunction, m_xSize, m_ySize, unitless, and updateTooltips().

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:

◆ alignmentPropertiesForUI()

QVector< std::variant< VectorDescriptor, DoubleDescriptor > > RectangularDetectorItem::alignmentPropertiesForUI ( ) const

The properties of the currently active alignment. Sorted as expected on the UI.

Definition at line 175 of file RectangularDetectorItem.cpp.

 {
     if (m_detectorAlignment == RectangularDetector::GENERIC)
         return {normalVector(), directionVector(), u0(), v0()};
  
     return {u0(), v0(), distance()};
 }

References m_detectorAlignment.

◆ axesToCoreUnitsFactor()

virtual double DetectorItem::axesToCoreUnitsFactor ( ) const

inlinevirtualinherited

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.

57 { return 1.0; }

Referenced by DetectorItem::addMasksToCore(), and DetectorItem::createResolutionFunction().

◆ 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 > RectangularDetectorItem::createDomainDetector ( ) const

overrideprivatevirtual

Implements DetectorItem.

Definition at line 183 of file RectangularDetectorItem.cpp.

 {
     auto result = std::make_unique<RectangularDetector>(xSize(), width(), ySize(), height());
  
     // distance and alignment
     switch (m_detectorAlignment) {
     case RectangularDetector::GENERIC:
         result->setDetectorPosition(m_normalVector, m_u0, m_v0, m_directionVector);
         break;
     case RectangularDetector::PERPENDICULAR_TO_SAMPLE:
         result->setPerpendicularToSampleX(m_distance, m_u0, m_v0);
         break;
     case RectangularDetector::PERPENDICULAR_TO_DIRECT_BEAM:
         result->setPerpendicularToDirectBeam(m_distance, m_u0, m_v0);
         break;
     case RectangularDetector::PERPENDICULAR_TO_REFLECTED_BEAM:
         result->setPerpendicularToReflectedBeam(m_distance, m_u0, m_v0);
         break;
     case RectangularDetector::PERPENDICULAR_TO_REFLECTED_BEAM_DPOS:
         result->setPerpendicularToReflectedBeam(m_distance);
         result->setDirectBeamPosition(m_u0, m_v0);
         break;
     default:
         break;
     }
  
     return std::unique_ptr<IDetector>(result.release());
 }

References m_detectorAlignment, xSize(), and ySize().

Here is the call graph for this function:

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

◆ detectorAlignment()

RectangularDetector::EDetectorArrangement RectangularDetectorItem::detectorAlignment ( ) const

Definition at line 132 of file RectangularDetectorItem.cpp.

 {
     return m_detectorAlignment;
 }

References m_detectorAlignment.

Referenced by DetectorAlignmentEditor::createAligmentWidgets().

◆ detectorAlignmentSelection()

SelectionDescriptor< RectangularDetector::EDetectorArrangement > RectangularDetectorItem::detectorAlignmentSelection ( ) const

Definition at line 158 of file RectangularDetectorItem.cpp.

 {
     SelectionDescriptor<RectangularDetector::EDetectorArrangement> d;
  
     d.label = "Alignment";
     for (auto a : alignments())
         d.options << alignmentTitle(a);
  
     d.currentIndexSetter = [&](int newIndex) {
         const_cast<RectangularDetectorItem*>(this)->setDetectorAlignment(alignments()[newIndex]);
     };
  
     d.currentIndexGetter = [&]() { return alignments().indexOf(m_detectorAlignment); };
     return d;
 }

References SelectionDescriptor< T >::currentIndexGetter, SelectionDescriptor< T >::currentIndexSetter, SelectionDescriptor< T >::label, m_detectorAlignment, SelectionDescriptor< T >::options, and setDetectorAlignment().

Referenced by DetectorAlignmentEditor::DetectorAlignmentEditor().

Here is the call graph for this function:

◆ DOUBLE_PROPERTY() [1/5]

RectangularDetectorItem::DOUBLE_PROPERTY	(	distance	,
		Distance
	)

◆ DOUBLE_PROPERTY() [2/5]

RectangularDetectorItem::DOUBLE_PROPERTY	(	height	,
		Height
	)

◆ DOUBLE_PROPERTY() [3/5]

RectangularDetectorItem::DOUBLE_PROPERTY	(	u0	,
		U0
	)

◆ DOUBLE_PROPERTY() [4/5]

RectangularDetectorItem::DOUBLE_PROPERTY	(	v0	,
		V0
	)

◆ DOUBLE_PROPERTY() [5/5]

RectangularDetectorItem::DOUBLE_PROPERTY	(	width	,
		Width
	)

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

overridevirtual

Implements DetectorItem.

Definition at line 98 of file RectangularDetectorItem.cpp.

 {
     int alignment = m_detectorAlignment;
  
     s.assertVersion(0);
     // base class members
     Serialize::rwClass(s, "masks", m_maskItems);
     Serialize::rwSelected<ResolutionFunctionItemCatalog>(s, m_resolutionFunction);
  
     // own members
     Serialize::rwValue(s, "xSize", m_xSize);
     Serialize::rwValue(s, "ySize", m_ySize);
     Serialize::rwProperty(s, m_width);
     Serialize::rwProperty(s, m_height);
     Serialize::rwValue(s, "alignment", alignment);
     Serialize::rwProperty(s, m_normalVector);
     Serialize::rwProperty(s, m_directionVector);
     Serialize::rwProperty(s, m_u0);
     Serialize::rwProperty(s, m_v0);
     Serialize::rwProperty(s, m_distance);
  
     if (s.xmlReader()) {
         setDetectorAlignment(static_cast<RectangularDetector::EDetectorArrangement>(alignment));
         m_resolutionFunction->setUnit("mm");
     }
 }

References Streamer::assertVersion(), m_detectorAlignment, DetectorItem::m_maskItems, DetectorItem::m_resolutionFunction, m_xSize, m_ySize, Serialize::rwClass(), Serialize::rwProperty(), Serialize::rwValue(), setDetectorAlignment(), ResolutionFunctionItem::setUnit(), and Streamer::xmlReader().

Here is the call graph for this function:

◆ setDetectorAlignment()

void RectangularDetectorItem::setDetectorAlignment ( RectangularDetector::EDetectorArrangement alignment )

Definition at line 125 of file RectangularDetectorItem.cpp.

 {
     m_detectorAlignment = alignment;
     updateTooltips();
 }

References m_detectorAlignment, and updateTooltips().

Referenced by detectorAlignmentSelection(), and serialize().

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 RectangularDetectorItem::setXSize ( size_t nx )

overridevirtual

sets the size of x-axis of the detector

Implements DetectorItem.

Definition at line 147 of file RectangularDetectorItem.cpp.

 {
     m_xSize = static_cast<int>(nx);
 }

References m_xSize.

Referenced by RectangularDetectorEditor::RectangularDetectorEditor().

◆ setYSize()

void RectangularDetectorItem::setYSize ( size_t ny )

overridevirtual

sets the size of y-axis of the detector

Implements DetectorItem.

Definition at line 152 of file RectangularDetectorItem.cpp.

 {
     m_ySize = static_cast<int>(ny);
 }

References m_ySize.

Referenced by RectangularDetectorEditor::RectangularDetectorEditor().

◆ updateTooltips()

void RectangularDetectorItem::updateTooltips ( )

private

Definition at line 212 of file RectangularDetectorItem.cpp.

 {
     switch (m_detectorAlignment) {
     case RectangularDetector::GENERIC:
         m_u0.setTooltip(
             "u-coordinate of point of intersection of normal vector and detector plane");
         m_v0.setTooltip(
             "v-coordinate of point of intersection of normal vector and detector plane");
         break;
     case RectangularDetector::PERPENDICULAR_TO_SAMPLE:
         m_u0.setTooltip("u-coordinate of point where sample x-axis crosses the detector");
         m_v0.setTooltip("v-coordinate of point where sample x-axis crosses the detector");
         break;
     case RectangularDetector::PERPENDICULAR_TO_REFLECTED_BEAM:
         m_u0.setTooltip("u-coordinate of point where reflected beam hits the detector");
         m_v0.setTooltip("v-coordinate of point where reflected beam hits the detector");
         break;
     case RectangularDetector::PERPENDICULAR_TO_DIRECT_BEAM: // fall-through!
     case RectangularDetector::PERPENDICULAR_TO_REFLECTED_BEAM_DPOS:
         m_u0.setTooltip("u-coordinate of point where direct beam hits the detector");
         m_v0.setTooltip("v-coordinate of point where direct beam hits the detector");
         break;
     default:
         break;
     }
 }

References m_detectorAlignment.

Referenced by RectangularDetectorItem(), and setDetectorAlignment().

◆ VECTOR_PROPERTY() [1/2]

RectangularDetectorItem::VECTOR_PROPERTY	(	directionVector	,
		DirectionVector
	)

◆ VECTOR_PROPERTY() [2/2]

RectangularDetectorItem::VECTOR_PROPERTY	(	normalVector	,
		NormalVector
	)

◆ xSize()

int RectangularDetectorItem::xSize ( ) const

overridevirtual

Returns the size of x-axis of the detector.

Implements DetectorItem.

Definition at line 137 of file RectangularDetectorItem.cpp.

 {
     return m_xSize;
 }

References m_xSize.

Referenced by RectangularDetectorEditor::RectangularDetectorEditor(), and createDomainDetector().

◆ ySize()

int RectangularDetectorItem::ySize ( ) const

overridevirtual

Returns the size of y-axis of the detector.

Implements DetectorItem.

Definition at line 142 of file RectangularDetectorItem.cpp.

 {
     return m_ySize;
 }

References m_ySize.

Referenced by RectangularDetectorEditor::RectangularDetectorEditor(), and createDomainDetector().

Member Data Documentation

◆ m_detectorAlignment

RectangularDetector::EDetectorArrangement RectangularDetectorItem::m_detectorAlignment

private

Definition at line 70 of file RectangularDetectorItem.h.

Referenced by RectangularDetectorItem(), alignmentPropertiesForUI(), createDomainDetector(), detectorAlignment(), detectorAlignmentSelection(), serialize(), setDetectorAlignment(), and updateTooltips().

◆ 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(), serialize(), and SphericalDetectorItem::serialize().

◆ m_resolutionFunction

SelectionProperty<ResolutionFunctionItem*> DetectorItem::m_resolutionFunction

protectedinherited

Definition at line 69 of file DetectorItems.h.

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

◆ m_xSize

int RectangularDetectorItem::m_xSize

private

Definition at line 71 of file RectangularDetectorItem.h.

Referenced by RectangularDetectorItem(), serialize(), setXSize(), and xSize().

◆ m_ySize

int RectangularDetectorItem::m_ySize

private

Definition at line 72 of file RectangularDetectorItem.h.

Referenced by RectangularDetectorItem(), serialize(), setYSize(), and ySize().

◆ P_DBEAM_U0

constexpr auto RectangularDetectorItem::P_DBEAM_U0 {"u0 (dbeam)"}

staticconstexprprivate

Definition at line 32 of file RectangularDetectorItem.h.

◆ P_DBEAM_V0

constexpr auto RectangularDetectorItem::P_DBEAM_V0 {"v0 (dbeam)"}

staticconstexprprivate

Definition at line 33 of file RectangularDetectorItem.h.

◆ P_DIRECTION

constexpr auto RectangularDetectorItem::P_DIRECTION {"Direction vector"}

staticconstexprprivate

Definition at line 29 of file RectangularDetectorItem.h.

◆ P_DISTANCE

constexpr auto RectangularDetectorItem::P_DISTANCE {"Distance"}

staticconstexprprivate

Definition at line 34 of file RectangularDetectorItem.h.

◆ P_NORMAL

constexpr auto RectangularDetectorItem::P_NORMAL {"Normal vector"}

staticconstexprprivate

Definition at line 28 of file RectangularDetectorItem.h.

◆ P_U0

constexpr auto RectangularDetectorItem::P_U0 {"u0"}

staticconstexprprivate

Definition at line 30 of file RectangularDetectorItem.h.

◆ P_V0

constexpr auto RectangularDetectorItem::P_V0 {"v0"}

staticconstexprprivate

Definition at line 31 of file RectangularDetectorItem.h.

◆ P_X_AXIS

constexpr auto RectangularDetectorItem::P_X_AXIS {"X axis"}

staticconstexprprivate

Definition at line 26 of file RectangularDetectorItem.h.

◆ P_Y_AXIS

constexpr auto RectangularDetectorItem::P_Y_AXIS {"Y axis"}

staticconstexprprivate

Definition at line 27 of file RectangularDetectorItem.h.

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

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

Description

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Constructor & Destructor Documentation

◆ RectangularDetectorItem()

Member Function Documentation

◆ addMasksToCore()

◆ alignmentPropertiesForUI()

◆ axesToCoreUnitsFactor()

◆ createDetector()

◆ createDomainDetector()

◆ createResolutionFunction()

◆ detectorAlignment()

◆ detectorAlignmentSelection()

◆ DOUBLE_PROPERTY() [1/5]

◆ DOUBLE_PROPERTY() [2/5]

◆ DOUBLE_PROPERTY() [3/5]

◆ DOUBLE_PROPERTY() [4/5]

◆ DOUBLE_PROPERTY() [5/5]

◆ importMasks()

◆ maskItems()

◆ resolutionFunction()

◆ resolutionFunctionSelection()

◆ serialize()

◆ setDetectorAlignment()

◆ setResolutionFunctionType()

◆ setXSize()

◆ setYSize()

◆ updateTooltips()

◆ VECTOR_PROPERTY() [1/2]

◆ VECTOR_PROPERTY() [2/2]

◆ xSize()

◆ ySize()

Member Data Documentation

◆ m_detectorAlignment

◆ m_maskItems

◆ m_resolutionFunction

◆ m_xSize

◆ m_ySize

◆ P_DBEAM_U0

◆ P_DBEAM_V0

◆ P_DIRECTION

◆ P_DISTANCE

◆ P_NORMAL

◆ P_U0

◆ P_V0

◆ P_X_AXIS

◆ P_Y_AXIS