StandardSimulations Namespace Reference

Standard pre-defined simulations. More...

Functions
DepthProbeSimulation *	BasicDepthProbe ()
GISASSimulation *	BasicGISAS ()
	Basic GISAS simulation with the detector phi[0,2], theta[0,2]. More...
GISASSimulation *	BasicGISAS00 ()
	Basic GISAS for polarization studies. More...
GISASSimulation *	BasicPolarizedGISAS ()
	Basic GISAS simulation for spin flip channel. More...
SpecularSimulation *	BasicSpecular ()
SpecularSimulation *	BasicSpecularMM ()
SpecularSimulation *	BasicSpecularMP ()
SpecularSimulation *	BasicSpecularPM ()
SpecularSimulation *	BasicSpecularPP ()
SpecularSimulation *	BasicSpecularQ ()
SpecularSimulation *	BasicSpecularQMM ()
SpecularSimulation *	BasicSpecularQMP ()
SpecularSimulation *	BasicSpecularQPM ()
SpecularSimulation *	BasicSpecularQPP ()
GISASSimulation *	ConstantBackgroundGISAS ()
GISASSimulation *	ExtraLongWavelengthGISAS ()
	GISAS simulation with an extra long wavelength. More...
GISASSimulation *	GISASWithMasks ()
	GISAS simulation with multiple masks on the detector plane. More...
GISASSimulation *	IsGISAXSSimulation1 ()
	Typical IsGISAXS simulation with the detector phi[-1,1], theta[0,2]. More...
GISASSimulation *	IsGISAXSSimulation2 ()
	Typical IsGISAXS simulation with the detector phi[0,2], theta[0,2]. More...
GISASSimulation *	MaxiGISAS ()
	GISAS simulation with large detector to test performance. More...
GISASSimulation *	MaxiGISAS00 ()
	Basic GISAS for polarization studies. More...
GISASSimulation *	MiniGISAS ()
	GISAS simulation with small detector and phi[-2,2], theta[0,2]. More...
GISASSimulation *	MiniGISAS_v2 ()
	GISAS simulation with small detector and phi[-1,1], theta[0,1]. More...
GISASSimulation *	MiniGISASBeamDivergence ()
	GISAS simulation with beam divergence applied. More...
GISASSimulation *	MiniGISASDetectorResolution ()
	GISAS simulation with detector resolution. More...
GISASSimulation *	MiniGISASFit ()
	ISimulation with fitting. More...
GISASSimulation *	MiniGISASMonteCarlo ()
	GISAS simulation with Monte-Carlo integration switched ON. More...
GISASSimulation *	MiniGISASPolarizationMM ()
GISASSimulation *	MiniGISASPolarizationMP ()
GISASSimulation *	MiniGISASPolarizationPM ()
GISASSimulation *	MiniGISASPolarizationPP ()
GISASSimulation *	MiniGISASSpecularPeak ()
	GISAS simulation with small detector and including specular peak. More...
OffSpecularSimulation *	MiniOffSpecular ()
GISASSimulation *	RectDetectorGeneric ()
	GISAS simulation with generic rectangular detector. More...
GISASSimulation *	RectDetectorPerpToDirectBeam ()
	GISAS simulation with the rectangular detector perpendicular to the direct beam. More...
GISASSimulation *	RectDetectorPerpToReflectedBeam ()
	GISAS simulation with the rectangular detector perpendicular to the reflected beam. More...
GISASSimulation *	RectDetectorPerpToReflectedBeamDpos ()
	GISAS simulation with the rectangular detector perpendicular to the reflected beam when the coordinates of direct beam are known. More...
GISASSimulation *	RectDetectorPerpToSample ()
	GISAS simulation with the rectangular detector perpendicular to the sample. More...
GISASSimulation *	RectDetWithRoi ()
	GISAS simulation with rectangular detector, region of interest and mask. More...
SpecularSimulation *	SpecularDivergentBeam ()
SpecularSimulation *	SpecularWithGaussianBeam ()
SpecularSimulation *	SpecularWithSquareBeam ()
GISASSimulation *	SphericalDetWithRoi ()
	GISAS simulation with spherical detector, region of interest and mask. More...
SpecularSimulation *	TOFRWithPointwiseResolution ()
SpecularSimulation *	TOFRWithRelativeResolution ()

Detailed Description

Standard pre-defined simulations.

Function Documentation

BasicDepthProbe()

DepthProbeSimulation * StandardSimulations::BasicDepthProbe

(

)

Definition at line 584 of file StandardSimulations.cpp.

