IDetector Class Reference

Description

Abstract detector interface.

Handles also "region of interest" (ROI). In general, the ROI is the whole detector, and all methods related to ROI work on the whole detector. If a ROI different to the detector size is explicitly set, then ROI-related methods work on this reduced ROI. Therefore, when calling ROI related methods, the distinction between "explicit ROI exists: yes/no" does not have to be made by the caller, but it is handled in here. For access to the whole detector, even if a smaller ROI is explicitly defined, use the non-ROI-related methods like totalSize() or axes(). Any method which is not speaking of "explicit ROI" handles the "implicit ROI", i.e. uses an explicitly set ROI or the whole detector if no explicit ROI exists. To access the explicitly set ROI, use the methods which have the explicit in its name, like sizeOfExplicitRegionOfInterest().

Definition at line 57 of file IDetector.h.

Inheritance diagram for IDetector:

Collaboration diagram for IDetector:

Classes
struct	RoiOfAxis
	Keeps RegionOfInterest (ROI) data of one axis. More...

Public Types
using	const_iterator = const SimulationAreaIterator &

Public Member Functions
	IDetector ()
	~IDetector () override
std::vector< size_t >	active_indices () const
	Returns vector of unmasked detector indices. More...
void	addDetAxis (const IAxis &axis)
void	addMask (const IShape2D &shape, bool mask_value=true)
	Adds mask of given shape to the stack of detector masks. The mask value 'true' means that the channel will be excluded from the simulation. The mask which is added last has priority. More...
const PolFilter &	analyzer () const
	Returns detection properties. More...
void	applyDetectorResolution (Datafield *p_intensity_map) const
	Applies the detector resolution to the given intensity maps. More...
OwningVector< IAxis >	axesClippedToRegionOfInterest () const
	Returns the axes clipped to the region of interest. If no region of interest is explicitly defined, then the whole detector is taken as "region of interest". More...
const IAxis &	axis (size_t index) const
	One axis of the complete detector. Any region of interest is not taken into account. More...
size_t	axisBinIndex (size_t index, size_t selected_axis) const
	Calculate axis index for given global index. More...
SimulationAreaIterator	beginNonMaskedPoints () const
	Create begin-iterator to iterate over all points which are not masked and lay within the "Region of Interest". More...
SimulationAreaIterator	beginRegionOfInterestPoints () const
	Create begin-iterator to iterate over all points which lay within the "Region of Interest". If no region of interest is explicitly defined, then the whole detector is taken as "region of interest". No matter whether masked or not. More...
void	checkNodeArgs () const
	Raises exception if a parameter value is invalid. More...
virtual std::string	className () const =0
	Returns the class name, to be hard-coded in each leaf class that inherits from INode. More...
IDetector *	clone () const override=0
std::unique_ptr< DetectorContext >	createContext () const
Datafield *	createDetectorIntensity (const std::vector< std::unique_ptr< DiffuseElement >> &elements) const
	Returns new intensity map with resolution applied, and cropped to ROI if applicable. More...
std::unique_ptr< Datafield >	createDetectorMap () const
	Returns empty detector map in given axes units. This map is a data array limited to the size of the "Region of interest". More...
virtual IPixel *	createPixel (size_t index) const =0
	Creates an IPixel for the given Datafield object and index. More...
virtual Coords	defaultCoords () const =0
	Return default axes units. More...
size_t	detectorIndexToRegionOfInterestIndex (size_t detectorIndex) const
const DetectorMask *	detectorMask () const
const IDetectorResolution *	detectorResolution () const
	Returns a pointer to detector resolution object. More...
SimulationAreaIterator	endNonMaskedPoints () const
	Create end-iterator to iterate over all points which are not masked and lay within the "Region of Interest". More...
SimulationAreaIterator	endRegionOfInterestPoints () const
	Create end-iterator to iterate over all points which lay within the "Region of Interest". If no region of interest is explicitly defined, then the whole detector is taken as "region of interest". No matter whether masked or not. More...
bool	hasExplicitRegionOfInterest () const
	True if a region of interest is explicitly set. More...
virtual size_t	indexOfSpecular (const Beam &beam) const =0
	Returns index of pixel that contains the specular wavevector. If no pixel contains this specular wavevector, the number of pixels is returned. This corresponds to an overflow index. More...
void	iterateOverNonMaskedPoints (std::function< void(const_iterator)> func) const
	Iterate over all non-masked points within "region of interest". If no region of interest is explicitly defined, then the whole detector is taken as "region of interest". More...
void	iterateOverRegionOfInterest (std::function< void(const_iterator)> func) const
	Iterate over all points within "region of interest", no matter whether they are masked or not. If no region of interest is explicitly defined, then the whole detector is taken as "region of interest". More...
void	maskAll ()
	Put the mask for all detector channels (i.e. exclude whole detector from the analysis) More...
std::vector< const INode * >	nodeChildren () const override
	Returns all children. More...
std::vector< const INode * >	nodeOffspring () const
	Returns all descendants. More...
size_t	numberOfElements () const
	Returns number of simulation elements. More...
virtual ICoordSystem *	offspecCoords (IAxis *beamAxis, const Direction &beamDirection) const =0
virtual std::vector< ParaMeta >	parDefs () const
	Returns the parameter definitions, to be hard-coded in each leaf class. More...
size_t	rank () const
	Returns number of defined axes. More...
std::pair< double, double >	regionOfInterestBounds (size_t iAxis) const
	The lower and upper bound of the region of interest. If no region of interest is explicitly defined, then the whole detector is taken as "region of interest". More...
size_t	regionOfInterestIndexToDetectorIndex (size_t regionOfInterestIndex) const
	Convert an index of the region of interest to an index of the detector. If no region of interest is set, then the index stays unmodified (since ROI == detector area). More...
