RectangularDetector Class Reference

Description

A flat rectangular detector with axes and resolution function.

Definition at line 26 of file RectangularDetector.h.

Inheritance diagram for RectangularDetector:

Collaboration diagram for RectangularDetector:

Public Types
using	const_iterator = const SimulationAreaIterator &
enum	EDetectorArrangement {   GENERIC , PERPENDICULAR_TO_SAMPLE , PERPENDICULAR_TO_DIRECT_BEAM , PERPENDICULAR_TO_REFLECTED_BEAM ,   PERPENDICULAR_TO_REFLECTED_BEAM_DPOS }

Public Member Functions
	RectangularDetector (const RectangularDetector &other)
	RectangularDetector (size_t nxbins, double width, size_t nybins, double height)
	Rectangular detector constructor. More...
	~RectangularDetector () 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...
std::string	className () const final
	Returns the class name, to be hard-coded in each leaf class that inherits from INode. More...
RectangularDetector *	clone () const override
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...
Coords	defaultCoords () const override
	Returns 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...
EDetectorArrangement	getDetectorArrangment () const
double	getDirectBeamU0 () const
double	getDirectBeamV0 () const
R3	getDirectionVector () const
double	getDistance () const
R3	getNormalVector () const
double	getU0 () const
double	getV0 () const
bool	hasExplicitRegionOfInterest () const
	True if a region of interest is explicitly set. More...
double	height () const
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...
ICoordSystem *	offspecCoords (IAxis *beamAxis, const Direction &beamDirection) const override
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...
RectangularPixel *	regionOfInterestPixel () const
void	resetRegionOfInterest ()
	Resets region of interest making whole detector plane available for the simulation. More...
CoordSystem2D *	scatteringCoords (const Beam &beam) const override
void	setAnalyzer (R3 direction, double efficiency, double total_transmission)
	Sets the polarization analyzer characteristics of the detector. More...
void	setDetectorNormal (const Direction &direction) override
	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	setDetectorPosition (R3 normal_to_detector, double u0, double v0, R3 direction=R3(0.0, -1.0, 0.0))
void	setDetectorResolution (const IDetectorResolution &p_detector_resolution)
	Sets the detector resolution. More...
void	setDirectBeamPosition (double u0, double v0)
void	setPerpendicularToDirectBeam (double distance, double u0, double v0)
void	setPerpendicularToReflectedBeam (double distance, double u0=0.0, double v0=0.0)
void	setPerpendicularToSampleX (double distance, double u0, double v0)
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...
double	width () const
size_t	xSize () const
size_t	ySize () const

Protected Member Functions
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 Member Functions
std::string	axisName (size_t index) const override
	Returns the name for the axis with given index. More...
IPixel *	createPixel (size_t index) const override
	Creates an IPixel for the given Datafield object and index. More...
size_t	indexOfSpecular (const Beam &beam) const override
	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	initNormalVector (R3 central_k)
void	initUandV (double alpha_i)
void	setDistanceAndOffset (double distance, double u0, double v0)
void	swapContent (RectangularDetector &other)
	swap function More...

Private Attributes
OwningVector< IAxis >	m_axes
double	m_dbeam_u0
double	m_dbeam_v0
	position of direct beam in detector coordinates More...
EDetectorArrangement	m_detector_arrangement
std::shared_ptr< DetectorMask >	m_detector_mask
std::unique_ptr< IDetectorResolution >	m_detector_resolution
R3	m_direction
	direction vector of detector coordinate system More...
double	m_distance
	distance from sample origin to the detector plane More...
R3	m_normal_to_detector
PolFilter	m_polAnalyzer
double	m_u0
R3	m_u_unit
double	m_v0
	position of normal vector hitting point in detector coordinates More...
R3	m_v_unit

Member Typedef Documentation

const_iterator

using IDetector::const_iterator = const SimulationAreaIterator&

inherited

Definition at line 59 of file IDetector.h.

Member Enumeration Documentation

EDetectorArrangement

enum RectangularDetector::EDetectorArrangement

Enumerator
GENERIC
PERPENDICULAR_TO_SAMPLE
PERPENDICULAR_TO_DIRECT_BEAM
PERPENDICULAR_TO_REFLECTED_BEAM
PERPENDICULAR_TO_REFLECTED_BEAM_DPOS