{
    auto* result = new DepthProbeSimulation;
 
    const double wavelength = 10 * angstrom;
    const size_t n_alpha = 20;
    const double alpha_min = 0 * deg;
    const double alpha_max = 1 * deg;
    const size_t n_z = n_alpha;
    const double z_min = -100.0 * Units::nm;
    const double z_max = 100.0 * Units::nm;
 
    result->setBeamParameters(wavelength, n_alpha, alpha_min, alpha_max);
    result->setZSpan(n_z, z_min, z_max);
 
    return result;
}

References Units::angstrom, Units::deg, and Units::nm.

Referenced by SimulationFactory::SimulationFactory().

BasicGISAS()

GISASSimulation * StandardSimulations::BasicGISAS

(

)

Basic GISAS simulation with the detector phi[0,2], theta[0,2].

Definition at line 53 of file StandardSimulations.cpp.

{
    Beam beam(1.0, 1 * angstrom, Direction(0.2 * deg, 0 * deg));
    SphericalDetector det(100, 0 * deg, 2 * deg, 100, 0 * deg, 2 * deg);
    return new GISASSimulation(beam, det);
}

References Units::angstrom, and Units::deg.

Referenced by SimulationFactory::SimulationFactory(), BasicGISAS00(), and BasicPolarizedGISAS().

BasicGISAS00()

GISASSimulation * StandardSimulations::BasicGISAS00

(

)

Basic GISAS for polarization studies.

Definition at line 62 of file StandardSimulations.cpp.

{
    GISASSimulation* result = BasicGISAS();
    kvector_t zplus(0.0, 0.0, 1.0);
    result->beam().setPolarization(zplus);
    result->detector().setAnalyzerProperties(zplus, 1.0, 0.5);
    return result;
}

References BasicGISAS(), ISimulation::beam(), ISimulation::detector(), IDetector::setAnalyzerProperties(), and Beam::setPolarization().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function:

BasicPolarizedGISAS()

GISASSimulation * StandardSimulations::BasicPolarizedGISAS

(

)

Basic GISAS simulation for spin flip channel.

Definition at line 73 of file StandardSimulations.cpp.

{
    GISASSimulation* result = BasicGISAS();
    kvector_t zplus(0.0, 0.0, 1.0);
    result->beam().setPolarization(zplus);
    result->detector().setAnalyzerProperties(zplus, -1.0, 0.5);
    return result;
}

References BasicGISAS(), ISimulation::beam(), ISimulation::detector(), IDetector::setAnalyzerProperties(), and Beam::setPolarization().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function:

BasicSpecular()

SpecularSimulation * StandardSimulations::BasicSpecular

(

)

Definition at line 366 of file StandardSimulations.cpp.

{
    const double wavelength = 1.54 * angstrom;
    const int number_of_bins = 2000;
    const double min_angle = 0 * deg;
    const double max_angle = 5 * deg;
    AngularSpecScan scan(wavelength, FixedBinAxis("axis", number_of_bins, min_angle, max_angle));
 
    auto* result = new SpecularSimulation();
    result->setScan(scan);
    result->getOptions().setUseAvgMaterials(true);
    return result;
}

References Units::angstrom, and Units::deg.

Referenced by SimulationFactory::SimulationFactory(), BasicSpecularMM(), BasicSpecularMP(), BasicSpecularPM(), and BasicSpecularPP().

BasicSpecularMM()

SpecularSimulation * StandardSimulations::BasicSpecularMM

(

)

Definition at line 515 of file StandardSimulations.cpp.

{
    auto* simulation = BasicSpecular();
    simulation->beam().setPolarization({0.0, -1.0, 0.0});
    simulation->detector().setAnalyzerProperties({0.0, -1.0, 0.0}, 1.0, 0.5);
    return simulation;
}

References BasicSpecular().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function:

BasicSpecularMP()

SpecularSimulation * StandardSimulations::BasicSpecularMP

(

)

Definition at line 507 of file StandardSimulations.cpp.

{
    auto* simulation = BasicSpecular();
    simulation->beam().setPolarization({0.0, -1.0, 0.0});
    simulation->detector().setAnalyzerProperties({0.0, 1.0, 0.0}, 1.0, 0.5);
    return simulation;
}

References BasicSpecular().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function:

BasicSpecularPM()

SpecularSimulation * StandardSimulations::BasicSpecularPM

(

)

Definition at line 499 of file StandardSimulations.cpp.

{
    auto* simulation = BasicSpecular();
    simulation->beam().setPolarization({0.0, 1.0, 0.0});
    simulation->detector().setAnalyzerProperties({0.0, -1.0, 0.0}, 1.0, 0.5);
    return simulation;
}

References BasicSpecular().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function:

BasicSpecularPP()

SpecularSimulation * StandardSimulations::BasicSpecularPP

(

)

Definition at line 491 of file StandardSimulations.cpp.