void	resetRegionOfInterest ()
	Resets region of interest making whole detector plane available for the simulation. More...
virtual CoordSystem2D *	scatteringCoords (const Beam &beam) const =0
void	setAnalyzer (R3 direction, double efficiency, double total_transmission)
	Sets the polarization analyzer characteristics of the detector. More...
virtual void	setDetectorNormal (const Direction &)
	Inits detector with the beam settings. More...
void	setDetectorParameters (size_t n_x, double x_min, double x_max, size_t n_y, double y_min, double y_max)
	Sets equidistant axes. More...
void	setDetectorResolution (const IDetectorResolution &p_detector_resolution)
	Sets the detector resolution. More...
void	setRegionOfInterest (double xlow, double ylow, double xup, double yup)
	Sets rectangular region of interest with lower left and upper right corners defined. More...
void	setResolutionFunction (const IResolutionFunction2D &resFunc)
size_t	sizeOfRegionOfInterest () const
	The size of the "Region of Interest". Same as totalSize() if no region of interest has been explicitly set. More...
size_t	totalSize () const
	Returns total number of pixels. Any region of interest is not taken into account. More...
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...

Protected Member Functions
	IDetector (const IDetector &other)
virtual std::string	axisName (size_t index) const =0
	Returns the name for the axis with given index. More...
virtual std::pair< double, double >	boundsOfExplicitRegionOfInterest (size_t iAxis) const
	Lower and upper bound of one axis of an explicitly set ROI. Return 0/0 if no ROI has been explicitly set. More...
void	clear ()
size_t	getGlobalIndex (size_t x, size_t y) const
	Calculate global index from two axis indices. More...
virtual size_t	sizeOfExplicitRegionOfInterest () const
	Return 0 if no ROI has been explicitly set. Size means number of data points. More...

Protected Attributes
std::vector< RoiOfAxis >	m_explicitROI
	an explicitly defined region of interest. Empty if no ROI has been defined. Vector index corresponds to axis index in m_axes More...
std::vector< double >	m_P

Private Attributes
OwningVector< IAxis >	m_axes
std::shared_ptr< DetectorMask >	m_detector_mask
std::unique_ptr< IDetectorResolution >	m_detector_resolution
PolFilter	m_polAnalyzer

Member Typedef Documentation

const_iterator

using IDetector::const_iterator = const SimulationAreaIterator&

Definition at line 59 of file IDetector.h.

Constructor & Destructor Documentation

IDetector() [1/2]

IDetector::IDetector

(

)

Definition at line 42 of file IDetector.cpp.

{}

~IDetector()

IDetector::~IDetector ( )

overridedefault

IDetector() [2/2]

IDetector::IDetector ( const IDetector &  other )

protected

Definition at line 44 of file IDetector.cpp.

    : INode()
    , m_explicitROI(other.m_explicitROI)
    , m_axes(other.m_axes)
    , m_polAnalyzer(other.m_polAnalyzer)
    , m_detector_mask(other.m_detector_mask)
{
    if (other.m_detector_resolution)
        setDetectorResolution(*other.m_detector_resolution);
}

References m_detector_resolution, and setDetectorResolution().

Here is the call graph for this function:

Member Function Documentation

active_indices()

std::vector< size_t > IDetector::active_indices

(

)

const

Returns vector of unmasked detector indices.

Definition at line 346 of file IDetector.cpp.

{
    std::vector<size_t> result;
 
    iterateOverNonMaskedPoints([&](const_iterator it) { result.push_back(it.detectorIndex()); });
 
    return result;
}

References SimulationAreaIterator::detectorIndex(), and iterateOverNonMaskedPoints().

Referenced by DetectorContext::setup_context().

Here is the call graph for this function:

addDetAxis()

void IDetector::addDetAxis

(

const IAxis &

axis

)

Definition at line 57 of file IDetector.cpp.

{
    m_axes.emplace_back(axis.clone());
    if (rank() == 2)
        m_detector_mask.reset(new DetectorMask(*m_axes[0], *m_axes[1]));
}

References axis(), IAxis::clone(), OwningVector< T >::emplace_back(), m_axes, m_detector_mask, and rank().

Referenced by setDetectorParameters().

Here is the call graph for this function:

addMask()

void IDetector::addMask	(	const IShape2D &	shape,
		bool	mask_value = true
	)

Adds mask of given shape to the stack of detector masks. The mask value 'true' means that the channel will be excluded from the simulation. The mask which is added last has priority.

Parameters

shape	The shape of mask (Rectangle, Polygon, Line, Ellipse)
mask_value	The value of mask

Definition at line 360 of file IDetector.cpp.

{
    m_detector_mask->addMask(shape, mask_value);
}

References m_detector_mask.

Referenced by ISimulation2D::addMask(), and maskAll().

analyzer()

const PolFilter& IDetector::analyzer ( ) const

inline

Returns detection properties.

Definition at line 204 of file IDetector.h.

{ return m_polAnalyzer; }

References m_polAnalyzer.

Referenced by ISimulation2D::force_polarized(), ISimulation2D::generateElements(), and DetectorContext::setup_context().

applyDetectorResolution()

void IDetector::applyDetectorResolution

(

Datafield *

p_intensity_map

)

const

Applies the detector resolution to the given intensity maps.

Definition at line 169 of file IDetector.cpp.

{
    ASSERT(p_intensity_map);
 
    if (m_detector_resolution) {
        m_detector_resolution->applyDetectorResolution(p_intensity_map);
        if (detectorMask() && detectorMask()->hasMasks()) {
            // sets amplitude in masked areas to zero
            std::unique_ptr<Datafield> buff(new Datafield(p_intensity_map->frame().cloned_axes()));
            iterateOverNonMaskedPoints([&](const_iterator it) {
                (*buff)[it.roiIndex()] = (*p_intensity_map)[it.roiIndex()];
            });
            p_intensity_map->setVector(buff->flatVector());
        }
    }
}