Definition at line 28 of file RectangularDetector.h.

                              {
        GENERIC,
        PERPENDICULAR_TO_SAMPLE,
        PERPENDICULAR_TO_DIRECT_BEAM,
        PERPENDICULAR_TO_REFLECTED_BEAM,
        PERPENDICULAR_TO_REFLECTED_BEAM_DPOS
    };

Constructor & Destructor Documentation

RectangularDetector() [1/2]

RectangularDetector::RectangularDetector	(	size_t	nxbins,
		double	width,
		size_t	nybins,
		double	height
	)

Rectangular detector constructor.

Parameters

nxbins	Number of bins (pixels) in x-direction
width	Width of the detector in mm along x-direction
nybins	Number of bins (pixels) in y-direction
height	Height of the detector in mm along y-direction

Definition at line 27 of file RectangularDetector.cpp.

    : m_u0(0.0)
    , m_v0(0.0)
    , m_direction(R3(0.0, -1.0, 0.0))
    , m_distance(0.0)
    , m_dbeam_u0(0.0)
    , m_dbeam_v0(0.0)
    , m_detector_arrangement(GENERIC)
{
    setDetectorParameters(nxbins, 0.0, width, nybins, 0.0, height);
}

References height(), IDetector::setDetectorParameters(), and width().

Referenced by clone().

Here is the call graph for this function:

RectangularDetector() [2/2]

RectangularDetector::RectangularDetector ( const RectangularDetector &  other )

default

~RectangularDetector()

RectangularDetector::~RectangularDetector ( )

overridedefault

Member Function Documentation

active_indices()

std::vector< size_t > IDetector::active_indices ( ) const

inherited

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 IDetector::iterateOverNonMaskedPoints().

Referenced by DetectorContext::setup_context().

Here is the call graph for this function:

addDetAxis()

void IDetector::addDetAxis ( const IAxis &  axis )

inherited

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 IDetector::axis(), IAxis::clone(), OwningVector< T >::emplace_back(), IDetector::m_axes, IDetector::m_detector_mask, and IDetector::rank().

Referenced by IDetector::setDetectorParameters().

Here is the call graph for this function:

addMask()

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

inherited

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 IDetector::m_detector_mask.

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

analyzer()

const PolFilter& IDetector::analyzer ( ) const

inlineinherited

Returns detection properties.

Definition at line 204 of file IDetector.h.

{ return m_polAnalyzer; }

References IDetector::m_polAnalyzer.

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

applyDetectorResolution()

void IDetector::applyDetectorResolution ( Datafield *  p_intensity_map ) const

inherited

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(), IDetector::detectorMask(), Datafield::frame(), IDetector::iterateOverNonMaskedPoints(), IDetector::m_detector_resolution, SimulationAreaIterator::roiIndex(), and Datafield::setVector().

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

Here is the call graph for this function:

axesClippedToRegionOfInterest()

OwningVector< IAxis > IDetector::axesClippedToRegionOfInterest ( ) const

inherited

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 IDetector::axis(), IAxis::clip(), OwningVector< T >::emplace_back(), IDetector::m_axes, IDetector::regionOfInterestBounds(), and OwningVector< T >::size().

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

Here is the call graph for this function:

axis()

const IAxis & IDetector::axis ( size_t  index ) const

inherited

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, IDetector::m_axes, and IDetector::rank().

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

Here is the call graph for this function:

axisBinIndex()

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

inherited

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, IDetector::m_axes, IDetector::rank(), and OwningVector< T >::size().

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

Here is the call graph for this function:

axisName()

std::string RectangularDetector::axisName ( size_t  index ) const

overrideprivatevirtual

Returns the name for the axis with given index.

Implements IDetector.

Definition at line 185 of file RectangularDetector.cpp.

{
    switch (index) {
    case 0:
        return "u";
    case 1:
        return "v";
    default:
        throw std::runtime_error(
            "RectangularDetector::getAxisName(size_t index) -> Error! index > 1");
    }
}

beginNonMaskedPoints()

SimulationAreaIterator IDetector::beginNonMaskedPoints ( ) const

inherited

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 IDetector::createDetectorIntensity(), and IDetector::iterateOverNonMaskedPoints().

Here is the call graph for this function:

beginRegionOfInterestPoints()

SimulationAreaIterator IDetector::beginRegionOfInterestPoints ( ) const

inherited

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 IDetector::iterateOverRegionOfInterest().

Here is the call graph for this function:

boundsOfExplicitRegionOfInterest()

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

protectedvirtualinherited

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, IDetector::m_explicitROI, and IDetector::rank().

Referenced by IDetector::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()

std::string RectangularDetector::className ( ) const

inlinefinalvirtual

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

Implements INode.

Definition at line 47 of file RectangularDetector.h.

{ return "RectangularDetector"; }

clear()

void IDetector::clear ( )

protectedinherited

Definition at line 69 of file IDetector.cpp.

{
    m_axes.clear();
}

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

Referenced by IDetector::setDetectorParameters().

Here is the call graph for this function:

clone()

RectangularDetector * RectangularDetector::clone ( ) const

overridevirtual

Implements IDetector.

Definition at line 45 of file RectangularDetector.cpp.

{
    return new RectangularDetector(*this);
}

References RectangularDetector().

Here is the call graph for this function:

createContext()

std::unique_ptr< DetectorContext > IDetector::createContext ( ) const

inherited

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

inherited

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 IDetector::applyDetectorResolution(), ASSERT, IDetector::beginNonMaskedPoints(), IDetector::createDetectorMap(), IDetector::endNonMaskedPoints(), and IDetector::m_detector_resolution.

Here is the call graph for this function:

createDetectorMap()

std::unique_ptr< Datafield > IDetector::createDetectorMap ( ) const

inherited

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, IDetector::axis(), IAxis::clip(), IAxis::clone(), IDetector::rank(), and IDetector::regionOfInterestBounds().

Referenced by IDetector::createDetectorIntensity().

Here is the call graph for this function:

createPixel()

IPixel * RectangularDetector::createPixel ( size_t  index ) const

overrideprivatevirtual

Creates an IPixel for the given Datafield object and index.

Implements IDetector.

Definition at line 169 of file RectangularDetector.cpp.

{
    const IAxis& u_axis = axis(0);
    const IAxis& v_axis = axis(1);
    const size_t u_index = axisBinIndex(index, 0);
    const size_t v_index = axisBinIndex(index, 1);
 
    const Bin1D u_bin = u_axis.bin(u_index);
    const Bin1D v_bin = v_axis.bin(v_index);
    const R3 corner_position(m_normal_to_detector + (u_bin.m_lower - m_u0) * m_u_unit
                             + (v_bin.m_lower - m_v0) * m_v_unit);
    const R3 width = u_bin.binSize() * m_u_unit;
    const R3 height = v_bin.binSize() * m_v_unit;
    return new RectangularPixel(corner_position, width, height);
}

References IDetector::axis(), IDetector::axisBinIndex(), IAxis::bin(), Bin1D::binSize(), height(), Bin1D::m_lower, m_normal_to_detector, m_u0, m_u_unit, m_v0, m_v_unit, and width().

Here is the call graph for this function:

defaultCoords()

Coords RectangularDetector::defaultCoords ( ) const

inlineoverridevirtual

Returns default axes units.

Implements IDetector.

Definition at line 74 of file RectangularDetector.h.

{ return Coords::MM; }

References MM.

detectorIndexToRegionOfInterestIndex()

size_t IDetector::detectorIndexToRegionOfInterestIndex ( size_t  detectorIndex ) const

inherited

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 IDetector::m_explicitROI.

detectorMask()

const DetectorMask * IDetector::detectorMask ( ) const

inherited

Definition at line 372 of file IDetector.cpp.

{
    return m_detector_mask.get();
}

References IDetector::m_detector_mask.

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

detectorResolution()

const IDetectorResolution * IDetector::detectorResolution ( ) const

inherited

Returns a pointer to detector resolution object.

Definition at line 186 of file IDetector.cpp.

{
    return m_detector_resolution.get();
}

References IDetector::m_detector_resolution.

endNonMaskedPoints()

SimulationAreaIterator IDetector::endNonMaskedPoints ( ) const

inherited

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 IDetector::createDetectorIntensity(), and IDetector::iterateOverNonMaskedPoints().

Here is the call graph for this function:

endRegionOfInterestPoints()

SimulationAreaIterator IDetector::endRegionOfInterestPoints ( ) const

inherited

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 IDetector::iterateOverRegionOfInterest().

Here is the call graph for this function:

getDetectorArrangment()

RectangularDetector::EDetectorArrangement RectangularDetector::getDetectorArrangment

(

)

const