{
    auto* simulation = BasicSpecular();
    simulation->beam().setPolarization({0.0, 1.0, 0.0});
    simulation->detector().setAnalyzerProperties({0.0, 1.0, 0.0}, 1.0, 0.5);
    return simulation;
}

References BasicSpecular().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function:

BasicSpecularQ()

SpecularSimulation * StandardSimulations::BasicSpecularQ

(

)

Definition at line 380 of file StandardSimulations.cpp.

{
    std::vector<double> qs;
    {
        const double wavelength_0 = 1.54 * angstrom;
        const int number_of_bins = 2000;
        const double min_angle = 0 * deg;
        const double max_angle = 5 * deg;
        FixedBinAxis angle_axis("axis", number_of_bins, min_angle, max_angle);
        auto angles = angle_axis.binCenters();
 
        qs.resize(angle_axis.size(), 0.0);
        for (size_t i = 0, size = qs.size(); i < size; ++i)
            qs[i] = 4.0 * M_PI * std::sin(angles[i]) / wavelength_0;
    }
    QSpecScan q_scan(qs);
 
    auto* result = new SpecularSimulation;
    result->setScan(q_scan);
    result->getOptions().setUseAvgMaterials(true);
    return result;
}

References Units::angstrom, FixedBinAxis::binCenters(), Units::deg, M_PI, SpecularSimulation::setScan(), and FixedBinAxis::size().

Referenced by SimulationFactory::SimulationFactory(), BasicSpecularQMM(), BasicSpecularQMP(), BasicSpecularQPM(), and BasicSpecularQPP().

Here is the call graph for this function:

BasicSpecularQMM()

SpecularSimulation * StandardSimulations::BasicSpecularQMM

(

)

Definition at line 531 of file StandardSimulations.cpp.

{
    auto* simulation = BasicSpecularQ();
    simulation->beam().setPolarization({0.0, -1.0, 0.0});
    simulation->detector().setAnalyzerProperties({0.0, -1.0, 0.0}, 1.0, 0.5);
    return simulation;
}

References BasicSpecularQ().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function:

BasicSpecularQMP()

SpecularSimulation * StandardSimulations::BasicSpecularQMP

(

)

Definition at line 547 of file StandardSimulations.cpp.

{
    auto* simulation = BasicSpecularQ();
    simulation->beam().setPolarization({0.0, -1.0, 0.0});
    simulation->detector().setAnalyzerProperties({0.0, 1.0, 0.0}, 1.0, 0.5);
    return simulation;
}

References BasicSpecularQ().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function:

BasicSpecularQPM()

SpecularSimulation * StandardSimulations::BasicSpecularQPM

(

)

Definition at line 539 of file StandardSimulations.cpp.

{
    auto* simulation = BasicSpecularQ();
    simulation->beam().setPolarization({0.0, 1.0, 0.0});
    simulation->detector().setAnalyzerProperties({0.0, -1.0, 0.0}, 1.0, 0.5);
    return simulation;
}

References BasicSpecularQ().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function:

BasicSpecularQPP()

SpecularSimulation * StandardSimulations::BasicSpecularQPP

(

)

Definition at line 523 of file StandardSimulations.cpp.

{
    auto* simulation = BasicSpecularQ();
    simulation->beam().setPolarization({0.0, 1.0, 0.0});
    simulation->detector().setAnalyzerProperties({0.0, 1.0, 0.0}, 1.0, 0.5);
    return simulation;
}

References BasicSpecularQ().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function:

ConstantBackgroundGISAS()

GISASSimulation * StandardSimulations::ConstantBackgroundGISAS

(

)

Definition at line 347 of file StandardSimulations.cpp.

{
    GISASSimulation* result = MiniGISAS();
    ConstantBackground bg(1e3);
    result->setBackground(bg);
    return result;
}

References MiniGISAS(), and ISimulation::setBackground().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function:

ExtraLongWavelengthGISAS()

GISASSimulation * StandardSimulations::ExtraLongWavelengthGISAS

(

)

GISAS simulation with an extra long wavelength.

Definition at line 357 of file StandardSimulations.cpp.

{
    Beam beam(1e8, 13.52 * Units::nm, Direction(0.2 * deg, 0 * deg));
    SphericalDetector det(100, -1 * deg, 1 * deg, 100, 0.0, 2 * deg);
    auto* simulation = new GISASSimulation(beam, det);
    simulation->getOptions().setIncludeSpecular(true);
    return simulation;
}

References Units::deg, and Units::nm.

Referenced by SimulationFactory::SimulationFactory().

GISASWithMasks()

GISASSimulation * StandardSimulations::GISASWithMasks

(

)

GISAS simulation with multiple masks on the detector plane.

Definition at line 125 of file StandardSimulations.cpp.