References ASSERT, Frame::cloned_axes(), detectorMask(), Datafield::frame(), iterateOverNonMaskedPoints(), m_detector_resolution, SimulationAreaIterator::roiIndex(), and Datafield::setVector().

Referenced by createDetectorIntensity(), and OffspecSimulation::transferDetectorImage().

Here is the call graph for this function:

axesClippedToRegionOfInterest()

OwningVector< IAxis > IDetector::axesClippedToRegionOfInterest

(

)

const

Returns the axes clipped to the region of interest. If no region of interest is explicitly defined, then the whole detector is taken as "region of interest".

Definition at line 136 of file IDetector.cpp.

{
    OwningVector<IAxis> result;
    for (size_t iAxis = 0; iAxis < m_axes.size(); ++iAxis) {
        auto* axis = m_axes[iAxis]->clone();
        axis->clip(regionOfInterestBounds(iAxis));
        result.emplace_back(axis);
    }
    return result;
}

References axis(), IAxis::clip(), OwningVector< T >::emplace_back(), m_axes, regionOfInterestBounds(), and OwningVector< T >::size().

Referenced by RectangularDetector::offspecCoords(), SphericalDetector::offspecCoords(), RectangularDetector::scatteringCoords(), and SphericalDetector::scatteringCoords().

Here is the call graph for this function:

axis()

const IAxis & IDetector::axis

(

size_t

index

)

const

One axis of the complete detector. Any region of interest is not taken into account.

Definition at line 74 of file IDetector.cpp.

{
    ASSERT(index < rank());
    return *m_axes[index];
}

References ASSERT, m_axes, and rank().

Referenced by IDetector::RoiOfAxis::RoiOfAxis(), addDetAxis(), axesClippedToRegionOfInterest(), createDetectorMap(), RectangularDetector::createPixel(), SphericalDetector::createPixel(), getGlobalIndex(), RectangularDetector::height(), RectangularDetector::indexOfSpecular(), SphericalDetector::indexOfSpecular(), OffspecSimulation::intensityMapSize(), OffspecSimulation::pack_result(), setRegionOfInterest(), OffspecSimulation::transferDetectorImage(), RectangularDetector::width(), RectangularDetector::xSize(), and RectangularDetector::ySize().

Here is the call graph for this function:

axisBinIndex()

size_t IDetector::axisBinIndex	(	size_t	index,
		size_t	selected_axis
	)		const

Calculate axis index for given global index.

Definition at line 80 of file IDetector.cpp.

{
    const size_t dim = rank();
    size_t remainder(index);
    size_t i_axis = dim;
    for (size_t i = 0; i < dim; ++i) {
        --i_axis;
        if (selected_axis == i_axis)
            return remainder % m_axes[i_axis]->size();
        remainder /= m_axes[i_axis]->size();
    }
    ASSERT(0);
}

References ASSERT, m_axes, rank(), and OwningVector< T >::size().

Referenced by RectangularDetector::createPixel(), and SphericalDetector::createPixel().

Here is the call graph for this function:

axisName()

virtual std::string IDetector::axisName ( size_t  index ) const

protectedpure virtual

Returns the name for the axis with given index.

Implemented in SphericalDetector, and RectangularDetector.

Referenced by setDetectorParameters().

beginNonMaskedPoints()

SimulationAreaIterator IDetector::beginNonMaskedPoints

(

)

const

Create begin-iterator to iterate over all points which are not masked and lay within the "Region of Interest".

Definition at line 261 of file IDetector.cpp.

{
    return SimulationAreaIterator::createBegin(this, SimulationAreaIterator::notMasked);
}

References SimulationAreaIterator::createBegin(), and SimulationAreaIterator::notMasked.

Referenced by createDetectorIntensity(), and iterateOverNonMaskedPoints().

Here is the call graph for this function:

beginRegionOfInterestPoints()

SimulationAreaIterator IDetector::beginRegionOfInterestPoints

(

)

const

Create begin-iterator to iterate over all points which lay within the "Region of Interest". If no region of interest is explicitly defined, then the whole detector is taken as "region of interest". No matter whether masked or not.

Definition at line 271 of file IDetector.cpp.

{
    return SimulationAreaIterator::createBegin(this, SimulationAreaIterator::regionOfInterest);
}

References SimulationAreaIterator::createBegin(), and SimulationAreaIterator::regionOfInterest.

Referenced by iterateOverRegionOfInterest().

Here is the call graph for this function:

boundsOfExplicitRegionOfInterest()

std::pair< double, double > IDetector::boundsOfExplicitRegionOfInterest ( size_t  iAxis ) const

protectedvirtual

Lower and upper bound of one axis of an explicitly set ROI. Return 0/0 if no ROI has been explicitly set.

Definition at line 106 of file IDetector.cpp.

{
    ASSERT(iAxis < rank());
    if (iAxis < m_explicitROI.size())
        return {m_explicitROI[iAxis].lower, m_explicitROI[iAxis].upper};
    return {0., 0.};
}

References ASSERT, m_explicitROI, and rank().

Referenced by regionOfInterestBounds().

Here is the call graph for this function:

checkNodeArgs()

void INode::checkNodeArgs ( ) const

inherited

Raises exception if a parameter value is invalid.

Definition at line 27 of file INode.cpp.

