From e8b6b16cb8e87236fd3f61492bf1c33cd0a44886 Mon Sep 17 00:00:00 2001 From: "Joachim Wuttke (h)" <j.wuttke@fz-juelich.de> Date: Wed, 3 Mar 2021 21:54:54 +0100 Subject: [PATCH] Examples + shebang header line --- .../fit51_Basic/basic_fitting_tutorial.py | 1 + Examples/fit51_Basic/consecutive_fitting.py | 1 + Examples/fit51_Basic/minimal_fit_example.py | 1 + Examples/fit51_Basic/minimizer_settings.py | 1 + Examples/fit52_Advanced/find_background.py | 1 + Examples/fit52_Advanced/fit_along_slices.py | 1 + Examples/fit52_Advanced/fit_with_masks.py | 1 + Examples/fit52_Advanced/multiple_datasets.py | 1 + .../custom_objective_function.py | 1 + .../fit54_ExternalMinimizer/lmfit_basics.py | 1 + .../lmfit_with_plotting.py | 1 + .../fit55_SpecularIntro/FitSpecularBasics.py | 1 + .../FitWithUncertainties.py | 1 + .../PolarizedSpinAsymmetryFit.py | 1 + .../RealLifeReflectometryFitting.py | 1 + .../fit56_SpecularAdvanced/Honeycomb_fit.py | 1 + .../fit56_SpecularAdvanced/Pt_layer_fit.py | 1 + Examples/fit61_Galaxi/fit_galaxi_data.py | 1 + Examples/fit61_Galaxi/sample_builder.py | 1 + Examples/scatter2d/ApproximationDA.py | 1 + Examples/scatter2d/ApproximationLMA.py | 1 + Examples/scatter2d/ApproximationSSCA.py | 1 + Examples/scatter2d/BeamDivergence.py | 1 + Examples/scatter2d/BiMaterialCylinders.py | 1 + Examples/scatter2d/BoxesWithSpecularPeak.py | 1 + Examples/scatter2d/BuriedParticles.py | 1 + Examples/scatter2d/ConstantBackground.py | 1 + Examples/scatter2d/CoreShellNanoparticles.py | 1 + Examples/scatter2d/CorrelatedRoughness.py | 1 + .../scatter2d/CosineRipplesAtRectLattice.py | 1 + Examples/scatter2d/CylindersAndPrisms.py | 1 + Examples/scatter2d/CylindersInAverageLayer.py | 1 + Examples/scatter2d/CylindersInBA.py | 1 + Examples/scatter2d/CylindersInDWBA.py | 1 + .../CylindersWithSizeDistribution.py | 1 + .../scatter2d/DetectorResolutionFunction.py | 1 + .../scatter2d/HalfSpheresInAverageTopLayer.py | 1 + .../scatter2d/HexagonalLatticesWithBasis.py | 1 + .../Interference1DRadialParaCrystal.py | 1 + .../Interference2DCenteredSquareLattice.py | 1 + .../Interference2DLatticeSumOfRotated.py | 1 + .../scatter2d/Interference2DParaCrystal.py | 1 + .../Interference2DRotatedSquareLattice.py | 1 + .../Interference2DSquareFiniteLattice.py | 1 + .../scatter2d/Interference2DSquareLattice.py | 1 + Examples/scatter2d/MagneticSpheres.py | 1 + Examples/scatter2d/MesoCrystal.py | 1 + .../scatter2d/ParticlesCrossingInterface.py | 1 + Examples/scatter2d/RectangularGrating.py | 1 + Examples/scatter2d/RotatedPyramids.py | 1 + Examples/scatter2d/SpheresAtHexLattice.py | 1 + Examples/scatter2d/TriangularRipple.py | 1 + ...TwoTypesOfCylindersWithSizeDistribution.py | 1 + Examples/specular/BasicSpecularSimulation.py | 1 + Examples/specular/BeamAngularDivergence.py | 1 + Examples/specular/BeamFullDivergence.py | 1 + Examples/specular/TOFRWithResolution.py | 1 + .../specular/TimeOfFlightReflectometry.py | 1 + Examples/varia/AccessingSimulationResults.py | 1 + Examples/varia/AllFormFactorsAvailable.py | 1 + Examples/varia/AxesInDifferentUnits.py | 1 + Examples/varia/BasicPolarizedReflectometry.py | 1 + Examples/varia/CustomFormFactor.py | 1 + Examples/varia/DepthProbe.py | 1 + Examples/varia/FindPeaks.py | 1 + Examples/varia/FootprintCorrection.py | 1 + Examples/varia/GratingMC.py | 1 + Examples/varia/Interference1DLattice.py | 1 + Examples/varia/LargeParticlesFormFactor.py | 1 + Examples/varia/MaterialProfile.py | 1 + .../varia/MaterialProfileWithParticles.py | 1 + Examples/varia/OffSpecularSimulation.py | 1 + Examples/varia/PolarizedNoAnalyzer.py | 1 + .../PolarizedNonperfectAnalyzerPolarizer.py | 1 + Examples/varia/PolarizedSANS.py | 1 + Examples/varia/PolarizedSpinAsymmetry.py | 1 + Examples/varia/PolarizedSpinFlip.py | 1 + Examples/varia/RectangularDetector.py | 1 + Examples/varia/ResonatorOffSpecSetup.py | 1 + Examples/varia/RoughnessModel.py | 1 + Examples/varia/SimulationParameters.py | 1 + .../varia/SpecularSimulationWithRoughness.py | 1 + auto/Wrap/doxygenBase.i | 5 +- auto/Wrap/doxygenFit.i | 165 ++++++++++-------- auto/Wrap/doxygenSample.i | 2 +- 85 files changed, 177 insertions(+), 77 deletions(-) diff --git a/Examples/fit51_Basic/basic_fitting_tutorial.py b/Examples/fit51_Basic/basic_fitting_tutorial.py index 0ae9626101e..f87b6f6cc0a 100644 --- a/Examples/fit51_Basic/basic_fitting_tutorial.py +++ b/Examples/fit51_Basic/basic_fitting_tutorial.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Fitting example: 4 parameters fit for mixture of cylinders and prisms on top of substrate. diff --git a/Examples/fit51_Basic/consecutive_fitting.py b/Examples/fit51_Basic/consecutive_fitting.py index 59193cf7f5d..8b6a79b248b 100644 --- a/Examples/fit51_Basic/consecutive_fitting.py +++ b/Examples/fit51_Basic/consecutive_fitting.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Fitting example: running one fit after another using different minimizers. diff --git a/Examples/fit51_Basic/minimal_fit_example.py b/Examples/fit51_Basic/minimal_fit_example.py index cf2883a060d..4cac7fe64a2 100644 --- a/Examples/fit51_Basic/minimal_fit_example.py +++ b/Examples/fit51_Basic/minimal_fit_example.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Minimal working fit examples: finds radius of sphere in Born approximation. """ diff --git a/Examples/fit51_Basic/minimizer_settings.py b/Examples/fit51_Basic/minimizer_settings.py index dfffad0b1fa..469cd26e36b 100644 --- a/Examples/fit51_Basic/minimizer_settings.py +++ b/Examples/fit51_Basic/minimizer_settings.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Fitting example: running same fit using various minimizer and their settings. """ diff --git a/Examples/fit52_Advanced/find_background.py b/Examples/fit52_Advanced/find_background.py index 001f8382bce..5b32f9d604a 100644 --- a/Examples/fit52_Advanced/find_background.py +++ b/Examples/fit52_Advanced/find_background.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Fitting example: looking for background and scale factors. diff --git a/Examples/fit52_Advanced/fit_along_slices.py b/Examples/fit52_Advanced/fit_along_slices.py index 52e1fe7ad1c..bd8d595d331 100644 --- a/Examples/fit52_Advanced/fit_along_slices.py +++ b/Examples/fit52_Advanced/fit_along_slices.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Fitting example: fit along slices """ diff --git a/Examples/fit52_Advanced/fit_with_masks.py b/Examples/fit52_Advanced/fit_with_masks.py index 6c00d5a7a62..eae6aeaa382 100644 --- a/Examples/fit52_Advanced/fit_with_masks.py +++ b/Examples/fit52_Advanced/fit_with_masks.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Fitting example: fit with masks """ diff --git a/Examples/fit52_Advanced/multiple_datasets.py b/Examples/fit52_Advanced/multiple_datasets.py index 96a02b7ca04..de24da26ecf 100644 --- a/Examples/fit52_Advanced/multiple_datasets.py +++ b/Examples/fit52_Advanced/multiple_datasets.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Fitting example: simultaneous fit of two datasets """ diff --git a/Examples/fit53_CustomObjective/custom_objective_function.py b/Examples/fit53_CustomObjective/custom_objective_function.py index c9d41a5d81f..1690de82ffa 100644 --- a/Examples/fit53_CustomObjective/custom_objective_function.py +++ b/Examples/fit53_CustomObjective/custom_objective_function.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Using custom objective function to fit GISAS data. diff --git a/Examples/fit54_ExternalMinimizer/lmfit_basics.py b/Examples/fit54_ExternalMinimizer/lmfit_basics.py index a2bd371deff..2cc226890c9 100644 --- a/Examples/fit54_ExternalMinimizer/lmfit_basics.py +++ b/Examples/fit54_ExternalMinimizer/lmfit_basics.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ External minimize: using lmfit minimizers for BornAgain fits. """ diff --git a/Examples/fit54_ExternalMinimizer/lmfit_with_plotting.py b/Examples/fit54_ExternalMinimizer/lmfit_with_plotting.py index 2c78516ec5e..c8414a9b13d 100644 --- a/Examples/fit54_ExternalMinimizer/lmfit_with_plotting.py +++ b/Examples/fit54_ExternalMinimizer/lmfit_with_plotting.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ External minimize: using lmfit minimizers for BornAgain fits. Fit progress is plotted using lmfit iteration calbback function. diff --git a/Examples/fit55_SpecularIntro/FitSpecularBasics.py b/Examples/fit55_SpecularIntro/FitSpecularBasics.py index 0a6b67271af..f914dcbb25d 100644 --- a/Examples/fit55_SpecularIntro/FitSpecularBasics.py +++ b/Examples/fit55_SpecularIntro/FitSpecularBasics.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Example demonstrates how to fit specular data. Our sample represents twenty interchanging layers of Ti and Ni. We will fit diff --git a/Examples/fit55_SpecularIntro/FitWithUncertainties.py b/Examples/fit55_SpecularIntro/FitWithUncertainties.py index 56b19c690fc..416685355b4 100644 --- a/Examples/fit55_SpecularIntro/FitWithUncertainties.py +++ b/Examples/fit55_SpecularIntro/FitWithUncertainties.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Example demonstrates how to fit specular data. Our sample represents twenty interchanging layers of Ti and Ni. We will fit diff --git a/Examples/fit55_SpecularIntro/PolarizedSpinAsymmetryFit.py b/Examples/fit55_SpecularIntro/PolarizedSpinAsymmetryFit.py index 970338e1de1..5262ea8031c 100644 --- a/Examples/fit55_SpecularIntro/PolarizedSpinAsymmetryFit.py +++ b/Examples/fit55_SpecularIntro/PolarizedSpinAsymmetryFit.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ This fitting and simulation example demonstrates how to replicate the fitting example "Magnetically Dead Layers in Spinel Films" diff --git a/Examples/fit55_SpecularIntro/RealLifeReflectometryFitting.py b/Examples/fit55_SpecularIntro/RealLifeReflectometryFitting.py index d0b061bdffe..7c7aabe6ae7 100644 --- a/Examples/fit55_SpecularIntro/RealLifeReflectometryFitting.py +++ b/Examples/fit55_SpecularIntro/RealLifeReflectometryFitting.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Real life example: Fitting data from an X-ray reflectometer diff --git a/Examples/fit56_SpecularAdvanced/Honeycomb_fit.py b/Examples/fit56_SpecularAdvanced/Honeycomb_fit.py index e5977866c95..d6ead29c29f 100644 --- a/Examples/fit56_SpecularAdvanced/Honeycomb_fit.py +++ b/Examples/fit56_SpecularAdvanced/Honeycomb_fit.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ This example demonstrates how to fit a complex experimental setup using BornAgain. It is based on real data published in https://doi.org/10.1002/advs.201700856 diff --git a/Examples/fit56_SpecularAdvanced/Pt_layer_fit.py b/Examples/fit56_SpecularAdvanced/Pt_layer_fit.py index 1eb2a1f861b..e06ddd9c538 100644 --- a/Examples/fit56_SpecularAdvanced/Pt_layer_fit.py +++ b/Examples/fit56_SpecularAdvanced/Pt_layer_fit.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ This example demonstrates how to fit actual experimental data by M. Fitzsimmons et al. that is published in diff --git a/Examples/fit61_Galaxi/fit_galaxi_data.py b/Examples/fit61_Galaxi/fit_galaxi_data.py index fb7d6fcd69e..faeb0723acd 100644 --- a/Examples/fit61_Galaxi/fit_galaxi_data.py +++ b/Examples/fit61_Galaxi/fit_galaxi_data.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Fitting experimental data: spherical nanoparticles with size distribution in 3 layers system (experiment at GALAXI). diff --git a/Examples/fit61_Galaxi/sample_builder.py b/Examples/fit61_Galaxi/sample_builder.py index 3ada2bdcb3f..b9a919eca84 100644 --- a/Examples/fit61_Galaxi/sample_builder.py +++ b/Examples/fit61_Galaxi/sample_builder.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ 3 layers system (substrate, teflon, air). Vacuum layer is populated with spheres with size distribution. diff --git a/Examples/scatter2d/ApproximationDA.py b/Examples/scatter2d/ApproximationDA.py index f31561b356b..6fbd99ed31d 100644 --- a/Examples/scatter2d/ApproximationDA.py +++ b/Examples/scatter2d/ApproximationDA.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Cylinders of two different sizes in Decoupling Approximation """ diff --git a/Examples/scatter2d/ApproximationLMA.py b/Examples/scatter2d/ApproximationLMA.py index 5ac53ba473a..ee4dc132730 100644 --- a/Examples/scatter2d/ApproximationLMA.py +++ b/Examples/scatter2d/ApproximationLMA.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Cylinders of two different sizes in Local Monodisperse Approximation """ diff --git a/Examples/scatter2d/ApproximationSSCA.py b/Examples/scatter2d/ApproximationSSCA.py index 0f755324a38..b2f8a8e5c82 100644 --- a/Examples/scatter2d/ApproximationSSCA.py +++ b/Examples/scatter2d/ApproximationSSCA.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Cylinders of two different sizes in Size-Spacing Coupling Approximation """ diff --git a/Examples/scatter2d/BeamDivergence.py b/Examples/scatter2d/BeamDivergence.py index 7427e5be5d0..9045ea1767d 100644 --- a/Examples/scatter2d/BeamDivergence.py +++ b/Examples/scatter2d/BeamDivergence.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Cylinder form factor in DWBA with beam divergence """ diff --git a/Examples/scatter2d/BiMaterialCylinders.py b/Examples/scatter2d/BiMaterialCylinders.py index 984d9b730d9..275f56f833f 100644 --- a/Examples/scatter2d/BiMaterialCylinders.py +++ b/Examples/scatter2d/BiMaterialCylinders.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Cylindrical particle made from two materials. Particle crosses air/substrate interface. diff --git a/Examples/scatter2d/BoxesWithSpecularPeak.py b/Examples/scatter2d/BoxesWithSpecularPeak.py index 045e2d774ee..aab73f75c80 100644 --- a/Examples/scatter2d/BoxesWithSpecularPeak.py +++ b/Examples/scatter2d/BoxesWithSpecularPeak.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Square lattice of boxes on substrate (including the specular peak) """ diff --git a/Examples/scatter2d/BuriedParticles.py b/Examples/scatter2d/BuriedParticles.py index 8f632ef8f1f..806d1d379f6 100644 --- a/Examples/scatter2d/BuriedParticles.py +++ b/Examples/scatter2d/BuriedParticles.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Spherical particles embedded in the middle of the layer on top of substrate. """ diff --git a/Examples/scatter2d/ConstantBackground.py b/Examples/scatter2d/ConstantBackground.py index 46211573d77..9fbb322fd87 100644 --- a/Examples/scatter2d/ConstantBackground.py +++ b/Examples/scatter2d/ConstantBackground.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Cylinder form factor in DWBA with constant background """ diff --git a/Examples/scatter2d/CoreShellNanoparticles.py b/Examples/scatter2d/CoreShellNanoparticles.py index d47fa529f1c..463858ed9d3 100644 --- a/Examples/scatter2d/CoreShellNanoparticles.py +++ b/Examples/scatter2d/CoreShellNanoparticles.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Core shell nanoparticles """ diff --git a/Examples/scatter2d/CorrelatedRoughness.py b/Examples/scatter2d/CorrelatedRoughness.py index 6e844179cce..c92cb436be1 100644 --- a/Examples/scatter2d/CorrelatedRoughness.py +++ b/Examples/scatter2d/CorrelatedRoughness.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ MultiLayer with correlated roughness """ diff --git a/Examples/scatter2d/CosineRipplesAtRectLattice.py b/Examples/scatter2d/CosineRipplesAtRectLattice.py index 741ba3e5ada..d5bf586e48b 100644 --- a/Examples/scatter2d/CosineRipplesAtRectLattice.py +++ b/Examples/scatter2d/CosineRipplesAtRectLattice.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Cosine ripple on a 2D lattice """ diff --git a/Examples/scatter2d/CylindersAndPrisms.py b/Examples/scatter2d/CylindersAndPrisms.py index a14fcef8837..7db298a07b4 100644 --- a/Examples/scatter2d/CylindersAndPrisms.py +++ b/Examples/scatter2d/CylindersAndPrisms.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Mixture of cylinders and prisms without interference """ diff --git a/Examples/scatter2d/CylindersInAverageLayer.py b/Examples/scatter2d/CylindersInAverageLayer.py index 410a434a9cf..55c7e31fa33 100644 --- a/Examples/scatter2d/CylindersInAverageLayer.py +++ b/Examples/scatter2d/CylindersInAverageLayer.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Square lattice of cylinders inside finite layer with usage of average material """ diff --git a/Examples/scatter2d/CylindersInBA.py b/Examples/scatter2d/CylindersInBA.py index 64d5c7b3711..27be2a5261b 100644 --- a/Examples/scatter2d/CylindersInBA.py +++ b/Examples/scatter2d/CylindersInBA.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Cylinder form factor in Born approximation """ diff --git a/Examples/scatter2d/CylindersInDWBA.py b/Examples/scatter2d/CylindersInDWBA.py index 84360e98e9f..a9b18ba2e49 100644 --- a/Examples/scatter2d/CylindersInDWBA.py +++ b/Examples/scatter2d/CylindersInDWBA.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Cylinder form factor in DWBA """ diff --git a/Examples/scatter2d/CylindersWithSizeDistribution.py b/Examples/scatter2d/CylindersWithSizeDistribution.py index 398dc1e219d..fcc66e4795e 100644 --- a/Examples/scatter2d/CylindersWithSizeDistribution.py +++ b/Examples/scatter2d/CylindersWithSizeDistribution.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Cylinders with size distribution """ diff --git a/Examples/scatter2d/DetectorResolutionFunction.py b/Examples/scatter2d/DetectorResolutionFunction.py index efe1718d899..8eeaf26f000 100644 --- a/Examples/scatter2d/DetectorResolutionFunction.py +++ b/Examples/scatter2d/DetectorResolutionFunction.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Cylinder form factor in DWBA with detector resolution function applied """ diff --git a/Examples/scatter2d/HalfSpheresInAverageTopLayer.py b/Examples/scatter2d/HalfSpheresInAverageTopLayer.py index dd82a0df3f9..d3328cb5946 100644 --- a/Examples/scatter2d/HalfSpheresInAverageTopLayer.py +++ b/Examples/scatter2d/HalfSpheresInAverageTopLayer.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Square lattice of half spheres on substrate with usage of average material and slicing diff --git a/Examples/scatter2d/HexagonalLatticesWithBasis.py b/Examples/scatter2d/HexagonalLatticesWithBasis.py index 9f83af14f31..95335e8009a 100644 --- a/Examples/scatter2d/HexagonalLatticesWithBasis.py +++ b/Examples/scatter2d/HexagonalLatticesWithBasis.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Spheres on two hexagonal close packed layers """ diff --git a/Examples/scatter2d/Interference1DRadialParaCrystal.py b/Examples/scatter2d/Interference1DRadialParaCrystal.py index 2b0033bfffe..0915d819a30 100644 --- a/Examples/scatter2d/Interference1DRadialParaCrystal.py +++ b/Examples/scatter2d/Interference1DRadialParaCrystal.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ radial paracrystal """ diff --git a/Examples/scatter2d/Interference2DCenteredSquareLattice.py b/Examples/scatter2d/Interference2DCenteredSquareLattice.py index ba72804532f..1ce18932a8c 100644 --- a/Examples/scatter2d/Interference2DCenteredSquareLattice.py +++ b/Examples/scatter2d/Interference2DCenteredSquareLattice.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ 2D lattice with disorder, centered square lattice """ diff --git a/Examples/scatter2d/Interference2DLatticeSumOfRotated.py b/Examples/scatter2d/Interference2DLatticeSumOfRotated.py index f64b969c613..9866a4a5373 100644 --- a/Examples/scatter2d/Interference2DLatticeSumOfRotated.py +++ b/Examples/scatter2d/Interference2DLatticeSumOfRotated.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 import bornagain as ba from bornagain import deg, nm diff --git a/Examples/scatter2d/Interference2DParaCrystal.py b/Examples/scatter2d/Interference2DParaCrystal.py index 90bb8b7f7f8..77d5ba2efce 100644 --- a/Examples/scatter2d/Interference2DParaCrystal.py +++ b/Examples/scatter2d/Interference2DParaCrystal.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ 2D paracrystal """ diff --git a/Examples/scatter2d/Interference2DRotatedSquareLattice.py b/Examples/scatter2d/Interference2DRotatedSquareLattice.py index 22ec4a4222c..09595e8a75f 100644 --- a/Examples/scatter2d/Interference2DRotatedSquareLattice.py +++ b/Examples/scatter2d/Interference2DRotatedSquareLattice.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Cylinders on a rotated 2D lattice """ diff --git a/Examples/scatter2d/Interference2DSquareFiniteLattice.py b/Examples/scatter2d/Interference2DSquareFiniteLattice.py index 32f6f7c3be1..aa6831b1c70 100644 --- a/Examples/scatter2d/Interference2DSquareFiniteLattice.py +++ b/Examples/scatter2d/Interference2DSquareFiniteLattice.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Cylinders on a 2D square lattice """ diff --git a/Examples/scatter2d/Interference2DSquareLattice.py b/Examples/scatter2d/Interference2DSquareLattice.py index b843d880185..b8c679c8ebc 100644 --- a/Examples/scatter2d/Interference2DSquareLattice.py +++ b/Examples/scatter2d/Interference2DSquareLattice.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Cylinders on a 2D square lattice """ diff --git a/Examples/scatter2d/MagneticSpheres.py b/Examples/scatter2d/MagneticSpheres.py index ab0431edaf5..d8389c08fcc 100644 --- a/Examples/scatter2d/MagneticSpheres.py +++ b/Examples/scatter2d/MagneticSpheres.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Simulation demo: magnetic spheres in substrate """ diff --git a/Examples/scatter2d/MesoCrystal.py b/Examples/scatter2d/MesoCrystal.py index 149c9c171cd..fa7a0cbca3e 100644 --- a/Examples/scatter2d/MesoCrystal.py +++ b/Examples/scatter2d/MesoCrystal.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Cylindrical mesocrystal on a substrate """ diff --git a/Examples/scatter2d/ParticlesCrossingInterface.py b/Examples/scatter2d/ParticlesCrossingInterface.py index ed344c9cfa8..bf4d512400b 100644 --- a/Examples/scatter2d/ParticlesCrossingInterface.py +++ b/Examples/scatter2d/ParticlesCrossingInterface.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ This example demonstrates new experimental feature of release-1.8.0: particles can now cross interfaces. diff --git a/Examples/scatter2d/RectangularGrating.py b/Examples/scatter2d/RectangularGrating.py index 72b827ef2ef..640b24778ab 100644 --- a/Examples/scatter2d/RectangularGrating.py +++ b/Examples/scatter2d/RectangularGrating.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Simulation of grating using very long boxes and 1D lattice. Monte-carlo integration is used to get rid of diff --git a/Examples/scatter2d/RotatedPyramids.py b/Examples/scatter2d/RotatedPyramids.py index 55e7822bca7..477807ae07a 100644 --- a/Examples/scatter2d/RotatedPyramids.py +++ b/Examples/scatter2d/RotatedPyramids.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Rotated pyramids on top of substrate """ diff --git a/Examples/scatter2d/SpheresAtHexLattice.py b/Examples/scatter2d/SpheresAtHexLattice.py index 3b3ca8c0d9e..a3e8f359a65 100644 --- a/Examples/scatter2d/SpheresAtHexLattice.py +++ b/Examples/scatter2d/SpheresAtHexLattice.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Spheres on a hexagonal lattice """ diff --git a/Examples/scatter2d/TriangularRipple.py b/Examples/scatter2d/TriangularRipple.py index df049044dfb..6f7dddc73f6 100644 --- a/Examples/scatter2d/TriangularRipple.py +++ b/Examples/scatter2d/TriangularRipple.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Sample from the article D. Babonneau et. al., Phys. Rev. B 85, 235415, 2012 (Fig.3) """ diff --git a/Examples/scatter2d/TwoTypesOfCylindersWithSizeDistribution.py b/Examples/scatter2d/TwoTypesOfCylindersWithSizeDistribution.py index b7bdd862d8d..e3089e34e46 100644 --- a/Examples/scatter2d/TwoTypesOfCylindersWithSizeDistribution.py +++ b/Examples/scatter2d/TwoTypesOfCylindersWithSizeDistribution.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Mixture cylinder particles with different size distribution """ diff --git a/Examples/specular/BasicSpecularSimulation.py b/Examples/specular/BasicSpecularSimulation.py index 283e14ab641..491a1e53820 100644 --- a/Examples/specular/BasicSpecularSimulation.py +++ b/Examples/specular/BasicSpecularSimulation.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Basic example of specular simulation with BornAgain. diff --git a/Examples/specular/BeamAngularDivergence.py b/Examples/specular/BeamAngularDivergence.py index a8db4eb7ac4..27f9d9c4e63 100644 --- a/Examples/specular/BeamAngularDivergence.py +++ b/Examples/specular/BeamAngularDivergence.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ An example of taking into account beam angular divergence and beam footprint correction in reflectometry calculations diff --git a/Examples/specular/BeamFullDivergence.py b/Examples/specular/BeamFullDivergence.py index 21d34bd0956..2aac626629c 100644 --- a/Examples/specular/BeamFullDivergence.py +++ b/Examples/specular/BeamFullDivergence.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ An example of taking into account beam angular and wavelength divergence in reflectometry calculations with BornAgain. diff --git a/Examples/specular/TOFRWithResolution.py b/Examples/specular/TOFRWithResolution.py index b8a5ed34096..f7d3783571c 100644 --- a/Examples/specular/TOFRWithResolution.py +++ b/Examples/specular/TOFRWithResolution.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ An example of defining reflectometry instrument for time of flight experiment. In this example diff --git a/Examples/specular/TimeOfFlightReflectometry.py b/Examples/specular/TimeOfFlightReflectometry.py index 02709aa98b6..d81eace85f5 100644 --- a/Examples/specular/TimeOfFlightReflectometry.py +++ b/Examples/specular/TimeOfFlightReflectometry.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ An example of defining reflectometry instrument for time of flight experiment. In this example diff --git a/Examples/varia/AccessingSimulationResults.py b/Examples/varia/AccessingSimulationResults.py index 068b7ba7c1a..b99f0114448 100644 --- a/Examples/varia/AccessingSimulationResults.py +++ b/Examples/varia/AccessingSimulationResults.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Extended example for simulation results treatment (cropping, slicing, exporting) The standard "Cylinders in DWBA" sample is used to setup the simulation. diff --git a/Examples/varia/AllFormFactorsAvailable.py b/Examples/varia/AllFormFactorsAvailable.py index e412aad4baa..b7ecd5bd3fe 100644 --- a/Examples/varia/AllFormFactorsAvailable.py +++ b/Examples/varia/AllFormFactorsAvailable.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ All form factors available in BornAgain in the Born Approximation """ diff --git a/Examples/varia/AxesInDifferentUnits.py b/Examples/varia/AxesInDifferentUnits.py index e657d8f701d..09d0919d796 100644 --- a/Examples/varia/AxesInDifferentUnits.py +++ b/Examples/varia/AxesInDifferentUnits.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ In this example we demonstrate how to plot simulation results with axes in different units (nbins, mm, degs and QyQz). diff --git a/Examples/varia/BasicPolarizedReflectometry.py b/Examples/varia/BasicPolarizedReflectometry.py index 11c3d85fd11..1783e0672aa 100644 --- a/Examples/varia/BasicPolarizedReflectometry.py +++ b/Examples/varia/BasicPolarizedReflectometry.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ An example of computing reflectivity on a magnetized sample. diff --git a/Examples/varia/CustomFormFactor.py b/Examples/varia/CustomFormFactor.py index 5e416d89f17..2f962490866 100644 --- a/Examples/varia/CustomFormFactor.py +++ b/Examples/varia/CustomFormFactor.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Custom form factor in DWBA. """ diff --git a/Examples/varia/DepthProbe.py b/Examples/varia/DepthProbe.py index 284d721c247..c954d3dc36b 100644 --- a/Examples/varia/DepthProbe.py +++ b/Examples/varia/DepthProbe.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Basic example of depth-probe simulation with BornAgain. Sample structure: diff --git a/Examples/varia/FindPeaks.py b/Examples/varia/FindPeaks.py index a0d8d9ea892..e312c82980f 100644 --- a/Examples/varia/FindPeaks.py +++ b/Examples/varia/FindPeaks.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Simulation of grating using very long boxes and 1D lattice. Monte-carlo integration is used to get rid of diff --git a/Examples/varia/FootprintCorrection.py b/Examples/varia/FootprintCorrection.py index 17e911b84da..12d46ac9471 100644 --- a/Examples/varia/FootprintCorrection.py +++ b/Examples/varia/FootprintCorrection.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Specular simulation with a footprint correction for a square beam diff --git a/Examples/varia/GratingMC.py b/Examples/varia/GratingMC.py index 87fd859ebf5..d2cee7b4c29 100644 --- a/Examples/varia/GratingMC.py +++ b/Examples/varia/GratingMC.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Simulation of grating using very long boxes and 1D lattice. Monte-carlo integration is used to get rid of diff --git a/Examples/varia/Interference1DLattice.py b/Examples/varia/Interference1DLattice.py index 9f0d93109e5..ee0e49a2b3a 100644 --- a/Examples/varia/Interference1DLattice.py +++ b/Examples/varia/Interference1DLattice.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Simulation of grating using very long boxes and 1D lattice. Monte-carlo integration is used to get rid of diff --git a/Examples/varia/LargeParticlesFormFactor.py b/Examples/varia/LargeParticlesFormFactor.py index ab986f06297..219737a9900 100644 --- a/Examples/varia/LargeParticlesFormFactor.py +++ b/Examples/varia/LargeParticlesFormFactor.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Large cylinders in DWBA. diff --git a/Examples/varia/MaterialProfile.py b/Examples/varia/MaterialProfile.py index 423a7cbfeda..82bd3391d5b 100644 --- a/Examples/varia/MaterialProfile.py +++ b/Examples/varia/MaterialProfile.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Basic example for producing a profile of SLD of a multilayer. """ diff --git a/Examples/varia/MaterialProfileWithParticles.py b/Examples/varia/MaterialProfileWithParticles.py index ffa2224a273..02f7b25910e 100644 --- a/Examples/varia/MaterialProfileWithParticles.py +++ b/Examples/varia/MaterialProfileWithParticles.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Example for producing a profile of SLD of a multilayer with particles and slicing. diff --git a/Examples/varia/OffSpecularSimulation.py b/Examples/varia/OffSpecularSimulation.py index fb437dd3444..023e03050a1 100644 --- a/Examples/varia/OffSpecularSimulation.py +++ b/Examples/varia/OffSpecularSimulation.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Long boxes at 1D lattice, ba.OffSpecular simulation """ diff --git a/Examples/varia/PolarizedNoAnalyzer.py b/Examples/varia/PolarizedNoAnalyzer.py index a2d83342b89..6c1ec76a783 100644 --- a/Examples/varia/PolarizedNoAnalyzer.py +++ b/Examples/varia/PolarizedNoAnalyzer.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ An example of computing splin-flip reflectivity from a magnetized sample. diff --git a/Examples/varia/PolarizedNonperfectAnalyzerPolarizer.py b/Examples/varia/PolarizedNonperfectAnalyzerPolarizer.py index afda3b0bf9b..5c47342d9fd 100644 --- a/Examples/varia/PolarizedNonperfectAnalyzerPolarizer.py +++ b/Examples/varia/PolarizedNonperfectAnalyzerPolarizer.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ An example that shows how to simulate a non-perfect polarizer and analyzer diff --git a/Examples/varia/PolarizedSANS.py b/Examples/varia/PolarizedSANS.py index 00595d49e69..7c07918c1ac 100644 --- a/Examples/varia/PolarizedSANS.py +++ b/Examples/varia/PolarizedSANS.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Simple example demonstrating how polarized SANS experiments can be simulated with BornAgain. diff --git a/Examples/varia/PolarizedSpinAsymmetry.py b/Examples/varia/PolarizedSpinAsymmetry.py index c38a1566580..b5e4d71c057 100644 --- a/Examples/varia/PolarizedSpinAsymmetry.py +++ b/Examples/varia/PolarizedSpinAsymmetry.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ This simulation example demonstrates how to replicate the fitting example "Magnetically Dead Layers in Spinel Films" diff --git a/Examples/varia/PolarizedSpinFlip.py b/Examples/varia/PolarizedSpinFlip.py index d138358ed66..c393b7bf5cd 100644 --- a/Examples/varia/PolarizedSpinFlip.py +++ b/Examples/varia/PolarizedSpinFlip.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ An example of computing splin-flip reflectivity from a magnetized sample. diff --git a/Examples/varia/RectangularDetector.py b/Examples/varia/RectangularDetector.py index 81cfa4d73d9..030b6be9071 100644 --- a/Examples/varia/RectangularDetector.py +++ b/Examples/varia/RectangularDetector.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Simulation with rectangular detector. Pilatus3-1M detector is used as an example. Results will be compared against simulation with spherical detector. diff --git a/Examples/varia/ResonatorOffSpecSetup.py b/Examples/varia/ResonatorOffSpecSetup.py index fe5faa1480e..66ab0dea37c 100644 --- a/Examples/varia/ResonatorOffSpecSetup.py +++ b/Examples/varia/ResonatorOffSpecSetup.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Resonator in off-specular experiment. """ diff --git a/Examples/varia/RoughnessModel.py b/Examples/varia/RoughnessModel.py index 041a31d29e5..3950e975054 100644 --- a/Examples/varia/RoughnessModel.py +++ b/Examples/varia/RoughnessModel.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Example of simulating a rough sample with a tanh and Nevot-Croce roughness model using BornAgain. diff --git a/Examples/varia/SimulationParameters.py b/Examples/varia/SimulationParameters.py index a4fd150cae8..c3d2a400f04 100644 --- a/Examples/varia/SimulationParameters.py +++ b/Examples/varia/SimulationParameters.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Working with sample parameters. diff --git a/Examples/varia/SpecularSimulationWithRoughness.py b/Examples/varia/SpecularSimulationWithRoughness.py index 0fd4821842c..72d9c59b602 100644 --- a/Examples/varia/SpecularSimulationWithRoughness.py +++ b/Examples/varia/SpecularSimulationWithRoughness.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Example of simulating a reflectometry experiment with a rough sample using BornAgain. diff --git a/auto/Wrap/doxygenBase.i b/auto/Wrap/doxygenBase.i index 5ae497b8532..6b53a9f9f13 100644 --- a/auto/Wrap/doxygenBase.i +++ b/auto/Wrap/doxygenBase.i @@ -767,7 +767,7 @@ Returns value of last on-axis point. %feature("docstring") PointwiseAxis::binCenter "double PointwiseAxis::binCenter(size_t index) const override -Returns the coordinate corresponding to the given index. +Returns the coordinate corresponding to the given index. For this type of axis (\"pointwise\") this equals returning an explicitly defined coordinate. "; %feature("docstring") PointwiseAxis::findClosestIndex "size_t PointwiseAxis::findClosestIndex(double value) const override @@ -1436,6 +1436,9 @@ Returns string representing python stack trace. "; +// File: namespacestd.xml + + // File: namespaceStringUtils.xml %feature("docstring") StringUtils::matchesPattern "bool StringUtils::matchesPattern(const std::string &text, const std::string &wildcardPattern) diff --git a/auto/Wrap/doxygenFit.i b/auto/Wrap/doxygenFit.i index a57314eb406..0bc683d4cf0 100644 --- a/auto/Wrap/doxygenFit.i +++ b/auto/Wrap/doxygenFit.i @@ -3344,9 +3344,13 @@ Copy constructor for functor based on ROOT::Math::IMultiGenFunction "; %feature("docstring") ROOT::Math::Functor::Clone "ImplBase* ROOT::Math::Functor::Clone() const + +Clone a function. Each derived class must implement their version of the Clone method "; %feature("docstring") ROOT::Math::Functor::NDim "unsigned int ROOT::Math::Functor::NDim() const + +Retrieve the dimension of the function "; @@ -3596,6 +3600,71 @@ C++ includes: GenericFunction.h "; +// File: classGeneticMinimizer.xml +%feature("docstring") GeneticMinimizer " + +Wrapper for the CERN ROOT Genetic minimizer. + +C++ includes: GeneticMinimizer.h +"; + +%feature("docstring") GeneticMinimizer::GeneticMinimizer "GeneticMinimizer::GeneticMinimizer() +"; + +%feature("docstring") GeneticMinimizer::~GeneticMinimizer "GeneticMinimizer::~GeneticMinimizer() +"; + +%feature("docstring") GeneticMinimizer::setTolerance "void GeneticMinimizer::setTolerance(double value) + +Sets tolerance on the function value at the minimum. Minimization will stop when the estimated vertical distance to the minimum (EDM) is less than 0.001*tolerance*ErrorDef. Here ErrorDef=1.0 for chi squared fit and ErrorDef=0.5 for negative log likelihood fit. +"; + +%feature("docstring") GeneticMinimizer::tolerance "double GeneticMinimizer::tolerance() const +"; + +%feature("docstring") GeneticMinimizer::setPrintLevel "void GeneticMinimizer::setPrintLevel(int value) + +Sets minimizer internal print level. +"; + +%feature("docstring") GeneticMinimizer::printLevel "int GeneticMinimizer::printLevel() const +"; + +%feature("docstring") GeneticMinimizer::setMaxIterations "void GeneticMinimizer::setMaxIterations(int value) + +Sets maximum number of iterations to try at each step. +"; + +%feature("docstring") GeneticMinimizer::maxIterations "int GeneticMinimizer::maxIterations() const +"; + +%feature("docstring") GeneticMinimizer::setPopulationSize "void GeneticMinimizer::setPopulationSize(int value) + +Sets population size. +"; + +%feature("docstring") GeneticMinimizer::populationSize "int GeneticMinimizer::populationSize() const +"; + +%feature("docstring") GeneticMinimizer::setRandomSeed "void GeneticMinimizer::setRandomSeed(int value) + +Sets random seed. +"; + +%feature("docstring") GeneticMinimizer::randomSeed "int GeneticMinimizer::randomSeed() const +"; + +%feature("docstring") GeneticMinimizer::statusToString "std::string GeneticMinimizer::statusToString() const override + +Returns string representation of current minimizer status. +"; + +%feature("docstring") GeneticMinimizer::statusMap "std::map< std::string, std::string > GeneticMinimizer::statusMap() const override + +Returns map of string representing different minimizer statuses. +"; + + // File: classROOT_1_1Math_1_1GeneticMinimizer.xml %feature("docstring") ROOT::Math::GeneticMinimizer " @@ -3710,71 +3779,6 @@ retrieve the minimizer options (implement derived class if needed) "; -// File: classGeneticMinimizer.xml -%feature("docstring") GeneticMinimizer " - -Wrapper for the CERN ROOT Genetic minimizer. - -C++ includes: GeneticMinimizer.h -"; - -%feature("docstring") GeneticMinimizer::GeneticMinimizer "GeneticMinimizer::GeneticMinimizer() -"; - -%feature("docstring") GeneticMinimizer::~GeneticMinimizer "GeneticMinimizer::~GeneticMinimizer() -"; - -%feature("docstring") GeneticMinimizer::setTolerance "void GeneticMinimizer::setTolerance(double value) - -Sets tolerance on the function value at the minimum. Minimization will stop when the estimated vertical distance to the minimum (EDM) is less than 0.001*tolerance*ErrorDef. Here ErrorDef=1.0 for chi squared fit and ErrorDef=0.5 for negative log likelihood fit. -"; - -%feature("docstring") GeneticMinimizer::tolerance "double GeneticMinimizer::tolerance() const -"; - -%feature("docstring") GeneticMinimizer::setPrintLevel "void GeneticMinimizer::setPrintLevel(int value) - -Sets minimizer internal print level. -"; - -%feature("docstring") GeneticMinimizer::printLevel "int GeneticMinimizer::printLevel() const -"; - -%feature("docstring") GeneticMinimizer::setMaxIterations "void GeneticMinimizer::setMaxIterations(int value) - -Sets maximum number of iterations to try at each step. -"; - -%feature("docstring") GeneticMinimizer::maxIterations "int GeneticMinimizer::maxIterations() const -"; - -%feature("docstring") GeneticMinimizer::setPopulationSize "void GeneticMinimizer::setPopulationSize(int value) - -Sets population size. -"; - -%feature("docstring") GeneticMinimizer::populationSize "int GeneticMinimizer::populationSize() const -"; - -%feature("docstring") GeneticMinimizer::setRandomSeed "void GeneticMinimizer::setRandomSeed(int value) - -Sets random seed. -"; - -%feature("docstring") GeneticMinimizer::randomSeed "int GeneticMinimizer::randomSeed() const -"; - -%feature("docstring") GeneticMinimizer::statusToString "std::string GeneticMinimizer::statusToString() const override - -Returns string representation of current minimizer status. -"; - -%feature("docstring") GeneticMinimizer::statusMap "std::map< std::string, std::string > GeneticMinimizer::statusMap() const override - -Returns map of string representing different minimizer statuses. -"; - - // File: structROOT_1_1Math_1_1GeneticMinimizerParameters.xml %feature("docstring") ROOT::Math::GeneticMinimizerParameters ""; @@ -8003,8 +8007,8 @@ This table describes the properties of the MIXMAX generators. MIXMAX is a genuin $p=2^{61}-1$ is the Mersenne prime number. The MIXMAX generators with these parameters pass all of the BigCrush tests in the <a href=\"http://simul.iro.umontreal.ca/testu01/tu01.html\">TestU01 suite</a\\\\>. - -\\\\begin{table}[h] + + \\\\begin{table}[h] \\\\centering \\\\begin{tabular}{@{} rrlcrr @{}} @@ -8871,14 +8875,14 @@ ask for MinosError (Lower + Upper) can be printed via std::cout "; -// File: classROOT_1_1Minuit2_1_1MinimumError_1_1MnNotPosDef.xml -%feature("docstring") ROOT::Minuit2::MinimumError::MnNotPosDef ""; - - // File: classROOT_1_1Minuit2_1_1BasicMinimumError_1_1MnNotPosDef.xml %feature("docstring") ROOT::Minuit2::BasicMinimumError::MnNotPosDef ""; +// File: classROOT_1_1Minuit2_1_1MinimumError_1_1MnNotPosDef.xml +%feature("docstring") ROOT::Minuit2::MinimumError::MnNotPosDef ""; + + // File: classROOT_1_1Minuit2_1_1MnParabola.xml %feature("docstring") ROOT::Minuit2::MnParabola " @@ -12602,6 +12606,8 @@ Return the number of Parameters "; %feature("docstring") ROOT::Math::WrappedParamFunctionGen::NDim "unsigned int ROOT::Math::WrappedParamFunctionGen< FuncPtr >::NDim() const + +Retrieve the dimension of the function "; @@ -12703,6 +12709,9 @@ Returns horizontal line of 80 characters length with section name in it. "; +// File: namespaceParentFunctor.xml + + // File: namespaceROOT.xml @@ -13219,6 +13228,9 @@ LAPACK Algebra function specialize the Outer_product function for LAVector; "; +// File: namespacestd.xml + + // File: namespaceTestFunctions.xml %feature("docstring") TestFunctions::RosenBrock "double TestFunctions::RosenBrock(const std::vector< double > &par) @@ -13241,6 +13253,9 @@ Decaying sinus from lmfit tutorial. "; +// File: namespacetesting.xml + + // File: namespaceTMath.xml %feature("docstring") TMath::Abs "Short_t TMath::Abs(Short_t d) "; @@ -15056,10 +15071,10 @@ Decaying sinus from lmfit tutorial. // File: dir_ead683f11b26d141553bc0f1c348dc86.xml -// File: dir_892d84e8d1420bf45a9053cf0eede900.xml +// File: dir_05e24f99ab216f03e9d0cf366ad39939.xml -// File: dir_05e24f99ab216f03e9d0cf366ad39939.xml +// File: dir_892d84e8d1420bf45a9053cf0eede900.xml // File: dir_ddbc8017d498762c6500a9e593e25277.xml @@ -15071,10 +15086,10 @@ Decaying sinus from lmfit tutorial. // File: dir_346bee264126587e5b77542d134e4add.xml -// File: dir_5432497378cfbce702dc5799f292905b.xml +// File: dir_7c95011753c2f8fb6f2a9c22c1fbdc50.xml -// File: dir_7c95011753c2f8fb6f2a9c22c1fbdc50.xml +// File: dir_5432497378cfbce702dc5799f292905b.xml // File: dir_60772aca5f018fa4d428540699d2a67c.xml diff --git a/auto/Wrap/doxygenSample.i b/auto/Wrap/doxygenSample.i index a05b6b7c457..6e218ea906f 100644 --- a/auto/Wrap/doxygenSample.i +++ b/auto/Wrap/doxygenSample.i @@ -7867,7 +7867,7 @@ Complex form factor of rectangular ripple (bar). %feature("docstring") ripples::profile_yz_cosine "complex_t ripples::profile_yz_cosine(complex_t qy, complex_t qz, double width, double height) -Complex form factor of triangular ripple. +Complex form factor of cosine ripple. "; %feature("docstring") ripples::profile_yz_triangular "complex_t ripples::profile_yz_triangular(complex_t qy, complex_t qz, double width, double height, double asymmetry) -- GitLab