{
    Beam beam(1e7, 1 * angstrom, Direction(0.2 * deg, 0 * deg));
    SphericalDetector det(50, -1 * deg, 1 * deg, 50, 0 * deg, 2 * deg);
    GISASSimulation* result = new GISASSimulation(beam, det);
 
    result->maskAll();
    // pacman
    const double deg = Units::deg;
    result->addMask(Ellipse(0.0 * deg, 1.0 * deg, 0.5 * deg, 0.5 * deg), false);
    result->addMask(Ellipse(0.11 * deg, 1.25 * deg, 0.05 * deg, 0.05 * deg), true);
 
    std::vector<std::vector<double>> points = {{0.0 * deg, 1.0 * deg},
                                               {0.5 * deg, 1.2 * deg},
                                               {0.5 * deg, 0.8 * deg},
                                               {0.0 * deg, 1.0 * deg}};
    result->addMask(Polygon(points), true);
 
    result->addMask(Rectangle(0.45 * deg, 0.95 * deg, 0.55 * deg, 1.05 * deg), false);
    result->addMask(Rectangle(0.61 * deg, 0.95 * deg, 0.71 * deg, 1.05 * deg), false);
    result->addMask(Rectangle(0.75 * deg, 0.95 * deg, 0.85 * deg, 1.05 * deg), false);
 
    // more masks
    result->addMask(Ellipse(-0.5 * deg, 1.5 * deg, 0.3 * deg, 0.1 * deg, 45. * deg), false);
    result->addMask(VerticalLine(-0.6 * deg), true);
    result->addMask(HorizontalLine(0.3 * deg), false);
 
    return result;
}

References ISimulation2D::addMask(), Units::angstrom, Units::deg, and ISimulation2D::maskAll().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function:

IsGISAXSSimulation1()

GISASSimulation * StandardSimulations::IsGISAXSSimulation1

(

)

Typical IsGISAXS simulation with the detector phi[-1,1], theta[0,2].

Definition at line 247 of file StandardSimulations.cpp.

{
    Beam beam(1.0, 1 * angstrom, Direction(0.2 * deg, 0 * deg));
    IsGISAXSDetector det(100, -1 * deg, 1 * deg, 100, 0 * deg, 2 * deg);
    return new GISASSimulation(beam, det);
}

References Units::angstrom, and Units::deg.

Referenced by SimulationFactory::SimulationFactory().

IsGISAXSSimulation2()

GISASSimulation * StandardSimulations::IsGISAXSSimulation2

(

)

Typical IsGISAXS simulation with the detector phi[0,2], theta[0,2].

Definition at line 256 of file StandardSimulations.cpp.

{
    Beam beam(1.0, 1 * angstrom, Direction(0.2 * deg, 0 * deg));
    SphericalDetector det(100, 0 * deg, 2 * deg, 100, 0 * deg, 2 * deg);
    return new GISASSimulation(beam, det);
}

References Units::angstrom, and Units::deg.

Referenced by SimulationFactory::SimulationFactory().

MaxiGISAS()

GISASSimulation * StandardSimulations::MaxiGISAS

(

)

GISAS simulation with large detector to test performance.

Definition at line 227 of file StandardSimulations.cpp.

{
    Beam beam(1.0, 1 * angstrom, Direction(0.2 * deg, 0 * deg));
    SphericalDetector det(256, -2 * deg, 2 * deg, 256, 0 * deg, 2 * deg);
    return new GISASSimulation(beam, det);
}

References Units::angstrom, and Units::deg.

Referenced by SimulationFactory::SimulationFactory(), and MaxiGISAS00().

MaxiGISAS00()

GISASSimulation * StandardSimulations::MaxiGISAS00

(

)

Basic GISAS for polarization studies.

Definition at line 236 of file StandardSimulations.cpp.

{
    GISASSimulation* result = MaxiGISAS();
    kvector_t zplus(0.0, 0.0, 1.0);
    result->beam().setPolarization(zplus);
    result->detector().setAnalyzerProperties(zplus, 1.0, 0.5);
    return result;
}

References ISimulation::beam(), ISimulation::detector(), MaxiGISAS(), IDetector::setAnalyzerProperties(), and Beam::setPolarization().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function:

MiniGISAS()

GISASSimulation * StandardSimulations::MiniGISAS

(

)

GISAS simulation with small detector and phi[-2,2], theta[0,2].

Definition at line 84 of file StandardSimulations.cpp.

{
    Beam beam(1.0, 1 * angstrom, Direction(0.2 * deg, 0 * deg));
    SphericalDetector det(25, -2 * deg, 2 * deg, 25, 0 * deg, 2 * deg);
    return new GISASSimulation(beam, det);
}

References Units::angstrom, and Units::deg.