{
    size_t nP = m_P.size();
    if (parDefs().size() != nP) {
        std::cerr << "BUG in class " << className() << std::endl;
        std::cerr << "#m_P = " << nP << std::endl;
        std::cerr << "#PDf = " << parDefs().size() << std::endl;
        for (const ParaMeta& pm : parDefs())
            std::cerr << "  PDf: " << pm.name << std::endl;
        ASSERT(0);
    }
    ASSERT(parDefs().size() == nP);
    for (size_t i = 0; i < nP; ++i) {
        const ParaMeta pm = parDefs()[i];
 
        RealLimits limits = RealLimits::limitless();
        if (pm.vMin == -INF) {
            ASSERT(pm.vMax == +INF);
            // nothing to do
        } else if (pm.vMax == +INF) {
            ASSERT(pm.vMin == 0);
            limits = RealLimits::nonnegative();
        } else {
            limits = RealLimits::limited(pm.vMin, pm.vMax);
        }
        limits.check(pm.name, m_P[i]);
    }
}

References ASSERT, RealLimits::check(), INode::className(), INF, RealLimits::limited(), RealLimits::limitless(), INode::m_P, ParaMeta::name, RealLimits::nonnegative(), INode::parDefs(), ParaMeta::vMax, and ParaMeta::vMin.

Referenced by BarGauss::BarGauss(), BarLorentz::BarLorentz(), Bipyramid4::Bipyramid4(), Box::Box(), CantellatedCube::CantellatedCube(), Cone::Cone(), ConstantBackground::ConstantBackground(), CosineRippleBox::CosineRippleBox(), CosineRippleGauss::CosineRippleGauss(), CosineRippleLorentz::CosineRippleLorentz(), Cylinder::Cylinder(), DistributionCosine::DistributionCosine(), DistributionGate::DistributionGate(), DistributionGaussian::DistributionGaussian(), DistributionLogNormal::DistributionLogNormal(), DistributionLorentz::DistributionLorentz(), DistributionTrapezoid::DistributionTrapezoid(), Dodecahedron::Dodecahedron(), EllipsoidalCylinder::EllipsoidalCylinder(), FootprintGauss::FootprintGauss(), FootprintSquare::FootprintSquare(), FuzzySphere::FuzzySphere(), GaussSphere::GaussSphere(), HemiEllipsoid::HemiEllipsoid(), HollowSphere::HollowSphere(), HorizontalCylinder::HorizontalCylinder(), Icosahedron::Icosahedron(), LongBoxGauss::LongBoxGauss(), LongBoxLorentz::LongBoxLorentz(), PlatonicOctahedron::PlatonicOctahedron(), PlatonicTetrahedron::PlatonicTetrahedron(), Prism3::Prism3(), Prism6::Prism6(), Profile1DCauchy::Profile1DCauchy(), Profile1DCosine::Profile1DCosine(), Profile1DGate::Profile1DGate(), Profile1DGauss::Profile1DGauss(), Profile1DTriangle::Profile1DTriangle(), Profile1DVoigt::Profile1DVoigt(), Profile2DCauchy::Profile2DCauchy(), Profile2DCone::Profile2DCone(), Profile2DGate::Profile2DGate(), Profile2DGauss::Profile2DGauss(), Profile2DVoigt::Profile2DVoigt(), Pyramid2::Pyramid2(), Pyramid3::Pyramid3(), Pyramid4::Pyramid4(), Pyramid6::Pyramid6(), RotationEuler::RotationEuler(), RotationX::RotationX(), RotationY::RotationY(), RotationZ::RotationZ(), SawtoothRippleBox::SawtoothRippleBox(), SawtoothRippleGauss::SawtoothRippleGauss(), SawtoothRippleLorentz::SawtoothRippleLorentz(), Sphere::Sphere(), Spheroid::Spheroid(), TruncatedCube::TruncatedCube(), TruncatedSphere::TruncatedSphere(), and TruncatedSpheroid::TruncatedSpheroid().

Here is the call graph for this function:

className()

virtual std::string INode::className ( ) const

pure virtualinherited

Returns the class name, to be hard-coded in each leaf class that inherits from INode.

Implemented in Particle, SphericalDetector, SpecularSimulation, ScatteringSimulation, OffspecSimulation, DepthProbeSimulation, PoissonBackground, ConstantBackground, GaussSphere, FuzzySphere, RotationEuler, RotationZ, RotationY, RotationX, IdentityRotation, ParticleCoreShell, ParticleComposition, MesoCrystal, Crystal, MultiLayer, Layer, Lattice3D, HexagonalLattice2D, SquareLattice2D, BasicLattice2D, LayerRoughness, LayerInterface, TruncatedSpheroid, TruncatedSphere, TruncatedCube, Spheroid, Sphere, SawtoothRippleLorentz, SawtoothRippleGauss, SawtoothRippleBox, Pyramid6, Pyramid4, Pyramid3, Pyramid2, Prism6, Prism3, PlatonicTetrahedron, PlatonicOctahedron, LongBoxLorentz, LongBoxGauss, Icosahedron, HorizontalCylinder, HollowSphere, HemiEllipsoid, EllipsoidalCylinder, Dodecahedron, Cylinder, CosineRippleLorentz, CosineRippleGauss, CosineRippleBox, Cone, CantellatedCube, Box, Bipyramid4, BarLorentz, BarGauss, Profile2DVoigt, Profile2DCone, Profile2DGate, Profile2DGauss, Profile2DCauchy, Profile1DVoigt, Profile1DCosine, Profile1DTriangle, Profile1DGate, Profile1DGauss, Profile1DCauchy, MisesGaussPeakShape, MisesFisherGaussPeakShape, LorentzFisherPeakShape, GaussFisherPeakShape, IsotropicLorentzPeakShape, IsotropicGaussPeakShape, ParticleLayout, InterferenceTwin, InterferenceRadialParaCrystal, InterferenceNone, InterferenceHardDisk, InterferenceFinite3DLattice, InterferenceFinite2DLattice, Interference3DLattice, Interference2DSuperLattice, Interference2DParaCrystal, Interference2DLattice, Interference1DLattice, DistributionTrapezoid, DistributionCosine, DistributionLogNormal, DistributionGaussian, DistributionLorentz, DistributionGate, ResolutionFunction2DGaussian, ConvolutionDetectorResolution, PolFilter, RectangularDetector, FootprintSquare, FootprintGauss, and Beam.