Definition at line 147 of file RectangularDetector.cpp.

{
    return m_detector_arrangement;
}

References m_detector_arrangement.

getDirectBeamU0()

double RectangularDetector::getDirectBeamU0

(

)

const

Definition at line 137 of file RectangularDetector.cpp.

{
    return m_dbeam_u0;
}

References m_dbeam_u0.

getDirectBeamV0()

double RectangularDetector::getDirectBeamV0

(

)

const

Definition at line 142 of file RectangularDetector.cpp.

{
    return m_dbeam_v0;
}

References m_dbeam_v0.

getDirectionVector()

R3 RectangularDetector::getDirectionVector

(

)

const

Definition at line 127 of file RectangularDetector.cpp.

{
    return m_direction;
}

References m_direction.

getDistance()

double RectangularDetector::getDistance

(

)

const

Definition at line 132 of file RectangularDetector.cpp.

{
    return m_distance;
}

References m_distance.

getGlobalIndex()

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

protectedinherited

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 IDetector::axis(), IDetector::rank(), IAxis::size(), and IDetector::totalSize().

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

Here is the call graph for this function:

getNormalVector()

R3 RectangularDetector::getNormalVector

(

)

const

Definition at line 112 of file RectangularDetector.cpp.

{
    return m_normal_to_detector;
}

References m_normal_to_detector.

getU0()

double RectangularDetector::getU0

(

)

const

Definition at line 117 of file RectangularDetector.cpp.

{
    return m_u0;
}

References m_u0.

getV0()

double RectangularDetector::getV0

(

)

const

Definition at line 122 of file RectangularDetector.cpp.

{
    return m_v0;
}

References m_v0.

hasExplicitRegionOfInterest()

bool IDetector::hasExplicitRegionOfInterest ( ) const

inherited

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(), IDetector::m_axes, IDetector::m_explicitROI, and OwningVector< T >::size().

Here is the call graph for this function:

height()

double RectangularDetector::height

(

)

const

Definition at line 97 of file RectangularDetector.cpp.

{
    return axis(1).span();
}

References IDetector::axis(), and IAxis::span().

Referenced by RectangularDetector(), createPixel(), and regionOfInterestPixel().

Here is the call graph for this function:

indexOfSpecular()

size_t RectangularDetector::indexOfSpecular ( const Beam &  beam ) const

overrideprivatevirtual

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.

Implements IDetector.

Definition at line 198 of file RectangularDetector.cpp.

{
    if (rank() != 2)
        return totalSize();
    const double alpha = beam.direction().alpha();
    const double phi = beam.direction().phi();
    const R3 k_spec = vecOfLambdaAlphaPhi(beam.wavelength(), alpha, phi);
    const R3 normal_unit = m_normal_to_detector.unit();
    const double kd = k_spec.dot(normal_unit);
    if (kd <= 0.0)
        return totalSize();
    ASSERT(m_distance != 0);
    const R3 rpix = k_spec * (m_distance / kd);
    const double u = rpix.dot(m_u_unit) + m_u0;
    const double v = rpix.dot(m_v_unit) + m_v0;
    const IAxis& u_axis = axis(0); // the x axis, GISAS only
    const IAxis& v_axis = axis(1); // the y axis, in reflectometer plane
    if (!u_axis.contains(u) || !v_axis.contains(v))
        return totalSize();
    return getGlobalIndex(u_axis.findClosestIndex(u), v_axis.findClosestIndex(v));
}

References Direction::alpha(), ASSERT, IDetector::axis(), IAxis::contains(), Beam::direction(), IAxis::findClosestIndex(), IDetector::getGlobalIndex(), m_distance, m_normal_to_detector, m_u0, m_u_unit, m_v0, m_v_unit, Direction::phi(), IDetector::rank(), IDetector::totalSize(), vecOfLambdaAlphaPhi(), and Beam::wavelength().

Here is the call graph for this function:

initNormalVector()

void RectangularDetector::initNormalVector ( R3  central_k )

private

Definition at line 233 of file RectangularDetector.cpp.

