![]() |
BornAgain
1.19.79
Open-source research software to simulate and fit neutron and x-ray reflectometry and grazing-incidence small-angle scattering
|
►Nmumufit | |
CAlphaScan | Scan type with inclination angles as coordinate values and a unique wavelength. Features footprint correction |
CAttLimits | Attributes and limits of a fit parameter, and coupling between these properties |
CBarGauss | The form factor of an elongated bar, with Gaussian profile in elongation direction |
CBarLorentz | The form factor of an elongated, with Lorentz form factor in elongation direction |
CBasicLattice2D | A two-dimensional Bravais lattice with no special symmetry |
CBeam | An incident neutron or x-ray beam |
CBin1D | |
CBipyramid4 | A truncated bifrustum with quadratic base |
CBox | A rectangular prism (parallelepiped) |
CCantellatedCube | A cube, with truncation of all edges and corners, as in Croset (2017) Fig 7 |
CChiSquaredModule | Calculation of chi2 between two data sets |
CCone | A conical frustum (cone truncated parallel to the base) with circular base |
CConstantBackground | Constant background, to be added to simulated scattering |
CConstKBinAxis | Axis with fixed bin size in sin(angle) space |
CCosineRippleBox | The form factor for a cosine ripple, with box profile in elongation direction |
CCosineRippleGauss | The form factor for a cosine ripple, with Gaussian profile in elongation direction |
CCosineRippleLorentz | The form factor for a cosine ripple, with Lorentz form factor in elongation direction |
CCrystal | A crystal structure, defined by a Bravais lattice, a basis, and a position variance |
CCustomBinAxis | Axis with fixed bin size in sin(angle) space used for numerical comparison with IsGisaxs. The main feature of the axis is that it produces zero bin sizes |
CCylinder | A circular cylinder |
CDatafield | Stores radiation power per bin |
CDepthProbeSimulation | Simulation of radiation depth profile |
CDetectorMask | Collection of detector masks |
CDirection | A direction in three-dimensional space |
CDistributionCosine | Cosine distribution |
CDistributionGate | Uniform distribution function with half width hwhm |
CDistributionGaussian | Gaussian distribution with standard deviation std_dev |
CDistributionLogNormal | Log-normal distribution |
CDistributionLorentz | Lorentz distribution with half width hwhm |
CDistributionTrapezoid | Trapezoidal distribution |
CDodecahedron | A regular dodecahedron |
CEllipse | An ellipse, for use in detector masks |
CEllipsoidalCylinder | A cylinder with elliptical base |
CFixedBinAxis | Axis with fixed bin size |
CFootprintGauss | Gaussian beam footprint |
CFootprintSquare | Rectangular beam footprint |
CFrame | Holds one or two axes |
CFuzzySphere | A sphere with gaussian radius distribution |
CGaussSphere | The form factor of a Gaussian sphere |
CHemiEllipsoid | An hemi ellipsoid, obtained by truncating a full ellipsoid in the middle plane spanned by two principal axes |
CHexagonalLattice2D | A two-dimensional Bravais lattice with hexagonal symmetry |
CHollowSphere | Integrated full sphere form factor over a uniform distribution of radii |
CHorizontalCylinder | A circular cylinder |
CHorizontalLine | An infinite horizontal line |
CIBackground | Abstract base class for background noise, to be added to simulated scattering |
CIChiSquaredModule | Interface residual calculations |
CIcosahedron | A regular icosahedron |
CIdentityRotation | The identity rotation, which leaves everything in place |
CIDetector | Abstract detector interface |
CIDetectorResolution | Interface for detector resolution algorithms |
CIFootprintFactor | Abstract base for classes that calculate the beam footprint factor |
CIIntensityFunction | Interface for applying arbitrary function to the measured intensity |
CIInterference | Abstract base class of interference functions |
CIMinimizer | Abstract base class for all kind minimizers |
CIntensityFunctionLog | Algorithm for applying log function to the measured intensity |
CIntensityFunctionSqrt | Algorithm for applying sqrt function to the measured intensity |
CInterference1DLattice | Interference function of a 1D lattice |
CInterference2DLattice | Interference function of a 2D lattice |
CInterference2DParaCrystal | Interference function of a 2D paracrystal |
CInterference2DSuperLattice | Interference function of a 2D superlattice with a configurable interference function for each lattice site |
CInterference3DLattice | Interference function of a 3D lattice |
CInterferenceFinite2DLattice | Interference function of a finite 2D lattice |
CInterferenceFinite3DLattice | Interference function of a finite 3D lattice |
CInterferenceHardDisk | Percus-Yevick hard disk interference function |
CInterferenceNone | Default interference function (i.e. absence of any interference) |
CInterferenceRadialParaCrystal | Interference function of radial paracrystal |
CInterferenceTwin | Interference function for two particles at a mean distance and given standard deviation from each other in a given direction. TODO: RENAME (has nothing to do with crystallographic twin) |
CIOFactory | Provides users with possibility to read and write IntensityData from/to files in different format. Type of the file will be deduced from file name. *.txt - ASCII file with 2D array [nrow][ncol], layout as in numpy. *.int - BornAgain internal ASCII format. *.tif - 32-bits tiff file. If file name ends with "*.gz" or "*.bz2" the file will be zipped on the fly using appropriate algorithm |
CIResolutionFunction2D | Interface providing two-dimensional resolution function |
CISelectionRule | Abstract base class for selection rules |
CIShape2D | Basic class for all shapes in 2D |
CISimulation | Abstract base class, holds the infrastructure to run a simulation |
CISimulation2D | Abstract base class of simulations that generate 2D patterns |
CIterationInfo | Stores fit iteration info to track fit flow from various observers. Used in context of FitObjective |
►CLattice2D | A two-dimensional Bravais lattice |
CLattice3D | A Bravais lattice, characterized by three basis vectors, and optionally an ISelectionRule |
CLayer | A layer in a MultiLayer sample |
CLayerRoughness | A roughness of interface between two layers |
CLine | A line segment, for use in detector masks |
CLongBoxGauss | The form factor for a long rectangular box |
CLongBoxLorentz | The form factor for a long rectangular box |
CMaskPattern | |
CMaterial | A wrapper for underlying material implementation |
CMesoCrystal | A particle with a crystalline inner structure, made of smaller particles, and an outer shape described by a particle form factor |
CMultiLayer | Our sample model: a stack of layers one below the other |
COffspecSimulation | Off-specular scattering simulation |
CParameterDistribution | A parametric distribution function, for use with any model parameter |
CParameterSample | A parameter value with a weight, as obtained when sampling from a distribution |
CParticle | A particle with a form factor and refractive index |
CParticleComposition | A composition of particles at fixed positions |
CParticleCoreShell | A particle with a core/shell geometry |
CParticleLayout | Decorator class that adds particles to ISampleNode objects |
CPlatonicOctahedron | A truncated bifrustum with quadratic base |
CPlatonicTetrahedron | A frustum with equilateral trigonal base |
CPoissonBackground | Poisson distributed noise, to be added to simulated scattering |
CPolygon | A polygon, for use in detector masks |
CPrism3 | A prism based on an equilateral triangle |
CPrism6 | A prism based on a regular hexagonal |
CProfile1DCauchy | Exponential IProfile1D exp(-|omega*x|); its Fourier transform standardizedFT(q) is a Cauchy-Lorentzian starting at standardizedFT(0)=1 |
CProfile1DCosine | IProfile1D consisting of one cosine wave [1+cos(pi*x/omega) if |x|<omega, and 0 otherwise]; its Fourier transform standardizedFT(q) starts at standardizedFT(0)=1 |
CProfile1DGate | Square gate IProfile1D; its Fourier transform standardizedFT(q) is a sinc function starting at standardizedFT(0)=1 |
CProfile1DGauss | Gaussian IProfile1D; its Fourier transform standardizedFT(q) is a Gaussian starting at standardizedFT(0)=1 |
CProfile1DTriangle | Triangle IProfile1D [1-|x|/omega if |x|<omega, and 0 otherwise]; its Fourier transform standardizedFT(q) is a squared sinc function starting at standardizedFT(0)=1 |
CProfile1DVoigt | IProfile1D that provides a Fourier transform standardizedFT(q) in form of a pseudo-Voigt decay function eta*Gauss + (1-eta)*Cauchy, with both components starting at 1 for q=0 |
CProfile2DCauchy | Two-dimensional Cauchy distribution in Fourier space; corresponds to a normalized exp(-r) in real space, with ![]() |
CProfile2DCone | Two-dimensional cone distribution in Fourier space; corresponds to 1-r if r<1 (and 0 otherwise) in real space with ![]() |
CProfile2DGate | Two-dimensional gate distribution in Fourier space; corresponds to normalized constant if r<1 (and 0 otherwise) in real space, with ![]() |
CProfile2DGauss | Two-dimensional Gauss distribution in Fourier space; corresponds to normalized exp(-r^2/2) in real space with ![]() |
CProfile2DVoigt | Two-dimensional Voigt distribution in Fourier space; corresponds to eta*Gauss + (1-eta)*Cauchy |
CPyBuilderCallback | Builds simulation object using a Python callable. Base class to wrap Python callable and pass it to C++. Used in swig interface file, intended to be overloaded from Python |
CPyObserverCallback | Observer for FitObjective based on Python callable. Base class to wrap Python callable and pass it to C++. Used in swig interface file, intended to be overloaded from Python |
CPyramid2 | A frustum (truncated pyramid) with rectangular base |
CPyramid3 | A frustum with equilateral trigonal base |
CPyramid4 | A frustum with a quadratic base |
CPyramid6 | A frustum (truncated pyramid) with regular hexagonal base |
CQzScan | Scan type with z-components of scattering vector as coordinate values. Wavelength and incident angles are not accessible separately |
CRangedDistributionCosine | Cosine distribution |
CRangedDistributionGate | Uniform distribution function |
CRangedDistributionGaussian | Gaussian distribution with standard deviation std_dev |
CRangedDistributionLogNormal | Log-normal distribution |
CRangedDistributionLorentz | Lorentz distribution with median and hwhm |
CRealLimits | Limits for a real fit parameter |
CRectangle | A rectangle, for use in detector masks |
CRectangularDetector | A flat rectangular detector with axes and resolution function |
CResolutionFunction2DGaussian | Simple gaussian two-dimensional resolution function |
CRotationEuler | A sequence of rotations about the z-x'-z'' axes |
CRotationX | A rotation about the x axis |
CRotationY | A rotation about the y axis |
CRotationZ | A rotation about the z axis |
CRotMatrix | Rotation matrix in three dimensions. Represents group SO(3). Internal parameterization based on quaternions |
CRoughnessModelWrap | |
CSawtoothRippleBox | The form factor for a cosine ripple, with box profile in elongation direction |
CSawtoothRippleGauss | The form factor for a cosine ripple, with Gaussian profile in elongation direction |
CSawtoothRippleLorentz | The form factor for a cosine ripple, with Lorentz form factor in elongation direction |
CScanResolution | Container for reflectivity resolution data |
CScatteringSimulation | GISAS simulation |
CSimpleSelectionRule | Selection rule (v*q)modulus!=0, defined by vector v(a,b,c) and modulus |
CSimulationResult | Wrapper around Datafield that also provides unit conversions |
CSpecularSimulation | Specular reflectometry simulation |
CSphere | A full sphere |
CSphericalDetector | A detector with coordinate axes along angles phi and alpha |
CSpheroid | A full spheroid (an ellipsoid with two equal axes, hence with circular cross section) |
CSpinMatrix | |
CSpinor | |
CSquareLattice2D | A two-dimensional Bravais lattice with square unit cell |
CThreadInfo | Information to run simulation with dedicated number of threads |
CTruncatedCube | A cube, with tetrahedral truncation of all corners |
CTruncatedSphere | A truncated Sphere |
CTruncatedSpheroid | A truncated spheroid. An ellipsoid with two equal axis, truncated by a plane perpendicular to the third axis |
CVariableBinAxis | Axis with variable bin size |
CVarianceConstantFunction | Returns 1.0 as variance value |
CVarianceSimFunction | Returns max(sim, epsilon) |
CVec3 | Three-dimensional vector class, templated on base type |
CVerticalLine | An infinite vertical line |