Referenced by SimulationFactory::SimulationFactory(), ConstantBackgroundGISAS(), MiniGISASBeamDivergence(), MiniGISASDetectorResolution(), MiniGISASMonteCarlo(), MiniGISASPolarizationMM(), MiniGISASPolarizationMP(), MiniGISASPolarizationPM(), and MiniGISASPolarizationPP().

MiniGISAS_v2()

GISASSimulation * StandardSimulations::MiniGISAS_v2

(

)

GISAS simulation with small detector and phi[-1,1], theta[0,1].

Definition at line 93 of file StandardSimulations.cpp.

{
    Beam beam(1.0, 1 * angstrom, Direction(0.2 * deg, 0 * deg));
    SphericalDetector det(25, -1 * deg, 1 * deg, 25, 0 * deg, 1 * deg);
    return new GISASSimulation(beam, det);
}

References Units::angstrom, and Units::deg.

Referenced by SimulationFactory::SimulationFactory().

MiniGISASBeamDivergence()

GISASSimulation * StandardSimulations::MiniGISASBeamDivergence

(

)

GISAS simulation with beam divergence applied.

Definition at line 102 of file StandardSimulations.cpp.

{
    GISASSimulation* result = MiniGISAS();
 
    DistributionLogNormal wavelength_distr(1 * angstrom, 0.1);
    DistributionGaussian alpha_distr(0.2 * deg, 0.02 * deg);
    DistributionGate phi_distr(-0.1 * deg, 0.02 * deg);
 
    ParameterPattern pattern1;
    pattern1.beginsWith("*").add("Beam").add("Wavelength");
    result->addParameterDistribution(pattern1.toStdString(), wavelength_distr, 5);
    ParameterPattern pattern2;
    pattern2.beginsWith("*").add("Beam").add("InclinationAngle");
    result->addParameterDistribution(pattern2.toStdString(), alpha_distr, 4);
    ParameterPattern pattern3;
    pattern3.beginsWith("*").add("Beam").add("AzimuthalAngle");
    result->addParameterDistribution(pattern3.toStdString(), phi_distr, 3);
 
    return result;
}

References ParameterPattern::add(), ISimulation::addParameterDistribution(), Units::angstrom, ParameterPattern::beginsWith(), Units::deg, MiniGISAS(), and ParameterPattern::toStdString().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function:

MiniGISASDetectorResolution()

GISASSimulation * StandardSimulations::MiniGISASDetectorResolution

(

)

GISAS simulation with detector resolution.

Definition at line 157 of file StandardSimulations.cpp.

{
    GISASSimulation* result = MiniGISAS();
    ResolutionFunction2DGaussian resfunc(0.0025, 0.0025);
    result->setDetectorResolutionFunction(resfunc);
    return result;
}

References MiniGISAS(), and ISimulation::setDetectorResolutionFunction().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function:

MiniGISASFit()

GISASSimulation * StandardSimulations::MiniGISASFit

(

)

ISimulation with fitting.

Beam intensity set to provide reasonably large values in detector channels.

Definition at line 604 of file StandardSimulations.cpp.

{
    auto* result = new GISASSimulation;
    result->setDetectorParameters(25, -2 * deg, 2 * deg, 25, 0 * deg, 2 * deg);
    result->setBeamParameters(1 * angstrom, 0.2 * deg, 0 * deg);
    result->beam().setIntensity(1e6);
    return result;
}

References Units::angstrom, Units::deg, and ISimulation2D::setDetectorParameters().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function:

MiniGISASMonteCarlo()

GISASSimulation * StandardSimulations::MiniGISASMonteCarlo

(

)

GISAS simulation with Monte-Carlo integration switched ON.

Definition at line 318 of file StandardSimulations.cpp.

{
    GISASSimulation* result = MiniGISAS();
    result->getOptions().setMonteCarloIntegration(true, 100);
    return result;
}

References ISimulation::getOptions(), MiniGISAS(), and SimulationOptions::setMonteCarloIntegration().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function:

MiniGISASPolarizationMM()

GISASSimulation * StandardSimulations::MiniGISASPolarizationMM

(

)

Definition at line 201 of file StandardSimulations.cpp.

{
    GISASSimulation* result = MiniGISAS();
 
    kvector_t analyzer_dir(0.0, 0.0, -1.0);
    kvector_t beampol(0.0, 0.0, -1.0);
 
    result->beam().setPolarization(beampol);
    result->detector().setAnalyzerProperties(analyzer_dir, 1.0, 0.5);
    return result;
}

References ISimulation::beam(), ISimulation::detector(), MiniGISAS(), IDetector::setAnalyzerProperties(), and Beam::setPolarization().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function:

MiniGISASPolarizationMP()

GISASSimulation * StandardSimulations::MiniGISASPolarizationMP

(

)

Definition at line 189 of file StandardSimulations.cpp.