{
    R3 central_k_unit = central_k.unit();
 
    if (m_detector_arrangement == GENERIC) {
        // do nothing
    }
 
    else if (m_detector_arrangement == PERPENDICULAR_TO_SAMPLE)
        m_normal_to_detector = R3(m_distance, 0.0, 0.0);
 
 
    else if (m_detector_arrangement == PERPENDICULAR_TO_DIRECT_BEAM)
        m_normal_to_detector = m_distance * central_k_unit;
 
 
    else if (m_detector_arrangement == PERPENDICULAR_TO_REFLECTED_BEAM
             || m_detector_arrangement == PERPENDICULAR_TO_REFLECTED_BEAM_DPOS) {
        m_normal_to_detector = m_distance * central_k_unit;
        m_normal_to_detector.setZ(-m_normal_to_detector.z());
    }
 
    else
        throw std::runtime_error("RectangularDetector::init() -> Unknown detector arrangement");
}

References GENERIC, m_detector_arrangement, m_distance, m_normal_to_detector, PERPENDICULAR_TO_DIRECT_BEAM, PERPENDICULAR_TO_REFLECTED_BEAM, PERPENDICULAR_TO_REFLECTED_BEAM_DPOS, and PERPENDICULAR_TO_SAMPLE.

Referenced by setDetectorNormal().

initUandV()

void RectangularDetector::initUandV ( double  alpha_i )

private

Definition at line 259 of file RectangularDetector.cpp.

{
    double d2 = m_normal_to_detector.dot(m_normal_to_detector);
    R3 u_direction =
        d2 * m_direction - m_direction.dot(m_normal_to_detector) * m_normal_to_detector;
    m_u_unit = u_direction.unit();
    m_v_unit = m_u_unit.cross(m_normal_to_detector).unit();
 
    if (m_detector_arrangement == PERPENDICULAR_TO_REFLECTED_BEAM_DPOS) {
        R3 z(0.0, 0.0, 1.0);
        R3 normal_unit = m_normal_to_detector.unit();
        R3 zp = z - z.dot(normal_unit) * normal_unit;
        double uz = zp.dot(m_u_unit) / zp.mag();
        double vz = zp.dot(m_v_unit) / zp.mag();
        m_u0 = m_dbeam_u0 + m_distance * std::tan(2 * alpha_i) * uz;
        m_v0 = m_dbeam_v0 + m_distance * std::tan(2 * alpha_i) * vz;
    }
}

References m_dbeam_u0, m_dbeam_v0, m_detector_arrangement, m_direction, m_distance, m_normal_to_detector, m_u0, m_u_unit, m_v0, m_v_unit, and PERPENDICULAR_TO_REFLECTED_BEAM_DPOS.

Referenced by setDetectorNormal().

iterateOverNonMaskedPoints()

void IDetector::iterateOverNonMaskedPoints ( std::function< void(const_iterator)>  func ) const

inherited

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 IDetector::beginNonMaskedPoints(), IDetector::endNonMaskedPoints(), and IDetector::rank().

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

Here is the call graph for this function:

iterateOverRegionOfInterest()

void IDetector::iterateOverRegionOfInterest ( std::function< void(const_iterator)>  func ) const

inherited

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 IDetector::beginRegionOfInterestPoints(), IDetector::endRegionOfInterestPoints(), and IDetector::rank().

Referenced by ScatteringSimulation::intensityMapSize().

Here is the call graph for this function:

maskAll()

void IDetector::maskAll ( )

inherited

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 IDetector::addMask(), and IDetector::rank().

Referenced by ISimulation2D::maskAll().

Here is the call graph for this function:

nodeChildren()

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

overridevirtualinherited

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 IDetector::m_detector_resolution, and IDetector::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

inherited

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 IDetector::iterateOverNonMaskedPoints().

Here is the call graph for this function:

offspecCoords()

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

overridevirtual

Implements IDetector.

Definition at line 278 of file RectangularDetector.cpp.

{
    const auto axes = axesClippedToRegionOfInterest();
    ASSERT(axes.size() == 2);
    const IAxis& yAxis = *axes[1];
 
    std::unique_ptr<RectangularPixel> det_pixel(regionOfInterestPixel());
    IAxis* alpha_f_axis = det_pixel->createAxis(yAxis.size());
 
    OwningVector<IAxis> axes2({beamAxis, alpha_f_axis});
    return new OffspecCoordinates(axes2, beamDirection);
}

References ASSERT, IDetector::axesClippedToRegionOfInterest(), regionOfInterestPixel(), and IAxis::size().

Here is the call graph for this function:

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

inherited

Returns number of defined axes.

Definition at line 64 of file IDetector.cpp.

{
    return m_axes.size();
}

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

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