Referenced by INode::checkNodeArgs(), ExemplarySamples::createBasic2DParaCrystalWithFTDis(), IProfile1D::pythonConstructor(), IProfile2D::pythonConstructor(), IFormFactor::pythonConstructor(), and IFormFactor::shapeName().

clear()

void IDetector::clear ( )

protected

Definition at line 69 of file IDetector.cpp.

{
    m_axes.clear();
}

References OwningVector< T >::clear(), and m_axes.

Referenced by setDetectorParameters().

Here is the call graph for this function:

clone()

IDetector* IDetector::clone ( ) const

overridepure virtual

Implements ICloneable.

Implemented in SphericalDetector, and RectangularDetector.

createContext()

std::unique_ptr< DetectorContext > IDetector::createContext

(

)

const

Definition at line 355 of file IDetector.cpp.

{
    return std::make_unique<DetectorContext>(this);
}

Referenced by ISimulation2D::prepareSimulation().

createDetectorIntensity()

Datafield * IDetector::createDetectorIntensity

(

const std::vector< std::unique_ptr< DiffuseElement >> &

elements

)

const

Returns new intensity map with resolution applied, and cropped to ROI if applicable.

Definition at line 191 of file IDetector.cpp.

{
    std::unique_ptr<Datafield> detectorMap(createDetectorMap());
    ASSERT(detectorMap);
    size_t elementIndex = 0;
    for (auto it = beginNonMaskedPoints(); it != endNonMaskedPoints(); ++it)
        (*detectorMap)[it.roiIndex()] = elements[elementIndex++]->intensity();
    if (m_detector_resolution)
        applyDetectorResolution(detectorMap.get());
 
    return detectorMap.release();
}

References applyDetectorResolution(), ASSERT, beginNonMaskedPoints(), createDetectorMap(), endNonMaskedPoints(), and m_detector_resolution.

Here is the call graph for this function:

createDetectorMap()

std::unique_ptr< Datafield > IDetector::createDetectorMap

(

)

const

Returns empty detector map in given axes units. This map is a data array limited to the size of the "Region of interest".

Definition at line 205 of file IDetector.cpp.

{
    const size_t dim = rank();
    ASSERT(dim != 0);
 
    std::vector<IAxis*> axes;
    for (size_t iAxis = 0; iAxis < dim; ++iAxis) {
        IAxis* tmp = axis(iAxis).clone();
        tmp->clip(regionOfInterestBounds(iAxis));
        axes.emplace_back(tmp);
    }
 
    return std::make_unique<Datafield>(axes);
}

References ASSERT, axis(), IAxis::clip(), IAxis::clone(), rank(), and regionOfInterestBounds().

Referenced by createDetectorIntensity().

Here is the call graph for this function:

createPixel()

virtual IPixel* IDetector::createPixel ( size_t  index ) const

pure virtual

Creates an IPixel for the given Datafield object and index.

Implemented in SphericalDetector, and RectangularDetector.

Referenced by DetectorContext::setup_context().

defaultCoords()

virtual Coords IDetector::defaultCoords ( ) const

pure virtual

Return default axes units.

Implemented in SphericalDetector, and RectangularDetector.

detectorIndexToRegionOfInterestIndex()

size_t IDetector::detectorIndexToRegionOfInterestIndex

(

size_t

detectorIndex

)

const

Definition at line 294 of file IDetector.cpp.

{
    if (m_explicitROI.size() != 2)
        return detectorIndex;
 
    const auto& x = m_explicitROI[0];
    const auto& y = m_explicitROI[1];
 
    const size_t ny = ycoord(detectorIndex, y.detectorSize);
    if (ny < y.lowerIndex || ny > y.upperIndex)
        throw std::runtime_error("IDetector::detectorIndexToRegionOfInterestIndex() -> Error.");
 
    const size_t nx = xcoord(detectorIndex, x.detectorSize, y.detectorSize);
    if (nx < x.lowerIndex || nx > x.upperIndex)
        throw std::runtime_error("IDetector::detectorIndexToRegionOfInterestIndex() -> Error.");
 
    return ny - y.lowerIndex + (nx - x.lowerIndex) * y.roiSize;
}

References m_explicitROI.

detectorMask()

const DetectorMask * IDetector::detectorMask

(

)

const

Definition at line 372 of file IDetector.cpp.

{
    return m_detector_mask.get();
}

References m_detector_mask.

Referenced by applyDetectorResolution(), and SimulationAreaIterator::isMasked().

detectorResolution()

const IDetectorResolution * IDetector::detectorResolution

(

)

const

Returns a pointer to detector resolution object.

Definition at line 186 of file IDetector.cpp.

{
    return m_detector_resolution.get();
}

References m_detector_resolution.

endNonMaskedPoints()

SimulationAreaIterator IDetector::endNonMaskedPoints

(

)

const

Create end-iterator to iterate over all points which are not masked and lay within the "Region of Interest".

Definition at line 266 of file IDetector.cpp.

{
    return SimulationAreaIterator::createEnd(this, SimulationAreaIterator::notMasked);
}

References SimulationAreaIterator::createEnd(), and SimulationAreaIterator::notMasked.