{
    GISASSimulation* result = MiniGISAS();
 
    kvector_t analyzer_dir(0.0, 0.0, 1.0);
    kvector_t beampol(0.0, 0.0, -1.0);
 
    result->beam().setPolarization(beampol);
    result->detector().setAnalyzerProperties(analyzer_dir, 1.0, 0.5);
    return result;
}

References ISimulation::beam(), ISimulation::detector(), MiniGISAS(), IDetector::setAnalyzerProperties(), and Beam::setPolarization().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function:

MiniGISASPolarizationPM()

GISASSimulation * StandardSimulations::MiniGISASPolarizationPM

(

)

Definition at line 177 of file StandardSimulations.cpp.

{
    GISASSimulation* result = MiniGISAS();
 
    kvector_t analyzer_dir(0.0, 0.0, -1.0);
    kvector_t beampol(0.0, 0.0, 1.0);
 
    result->beam().setPolarization(beampol);
    result->detector().setAnalyzerProperties(analyzer_dir, 1.0, 0.5);
    return result;
}

References ISimulation::beam(), ISimulation::detector(), MiniGISAS(), IDetector::setAnalyzerProperties(), and Beam::setPolarization().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function:

MiniGISASPolarizationPP()

GISASSimulation * StandardSimulations::MiniGISASPolarizationPP

(

)

Definition at line 165 of file StandardSimulations.cpp.

{
    GISASSimulation* result = MiniGISAS();
 
    kvector_t analyzer_dir(0.0, 0.0, 1.0);
    kvector_t beampol(0.0, 0.0, 1.0);
 
    result->beam().setPolarization(beampol);
    result->detector().setAnalyzerProperties(analyzer_dir, 1.0, 0.5);
    return result;
}

References ISimulation::beam(), ISimulation::detector(), MiniGISAS(), IDetector::setAnalyzerProperties(), and Beam::setPolarization().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function:

MiniGISASSpecularPeak()

GISASSimulation * StandardSimulations::MiniGISASSpecularPeak

(

)

GISAS simulation with small detector and including specular peak.

Definition at line 215 of file StandardSimulations.cpp.

{
    Beam beam(1.0, 1 * angstrom, Direction(0.2 * deg, 0 * deg));
    SphericalDetector det(25, -2 * deg, 2 * deg, 25, 0 * deg, 2 * deg);
    GISASSimulation* result = new GISASSimulation(beam, det);
    result->setBeamParameters(1 * angstrom, 0.2 * deg, 0 * deg);
    result->getOptions().setIncludeSpecular(true);
    return result;
}

References Units::angstrom, Units::deg, ISimulation::getOptions(), GISASSimulation::setBeamParameters(), and SimulationOptions::setIncludeSpecular().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function:

MiniOffSpecular()

OffSpecularSimulation * StandardSimulations::MiniOffSpecular

(

)

Definition at line 558 of file StandardSimulations.cpp.

{
    auto* result = new OffSpecularSimulation;
 
    const int n_alpha(19);
    const double alpha_min(0 * deg);
    const double alpha_max(4 * deg);
    const int n_phi(9);
    const double phi_min(-0.1 * deg);
    const double phi_max(0.1 * deg);
 
    result->setDetectorParameters(n_phi, phi_min, phi_max, n_alpha, alpha_min, alpha_max);
 
    const int n_scan_points(n_alpha);
    const double alpha_i_min(alpha_min);
    const double alpha_i_max(alpha_max);
 
    FixedBinAxis alpha_i_axis("alpha_i", n_scan_points, alpha_i_min, alpha_i_max);
    result->setBeamParameters(5 * angstrom, alpha_i_axis, 0.0);
 
    result->beam().setIntensity(1e9);
    result->getOptions().setIncludeSpecular(true);
 
    return result;
}

References Units::angstrom, and Units::deg.

Referenced by SimulationFactory::SimulationFactory().

RectDetectorGeneric()

GISASSimulation * StandardSimulations::RectDetectorGeneric

(

)

GISAS simulation with generic rectangular detector.

Definition at line 265 of file StandardSimulations.cpp.

{
    Beam beam(1.0, 1 * angstrom, Direction(0.2 * deg, 0 * deg));
    RectangularDetector det(rdet_nbinsx, rdet_width, rdet_nbinsy, rdet_height);
    det.setPosition(kvector_t(rdet_distance, 10.0, 5.0), rdet_width / 2., 1.0,
                    kvector_t(0.1, -1.0, 0.2));
    return new GISASSimulation(beam, det);
}

References Units::angstrom, Units::deg, and RectangularDetector::setPosition().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function:

RectDetectorPerpToDirectBeam()

GISASSimulation * StandardSimulations::RectDetectorPerpToDirectBeam

(

)