Here is the call graph for this function:

regionOfInterestBounds()

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

inherited

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, IDetector::boundsOfExplicitRegionOfInterest(), IDetector::m_axes, and OwningVector< T >::size().

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

Here is the call graph for this function:

regionOfInterestIndexToDetectorIndex()

size_t IDetector::regionOfInterestIndexToDetectorIndex ( size_t  regionOfInterestIndex ) const

inherited

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 IDetector::m_explicitROI.

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

regionOfInterestPixel()

RectangularPixel * RectangularDetector::regionOfInterestPixel

(

)

const

Definition at line 152 of file RectangularDetector.cpp.

{
    const auto uAxisBoundsROI = regionOfInterestBounds(0);
    const auto vAxisBoundsROI = regionOfInterestBounds(1);
 
    const double u_min = uAxisBoundsROI.first;
    const double v_min = vAxisBoundsROI.first;
    const double width = uAxisBoundsROI.second - uAxisBoundsROI.first;
    const double height = vAxisBoundsROI.second - vAxisBoundsROI.first;
 
    const R3 corner_position(m_normal_to_detector + (u_min - m_u0) * m_u_unit
                             + (v_min - m_v0) * m_v_unit);
    const R3 uaxis_vector = width * m_u_unit;
    const R3 vaxis_vector = height * m_v_unit;
    return new RectangularPixel(corner_position, uaxis_vector, vaxis_vector);
}

References height(), m_normal_to_detector, m_u0, m_u_unit, m_v0, m_v_unit, IDetector::regionOfInterestBounds(), and width().

Referenced by offspecCoords(), and scatteringCoords().

Here is the call graph for this function:

resetRegionOfInterest()

void IDetector::resetRegionOfInterest ( )

inherited

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

Definition at line 164 of file IDetector.cpp.

{
    m_explicitROI.clear();
}

References IDetector::m_explicitROI.

scatteringCoords()

CoordSystem2D * RectangularDetector::scatteringCoords ( const Beam &  beam ) const

overridevirtual

Implements IDetector.

Definition at line 292 of file RectangularDetector.cpp.

{
    return new ImageCoords(axesClippedToRegionOfInterest(), regionOfInterestPixel(),
                           beam.direction(), beam.wavelength());
}

References IDetector::axesClippedToRegionOfInterest(), Beam::direction(), regionOfInterestPixel(), and Beam::wavelength().

Here is the call graph for this function:

setAnalyzer()

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

inherited

Sets the polarization analyzer characteristics of the detector.

Definition at line 147 of file IDetector.cpp.

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

References IDetector::m_polAnalyzer.

setDetectorNormal()

void RectangularDetector::setDetectorNormal ( const Direction &  )

overridevirtual

Inits detector with the beam settings.

Reimplemented from IDetector.

Definition at line 50 of file RectangularDetector.cpp.

{
    initNormalVector(direction.vector());
    initUandV(-direction.alpha());
}

References Direction::alpha(), initNormalVector(), initUandV(), and Direction::vector().

Here is the call graph for this function:

setDetectorParameters()

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

inherited

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 IDetector::addDetAxis(), IDetector::axisName(), and IDetector::clear().

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

Here is the call graph for this function:

setDetectorPosition()

void RectangularDetector::setDetectorPosition	(	R3	normal_to_detector,
		double	u0,
		double	v0,
		R3	direction = R3(0.0, -1.0, 0.0)
	)

Definition at line 56 of file RectangularDetector.cpp.

{
    m_detector_arrangement = GENERIC;
    m_normal_to_detector = normal_to_detector;
    m_distance = m_normal_to_detector.mag();
    m_u0 = u0;
    m_v0 = v0;
    m_direction = direction;
}

References GENERIC, m_detector_arrangement, m_direction, m_distance, m_normal_to_detector, m_u0, and m_v0.

setDetectorResolution()

void IDetector::setDetectorResolution ( const IDetectorResolution &  p_detector_resolution )

inherited

Sets the detector resolution.

Definition at line 152 of file IDetector.cpp.

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

References IDetectorResolution::clone(), and IDetector::m_detector_resolution.

Referenced by IDetector::IDetector(), and IDetector::setResolutionFunction().

Here is the call graph for this function:

setDirectBeamPosition()

void RectangularDetector::setDirectBeamPosition	(	double	u0,
		double	v0
	)

