diffpy.srfit package
Complex modeling framework for structure refinement and solution.
SrFit is a tool for coherently combining known information about a material to derive other properties, in particular material structure. SrFit allows the customization and creation of structure representations, profile calculators, constraints, restraints and file input parsers. The customized pieces can be glued together within SrFit to optimize a structure, or other physically relevant information from one or more experimental profiles. Other known information about the system of interest can be included with arbitrarily complex constraints and restraints. In this way, the end user creates a customized fitting application that suits the problem to the available information.
The subpackages herein define various pieces of the SrFit framework. Developers are encouraged to work through the examples described in the documentation to learn how to use and customize the various parts of SrFit.
Subpackages
- diffpy.srfit.equation package
- Subpackages
- diffpy.srfit.equation.literals package
- Submodules
- diffpy.srfit.equation.literals.abcs module
- diffpy.srfit.equation.literals.argument module
- diffpy.srfit.equation.literals.literal module
- diffpy.srfit.equation.literals.operators module
- Module contents
- diffpy.srfit.equation.visitors package
- diffpy.srfit.equation.literals package
- Submodules
- diffpy.srfit.equation.builder module
ArgumentBuilder
BaseBuilder
EquationFactory
EquationFactory.builders
EquationFactory.newargs
EquationFactory.equations
EquationFactory.deRegisterBuilder()
EquationFactory.ignore
EquationFactory.makeEquation()
EquationFactory.registerArgument()
EquationFactory.registerBuilder()
EquationFactory.registerConstant()
EquationFactory.registerFunction()
EquationFactory.registerOperator()
EquationFactory.symbols
EquationFactory.wipeout()
OperatorBuilder
getBuilder()
wrapArgument()
wrapFunction()
wrapOperator()
- diffpy.srfit.equation.equationmod module
Equation
Equation.root
Equation.argdict
Equation.args
Equation.args
Equation.name
Equation.nin
Equation.nout
Equation.operation
Equation.symbol
Equation._value
Equation.value
Equation.addLiteral()
Equation.args
Equation.identify()
Equation.nin
Equation.nout
Equation.operation()
Equation.setRoot()
Equation.swap()
Equation.symbol
- Module contents
Equation
Equation.root
Equation.argdict
Equation.args
Equation.args
Equation.name
Equation.nin
Equation.nout
Equation.operation
Equation.symbol
Equation._value
Equation.value
Equation.addLiteral()
Equation.args
Equation.identify()
Equation.nin
Equation.nout
Equation.operation()
Equation.setRoot()
Equation.swap()
Equation.symbol
- Subpackages
- diffpy.srfit.equation.literals package
- Submodules
- diffpy.srfit.equation.literals.abcs module
- diffpy.srfit.equation.literals.argument module
- diffpy.srfit.equation.literals.literal module
- diffpy.srfit.equation.literals.operators module
- Module contents
- diffpy.srfit.equation.visitors package
- diffpy.srfit.fitbase package
- Submodules
- diffpy.srfit.fitbase.calculator module
Calculator
Calculator.name
Calculator.meta
Calculator._calculators
Calculator._constraints
Calculator._parameters
Calculator._parsets
Calculator._restraints
Calculator._eqfactory
Calculator.args
Calculator.nin
Calculator.nout
Calculator.operation
Calculator.symbol
Calculator._value
Calculator.value
Calculator.names
Calculator.values
Calculator.nin
Calculator.nout
Calculator.operation()
Calculator.symbol
- diffpy.srfit.fitbase.configurable module
- diffpy.srfit.fitbase.constraint module
- diffpy.srfit.fitbase.fitcontribution module
FitContribution
FitContribution.name
FitContribution.profile
FitContribution._calculators
FitContribution._constraints
FitContribution._generators
FitContribution._parameters
FitContribution._restraints
FitContribution._parsets
FitContribution._eqfactory
FitContribution._eq
FitContribution._reseq
FitContribution._xname
FitContribution._yname
FitContribution._dyname
FitContribution.names
FitContribution.values
FitContribution.addProfileGenerator()
FitContribution.evaluate()
FitContribution.getEquation()
FitContribution.getResidualEquation()
FitContribution.residual()
FitContribution.setEquation()
FitContribution.setProfile()
FitContribution.setResidualEquation()
- diffpy.srfit.fitbase.fithook module
- diffpy.srfit.fitbase.fitrecipe module
FitRecipe
FitRecipe.name
FitRecipe.fithooks
FitRecipe._constraints
FitRecipe._oconstraints
FitRecipe._calculators
FitRecipe._contributions
FitRecipe._parameters
FitRecipe._parsets
FitRecipe._eqfactory
FitRecipe._restraintlist
FitRecipe._restraints
FitRecipe._ready
FitRecipe._tagmanager
FitRecipe._weights
FitRecipe._fixedtag
FitRecipe.names
FitRecipe.values
FitRecipe.fixednames
FitRecipe.fixedvalues
FitRecipe.bounds
FitRecipe.bounds2
FitRecipe.addContribution()
FitRecipe.addParameterSet()
FitRecipe.addVar()
FitRecipe.bounds
FitRecipe.bounds2
FitRecipe.boundsToRestraints()
FitRecipe.clearFitHooks()
FitRecipe.constrain()
FitRecipe.delVar()
FitRecipe.fix()
FitRecipe.fixednames
FitRecipe.fixedvalues
FitRecipe.free()
FitRecipe.getBounds()
FitRecipe.getBounds2()
FitRecipe.getFitHooks()
FitRecipe.getNames()
FitRecipe.getValues()
FitRecipe.isFree()
FitRecipe.newVar()
FitRecipe.popFitHook()
FitRecipe.pushFitHook()
FitRecipe.removeParameterSet()
FitRecipe.residual()
FitRecipe.scalarResidual()
FitRecipe.setWeight()
FitRecipe.unconstrain()
- diffpy.srfit.fitbase.fitresults module
ContributionResults
ContributionResults.y
ContributionResults.dy
ContributionResults.x
ContributionResults.ycalc
ContributionResults.residual
ContributionResults.chi2
ContributionResults.cumchi2
ContributionResults.rw
ContributionResults.cumrw
ContributionResults.weight
ContributionResults.conlocs
ContributionResults.convals
ContributionResults.conunc
FitResults
FitResults.recipe
FitResults.cov
FitResults.conresults
FitResults.derivstep
FitResults.varnames
FitResults.varvals
FitResults.varunc
FitResults.showfixed
FitResults.fixednames
FitResults.fixedvals
FitResults.showcon
FitResults.connames
FitResults.convals
FitResults.conunc
FitResults.residual
FitResults.penalty
FitResults.chi2
FitResults.cumchi2
FitResults.rchi2
FitResults.rw
FitResults.cumrw
FitResults.messages
FitResults.precision
FitResults._dcon
FitResults.formatResults()
FitResults.printResults()
FitResults.saveResults()
FitResults.update()
initializeRecipe()
- diffpy.srfit.fitbase.parameter module
Parameter
ParameterAdapter
ParameterProxy
- diffpy.srfit.fitbase.parameterset module
ParameterSet
ParameterSet.name
ParameterSet._calculators
ParameterSet._constraints
ParameterSet._parameters
ParameterSet._restraints
ParameterSet._parsets
ParameterSet._eqfactory
ParameterSet.names
ParameterSet.values
ParameterSet.addParameter()
ParameterSet.addParameterSet()
ParameterSet.newParameter()
ParameterSet.removeParameter()
ParameterSet.removeParameterSet()
ParameterSet.setConst()
- diffpy.srfit.fitbase.profile module
Parameter
Profile
Profile._xobs
Profile.xobs
Profile._yobs
Profile.yobs
Profile._dyobs
Profile.dyobs
Profile.x
Profile.y
Profile.dy
Profile.ycalc
Profile.xpar
Profile.ypar
Profile.dypar
Profile.ycpar
Profile.meta
Profile.dy
Profile.dyobs
Profile.loadParsedData()
Profile.loadtxt()
Profile.savetxt()
Profile.setCalculationPoints()
Profile.setCalculationRange()
Profile.setObservedProfile()
Profile.x
Profile.xobs
Profile.y
Profile.ycalc
Profile.yobs
- diffpy.srfit.fitbase.profilegenerator module
ProfileGenerator
ProfileGenerator.name
ProfileGenerator.profile
ProfileGenerator.meta
ProfileGenerator.eq
ProfileGenerator._calculators
ProfileGenerator._constraints
ProfileGenerator._parameters
ProfileGenerator._parsets
ProfileGenerator._restraints
ProfileGenerator._eqfactory
ProfileGenerator.args
ProfileGenerator.name
ProfileGenerator.nin
ProfileGenerator.nout
ProfileGenerator.operation
ProfileGenerator.symbol
ProfileGenerator._value
ProfileGenerator.value
ProfileGenerator.names
ProfileGenerator.values
ProfileGenerator.nin
ProfileGenerator.nout
ProfileGenerator.operation()
ProfileGenerator.processMetaData()
ProfileGenerator.setProfile()
ProfileGenerator.symbol
- diffpy.srfit.fitbase.profileparser module
ProfileParser
ProfileParser._format
ProfileParser._banks
ProfileParser._x
ProfileParser._y
ProfileParser._dx
ProfileParser._dy
ProfileParser._meta
ProfileParser.filename
ProfileParser.nbanks
ProfileParser.bank
ProfileParser.getData()
ProfileParser.getFormat()
ProfileParser.getMetaData()
ProfileParser.getNumBanks()
ProfileParser.parseFile()
ProfileParser.parseString()
ProfileParser.selectBank()
- diffpy.srfit.fitbase.recipeorganizer module
RecipeContainer
RecipeOrganizer
RecipeOrganizer.name
RecipeOrganizer._calculators
RecipeOrganizer._parameters
RecipeOrganizer._constraints
RecipeOrganizer._restraints
RecipeOrganizer._eqfactory
RecipeOrganizer.names
RecipeOrganizer.values
RecipeOrganizer.addRestraint()
RecipeOrganizer.clearConstraints()
RecipeOrganizer.clearRestraints()
RecipeOrganizer.constrain()
RecipeOrganizer.evaluateEquation()
RecipeOrganizer.getConstrainedPars()
RecipeOrganizer.isConstrained()
RecipeOrganizer.registerCalculator()
RecipeOrganizer.registerFunction()
RecipeOrganizer.registerStringFunction()
RecipeOrganizer.restrain()
RecipeOrganizer.show()
RecipeOrganizer.unconstrain()
RecipeOrganizer.unrestrain()
equationFromString()
- diffpy.srfit.fitbase.restraint module
- diffpy.srfit.fitbase.simplerecipe module
SimpleRecipe
SimpleRecipe.profile
SimpleRecipe.contribution
SimpleRecipe.results
SimpleRecipe.name
SimpleRecipe.fithook
SimpleRecipe._constraints
SimpleRecipe._oconstraints
SimpleRecipe._calculators
SimpleRecipe._contributions
SimpleRecipe._parameters
SimpleRecipe._parsets
SimpleRecipe._eqfactory
SimpleRecipe._fixed
SimpleRecipe._restraintlist
SimpleRecipe._restraints
SimpleRecipe._ready
SimpleRecipe._tagdict
SimpleRecipe._weights
SimpleRecipe.names
SimpleRecipe.values
SimpleRecipe.loadParsedData()
SimpleRecipe.loadtxt()
SimpleRecipe.printResults()
SimpleRecipe.saveResults()
SimpleRecipe.setCalculationPoints()
SimpleRecipe.setCalculationRange()
SimpleRecipe.setEquation()
SimpleRecipe.setObservedProfile()
- diffpy.srfit.fitbase.validatable module
- Module contents
Calculator
Calculator.name
Calculator.meta
Calculator._calculators
Calculator._constraints
Calculator._parameters
Calculator._parsets
Calculator._restraints
Calculator._eqfactory
Calculator.args
Calculator.nin
Calculator.nout
Calculator.operation
Calculator.symbol
Calculator._value
Calculator.value
Calculator.names
Calculator.values
Calculator.nin
Calculator.nout
Calculator.operation()
Calculator.symbol
FitContribution
FitContribution.name
FitContribution.profile
FitContribution._calculators
FitContribution._constraints
FitContribution._generators
FitContribution._parameters
FitContribution._restraints
FitContribution._parsets
FitContribution._eqfactory
FitContribution._eq
FitContribution._reseq
FitContribution._xname
FitContribution._yname
FitContribution._dyname
FitContribution.names
FitContribution.values
FitContribution.addProfileGenerator()
FitContribution.evaluate()
FitContribution.getEquation()
FitContribution.getResidualEquation()
FitContribution.residual()
FitContribution.setEquation()
FitContribution.setProfile()
FitContribution.setResidualEquation()
FitHook
FitRecipe
FitRecipe.name
FitRecipe.fithooks
FitRecipe._constraints
FitRecipe._oconstraints
FitRecipe._calculators
FitRecipe._contributions
FitRecipe._parameters
FitRecipe._parsets
FitRecipe._eqfactory
FitRecipe._restraintlist
FitRecipe._restraints
FitRecipe._ready
FitRecipe._tagmanager
FitRecipe._weights
FitRecipe._fixedtag
FitRecipe.names
FitRecipe.values
FitRecipe.fixednames
FitRecipe.fixedvalues
FitRecipe.bounds
FitRecipe.bounds2
FitRecipe.addContribution()
FitRecipe.addParameterSet()
FitRecipe.addVar()
FitRecipe.bounds
FitRecipe.bounds2
FitRecipe.boundsToRestraints()
FitRecipe.clearFitHooks()
FitRecipe.constrain()
FitRecipe.delVar()
FitRecipe.fix()
FitRecipe.fixednames
FitRecipe.fixedvalues
FitRecipe.free()
FitRecipe.getBounds()
FitRecipe.getBounds2()
FitRecipe.getFitHooks()
FitRecipe.getNames()
FitRecipe.getValues()
FitRecipe.isFree()
FitRecipe.newVar()
FitRecipe.popFitHook()
FitRecipe.pushFitHook()
FitRecipe.removeParameterSet()
FitRecipe.residual()
FitRecipe.scalarResidual()
FitRecipe.setWeight()
FitRecipe.unconstrain()
FitResults
FitResults.recipe
FitResults.cov
FitResults.conresults
FitResults.derivstep
FitResults.varnames
FitResults.varvals
FitResults.varunc
FitResults.showfixed
FitResults.fixednames
FitResults.fixedvals
FitResults.showcon
FitResults.connames
FitResults.convals
FitResults.conunc
FitResults.residual
FitResults.penalty
FitResults.chi2
FitResults.cumchi2
FitResults.rchi2
FitResults.rw
FitResults.cumrw
FitResults.messages
FitResults.precision
FitResults._dcon
FitResults.formatResults()
FitResults.printResults()
FitResults.saveResults()
FitResults.update()
PlotFitHook
Profile
Profile._xobs
Profile.xobs
Profile._yobs
Profile.yobs
Profile._dyobs
Profile.dyobs
Profile.x
Profile.y
Profile.dy
Profile.ycalc
Profile.xpar
Profile.ypar
Profile.dypar
Profile.ycpar
Profile.meta
Profile.dy
Profile.dyobs
Profile.loadParsedData()
Profile.loadtxt()
Profile.savetxt()
Profile.setCalculationPoints()
Profile.setCalculationRange()
Profile.setObservedProfile()
Profile.x
Profile.xobs
Profile.y
Profile.ycalc
Profile.yobs
ProfileGenerator
ProfileGenerator.name
ProfileGenerator.profile
ProfileGenerator.meta
ProfileGenerator.eq
ProfileGenerator._calculators
ProfileGenerator._constraints
ProfileGenerator._parameters
ProfileGenerator._parsets
ProfileGenerator._restraints
ProfileGenerator._eqfactory
ProfileGenerator.args
ProfileGenerator.name
ProfileGenerator.nin
ProfileGenerator.nout
ProfileGenerator.operation
ProfileGenerator.symbol
ProfileGenerator._value
ProfileGenerator.value
ProfileGenerator.names
ProfileGenerator.values
ProfileGenerator.nin
ProfileGenerator.nout
ProfileGenerator.operation()
ProfileGenerator.processMetaData()
ProfileGenerator.setProfile()
ProfileGenerator.symbol
SimpleRecipe
SimpleRecipe.profile
SimpleRecipe.contribution
SimpleRecipe.results
SimpleRecipe.name
SimpleRecipe.fithook
SimpleRecipe._constraints
SimpleRecipe._oconstraints
SimpleRecipe._calculators
SimpleRecipe._contributions
SimpleRecipe._parameters
SimpleRecipe._parsets
SimpleRecipe._eqfactory
SimpleRecipe._fixed
SimpleRecipe._restraintlist
SimpleRecipe._restraints
SimpleRecipe._ready
SimpleRecipe._tagdict
SimpleRecipe._weights
SimpleRecipe.names
SimpleRecipe.values
SimpleRecipe.loadParsedData()
SimpleRecipe.loadtxt()
SimpleRecipe.printResults()
SimpleRecipe.saveResults()
SimpleRecipe.setCalculationPoints()
SimpleRecipe.setCalculationRange()
SimpleRecipe.setEquation()
SimpleRecipe.setObservedProfile()
initializeRecipe()
- diffpy.srfit.interface package
- diffpy.srfit.pdf package
- Submodules
- diffpy.srfit.pdf.basepdfgenerator module
BasePDFGenerator
BasePDFGenerator._calc
BasePDFGenerator._phase
BasePDFGenerator.stru
BasePDFGenerator._lastr
BasePDFGenerator._pool
BasePDFGenerator.scale
BasePDFGenerator.delta1
BasePDFGenerator.delta2
BasePDFGenerator.qbroad
BasePDFGenerator.qdamp
BasePDFGenerator.stype
BasePDFGenerator.qmax
BasePDFGenerator.qmin
BasePDFGenerator.scale
BasePDFGenerator.delta1
BasePDFGenerator.delta2
BasePDFGenerator.qbroad
BasePDFGenerator.qdamp
BasePDFGenerator.getQmax()
BasePDFGenerator.getQmin()
BasePDFGenerator.getScatteringType()
BasePDFGenerator.parallel()
BasePDFGenerator.processMetaData()
BasePDFGenerator.setPhase()
BasePDFGenerator.setQmax()
BasePDFGenerator.setQmin()
BasePDFGenerator.setScatteringType()
BasePDFGenerator.setStructure()
- diffpy.srfit.pdf.characteristicfunctions module
- diffpy.srfit.pdf.debyepdfgenerator module
DebyePDFGenerator
DebyePDFGenerator._calc
DebyePDFGenerator._phase
DebyePDFGenerator.stru
DebyePDFGenerator._lastr
DebyePDFGenerator.scale
DebyePDFGenerator.delta1
DebyePDFGenerator.delta2
DebyePDFGenerator.qbroad
DebyePDFGenerator.qdamp
DebyePDFGenerator.stype
DebyePDFGenerator.qmax
DebyePDFGenerator.qmin
DebyePDFGenerator.scale
DebyePDFGenerator.delta1
DebyePDFGenerator.delta2
DebyePDFGenerator.qbroad
DebyePDFGenerator.qdamp
DebyePDFGenerator.setPhase()
DebyePDFGenerator.setStructure()
- diffpy.srfit.pdf.pdfcontribution module
PDFContribution
PDFContribution.name
PDFContribution.profile
PDFContribution._meta
PDFContribution._calculators
PDFContribution._constraints
PDFContribution._generators
PDFContribution._parameters
PDFContribution._restraints
PDFContribution._parsets
PDFContribution._eqfactory
PDFContribution._eq
PDFContribution._reseq
PDFContribution._xname
PDFContribution._yname
PDFContribution._dyname
PDFContribution.scale
PDFContribution.qbroad
PDFContribution.qdamp
PDFContribution.addPhase()
PDFContribution.addStructure()
PDFContribution.getQmax()
PDFContribution.getQmin()
PDFContribution.getScatteringType()
PDFContribution.loadData()
PDFContribution.savetxt()
PDFContribution.setCalculationRange()
PDFContribution.setQmax()
PDFContribution.setQmin()
PDFContribution.setScatteringType()
- diffpy.srfit.pdf.pdfgenerator module
PDFGenerator
PDFGenerator._calc
PDFGenerator._phase
PDFGenerator._lastr
PDFGenerator.scale
PDFGenerator.delta1
PDFGenerator.delta2
PDFGenerator.qbroad
PDFGenerator.qdamp
PDFGenerator.stype
PDFGenerator.qmax
PDFGenerator.qmin
PDFGenerator.scale
PDFGenerator.delta1
PDFGenerator.delta2
PDFGenerator.qbroad
PDFGenerator.qdamp
- diffpy.srfit.pdf.pdfparser module
PDFParser
PDFParser._format
PDFParser._banks
PDFParser._x
PDFParser._y
PDFParser._dx
PDFParser._dy
PDFParser._meta
PDFParser.filename
PDFParser.nbanks
PDFParser.bank
PDFParser.stype
PDFParser.qmin
PDFParser.qmax
PDFParser.qdamp
PDFParser.qbroad
PDFParser.spdiameter
PDFParser.scale
PDFParser.temperature
PDFParser.doping
PDFParser.parseString()
- Module contents
DebyePDFGenerator
DebyePDFGenerator._calc
DebyePDFGenerator._phase
DebyePDFGenerator.stru
DebyePDFGenerator._lastr
DebyePDFGenerator.scale
DebyePDFGenerator.delta1
DebyePDFGenerator.delta2
DebyePDFGenerator.qbroad
DebyePDFGenerator.qdamp
DebyePDFGenerator.stype
DebyePDFGenerator.qmax
DebyePDFGenerator.qmin
DebyePDFGenerator.scale
DebyePDFGenerator.delta1
DebyePDFGenerator.delta2
DebyePDFGenerator.qbroad
DebyePDFGenerator.qdamp
DebyePDFGenerator.setPhase()
DebyePDFGenerator.setStructure()
PDFContribution
PDFContribution.name
PDFContribution.profile
PDFContribution._meta
PDFContribution._calculators
PDFContribution._constraints
PDFContribution._generators
PDFContribution._parameters
PDFContribution._restraints
PDFContribution._parsets
PDFContribution._eqfactory
PDFContribution._eq
PDFContribution._reseq
PDFContribution._xname
PDFContribution._yname
PDFContribution._dyname
PDFContribution.scale
PDFContribution.qbroad
PDFContribution.qdamp
PDFContribution.addPhase()
PDFContribution.addStructure()
PDFContribution.getQmax()
PDFContribution.getQmin()
PDFContribution.getScatteringType()
PDFContribution.loadData()
PDFContribution.savetxt()
PDFContribution.setCalculationRange()
PDFContribution.setQmax()
PDFContribution.setQmin()
PDFContribution.setScatteringType()
PDFGenerator
PDFGenerator._calc
PDFGenerator._phase
PDFGenerator._lastr
PDFGenerator.scale
PDFGenerator.delta1
PDFGenerator.delta2
PDFGenerator.qbroad
PDFGenerator.qdamp
PDFGenerator.stype
PDFGenerator.qmax
PDFGenerator.qmin
PDFGenerator.scale
PDFGenerator.delta1
PDFGenerator.delta2
PDFGenerator.qbroad
PDFGenerator.qdamp
PDFParser
PDFParser._format
PDFParser._banks
PDFParser._x
PDFParser._y
PDFParser._dx
PDFParser._dy
PDFParser._meta
PDFParser.filename
PDFParser.nbanks
PDFParser.bank
PDFParser.stype
PDFParser.qmin
PDFParser.qmax
PDFParser.qdamp
PDFParser.qbroad
PDFParser.spdiameter
PDFParser.scale
PDFParser.temperature
PDFParser.doping
PDFParser.parseString()
- diffpy.srfit.sas package
- diffpy.srfit.structure package
- Submodules
- diffpy.srfit.structure.basestructureparset module
- diffpy.srfit.structure.bvsrestraint module
- diffpy.srfit.structure.cctbxparset module
- diffpy.srfit.structure.diffpyparset module
- diffpy.srfit.structure.objcrystparset module
- diffpy.srfit.structure.sgconstraints module
- diffpy.srfit.structure.srrealparset module
- Module contents
- diffpy.srfit.util package