GISAS simulation with the rectangular detector perpendicular to the direct beam.

Definition at line 286 of file StandardSimulations.cpp.

{
    Beam beam(1.0, 1 * angstrom, Direction(0.2 * deg, 0 * deg));
    RectangularDetector det(rdet_nbinsx, rdet_width, rdet_nbinsy, rdet_height);
    det.setPerpendicularToDirectBeam(rdet_distance, rdet_width / 2., 1.0);
    return new GISASSimulation(beam, det);
}

References Units::angstrom, Units::deg, and RectangularDetector::setPerpendicularToDirectBeam().

Referenced by SimulationFactory::SimulationFactory(), and RectDetWithRoi().

Here is the call graph for this function:

RectDetectorPerpToReflectedBeam()

GISASSimulation * StandardSimulations::RectDetectorPerpToReflectedBeam

(

)

GISAS simulation with the rectangular detector perpendicular to the reflected beam.

Definition at line 296 of file StandardSimulations.cpp.

{
    Beam beam(1.0, 1 * angstrom, Direction(0.2 * deg, 0 * deg));
    RectangularDetector det(rdet_nbinsx, rdet_width, rdet_nbinsy, rdet_height);
    det.setPerpendicularToReflectedBeam(rdet_distance, rdet_width / 2., 1.0);
    return new GISASSimulation(beam, det);
}

References Units::angstrom, Units::deg, and RectangularDetector::setPerpendicularToReflectedBeam().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function:

RectDetectorPerpToReflectedBeamDpos()

GISASSimulation * StandardSimulations::RectDetectorPerpToReflectedBeamDpos

(

)

GISAS simulation with the rectangular detector perpendicular to the reflected beam when the coordinates of direct beam are known.

Definition at line 307 of file StandardSimulations.cpp.

{
    Beam beam(1.0, 1 * angstrom, Direction(0.2 * deg, 0 * deg));
    RectangularDetector det(rdet_nbinsx, rdet_width, rdet_nbinsy, rdet_height);
    det.setPerpendicularToReflectedBeam(rdet_distance);
    det.setDirectBeamPosition(rdet_width / 2., 1.0);
    return new GISASSimulation(beam, det);
}

References Units::angstrom, Units::deg, RectangularDetector::setDirectBeamPosition(), and RectangularDetector::setPerpendicularToReflectedBeam().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function:

RectDetectorPerpToSample()

GISASSimulation * StandardSimulations::RectDetectorPerpToSample

(

)

GISAS simulation with the rectangular detector perpendicular to the sample.

Definition at line 276 of file StandardSimulations.cpp.

{
    Beam beam(1.0, 1 * angstrom, Direction(0.2 * deg, 0 * deg));
    RectangularDetector det(rdet_nbinsx, rdet_width, rdet_nbinsy, rdet_height);
    det.setPerpendicularToSampleX(rdet_distance, rdet_width / 2., 1.0);
    return new GISASSimulation(beam, det);
}

References Units::angstrom, Units::deg, and RectangularDetector::setPerpendicularToSampleX().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function:

RectDetWithRoi()

GISASSimulation * StandardSimulations::RectDetWithRoi

(

)

GISAS simulation with rectangular detector, region of interest and mask.

Definition at line 339 of file StandardSimulations.cpp.

{
    GISASSimulation* result = RectDetectorPerpToDirectBeam();
    result->addMask(Rectangle(3.0, 4.0, 5.0, 7.0));
    result->setRegionOfInterest(2.0, 3.0, 18.0, 15.0);
    return result;
}

References ISimulation2D::addMask(), RectDetectorPerpToDirectBeam(), and ISimulation2D::setRegionOfInterest().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function:

SpecularDivergentBeam()

SpecularSimulation * StandardSimulations::SpecularDivergentBeam

(

)

Definition at line 433 of file StandardSimulations.cpp.

{
    const double wavelength = 1.54 * angstrom;
    const int number_of_bins = 20;
    const size_t n_integration_points = 10;
    const double min_angle = 0 * deg;
    const double max_angle = 5 * deg;
    const double wl_stddev = 0.1 * angstrom;
    const double ang_stddev = 0.1 * deg;
    AngularSpecScan scan(wavelength, FixedBinAxis("axis", number_of_bins, min_angle, max_angle));
 
    RangedDistributionGaussian wl_distr(n_integration_points, /*sigma_factor = */ 2.0);
    std::unique_ptr<ScanResolution> wl_res(
        ScanResolution::scanAbsoluteResolution(wl_distr, wl_stddev));
 
    RangedDistributionGaussian alpha_distr(n_integration_points, /*sigma_factor = */ 2.0);
    std::unique_ptr<ScanResolution> ang_res(
        ScanResolution::scanAbsoluteResolution(alpha_distr, ang_stddev));
 
    scan.setWavelengthResolution(*wl_res);
    scan.setAngleResolution(*ang_res);
 
    auto* result = new SpecularSimulation;
    result->setScan(scan);
    return result;
}