Definition at line 85 of file RectangularDetector.cpp.

{
    m_detector_arrangement = PERPENDICULAR_TO_REFLECTED_BEAM_DPOS;
    m_dbeam_u0 = u0;
    m_dbeam_v0 = v0;
}

References m_dbeam_u0, m_dbeam_v0, m_detector_arrangement, and PERPENDICULAR_TO_REFLECTED_BEAM_DPOS.

setDistanceAndOffset()

void RectangularDetector::setDistanceAndOffset ( double  distance, double  u0, double  v0  )

private

Definition at line 220 of file RectangularDetector.cpp.

{
    if (distance <= 0.0) {
        std::ostringstream message;
        message << "RectangularDetector::setPerpendicularToSample() -> Error. "
                << "Distance to sample can't be negative or zero";
        throw std::runtime_error(message.str());
    }
    m_distance = distance;
    m_u0 = u0;
    m_v0 = v0;
}

References m_distance, m_u0, and m_v0.

Referenced by setPerpendicularToDirectBeam(), setPerpendicularToReflectedBeam(), and setPerpendicularToSampleX().

setPerpendicularToDirectBeam()

void RectangularDetector::setPerpendicularToDirectBeam	(	double	distance,
		double	u0,
		double	v0
	)

Definition at line 73 of file RectangularDetector.cpp.

{
    m_detector_arrangement = PERPENDICULAR_TO_DIRECT_BEAM;
    setDistanceAndOffset(distance, u0, v0);
}

References m_detector_arrangement, PERPENDICULAR_TO_DIRECT_BEAM, and setDistanceAndOffset().

Here is the call graph for this function:

setPerpendicularToReflectedBeam()

void RectangularDetector::setPerpendicularToReflectedBeam	(	double	distance,
		double	u0 = 0.0,
		double	v0 = 0.0
	)

Definition at line 79 of file RectangularDetector.cpp.

{
    m_detector_arrangement = PERPENDICULAR_TO_REFLECTED_BEAM;
    setDistanceAndOffset(distance, u0, v0);
}

References m_detector_arrangement, PERPENDICULAR_TO_REFLECTED_BEAM, and setDistanceAndOffset().

Here is the call graph for this function:

setPerpendicularToSampleX()

void RectangularDetector::setPerpendicularToSampleX	(	double	distance,
		double	u0,
		double	v0
	)

Definition at line 67 of file RectangularDetector.cpp.

{
    m_detector_arrangement = PERPENDICULAR_TO_SAMPLE;
    setDistanceAndOffset(distance, u0, v0);
}

References m_detector_arrangement, PERPENDICULAR_TO_SAMPLE, and setDistanceAndOffset().

Here is the call graph for this function:

setRegionOfInterest()

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

inherited

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, IDetector::axis(), IDetector::m_explicitROI, and IDetector::rank().

Referenced by ISimulation2D::setRegionOfInterest().

Here is the call graph for this function:

setResolutionFunction()

void IDetector::setResolutionFunction ( const IResolutionFunction2D &  resFunc )

inherited

Definition at line 158 of file IDetector.cpp.

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

References IDetector::setDetectorResolution().

Here is the call graph for this function:

sizeOfExplicitRegionOfInterest()

size_t IDetector::sizeOfExplicitRegionOfInterest ( ) const

protectedvirtualinherited

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 IDetector::m_axes, IDetector::m_explicitROI, and OwningVector< T >::size().

Referenced by IDetector::sizeOfRegionOfInterest().

Here is the call graph for this function:

sizeOfRegionOfInterest()

size_t IDetector::sizeOfRegionOfInterest ( ) const

inherited

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 IDetector::sizeOfExplicitRegionOfInterest(), and IDetector::totalSize().

Referenced by SimulationAreaIterator::createEnd().

Here is the call graph for this function:

swapContent()

void RectangularDetector::swapContent ( RectangularDetector &  other )

private

swap function

totalSize()

size_t IDetector::totalSize ( ) const

inherited

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 IDetector::m_axes, and IDetector::rank().

Referenced by IDetector::getGlobalIndex(), indexOfSpecular(), SphericalDetector::indexOfSpecular(), and IDetector::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.

width()

double RectangularDetector::width

(

)

const

Definition at line 92 of file RectangularDetector.cpp.

{
    return axis(0).span();
}

References IDetector::axis(), and IAxis::span().

Referenced by RectangularDetector(), createPixel(), and regionOfInterestPixel().

Here is the call graph for this function:

xSize()

size_t RectangularDetector::xSize

(

)

const

Definition at line 102 of file RectangularDetector.cpp.

{
    return axis(0).size();
}

References IDetector::axis(), and IAxis::size().

Here is the call graph for this function:

ySize()

size_t RectangularDetector::ySize

(

)

const

Definition at line 107 of file RectangularDetector.cpp.

{
    return axis(1).size();
}

References IDetector::axis(), and IAxis::size().

Here is the call graph for this function:

Member Data Documentation

m_axes

OwningVector<IAxis> IDetector::m_axes

privateinherited

Definition at line 248 of file IDetector.h.

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

m_dbeam_u0

double RectangularDetector::m_dbeam_u0

private

Definition at line 103 of file RectangularDetector.h.

Referenced by getDirectBeamU0(), initUandV(), and setDirectBeamPosition().

m_dbeam_v0

double RectangularDetector::m_dbeam_v0

private

position of direct beam in detector coordinates

Definition at line 103 of file RectangularDetector.h.

Referenced by getDirectBeamV0(), initUandV(), and setDirectBeamPosition().

m_detector_arrangement

EDetectorArrangement RectangularDetector::m_detector_arrangement

private

Definition at line 104 of file RectangularDetector.h.

Referenced by getDetectorArrangment(), initNormalVector(), initUandV(), setDetectorPosition(), setDirectBeamPosition(), setPerpendicularToDirectBeam(), setPerpendicularToReflectedBeam(), and setPerpendicularToSampleX().

m_detector_mask

std::shared_ptr<DetectorMask> IDetector::m_detector_mask

privateinherited

Definition at line 251 of file IDetector.h.

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

m_detector_resolution

std::unique_ptr<IDetectorResolution> IDetector::m_detector_resolution

privateinherited

Definition at line 250 of file IDetector.h.

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

m_direction

R3 RectangularDetector::m_direction

private

direction vector of detector coordinate system

Definition at line 101 of file RectangularDetector.h.

Referenced by getDirectionVector(), initUandV(), and setDetectorPosition().

m_distance

double RectangularDetector::m_distance

private

distance from sample origin to the detector plane

Definition at line 102 of file RectangularDetector.h.

Referenced by getDistance(), indexOfSpecular(), initNormalVector(), initUandV(), setDetectorPosition(), and setDistanceAndOffset().

m_explicitROI

std::vector<RoiOfAxis> IDetector::m_explicitROI

protectedinherited

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 IDetector::boundsOfExplicitRegionOfInterest(), IDetector::detectorIndexToRegionOfInterestIndex(), IDetector::hasExplicitRegionOfInterest(), IDetector::regionOfInterestIndexToDetectorIndex(), IDetector::resetRegionOfInterest(), IDetector::setRegionOfInterest(), and IDetector::sizeOfExplicitRegionOfInterest().

m_normal_to_detector

R3 RectangularDetector::m_normal_to_detector

private

Definition at line 99 of file RectangularDetector.h.

Referenced by createPixel(), getNormalVector(), indexOfSpecular(), initNormalVector(), initUandV(), regionOfInterestPixel(), and setDetectorPosition().

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

privateinherited

Definition at line 249 of file IDetector.h.

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

m_u0

double RectangularDetector::m_u0

private

Definition at line 100 of file RectangularDetector.h.

Referenced by createPixel(), getU0(), indexOfSpecular(), initUandV(), regionOfInterestPixel(), setDetectorPosition(), and setDistanceAndOffset().

m_u_unit

R3 RectangularDetector::m_u_unit

private

Definition at line 105 of file RectangularDetector.h.

Referenced by createPixel(), indexOfSpecular(), initUandV(), and regionOfInterestPixel().

m_v0

double RectangularDetector::m_v0

private

position of normal vector hitting point in detector coordinates

Definition at line 100 of file RectangularDetector.h.

Referenced by createPixel(), getV0(), indexOfSpecular(), initUandV(), regionOfInterestPixel(), setDetectorPosition(), and setDistanceAndOffset().

m_v_unit

R3 RectangularDetector::m_v_unit

private

Definition at line 106 of file RectangularDetector.h.

Referenced by createPixel(), indexOfSpecular(), initUandV(), and regionOfInterestPixel().

---

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

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