Referenced by createDetectorIntensity(), and iterateOverNonMaskedPoints().

Here is the call graph for this function:

endRegionOfInterestPoints()

SimulationAreaIterator IDetector::endRegionOfInterestPoints

(

)

const

Create end-iterator to iterate over all points which lay within the "Region of Interest". If no region of interest is explicitly defined, then the whole detector is taken as "region of interest". No matter whether masked or not.

Definition at line 276 of file IDetector.cpp.

{
    return SimulationAreaIterator::createEnd(this, SimulationAreaIterator::regionOfInterest);
}

References SimulationAreaIterator::createEnd(), and SimulationAreaIterator::regionOfInterest.

Referenced by iterateOverRegionOfInterest().

Here is the call graph for this function:

getGlobalIndex()

size_t IDetector::getGlobalIndex ( size_t  x, size_t  y  ) const

protected

Calculate global index from two axis indices.

Definition at line 377 of file IDetector.cpp.

{
    if (rank() != 2)
        return totalSize();
    return x * axis(1).size() + y;
}

References axis(), rank(), IAxis::size(), and totalSize().

Referenced by RectangularDetector::indexOfSpecular(), and SphericalDetector::indexOfSpecular().

Here is the call graph for this function:

hasExplicitRegionOfInterest()

bool IDetector::hasExplicitRegionOfInterest

(

)

const

True if a region of interest is explicitly set.

Definition at line 131 of file IDetector.cpp.

{
    return !m_axes.empty() && (m_explicitROI.size() == m_axes.size());
}

References OwningVector< T >::empty(), m_axes, m_explicitROI, and OwningVector< T >::size().

Here is the call graph for this function:

indexOfSpecular()

virtual size_t IDetector::indexOfSpecular ( const Beam &  beam ) const

pure virtual

Returns index of pixel that contains the specular wavevector. If no pixel contains this specular wavevector, the number of pixels is returned. This corresponds to an overflow index.

Implemented in SphericalDetector, and RectangularDetector.

Referenced by ISimulation2D::generateElements().

iterateOverNonMaskedPoints()

void IDetector::iterateOverNonMaskedPoints

(

std::function< void(const_iterator)>

func

)

const

Iterate over all non-masked points within "region of interest". If no region of interest is explicitly defined, then the whole detector is taken as "region of interest".

Definition at line 252 of file IDetector.cpp.

{
    if (this->rank() == 0)
        return;
 
    for (auto it = beginNonMaskedPoints(); it != endNonMaskedPoints(); ++it)
        func(it);
}

References beginNonMaskedPoints(), endNonMaskedPoints(), and rank().

Referenced by active_indices(), applyDetectorResolution(), and numberOfElements().

Here is the call graph for this function:

iterateOverRegionOfInterest()

void IDetector::iterateOverRegionOfInterest

(

std::function< void(const_iterator)>

func

)

const

Iterate over all points within "region of interest", no matter whether they are masked or not. If no region of interest is explicitly defined, then the whole detector is taken as "region of interest".

Definition at line 243 of file IDetector.cpp.

{
    if (this->rank() == 0)
        return;
 
    for (auto it = beginRegionOfInterestPoints(); it != endRegionOfInterestPoints(); ++it)
        func(it);
}

References beginRegionOfInterestPoints(), endRegionOfInterestPoints(), and rank().

Referenced by ScatteringSimulation::intensityMapSize().

Here is the call graph for this function:

maskAll()

void IDetector::maskAll

(

)

Put the mask for all detector channels (i.e. exclude whole detector from the analysis)

Definition at line 365 of file IDetector.cpp.

{
    if (rank() != 2)
        return;
    addMask(InfinitePlane(), true);
}

References addMask(), and rank().

Referenced by ISimulation2D::maskAll().

Here is the call graph for this function:

nodeChildren()

std::vector< const INode * > IDetector::nodeChildren ( ) const

overridevirtual

Returns all children.

Reimplemented from INode.

Definition at line 238 of file IDetector.cpp.

{
    return std::vector<const INode*>() << &m_polAnalyzer << m_detector_resolution;
}

References m_detector_resolution, and m_polAnalyzer.

nodeOffspring()

std::vector< const INode * > INode::nodeOffspring ( ) const

inherited

Returns all descendants.

Definition at line 61 of file INode.cpp.

{
    std::vector<const INode*> result;
    result.push_back(this);
    for (const auto* child : nodeChildren()) {
        for (const auto* p : child->nodeOffspring())
            result.push_back(p);
    }
    return result;
}

References INode::nodeChildren().

Here is the call graph for this function:

numberOfElements()

size_t IDetector::numberOfElements

(

)

const

Returns number of simulation elements.

Definition at line 220 of file IDetector.cpp.

{
    size_t result(0);
    iterateOverNonMaskedPoints([&result](const_iterator) { ++result; });
    return result;
}

References iterateOverNonMaskedPoints().

Here is the call graph for this function:

offspecCoords()

virtual ICoordSystem* IDetector::offspecCoords ( IAxis *  beamAxis, const Direction &  beamDirection  ) const

pure virtual

Implemented in SphericalDetector, and RectangularDetector.

Referenced by OffspecSimulation::createCoordSystem().

parDefs()

virtual std::vector<ParaMeta> INode::parDefs ( ) const

inlinevirtualinherited

Returns the parameter definitions, to be hard-coded in each leaf class.

Reimplemented in ConstantBackground, GaussSphere, FuzzySphere, RotationEuler, RotationZ, RotationY, RotationX, Crystal, Layer, HexagonalLattice2D, SquareLattice2D, BasicLattice2D, LayerRoughness, TruncatedSpheroid, TruncatedSphere, TruncatedCube, Spheroid, Sphere, SawtoothRippleLorentz, SawtoothRippleGauss, SawtoothRippleBox, Pyramid6, Pyramid4, Pyramid3, Pyramid2, Prism6, Prism3, PlatonicTetrahedron, PlatonicOctahedron, LongBoxLorentz, LongBoxGauss, Icosahedron, HorizontalCylinder, HollowSphere, HemiEllipsoid, EllipsoidalCylinder, Dodecahedron, Cylinder, CosineRippleLorentz, CosineRippleGauss, CosineRippleBox, Cone, CantellatedCube, Box, Bipyramid4, BarLorentz, BarGauss, Profile2DVoigt, Profile2DCone, Profile2DGate, Profile2DGauss, Profile2DCauchy, Profile1DVoigt, Profile1DCosine, Profile1DTriangle, Profile1DGate, Profile1DGauss, Profile1DCauchy, MisesGaussPeakShape, MisesFisherGaussPeakShape, LorentzFisherPeakShape, GaussFisherPeakShape, IsotropicLorentzPeakShape, IsotropicGaussPeakShape, ParticleLayout, InterferenceTwin, InterferenceRadialParaCrystal, InterferenceHardDisk, Interference2DSuperLattice, Interference2DParaCrystal, Interference1DLattice, DistributionTrapezoid, DistributionCosine, DistributionLogNormal, DistributionGaussian, DistributionLorentz, DistributionGate, ResolutionFunction2DGaussian, PolFilter, FootprintSquare, and FootprintGauss.

Definition at line 51 of file INode.h.

{ return {}; }

Referenced by INode::checkNodeArgs(), and IFormFactor::pythonConstructor().

rank()

size_t IDetector::rank

(

)

const

Returns number of defined axes.

Definition at line 64 of file IDetector.cpp.

{
    return m_axes.size();
}

References m_axes, and OwningVector< T >::size().

Referenced by addDetAxis(), axis(), axisBinIndex(), boundsOfExplicitRegionOfInterest(), createDetectorMap(), getGlobalIndex(), RectangularDetector::indexOfSpecular(), SphericalDetector::indexOfSpecular(), iterateOverNonMaskedPoints(), iterateOverRegionOfInterest(), maskAll(), setRegionOfInterest(), totalSize(), and OffspecSimulation::transferDetectorImage().

Here is the call graph for this function:

regionOfInterestBounds()

std::pair< double, double > IDetector::regionOfInterestBounds

(

size_t

iAxis

)

const

The lower and upper bound of the region of interest. If no region of interest is explicitly defined, then the whole detector is taken as "region of interest".

Definition at line 227 of file IDetector.cpp.

{
    ASSERT(iAxis < m_axes.size());
 
    const auto explicitBounds = boundsOfExplicitRegionOfInterest(iAxis);
    if (explicitBounds.first != 0 || explicitBounds.second != 0)
        return explicitBounds;
 
    return m_axes[iAxis]->bounds();
}

References ASSERT, boundsOfExplicitRegionOfInterest(), m_axes, and OwningVector< T >::size().

Referenced by axesClippedToRegionOfInterest(), createDetectorMap(), and RectangularDetector::regionOfInterestPixel().

Here is the call graph for this function:

regionOfInterestIndexToDetectorIndex()

size_t IDetector::regionOfInterestIndexToDetectorIndex

(

size_t

regionOfInterestIndex

)

const

Convert an index of the region of interest to an index of the detector. If no region of interest is set, then the index stays unmodified (since ROI == detector area).

Definition at line 281 of file IDetector.cpp.

{
    if (m_explicitROI.size() != 2)
        return regionOfInterestIndex;
 
    const auto& x = m_explicitROI[0];
    const auto& y = m_explicitROI[1];
 
    const size_t globalIndex0 = y.lowerIndex + x.lowerIndex * y.detectorSize;
    return globalIndex0 + ycoord(regionOfInterestIndex, y.roiSize)
           + xcoord(regionOfInterestIndex, x.roiSize, y.roiSize) * y.detectorSize;
}

References m_explicitROI.

Referenced by SimulationAreaIterator::detectorIndex(), and SimulationAreaIterator::isMasked().

resetRegionOfInterest()

void IDetector::resetRegionOfInterest

(

)

Resets region of interest making whole detector plane available for the simulation.

Definition at line 164 of file IDetector.cpp.

{
    m_explicitROI.clear();
}

References m_explicitROI.

scatteringCoords()

virtual CoordSystem2D* IDetector::scatteringCoords ( const Beam &  beam ) const

pure virtual

Implemented in SphericalDetector, and RectangularDetector.

setAnalyzer()

void IDetector::setAnalyzer	(	R3	direction,
		double	efficiency,
		double	total_transmission
	)

Sets the polarization analyzer characteristics of the detector.

Definition at line 147 of file IDetector.cpp.

{
    m_polAnalyzer = PolFilter(direction, efficiency, total_transmission);
}

References m_polAnalyzer.

setDetectorNormal()

virtual void IDetector::setDetectorNormal ( const Direction &  )

inlinevirtual

Inits detector with the beam settings.

Reimplemented in RectangularDetector.

Definition at line 67 of file IDetector.h.

{} // nontrivial only for RectangularDetector

setDetectorParameters()

void IDetector::setDetectorParameters	(	size_t	n_x,
		double	x_min,
		double	x_max,
		size_t	n_y,
		double	y_min,
		double	y_max
	)

Sets equidistant axes.

Definition at line 329 of file IDetector.cpp.

{
    clear();
    addDetAxis(FixedBinAxis(axisName(0), n_x, x_min, x_max));
    addDetAxis(FixedBinAxis(axisName(1), n_y, y_min, y_max));
}

References addDetAxis(), axisName(), and clear().

Referenced by RectangularDetector::RectangularDetector(), and SphericalDetector::SphericalDetector().

Here is the call graph for this function:

setDetectorResolution()

void IDetector::setDetectorResolution

(

const IDetectorResolution &

p_detector_resolution

)

Sets the detector resolution.

Definition at line 152 of file IDetector.cpp.

{
    m_detector_resolution.reset(p_detector_resolution.clone());
}

References IDetectorResolution::clone(), and m_detector_resolution.

Referenced by IDetector(), and setResolutionFunction().

Here is the call graph for this function:

setRegionOfInterest()

void IDetector::setRegionOfInterest	(	double	xlow,
		double	ylow,
		double	xup,
		double	yup
	)

Sets rectangular region of interest with lower left and upper right corners defined.

Definition at line 337 of file IDetector.cpp.

{
    ASSERT(rank() == 2);
 
    m_explicitROI.clear();
    m_explicitROI.emplace_back(axis(0), xlow, xup);
    m_explicitROI.emplace_back(axis(1), ylow, yup);
}

References ASSERT, axis(), m_explicitROI, and rank().

Referenced by ISimulation2D::setRegionOfInterest().

Here is the call graph for this function:

setResolutionFunction()

void IDetector::setResolutionFunction

(

const IResolutionFunction2D &

resFunc

)

Definition at line 158 of file IDetector.cpp.

{
    ConvolutionDetectorResolution convFunc(resFunc);
    setDetectorResolution(convFunc);
}

References setDetectorResolution().

Here is the call graph for this function:

sizeOfExplicitRegionOfInterest()

size_t IDetector::sizeOfExplicitRegionOfInterest ( ) const

protectedvirtual

Return 0 if no ROI has been explicitly set. Size means number of data points.

Definition at line 94 of file IDetector.cpp.

{
    if (m_explicitROI.size() != m_axes.size())
        return 0;
 
    size_t s = 1;
    for (const auto& roiOfAxis : m_explicitROI)
        s *= roiOfAxis.roiSize;
 
    return s;
}

References m_axes, m_explicitROI, and OwningVector< T >::size().

Referenced by sizeOfRegionOfInterest().

Here is the call graph for this function:

sizeOfRegionOfInterest()

size_t IDetector::sizeOfRegionOfInterest

(

)

const

The size of the "Region of Interest". Same as totalSize() if no region of interest has been explicitly set.

Definition at line 125 of file IDetector.cpp.

{
    const auto explicitSize = sizeOfExplicitRegionOfInterest();
    return (explicitSize != 0) ? explicitSize : totalSize();
}

References sizeOfExplicitRegionOfInterest(), and totalSize().

Referenced by SimulationAreaIterator::createEnd().

Here is the call graph for this function:

totalSize()

size_t IDetector::totalSize

(

)

const

Returns total number of pixels. Any region of interest is not taken into account.

Definition at line 114 of file IDetector.cpp.

{
    const size_t dim = rank();
    if (dim == 0)
        return 0;
    size_t result = 1;
    for (size_t i_axis = 0; i_axis < dim; ++i_axis)
        result *= m_axes[i_axis]->size();
    return result;
}

References m_axes, and rank().

Referenced by getGlobalIndex(), RectangularDetector::indexOfSpecular(), SphericalDetector::indexOfSpecular(), and sizeOfRegionOfInterest().

Here is the call graph for this function:

transferToCPP()

virtual void ICloneable::transferToCPP ( )

inlinevirtualinherited

Used for Python overriding of clone (see swig/tweaks.py)

Definition at line 32 of file ICloneable.h.

Member Data Documentation

m_axes

OwningVector<IAxis> IDetector::m_axes

private

Definition at line 248 of file IDetector.h.

Referenced by addDetAxis(), axesClippedToRegionOfInterest(), axis(), axisBinIndex(), clear(), hasExplicitRegionOfInterest(), rank(), regionOfInterestBounds(), sizeOfExplicitRegionOfInterest(), and totalSize().

m_detector_mask

std::shared_ptr<DetectorMask> IDetector::m_detector_mask

private

Definition at line 251 of file IDetector.h.

Referenced by addDetAxis(), addMask(), and detectorMask().

m_detector_resolution

std::unique_ptr<IDetectorResolution> IDetector::m_detector_resolution

private

Definition at line 250 of file IDetector.h.

Referenced by IDetector(), applyDetectorResolution(), createDetectorIntensity(), detectorResolution(), nodeChildren(), and setDetectorResolution().

m_explicitROI

std::vector<RoiOfAxis> IDetector::m_explicitROI

protected

an explicitly defined region of interest. Empty if no ROI has been defined. Vector index corresponds to axis index in m_axes

Definition at line 242 of file IDetector.h.

Referenced by boundsOfExplicitRegionOfInterest(), detectorIndexToRegionOfInterestIndex(), hasExplicitRegionOfInterest(), regionOfInterestIndexToDetectorIndex(), resetRegionOfInterest(), setRegionOfInterest(), and sizeOfExplicitRegionOfInterest().

m_P

std::vector<double> INode::m_P

protectedinherited

Definition at line 63 of file INode.h.

Referenced by IFootprintFactor::IFootprintFactor(), INode::checkNodeArgs(), IProfile1D::pythonConstructor(), IProfile2D::pythonConstructor(), IFormFactor::pythonConstructor(), Profile1DVoigt::pythonConstructor(), and Profile2DVoigt::pythonConstructor().

m_polAnalyzer

PolFilter IDetector::m_polAnalyzer

private

Definition at line 249 of file IDetector.h.

Referenced by analyzer(), nodeChildren(), and setAnalyzer().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Device/Detector/IDetector.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Device/Detector/IDetector.cpp