References Units::angstrom, Units::deg, ScanResolution::scanAbsoluteResolution(), AngularSpecScan::setAngleResolution(), SpecularSimulation::setScan(), and AngularSpecScan::setWavelengthResolution().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function:

SpecularWithGaussianBeam()

SpecularSimulation * StandardSimulations::SpecularWithGaussianBeam

(

)

Definition at line 403 of file StandardSimulations.cpp.

{
    const double wavelength = 1.54 * angstrom;
    const int number_of_bins = 2000;
    const double min_angle = 0 * deg;
    const double max_angle = 5 * deg;
    auto gaussian_ff = std::make_unique<FootprintGauss>(1.0);
    AngularSpecScan scan(wavelength, FixedBinAxis("axis", number_of_bins, min_angle, max_angle));
    scan.setFootprintFactor(gaussian_ff.get());
 
    auto* result = new SpecularSimulation;
    result->setScan(scan);
    return result;
}

References Units::angstrom, Units::deg, AngularSpecScan::setFootprintFactor(), and SpecularSimulation::setScan().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function:

SpecularWithSquareBeam()

SpecularSimulation * StandardSimulations::SpecularWithSquareBeam

(

)

Definition at line 418 of file StandardSimulations.cpp.

{
    const double wavelength = 1.54 * angstrom;
    const int number_of_bins = 2000;
    const double min_angle = 0 * deg;
    const double max_angle = 5 * deg;
    auto square_ff = std::make_unique<FootprintSquare>(1.0);
    AngularSpecScan scan(wavelength, FixedBinAxis("axis", number_of_bins, min_angle, max_angle));
    scan.setFootprintFactor(square_ff.get());
 
    auto* result = new SpecularSimulation;
    result->setScan(scan);
    return result;
}

References Units::angstrom, Units::deg, AngularSpecScan::setFootprintFactor(), and SpecularSimulation::setScan().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function:

SphericalDetWithRoi()

GISASSimulation * StandardSimulations::SphericalDetWithRoi

(

)

GISAS simulation with spherical detector, region of interest and mask.

Definition at line 327 of file StandardSimulations.cpp.

{
    Beam beam(1.0, 1 * angstrom, Direction(0.2 * deg, 0 * deg));
    SphericalDetector det(40, -2 * deg, 2 * deg, 30, 0 * deg, 3 * deg);
    GISASSimulation* result = new GISASSimulation(beam, det);
    result->addMask(Rectangle(-0.5 * deg, 0.3 * deg, -0.2 * deg, 0.6 * deg));
    result->setRegionOfInterest(-1.5 * deg, 0.25 * deg, 1.5 * deg, 1.75 * deg);
    return result;
}

References ISimulation2D::addMask(), Units::angstrom, Units::deg, and ISimulation2D::setRegionOfInterest().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function:

TOFRWithPointwiseResolution()

SpecularSimulation * StandardSimulations::TOFRWithPointwiseResolution

(

)

Definition at line 472 of file StandardSimulations.cpp.

{
    FixedBinAxis qs("axis", 500, 0.0, 1.0);
    QSpecScan q_scan(qs);
 
    std::vector<double> resolutions;
    resolutions.reserve(qs.size());
    auto qs_vector = qs.binCenters();
    std::for_each(qs_vector.begin(), qs_vector.end(),
                  [&resolutions](double q_val) { resolutions.push_back(0.03 * q_val); });
    q_scan.setAbsoluteQResolution(RangedDistributionGaussian(20, 2.0), resolutions);
 
    auto* result = new SpecularSimulation;
    result->setScan(q_scan);
    result->getOptions().setUseAvgMaterials(true);
    return result;
}

References FixedBinAxis::binCenters(), QSpecScan::setAbsoluteQResolution(), SpecularSimulation::setScan(), and FixedBinAxis::size().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function:

TOFRWithRelativeResolution()

SpecularSimulation * StandardSimulations::TOFRWithRelativeResolution

(

)

Definition at line 460 of file StandardSimulations.cpp.

{
    FixedBinAxis qs("axis", 500, 0.0, 1.0);
    QSpecScan q_scan(qs);
    q_scan.setRelativeQResolution(RangedDistributionGaussian(20, 2.0), 0.03);
 
    auto* result = new SpecularSimulation;
    result->setScan(q_scan);
    result->getOptions().setUseAvgMaterials(true);
    return result;
}

References QSpecScan::setRelativeQResolution(), and SpecularSimulation::setScan().

Referenced by SimulationFactory::SimulationFactory().

Here is the call graph for this function: