RectangularDetector Class Reference

Inheritance diagram for RectangularDetector:

Collaboration diagram for RectangularDetector:

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

Public Member Functions
	RectangularDetector (size_t nxbins, double width, size_t nybins, double height)
	RectangularDetector (const RectangularDetector &other)
RectangularDetector *	clone () const override
void	accept (INodeVisitor *visitor) const final
	~RectangularDetector ()
void	init (const Beam &beam) override
void	setPosition (const kvector_t normal_to_detector, double u0, double v0, const kvector_t direction=kvector_t(0.0, -1.0, 0.0))
void	setPerpendicularToSampleX (double distance, 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	setDirectBeamPosition (double u0, double v0)
double	getWidth () const
double	getHeight () const
size_t	getNbinsX () const
size_t	getNbinsY () const
kvector_t	getNormalVector () const
double	getU0 () const
double	getV0 () const
kvector_t	getDirectionVector () const
double	getDistance () const
double	getDirectBeamU0 () const
double	getDirectBeamV0 () const
EDetectorArrangement	getDetectorArrangment () const
Axes::Units	defaultAxesUnits () const override
RectangularPixel *	regionOfInterestPixel () const
void	setDetectorParameters (size_t n_x, double x_min, double x_max, size_t n_y, double y_min, double y_max)
void	removeMasks ()
const DetectorMask *	detectorMask () const override
void	addMask (const IShape2D &shape, bool mask_value=true)
void	maskAll ()
const RegionOfInterest *	regionOfInterest () const override
void	setRegionOfInterest (double xlow, double ylow, double xup, double yup)
void	resetRegionOfInterest () override
std::vector< size_t >	active_indices () const
std::unique_ptr< DetectorContext >	createContext () const
void	addAxis (const IAxis &axis)
const IAxis &	getAxis (size_t index) const
size_t	dimension () const
size_t	axisBinIndex (size_t index, size_t selected_axis) const
size_t	totalSize () const
void	setAnalyzerProperties (const kvector_t direction, double efficiency, double total_transmission)
void	setDetectorResolution (const IDetectorResolution &p_detector_resolution)
void	setResolutionFunction (const IResolutionFunction2D &resFunc)
void	applyDetectorResolution (OutputData< double > *p_intensity_map) const
void	removeDetectorResolution ()
const IDetectorResolution *	detectorResolution () const
std::unique_ptr< OutputData< double > >	createDetectorMap () const
const DetectionProperties &	detectionProperties () const
OutputData< double > *	createDetectorIntensity (const std::vector< SimulationElement > &elements) const
size_t	numberOfSimulationElements () const
std::vector< const INode * >	getChildren () const override
void	iterate (std::function< void(const_iterator)> func, bool visit_masks=false) const
virtual void	transferToCPP ()
virtual std::string	treeToString () const
void	registerChild (INode *node)
virtual void	setParent (const INode *newParent)
const INode *	parent () const
INode *	parent ()
int	copyNumber (const INode *node) const
std::string	displayName () const
ParameterPool *	createParameterTree () const
ParameterPool *	parameterPool () const
std::string	parametersToString () const
RealParameter &	registerParameter (const std::string &name, double *parpointer)
void	registerVector (const std::string &base_name, kvector_t *p_vec, const std::string &units="nm")
void	setParameterValue (const std::string &name, double value)
void	setVectorValue (const std::string &base_name, kvector_t value)
RealParameter *	parameter (const std::string &name) const
virtual void	onChange ()
void	removeParameter (const std::string &name)
void	removeVector (const std::string &base_name)
void	setName (const std::string &name)
const std::string &	getName () const

Static Public Member Functions
static std::string	XComponentName (const std::string &base_name)
static std::string	YComponentName (const std::string &base_name)
static std::string	ZComponentName (const std::string &base_name)

Protected Member Functions
IPixel *	createPixel (size_t index) const override
std::string	axisName (size_t index) const override
size_t	indexOfSpecular (const Beam &beam) const override
void	swapContent (RectangularDetector &other)
size_t	getGlobalIndex (size_t x, size_t y) const
void	clear ()
virtual std::unique_ptr< IAxis >	createAxis (size_t index, size_t n_bins, double min, double max) const

Protected Attributes
const size_t	m_NP
std::vector< double >	m_P

Private Member Functions
void	setDistanceAndOffset (double distance, double u0, double v0)
void	initNormalVector (const kvector_t central_k)
void	initUandV (double alpha_i)
void	setDataToDetectorMap (OutputData< double > &detectorMap, const std::vector< SimulationElement > &elements) const

Private Attributes
kvector_t	m_normal_to_detector
double	m_u0
double	m_v0
kvector_t	m_direction
double	m_distance
double	m_dbeam_u0
double	m_dbeam_v0
EDetectorArrangement	m_detector_arrangement
kvector_t	m_u_unit
kvector_t	m_v_unit
DetectorMask	m_detector_mask
std::unique_ptr< RegionOfInterest >	m_region_of_interest
CloneableVector< IAxis >	m_axes
DetectionProperties	m_detection_properties
std::unique_ptr< IDetectorResolution >	mP_detector_resolution
const INode *	m_parent {nullptr}
std::string	m_name
std::unique_ptr< ParameterPool >	m_pool

Detailed Description

A flat rectangular detector with axes and resolution function.

Definition at line 26 of file RectangularDetector.h.

Member Typedef Documentation

const_iterator

using IDetector::const_iterator = const SimulationAreaIterator&

inherited

Definition at line 38 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 29 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 24 of file RectangularDetector.cpp.

    : m_u0(0.0), m_v0(0.0), m_direction(kvector_t(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);
    setName("RectangularDetector");
}

References anonymous_namespace{BoxCompositionBuilder.cpp}::height, IDetector2D::setDetectorParameters(), IParameterized::setName(), and anonymous_namespace{BoxCompositionBuilder.cpp}::width.

Referenced by clone().

Here is the call graph for this function:

RectangularDetector() [2/2]

RectangularDetector::RectangularDetector

(

const RectangularDetector &

other

)

Definition at line 32 of file RectangularDetector.cpp.

    : IDetector2D(other), m_normal_to_detector(other.m_normal_to_detector), m_u0(other.m_u0),
      m_v0(other.m_v0), m_direction(other.m_direction), m_distance(other.m_distance),
      m_dbeam_u0(other.m_dbeam_u0), m_dbeam_v0(other.m_dbeam_v0),
      m_detector_arrangement(other.m_detector_arrangement), m_u_unit(other.m_u_unit),
      m_v_unit(other.m_v_unit)
{
    setName("RectangularDetector");
}

References IParameterized::setName().

Here is the call graph for this function:

~RectangularDetector()

RectangularDetector::~RectangularDetector ( )

default

Member Function Documentation

clone()

RectangularDetector * RectangularDetector::clone ( ) const

overridevirtual

Implements IDetector2D.

Definition at line 44 of file RectangularDetector.cpp.

{
    return new RectangularDetector(*this);
}

References RectangularDetector().

Here is the call graph for this function:

accept()

void RectangularDetector::accept ( INodeVisitor *  visitor ) const

inlinefinalvirtual

Calls the INodeVisitor's visit method.

Implements INode.

Definition at line 48 of file RectangularDetector.h.

{ visitor->visit(this); }

init()

void RectangularDetector::init ( const Beam &  )

overridevirtual

Inits detector with the beam settings.

Reimplemented from IDetector.

Definition at line 49 of file RectangularDetector.cpp.

{
    double alpha_i = beam.getAlpha();
    kvector_t central_k = beam.getCentralK();
    initNormalVector(central_k);
    initUandV(alpha_i);
}

References Beam::getAlpha(), Beam::getCentralK(), initNormalVector(), and initUandV().

Here is the call graph for this function:

setPosition()

void RectangularDetector::setPosition	(	const kvector_t	normal_to_detector,
		double	u0,
		double	v0,
		const kvector_t	direction = kvector_t(0.0, -1.0, 0.0)
	)

Definition at line 57 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, m_v0, and BasicVector3D< T >::mag().

Referenced by StandardSimulations::RectDetectorGeneric().

Here is the call graph for this function:

setPerpendicularToSampleX()

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

Definition at line 68 of file RectangularDetector.cpp.

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

References m_detector_arrangement, PERPENDICULAR_TO_SAMPLE, and setDistanceAndOffset().

Referenced by StandardSimulations::RectDetectorPerpToSample().

Here is the call graph for this function:

setPerpendicularToDirectBeam()

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

Definition at line 74 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().

Referenced by StandardSimulations::RectDetectorPerpToDirectBeam().

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 80 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().

Referenced by StandardSimulations::RectDetectorPerpToReflectedBeam(), and StandardSimulations::RectDetectorPerpToReflectedBeamDpos().

Here is the call graph for this function:

setDirectBeamPosition()

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

Definition at line 86 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.

Referenced by StandardSimulations::RectDetectorPerpToReflectedBeamDpos().

getWidth()

double RectangularDetector::getWidth

(

)

const

Definition at line 93 of file RectangularDetector.cpp.

{
    const IAxis& axis = getAxis(0);
    return axis.getMax() - axis.getMin();
}

References IDetector::getAxis(), IAxis::getMax(), and IAxis::getMin().

Referenced by regionOfInterestPixel().

Here is the call graph for this function:

getHeight()

double RectangularDetector::getHeight

(

)

const

Definition at line 99 of file RectangularDetector.cpp.

{
    const IAxis& axis = getAxis(1);
    return axis.getMax() - axis.getMin();
}

References IDetector::getAxis(), IAxis::getMax(), and IAxis::getMin().

Referenced by regionOfInterestPixel().

Here is the call graph for this function:

getNbinsX()

size_t RectangularDetector::getNbinsX

(

)

const

Definition at line 105 of file RectangularDetector.cpp.

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

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

Here is the call graph for this function:

getNbinsY()

size_t RectangularDetector::getNbinsY

(

)

const

Definition at line 110 of file RectangularDetector.cpp.

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

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

Here is the call graph for this function:

getNormalVector()

kvector_t RectangularDetector::getNormalVector

(

)

const

Definition at line 115 of file RectangularDetector.cpp.

{
    return m_normal_to_detector;
}

References m_normal_to_detector.

getU0()

double RectangularDetector::getU0

(

)

const

Definition at line 120 of file RectangularDetector.cpp.

{
    return m_u0;
}

References m_u0.

getV0()

double RectangularDetector::getV0

(

)

const

Definition at line 125 of file RectangularDetector.cpp.

{
    return m_v0;
}

References m_v0.

getDirectionVector()

kvector_t RectangularDetector::getDirectionVector

(

)

const

Definition at line 130 of file RectangularDetector.cpp.

{
    return m_direction;
}

References m_direction.

getDistance()

double RectangularDetector::getDistance

(

)

const

Definition at line 135 of file RectangularDetector.cpp.

{
    return m_distance;
}

References m_distance.

getDirectBeamU0()

double RectangularDetector::getDirectBeamU0

(

)

const

Definition at line 140 of file RectangularDetector.cpp.

{
    return m_dbeam_u0;
}

References m_dbeam_u0.

getDirectBeamV0()

double RectangularDetector::getDirectBeamV0

(

)

const

Definition at line 145 of file RectangularDetector.cpp.

{
    return m_dbeam_v0;
}

References m_dbeam_v0.

getDetectorArrangment()

RectangularDetector::EDetectorArrangement RectangularDetector::getDetectorArrangment

(

)

const

Definition at line 150 of file RectangularDetector.cpp.

{
    return m_detector_arrangement;
}

References m_detector_arrangement.

defaultAxesUnits()

Axes::Units RectangularDetector::defaultAxesUnits ( ) const

overridevirtual

return default axes units

Reimplemented from IDetector.

Definition at line 155 of file RectangularDetector.cpp.

{
    return Axes::Units::MM;
}

regionOfInterestPixel()

RectangularPixel * RectangularDetector::regionOfInterestPixel

(

)

const

Definition at line 160 of file RectangularDetector.cpp.

{
    const IAxis& u_axis = getAxis(0);
    const IAxis& v_axis = getAxis(1);
    double u_min, v_min, width, height;
    auto p_roi = regionOfInterest();
    if (p_roi) {
        u_min = p_roi->getXlow();
        v_min = p_roi->getYlow();
        width = p_roi->getXup() - p_roi->getXlow();
        height = p_roi->getYup() - p_roi->getYlow();
    } else {
        u_min = u_axis.getMin();
        v_min = v_axis.getMin();
        width = getWidth();
        height = getHeight();
    }
    const kvector_t corner_position(m_normal_to_detector + (u_min - m_u0) * m_u_unit
                                    + (v_min - m_v0) * m_v_unit);
    const kvector_t uaxis_vector = width * m_u_unit;
    const kvector_t vaxis_vector = height * m_v_unit;
    return new RectangularPixel(corner_position, uaxis_vector, vaxis_vector);
}

References IDetector::getAxis(), getHeight(), IAxis::getMin(), getWidth(), anonymous_namespace{BoxCompositionBuilder.cpp}::height, m_normal_to_detector, m_u0, m_u_unit, m_v0, m_v_unit, IDetector2D::regionOfInterest(), and anonymous_namespace{BoxCompositionBuilder.cpp}::width.

Referenced by RectangularConverter::RectangularConverter().

Here is the call graph for this function:

createPixel()

IPixel * RectangularDetector::createPixel ( size_t  index ) const

overrideprotectedvirtual

Creates an IPixel for the given OutputData object and index.

Implements IDetector2D.

Definition at line 184 of file RectangularDetector.cpp.

{
    const IAxis& u_axis = getAxis(0);
    const IAxis& v_axis = getAxis(1);
    const size_t u_index = axisBinIndex(index, 0);
    const size_t v_index = axisBinIndex(index, 1);
 
    const Bin1D u_bin = u_axis.getBin(u_index);
    const Bin1D v_bin = v_axis.getBin(v_index);
    const kvector_t 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 kvector_t width = u_bin.getBinSize() * m_u_unit;
    const kvector_t height = v_bin.getBinSize() * m_v_unit;
    return new RectangularPixel(corner_position, width, height);
}

References IDetector::axisBinIndex(), IDetector::getAxis(), IAxis::getBin(), Bin1D::getBinSize(), anonymous_namespace{BoxCompositionBuilder.cpp}::height, Bin1D::m_lower, m_normal_to_detector, m_u0, m_u_unit, m_v0, m_v_unit, and anonymous_namespace{BoxCompositionBuilder.cpp}::width.

Here is the call graph for this function:

axisName()

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

overrideprotectedvirtual

Returns the name for the axis with given index.

Implements IDetector.

Definition at line 200 of file RectangularDetector.cpp.

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

indexOfSpecular()

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

overrideprotectedvirtual

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

Definition at line 213 of file RectangularDetector.cpp.

{
    if (dimension() != 2)
        return totalSize();
    const double alpha = beam.getAlpha();
    const double phi = beam.getPhi();
    const kvector_t k_spec = vecOfLambdaAlphaPhi(beam.getWavelength(), alpha, phi);
    const kvector_t 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 kvector_t 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 = getAxis(0); // the x axis, GISAS only
    const IAxis& v_axis = getAxis(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 ASSERT, IAxis::contains(), IDetector::dimension(), BasicVector3D< T >::dot(), IAxis::findClosestIndex(), Beam::getAlpha(), IDetector::getAxis(), IDetector2D::getGlobalIndex(), Beam::getPhi(), Beam::getWavelength(), m_distance, m_normal_to_detector, m_u0, m_u_unit, m_v0, m_v_unit, IDetector::totalSize(), BasicVector3D< T >::unit(), and vecOfLambdaAlphaPhi().

Here is the call graph for this function:

swapContent()

void RectangularDetector::swapContent ( RectangularDetector &  other )

protected

swap function

setDistanceAndOffset()

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

private

Definition at line 235 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 Exceptions::LogicErrorException(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().

initNormalVector()

void RectangularDetector::initNormalVector ( const kvector_t  central_k )

private

Definition at line 248 of file RectangularDetector.cpp.

{
    kvector_t 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 = kvector_t(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 Exceptions::LogicErrorException(
            "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, PERPENDICULAR_TO_SAMPLE, BasicVector3D< T >::setZ(), BasicVector3D< T >::unit(), and BasicVector3D< T >::z().

Referenced by init().

Here is the call graph for this function:

initUandV()

void RectangularDetector::initUandV ( double  alpha_i )

private

Definition at line 276 of file RectangularDetector.cpp.

{
    double d2 = m_normal_to_detector.dot(m_normal_to_detector);
    kvector_t 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) {
        kvector_t z(0.0, 0.0, 1.0);
        kvector_t normal_unit = m_normal_to_detector.unit();
        kvector_t 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 BasicVector3D< T >::cross(), BasicVector3D< T >::dot(), 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, BasicVector3D< T >::mag(), PERPENDICULAR_TO_REFLECTED_BEAM_DPOS, and BasicVector3D< T >::unit().

Referenced by init().

Here is the call graph for this function:

setDetectorParameters()

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

inherited

Sets detector parameters using angle ranges.

Definition at line 35 of file IDetector2D.cpp.

{
    clear();
    addAxis(*createAxis(0, n_x, x_min, x_max));
    addAxis(*createAxis(1, n_y, y_min, y_max));
}

References IDetector::addAxis(), IDetector::clear(), and IDetector::createAxis().

Referenced by IsGISAXSDetector::IsGISAXSDetector(), StandardSimulations::IsGISAXSSimulation1(), StandardSimulations::IsGISAXSSimulation2(), RectangularDetector(), Simulation2D::setDetectorParameters(), and SphericalDetector::SphericalDetector().

Here is the call graph for this function:

removeMasks()

void IDetector2D::removeMasks ( )

inherited

Removes all masks from the detector.

Definition at line 74 of file IDetector2D.cpp.

{
    m_detector_mask.removeMasks();
}

References IDetector2D::m_detector_mask, and DetectorMask::removeMasks().

Referenced by Simulation2D::removeMasks().

Here is the call graph for this function:

detectorMask()

const DetectorMask * IDetector2D::detectorMask ( ) const

overridevirtualinherited

Returns detector masks container.

Implements IDetector.

Definition at line 93 of file IDetector2D.cpp.

{
    return &m_detector_mask;
}

References IDetector2D::m_detector_mask.

addMask()

void IDetector2D::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 79 of file IDetector2D.cpp.

{
    m_detector_mask.addMask(shape, mask_value);
    m_detector_mask.initMaskData(*this);
}

References DetectorMask::addMask(), DetectorMask::initMaskData(), and IDetector2D::m_detector_mask.

Referenced by Simulation2D::addMask(), and IDetector2D::maskAll().

Here is the call graph for this function:

maskAll()

void IDetector2D::maskAll ( )

inherited

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

Definition at line 85 of file IDetector2D.cpp.

{
    if (dimension() != 2)
        return;
    m_detector_mask.removeMasks();
    addMask(InfinitePlane(), true);
}

References IDetector2D::addMask(), IDetector::dimension(), IDetector2D::m_detector_mask, and DetectorMask::removeMasks().

Referenced by Simulation2D::maskAll().

Here is the call graph for this function:

regionOfInterest()

const RegionOfInterest * IDetector2D::regionOfInterest ( ) const

overridevirtualinherited

Returns region of interest if exists.

Implements IDetector.

Definition at line 43 of file IDetector2D.cpp.

{
    return m_region_of_interest.get();
}

References IDetector2D::m_region_of_interest.

Referenced by OffSpecularConverter::addDetectorYAxis(), IDetector2D::IDetector2D(), and regionOfInterestPixel().

setRegionOfInterest()

void IDetector2D::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 48 of file IDetector2D.cpp.

{
    m_region_of_interest = std::make_unique<RegionOfInterest>(*this, xlow, ylow, xup, yup);
    m_detector_mask.initMaskData(*this);
}

References DetectorMask::initMaskData(), IDetector2D::m_detector_mask, and IDetector2D::m_region_of_interest.

Referenced by Simulation2D::setRegionOfInterest().

Here is the call graph for this function:

resetRegionOfInterest()

void IDetector2D::resetRegionOfInterest ( )

overridevirtualinherited

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

Implements IDetector.

Definition at line 54 of file IDetector2D.cpp.

{
    m_region_of_interest.reset();
    m_detector_mask.initMaskData(*this);
}

References DetectorMask::initMaskData(), IDetector2D::m_detector_mask, and IDetector2D::m_region_of_interest.

Here is the call graph for this function:

active_indices()

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

inherited

Returns vector of unmasked detector indices.

Definition at line 60 of file IDetector2D.cpp.

{
    std::vector<size_t> result;
    SimulationArea area(this);
    for (SimulationArea::iterator it = area.begin(); it != area.end(); ++it)
        result.push_back(it.detectorIndex());
    return result;
}

References SimulationArea::begin(), and SimulationArea::end().

Referenced by DetectorContext::setup_context().

Here is the call graph for this function:

createContext()

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

inherited

Definition at line 69 of file IDetector2D.cpp.

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

Referenced by Simulation2D::prepareSimulation().

getGlobalIndex()

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

protectedinherited

Calculate global index from two axis indices.

Definition at line 98 of file IDetector2D.cpp.

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

References IDetector::dimension(), IDetector::getAxis(), IAxis::size(), and IDetector::totalSize().

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

Here is the call graph for this function:

addAxis()

void IDetector::addAxis ( const IAxis &  axis )

inherited

Definition at line 39 of file IDetector.cpp.

{
    m_axes.push_back(axis.clone());
}

References IAxis::clone(), IDetector::m_axes, and CloneableVector< T >::push_back().

Referenced by IDetector2D::setDetectorParameters(), and SpecularDetector1D::SpecularDetector1D().

Here is the call graph for this function:

getAxis()

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

inherited

Definition at line 54 of file IDetector.cpp.

{
    if (index < dimension())
        return *m_axes[index];
    throw std::runtime_error("Error in IDetector::getAxis: not so many axes in this detector.");
}

References IDetector::dimension(), and IDetector::m_axes.

Referenced by UnitConverterSimple::addDetectorAxis(), OffSpecularConverter::addDetectorYAxis(), IDetector::createDetectorMap(), createPixel(), SphericalDetector::createPixel(), anonymous_namespace{Simulation.cpp}::detHasSameDimensions(), IDetector2D::getGlobalIndex(), getHeight(), getNbinsX(), getNbinsY(), getWidth(), indexOfSpecular(), SphericalDetector::indexOfSpecular(), DetectorMask::initMaskData(), RegionOfInterest::RegionOfInterest(), and regionOfInterestPixel().

Here is the call graph for this function:

dimension()

size_t IDetector::dimension ( ) const

inherited

Returns actual dimensionality of the detector (number of defined axes)

Definition at line 44 of file IDetector.cpp.

{
    return m_axes.size();
}

References IDetector::m_axes.

Referenced by IDetector::axisBinIndex(), IDetector::createDetectorMap(), SimulationToPython::defineDetector(), anonymous_namespace{Simulation.cpp}::detHasSameDimensions(), IDetector::getAxis(), IDetector2D::getGlobalIndex(), indexOfSpecular(), SphericalDetector::indexOfSpecular(), DetectorMask::initMaskData(), IDetector::iterate(), IDetector2D::maskAll(), OffSpecularConverter::OffSpecularConverter(), RectangularConverter::RectangularConverter(), SimulationArea::SimulationArea(), SphericalConverter::SphericalConverter(), and IDetector::totalSize().

axisBinIndex()

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

inherited

Calculate axis index for given global index.

Definition at line 61 of file IDetector.cpp.

{
    const size_t dim = dimension();
    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();
    }
    throw std::runtime_error("IDetector::getAxisBinIndex() -> "
                             "Error! No axis with given number");
}

References IDetector::dimension(), and IDetector::m_axes.

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

Here is the call graph for this function:

totalSize()

size_t IDetector::totalSize ( ) const

inherited

Returns total number of pixels.

Definition at line 87 of file IDetector.cpp.

{
    const size_t dim = dimension();
    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::dimension(), and IDetector::m_axes.

Referenced by IDetector2D::getGlobalIndex(), IsGISAXSDetector::indexOfSpecular(), indexOfSpecular(), SphericalDetector::indexOfSpecular(), and SimulationArea::SimulationArea().

Here is the call graph for this function:

setAnalyzerProperties()

void IDetector::setAnalyzerProperties ( const kvector_t  direction, double  efficiency, double  total_transmission  )

inherited

Sets the polarization analyzer characteristics of the detector.

Definition at line 98 of file IDetector.cpp.

{
    m_detection_properties.setAnalyzerProperties(direction, efficiency, total_transmission);
}

References IDetector::m_detection_properties, and DetectionProperties::setAnalyzerProperties().

Here is the call graph for this function:

setDetectorResolution()

void IDetector::setDetectorResolution ( const IDetectorResolution &  p_detector_resolution )

inherited

Sets the detector resolution.

Definition at line 104 of file IDetector.cpp.

{
    mP_detector_resolution.reset(p_detector_resolution.clone());
    registerChild(mP_detector_resolution.get());
}

References IDetectorResolution::clone(), IDetector::mP_detector_resolution, and INode::registerChild().

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

Here is the call graph for this function:

setResolutionFunction()

void IDetector::setResolutionFunction ( const IResolutionFunction2D &  resFunc )

inherited

Definition at line 111 of file IDetector.cpp.

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

References IDetector::setDetectorResolution().

Here is the call graph for this function:

applyDetectorResolution()

void IDetector::applyDetectorResolution ( OutputData< double > *  p_intensity_map ) const

inherited

Applies the detector resolution to the given intensity maps.

Definition at line 117 of file IDetector.cpp.

{
    if (!p_intensity_map)
        throw std::runtime_error("IDetector::applyDetectorResolution() -> "
                                 "Error! Null pointer to intensity map");
    if (mP_detector_resolution) {
        mP_detector_resolution->applyDetectorResolution(p_intensity_map);
        if (detectorMask() && detectorMask()->hasMasks()) {
            // sets amplitude in masked areas to zero
            std::unique_ptr<OutputData<double>> buff(new OutputData<double>());
            buff->copyShapeFrom(*p_intensity_map);
 
            iterate([&](const_iterator it) {
                (*buff)[it.roiIndex()] = (*p_intensity_map)[it.roiIndex()];
            });
            p_intensity_map->setRawDataVector(buff->getRawDataVector());
        }
    }
}

References IDetector::detectorMask(), IDetector::iterate(), IDetector::mP_detector_resolution, SimulationAreaIterator::roiIndex(), and OutputData< T >::setRawDataVector().

Referenced by IDetector::createDetectorIntensity().

Here is the call graph for this function:

removeDetectorResolution()

void IDetector::removeDetectorResolution ( )

inherited

Removes detector resolution function.

Definition at line 137 of file IDetector.cpp.

{
    mP_detector_resolution.reset();
}

References IDetector::mP_detector_resolution.

detectorResolution()

const IDetectorResolution * IDetector::detectorResolution ( ) const

inherited

Returns a pointer to detector resolution object.

Definition at line 142 of file IDetector.cpp.

{
    return mP_detector_resolution.get();
}

References IDetector::mP_detector_resolution.

Referenced by SimulationToPython::defineDetectorResolutionFunction().

createDetectorMap()

std::unique_ptr< OutputData< double > > IDetector::createDetectorMap ( ) const

inherited

Returns empty detector map in given axes units.

Definition at line 162 of file IDetector.cpp.

{
    const size_t dim = dimension();
    if (dim == 0)
        throw std::runtime_error(
            "Error in IDetector::createDetectorMap: dimensions of the detector are undefined");
 
    std::unique_ptr<OutputData<double>> result(new OutputData<double>);
    for (size_t i = 0; i < dim; ++i)
        if (auto roi = regionOfInterest())
            result->addAxis(*roi->clipAxisToRoi(i, getAxis(i)));
        else
            result->addAxis(getAxis(i));
 
    return result;
}

References IDetector::dimension(), IDetector::getAxis(), and IDetector::regionOfInterest().

Referenced by IDetector::createDetectorIntensity().

Here is the call graph for this function:

detectionProperties()

const DetectionProperties& IDetector::detectionProperties ( ) const

inlineinherited

Returns detection properties.

Definition at line 93 of file IDetector.h.

{ return m_detection_properties; }

References IDetector::m_detection_properties.

Referenced by SimulationToPython::defineDetectorPolarizationAnalysis(), Simulation2D::generateSimulationElements(), anonymous_namespace{SpecularSimulation.cpp}::generateSimulationElements(), and DetectorContext::setup_context().

createDetectorIntensity()

OutputData< double > * IDetector::createDetectorIntensity ( const std::vector< SimulationElement > &  elements ) const

inherited

Returns new intensity map with detector resolution applied.

Map will be cropped to ROI if ROI is present.

Definition at line 148 of file IDetector.cpp.

{
    std::unique_ptr<OutputData<double>> detectorMap(createDetectorMap());
    if (!detectorMap)
        throw Exceptions::RuntimeErrorException("Instrument::createDetectorIntensity:"
                                                "can't create detector map.");
 
    setDataToDetectorMap(*detectorMap, elements);
    if (mP_detector_resolution)
        applyDetectorResolution(detectorMap.get());
 
    return detectorMap.release();
}

References IDetector::applyDetectorResolution(), IDetector::createDetectorMap(), IDetector::mP_detector_resolution, and IDetector::setDataToDetectorMap().

Here is the call graph for this function:

numberOfSimulationElements()

size_t IDetector::numberOfSimulationElements ( ) const

inherited

Returns number of simulation elements.

Definition at line 189 of file IDetector.cpp.

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

References IDetector::iterate().

Here is the call graph for this function:

getChildren()

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

overridevirtualinherited

Returns a vector of children (const).

Reimplemented from INode.

Definition at line 196 of file IDetector.cpp.

{
    return std::vector<const INode*>() << &m_detection_properties << mP_detector_resolution;
}

References IDetector::m_detection_properties, and IDetector::mP_detector_resolution.

iterate()

void IDetector::iterate ( std::function< void(const_iterator)>  func, bool  visit_masks = false  ) const

inherited

Definition at line 201 of file IDetector.cpp.

{
    if (this->dimension() == 0)
        return;
 
    if (visit_masks) {
        SimulationRoiArea area(this);
        for (SimulationRoiArea::iterator it = area.begin(); it != area.end(); ++it)
            func(it);
    } else {
        SimulationArea area(this);
        for (SimulationArea::iterator it = area.begin(); it != area.end(); ++it)
            func(it);
    }
}

References SimulationArea::begin(), IDetector::dimension(), and SimulationArea::end().

Referenced by IDetector::applyDetectorResolution(), Simulation::convertData(), GISASSimulation::intensityMapSize(), IDetector::numberOfSimulationElements(), and IDetector::setDataToDetectorMap().

Here is the call graph for this function:

clear()

void IDetector::clear ( )

protectedinherited

Definition at line 49 of file IDetector.cpp.

{
    m_axes.clear();
}

References IDetector::m_axes.

Referenced by IDetector2D::setDetectorParameters().

createAxis()

std::unique_ptr< IAxis > IDetector::createAxis ( size_t  index, size_t  n_bins, double  min, double  max  ) const

protectedvirtualinherited

Generates an axis with correct name and default binning for given index.

Reimplemented in IsGISAXSDetector.

Definition at line 76 of file IDetector.cpp.

{
    if (max <= min)
        throw Exceptions::LogicErrorException("IDetector::createAxis() -> Error! max <= min");
    if (n_bins == 0)
        throw Exceptions::LogicErrorException(
            "IDetector::createAxis() -> Error! Number n_bins can't be zero.");
    return std::make_unique<FixedBinAxis>(axisName(index), n_bins, min, max);
}

References IDetector::axisName().

Referenced by IDetector2D::setDetectorParameters().

Here is the call graph for this function:

setDataToDetectorMap()

void IDetector::setDataToDetectorMap ( OutputData< double > &  detectorMap, const std::vector< SimulationElement > &  elements  ) const

privateinherited

Definition at line 179 of file IDetector.cpp.

{
    if (elements.empty())
        return;
    iterate([&](const_iterator it) {
        detectorMap[it.roiIndex()] = elements[it.elementIndex()].getIntensity();
    });
}

References SimulationAreaIterator::elementIndex(), IDetector::iterate(), and SimulationAreaIterator::roiIndex().

Referenced by IDetector::createDetectorIntensity().

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 34 of file ICloneable.h.

treeToString()

std::string INode::treeToString ( ) const

virtualinherited

Returns multiline string representing tree structure below the node.

Definition at line 53 of file INode.cpp.

{
    return NodeUtils::nodeToString(*this);
}

References NodeUtils::nodeToString().

Here is the call graph for this function:

registerChild()

void INode::registerChild ( INode *  node )

inherited

Definition at line 58 of file INode.cpp.

{
    ASSERT(node);
    node->setParent(this);
}

References ASSERT, and INode::setParent().

Referenced by ParticleLayout::addAndRegisterAbstractParticle(), ParticleCoreShell::addAndRegisterCore(), MultiLayer::addAndRegisterInterface(), MultiLayer::addAndRegisterLayer(), ParticleCoreShell::addAndRegisterShell(), Layer::addLayout(), ParticleComposition::addParticlePointer(), Beam::Beam(), Crystal::Crystal(), IDetector::IDetector(), Simulation::initialize(), MesoCrystal::initialize(), Instrument::Instrument(), Beam::operator=(), Instrument::operator=(), Particle::Particle(), ParticleDistribution::ParticleDistribution(), IParticle::rotate(), ParticleLayout::setAndRegisterInterferenceFunction(), Simulation::setBackground(), InterferenceFunction1DLattice::setDecayFunction(), InterferenceFunction2DLattice::setDecayFunction(), Instrument::setDetector(), IDetector::setDetectorResolution(), Beam::setFootprintFactor(), Particle::setFormFactor(), InterferenceFunctionFinite3DLattice::setLattice(), InterferenceFunction2DLattice::setLattice(), InterferenceFunction2DParaCrystal::setLattice(), InterferenceFunction2DSuperLattice::setLattice(), InterferenceFunctionFinite2DLattice::setLattice(), InterferenceFunctionRadialParaCrystal::setProbabilityDistribution(), InterferenceFunction2DParaCrystal::setProbabilityDistributions(), ConvolutionDetectorResolution::setResolutionFunction(), IParticle::setRotation(), LayerInterface::setRoughness(), and InterferenceFunction2DSuperLattice::setSubstructureIFF().

Here is the call graph for this function:

setParent()

void INode::setParent ( const INode *  newParent )

virtualinherited

Reimplemented in SampleProvider.

Definition at line 69 of file INode.cpp.

{
    m_parent = newParent;
}

References INode::m_parent.

Referenced by INode::registerChild(), SampleProvider::setBuilder(), and SampleProvider::setParent().

parent() [1/2]

const INode * INode::parent ( ) const

inherited

Definition at line 74 of file INode.cpp.

{
    return m_parent;
}

References INode::m_parent.

Referenced by INode::copyNumber(), INode::createParameterTree(), NodeUtils::nodePath(), Lattice2D::onChange(), SampleProvider::setBuilder(), SampleProvider::setParent(), and SampleProvider::setSample().

parent() [2/2]

INode * INode::parent ( )

inherited

Definition at line 79 of file INode.cpp.

{
    return const_cast<INode*>(m_parent);
}

References INode::m_parent.

copyNumber()

int INode::copyNumber ( const INode *  node ) const

inherited

Returns copyNumber of child, which takes into account existence of children with same name.

Definition at line 84 of file INode.cpp.

{
    if (node->parent() != this)
        return -1;
 
    int result(-1), count(0);
    for (auto child : getChildren()) {
 
        if (child == nullptr)
            throw std::runtime_error("INode::copyNumber() -> Error. Nullptr as child.");
 
        if (child == node)
            result = count;
 
        if (child->getName() == node->getName())
            ++count;
    }
 
    return count > 1 ? result : -1;
}

References INode::getChildren(), IParameterized::getName(), and INode::parent().

Referenced by INode::displayName().

Here is the call graph for this function:

displayName()

std::string INode::displayName ( ) const

inherited

Returns display name, composed from the name of node and it's copy number.

Definition at line 105 of file INode.cpp.

{
    std::string result = getName();
    if (m_parent) {
        int index = m_parent->copyNumber(this);
        if (index >= 0)
            result = result + std::to_string(index);
    }
    return result;
}

References INode::copyNumber(), IParameterized::getName(), and INode::m_parent.

Referenced by NodeUtils::nodePath(), and anonymous_namespace{NodeUtils.cpp}::nodeString().

Here is the call graph for this function:

createParameterTree()

ParameterPool * INode::createParameterTree ( ) const

virtualinherited

Creates new parameter pool, with all local parameters and those of its children.

Reimplemented from IParameterized.

Definition at line 116 of file INode.cpp.

{
    std::unique_ptr<ParameterPool> result(new ParameterPool);
 
    NodeIterator<PreorderStrategy> it(this);
    it.first();
    while (!it.isDone()) {
        const INode* child = it.getCurrent();
        const std::string path = NodeUtils::nodePath(*child, this->parent()) + "/";
        child->parameterPool()->copyToExternalPool(path, result.get());
        it.next();
    }
 
    return result.release();
}

References ParameterPool::copyToExternalPool(), NodeIterator< Strategy >::first(), NodeIterator< Strategy >::getCurrent(), NodeIterator< Strategy >::isDone(), NodeIterator< Strategy >::next(), NodeUtils::nodePath(), IParameterized::parameterPool(), and INode::parent().

Referenced by ParticleDistribution::generateParticles(), Simulation::runSimulation(), DepthProbeSimulation::validateParametrization(), OffSpecSimulation::validateParametrization(), and SpecularSimulation::validateParametrization().

Here is the call graph for this function:

parameterPool()

ParameterPool* IParameterized::parameterPool ( ) const

inlineinherited

Returns pointer to the parameter pool.

Definition at line 38 of file IParameterized.h.

{ return m_pool.get(); } // has non-const usages!

References IParameterized::m_pool.

Referenced by pyfmt2::argumentList(), SampleBuilderNode::borrow_builder_parameters(), INode::createParameterTree(), INode::INode(), IParameterized::IParameterized(), anonymous_namespace{NodeUtils.cpp}::poolToString(), SampleBuilderNode::reset(), and IDistribution1D::setUnits().

parametersToString()

std::string IParameterized::parametersToString ( ) const

inherited

Returns multiline string representing available parameters.

Definition at line 40 of file IParameterized.cpp.

{
    std::ostringstream result;
    std::unique_ptr<ParameterPool> P_pool(createParameterTree());
    result << *P_pool << "\n";
    return result.str();
}

References IParameterized::createParameterTree().

Here is the call graph for this function:

registerParameter()

RealParameter & IParameterized::registerParameter ( const std::string &  name, double *  parpointer  )

inherited

Definition at line 48 of file IParameterized.cpp.

{
    return m_pool->addParameter(
        new RealParameter(name, data, getName(), [&]() -> void { onChange(); }));
}

References IParameterized::getName(), IParameterized::m_pool, and IParameterized::onChange().

Referenced by BasicLattice::BasicLattice(), Beam::Beam(), CylindersInBABuilder::CylindersInBABuilder(), DetectionProperties::DetectionProperties(), HexagonalLattice::HexagonalLattice(), IInterferenceFunction::IInterferenceFunction(), INode::INode(), InterferenceFunction1DLattice::InterferenceFunction1DLattice(), InterferenceFunction2DParaCrystal::InterferenceFunction2DParaCrystal(), InterferenceFunctionHardDisk::InterferenceFunctionHardDisk(), InterferenceFunctionRadialParaCrystal::InterferenceFunctionRadialParaCrystal(), InterferenceFunctionTwin::InterferenceFunctionTwin(), Lattice2D::Lattice2D(), LayerRoughness::LayerRoughness(), MultiLayer::MultiLayer(), ParticleDistribution::ParticleDistribution(), PlainMultiLayerBySLDBuilder::PlainMultiLayerBySLDBuilder(), IParticle::registerAbundance(), ParticleLayout::registerParticleDensity(), Layer::registerThickness(), IParameterized::registerVector(), ParticleLayout::registerWeight(), ResolutionFunction2DGaussian::ResolutionFunction2DGaussian(), ResonatorBuilder::ResonatorBuilder(), Lattice2D::setRotationEnabled(), SquareLattice::SquareLattice(), and TriangularRippleBuilder::TriangularRippleBuilder().

Here is the call graph for this function:

registerVector()

void IParameterized::registerVector ( const std::string &  base_name, kvector_t *  p_vec, const std::string &  units = "nm"  )

inherited

Definition at line 54 of file IParameterized.cpp.

{
    registerParameter(XComponentName(base_name), &((*p_vec)[0])).setUnit(units);
    registerParameter(YComponentName(base_name), &((*p_vec)[1])).setUnit(units);
    registerParameter(ZComponentName(base_name), &((*p_vec)[2])).setUnit(units);
}

References IParameterized::registerParameter(), RealParameter::setUnit(), IParameterized::XComponentName(), IParameterized::YComponentName(), and IParameterized::ZComponentName().

Referenced by Beam::Beam(), DetectionProperties::DetectionProperties(), InterferenceFunctionTwin::InterferenceFunctionTwin(), MultiLayer::MultiLayer(), Lattice::registerBasisVectors(), and IParticle::registerPosition().

Here is the call graph for this function:

setParameterValue()

void IParameterized::setParameterValue ( const std::string &  name, double  value  )

inherited

Definition at line 62 of file IParameterized.cpp.

{
    if (name.find('*') == std::string::npos && name.find('/') == std::string::npos) {
        m_pool->setParameterValue(name, value);
    } else {
        std::unique_ptr<ParameterPool> P_pool{createParameterTree()};
        if (name.find('*') != std::string::npos)
            P_pool->setMatchedParametersValue(name, value);
        else
            P_pool->setParameterValue(name, value);
    }
}

References IParameterized::createParameterTree(), IParameterized::m_pool, and ParameterPool::setMatchedParametersValue().

Referenced by AsymRippleBuilder::buildSample(), and IParameterized::setVectorValue().

Here is the call graph for this function:

setVectorValue()

void IParameterized::setVectorValue ( const std::string &  base_name, kvector_t  value  )

inherited

Definition at line 75 of file IParameterized.cpp.

{
    setParameterValue(XComponentName(base_name), value.x());
    setParameterValue(YComponentName(base_name), value.y());
    setParameterValue(ZComponentName(base_name), value.z());
}

References IParameterized::setParameterValue(), BasicVector3D< T >::x(), IParameterized::XComponentName(), BasicVector3D< T >::y(), IParameterized::YComponentName(), BasicVector3D< T >::z(), and IParameterized::ZComponentName().

Here is the call graph for this function:

parameter()

RealParameter * IParameterized::parameter ( const std::string &  name ) const

inherited

Returns parameter with given 'name'.

Definition at line 83 of file IParameterized.cpp.

{
    return m_pool->parameter(name);
}

References IParameterized::m_pool.

Referenced by DepthProbeSimulation::initialize(), SpecularSimulation::initialize(), IParticle::registerAbundance(), Lattice::registerBasisVectors(), ParticleLayout::registerParticleDensity(), IParticle::registerPosition(), Layer::registerThickness(), Lattice2D::setRotationEnabled(), and DistributionLogNormal::setUnits().

onChange()

virtual void IParameterized::onChange ( )

inlinevirtualinherited

Action to be taken in inherited class when a parameter has changed.

Reimplemented in IProfileRipple, FormFactorSphereLogNormalRadius, FormFactorSphereGaussianRadius, FormFactorGaussSphere, ISawtoothRipple, ICosineRipple, IProfileRectangularRipple, FormFactorTruncatedSpheroid, FormFactorTruncatedSphere, FormFactorTruncatedCube, FormFactorTetrahedron, FormFactorPyramid, FormFactorPrism6, FormFactorPrism3, FormFactorLongBoxLorentz, FormFactorLongBoxGauss, FormFactorIcosahedron, FormFactorHollowSphere, FormFactorHemiEllipsoid, FormFactorFullSpheroid, FormFactorFullSphere, FormFactorEllipsoidalCylinder, FormFactorDodecahedron, FormFactorCylinder, FormFactorCuboctahedron, FormFactorCone6, FormFactorCone, FormFactorCantellatedCube, FormFactorBox, FormFactorAnisoPyramid, InterferenceFunction3DLattice, InterferenceFunction2DLattice, Lattice, and Lattice2D.

Definition at line 58 of file IParameterized.h.

{}

Referenced by Lattice2D::onChange(), and IParameterized::registerParameter().

removeParameter()

void IParameterized::removeParameter ( const std::string &  name )

inherited

Definition at line 88 of file IParameterized.cpp.

{
    m_pool->removeParameter(name);
}

References IParameterized::m_pool.

Referenced by IParticle::registerAbundance(), ParticleLayout::registerParticleDensity(), Layer::registerThickness(), IParameterized::removeVector(), and Lattice2D::setRotationEnabled().

removeVector()

void IParameterized::removeVector ( const std::string &  base_name )

inherited

Definition at line 93 of file IParameterized.cpp.

{
    removeParameter(XComponentName(base_name));
    removeParameter(YComponentName(base_name));
    removeParameter(ZComponentName(base_name));
}

References IParameterized::removeParameter(), IParameterized::XComponentName(), IParameterized::YComponentName(), and IParameterized::ZComponentName().

Referenced by IParticle::registerPosition().

Here is the call graph for this function:

XComponentName()

std::string IParameterized::XComponentName ( const std::string &  base_name )

staticinherited

Definition at line 100 of file IParameterized.cpp.

{
    return base_name + "X";
}

Referenced by Lattice::registerBasisVectors(), IParticle::registerPosition(), IParameterized::registerVector(), IParameterized::removeVector(), and IParameterized::setVectorValue().

YComponentName()

std::string IParameterized::YComponentName ( const std::string &  base_name )

staticinherited

Definition at line 105 of file IParameterized.cpp.

{
    return base_name + "Y";
}

Referenced by IParameterized::registerVector(), IParameterized::removeVector(), and IParameterized::setVectorValue().

ZComponentName()

std::string IParameterized::ZComponentName ( const std::string &  base_name )

staticinherited

Definition at line 110 of file IParameterized.cpp.

{
    return base_name + "Z";
}

Referenced by IParameterized::registerVector(), IParameterized::removeVector(), and IParameterized::setVectorValue().

setName()

void IParameterized::setName ( const std::string &  name )

inlineinherited

Definition at line 68 of file IParameterized.h.

{ m_name = name; }

References IParameterized::m_name.

Referenced by BasicLattice::BasicLattice(), Beam::Beam(), Layer::clone(), ConvolutionDetectorResolution::ConvolutionDetectorResolution(), LayersWithAbsorptionBuilder::createSampleByIndex(), Basic2DParaCrystalBuilder::createSampleByIndex(), ParticleInVacuumBuilder::createSampleByIndex(), SimpleMagneticRotationBuilder::createSampleByIndex(), Crystal::Crystal(), DetectionProperties::DetectionProperties(), DistributionHandler::DistributionHandler(), FormFactorBAPol::FormFactorBAPol(), FormFactorCoreShell::FormFactorCoreShell(), FormFactorCrystal::FormFactorCrystal(), FormFactorDecoratorMaterial::FormFactorDecoratorMaterial(), FormFactorDecoratorPositionFactor::FormFactorDecoratorPositionFactor(), FormFactorDecoratorRotation::FormFactorDecoratorRotation(), FormFactorDWBA::FormFactorDWBA(), FormFactorDWBAPol::FormFactorDWBAPol(), FormFactorWeighted::FormFactorWeighted(), HexagonalLattice::HexagonalLattice(), IDetector::IDetector(), DepthProbeSimulation::initialize(), GISASSimulation::initialize(), OffSpecSimulation::initialize(), SpecularSimulation::initialize(), SpecularDetector1D::initialize(), MesoCrystal::initialize(), Particle::initialize(), ParticleComposition::initialize(), INode::INode(), Instrument::Instrument(), InterferenceFunction1DLattice::InterferenceFunction1DLattice(), InterferenceFunction2DLattice::InterferenceFunction2DLattice(), InterferenceFunction2DParaCrystal::InterferenceFunction2DParaCrystal(), InterferenceFunction2DSuperLattice::InterferenceFunction2DSuperLattice(), InterferenceFunction3DLattice::InterferenceFunction3DLattice(), InterferenceFunctionFinite2DLattice::InterferenceFunctionFinite2DLattice(), InterferenceFunctionFinite3DLattice::InterferenceFunctionFinite3DLattice(), InterferenceFunctionHardDisk::InterferenceFunctionHardDisk(), InterferenceFunctionNone::InterferenceFunctionNone(), InterferenceFunctionRadialParaCrystal::InterferenceFunctionRadialParaCrystal(), InterferenceFunctionTwin::InterferenceFunctionTwin(), ISampleBuilder::ISampleBuilder(), IsGISAXSDetector::IsGISAXSDetector(), Lattice::Lattice(), Layer::Layer(), LayerInterface::LayerInterface(), LayerRoughness::LayerRoughness(), MultiLayer::MultiLayer(), Beam::operator=(), SampleBuilderNode::operator=(), ParticleCoreShell::ParticleCoreShell(), ParticleDistribution::ParticleDistribution(), ParticleLayout::ParticleLayout(), RectangularDetector(), SampleBuilderNode::reset(), ResolutionFunction2DGaussian::ResolutionFunction2DGaussian(), SampleBuilderNode::SampleBuilderNode(), SampleBuilderNode::setSBN(), SphericalDetector::SphericalDetector(), and SquareLattice::SquareLattice().

getName()

const std::string& IParameterized::getName ( ) const

inlineinherited

Definition at line 69 of file IParameterized.h.

{ return m_name; }

References IParameterized::m_name.

Referenced by Beam::Beam(), Layer::clone(), IFormFactorBorn::computeSlicingEffects(), ConvolutionDetectorResolution::ConvolutionDetectorResolution(), INode::copyNumber(), IParameterized::createParameterTree(), IFormFactor::createSlicedFormFactor(), SampleToPython::defineFormFactors(), SampleToPython::defineInterferenceFunctions(), INode::displayName(), IDetector::IDetector(), Instrument::Instrument(), IParameterized::IParameterized(), Beam::operator=(), SampleBuilderNode::operator=(), anonymous_namespace{ParticleLayout.cpp}::particleDensityIsProvidedByInterference(), IParameterized::registerParameter(), SampleBuilderNode::SampleBuilderNode(), and IFormFactor::sliceFormFactor().

Member Data Documentation

m_normal_to_detector

kvector_t RectangularDetector::m_normal_to_detector

private

Definition at line 101 of file RectangularDetector.h.

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

m_u0

double RectangularDetector::m_u0

private

Definition at line 102 of file RectangularDetector.h.

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

m_v0

double RectangularDetector::m_v0

private

position of normal vector hitting point in detector coordinates

Definition at line 102 of file RectangularDetector.h.

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

m_direction

kvector_t RectangularDetector::m_direction

private

direction vector of detector coordinate system

Definition at line 103 of file RectangularDetector.h.

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

m_distance

double RectangularDetector::m_distance

private

distance from sample origin to the detector plane

Definition at line 104 of file RectangularDetector.h.

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

m_dbeam_u0

double RectangularDetector::m_dbeam_u0

private

Definition at line 105 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 105 of file RectangularDetector.h.

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

m_detector_arrangement

EDetectorArrangement RectangularDetector::m_detector_arrangement

private

Definition at line 106 of file RectangularDetector.h.

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

m_u_unit

kvector_t RectangularDetector::m_u_unit

private

Definition at line 107 of file RectangularDetector.h.

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

m_v_unit

kvector_t RectangularDetector::m_v_unit

private

Definition at line 108 of file RectangularDetector.h.

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

m_detector_mask

DetectorMask IDetector2D::m_detector_mask

privateinherited

Definition at line 89 of file IDetector2D.h.

Referenced by IDetector2D::addMask(), IDetector2D::detectorMask(), IDetector2D::maskAll(), IDetector2D::removeMasks(), IDetector2D::resetRegionOfInterest(), and IDetector2D::setRegionOfInterest().

m_region_of_interest

std::unique_ptr<RegionOfInterest> IDetector2D::m_region_of_interest

privateinherited

Definition at line 90 of file IDetector2D.h.

Referenced by IDetector2D::IDetector2D(), IDetector2D::regionOfInterest(), IDetector2D::resetRegionOfInterest(), and IDetector2D::setRegionOfInterest().

m_axes

CloneableVector<IAxis> IDetector::m_axes

privateinherited

Definition at line 126 of file IDetector.h.

Referenced by IDetector::addAxis(), IDetector::axisBinIndex(), IDetector::clear(), IDetector::dimension(), IDetector::getAxis(), and IDetector::totalSize().

m_detection_properties

DetectionProperties IDetector::m_detection_properties

privateinherited

Definition at line 127 of file IDetector.h.

Referenced by IDetector::detectionProperties(), IDetector::getChildren(), IDetector::IDetector(), and IDetector::setAnalyzerProperties().

mP_detector_resolution

std::unique_ptr<IDetectorResolution> IDetector::mP_detector_resolution

privateinherited

Definition at line 128 of file IDetector.h.

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

m_parent

const INode* INode::m_parent {nullptr}

privateinherited

Definition at line 81 of file INode.h.

Referenced by INode::displayName(), INode::parent(), and INode::setParent().

m_NP

const size_t INode::m_NP

protectedinherited

Definition at line 86 of file INode.h.

Referenced by INode::INode().

m_P

std::vector<double> INode::m_P

protectedinherited

Definition at line 87 of file INode.h.

Referenced by INode::INode(), and IFootprintFactor::setWidthRatio().

m_name

std::string IParameterized::m_name

privateinherited

Definition at line 72 of file IParameterized.h.

Referenced by IParameterized::getName(), and IParameterized::setName().

m_pool

std::unique_ptr<ParameterPool> IParameterized::m_pool

privateinherited

parameter pool (kind of pointer-to-implementation)

Definition at line 73 of file IParameterized.h.

Referenced by IParameterized::createParameterTree(), IParameterized::parameter(), IParameterized::parameterPool(), IParameterized::registerParameter(), IParameterized::removeParameter(), and IParameterized::setParameterValue().

---

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

• /home/www/ba/Device/Detector/RectangularDetector.h
• /home/www/ba/Device/Detector/RectangularDetector.cpp