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
ArgumentBuilderBaseBuilderEquationFactoryEquationFactory.buildersEquationFactory.newargsEquationFactory.equationsEquationFactory.deRegisterBuilder()EquationFactory.ignoreEquationFactory.makeEquation()EquationFactory.registerArgument()EquationFactory.registerBuilder()EquationFactory.registerConstant()EquationFactory.registerFunction()EquationFactory.registerOperator()EquationFactory.symbolsEquationFactory.wipeout()
OperatorBuildergetBuilder()wrapArgument()wrapFunction()wrapOperator()
- diffpy.srfit.equation.equationmod module
EquationEquation.rootEquation.argdictEquation.argsEquation.argsEquation.nameEquation.ninEquation.noutEquation.operationEquation.symbolEquation._valueEquation.valueEquation.addLiteral()Equation.argsEquation.identify()Equation.ninEquation.noutEquation.operation()Equation.setRoot()Equation.swap()Equation.symbol
- Module contents
EquationEquation.rootEquation.argdictEquation.argsEquation.argsEquation.nameEquation.ninEquation.noutEquation.operationEquation.symbolEquation._valueEquation.valueEquation.addLiteral()Equation.argsEquation.identify()Equation.ninEquation.noutEquation.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
CalculatorCalculator.nameCalculator.metaCalculator._calculatorsCalculator._constraintsCalculator._parametersCalculator._parsetsCalculator._restraintsCalculator._eqfactoryCalculator.argsCalculator.ninCalculator.noutCalculator.operationCalculator.symbolCalculator._valueCalculator.valueCalculator.namesCalculator.valuesCalculator.ninCalculator.noutCalculator.operation()Calculator.symbol
- diffpy.srfit.fitbase.configurable module
- diffpy.srfit.fitbase.constraint module
- diffpy.srfit.fitbase.fitcontribution module
FitContributionFitContribution.nameFitContribution.profileFitContribution._calculatorsFitContribution._constraintsFitContribution._generatorsFitContribution._parametersFitContribution._restraintsFitContribution._parsetsFitContribution._eqfactoryFitContribution._eqFitContribution._reseqFitContribution._xnameFitContribution._ynameFitContribution._dynameFitContribution.namesFitContribution.valuesFitContribution.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
FitRecipeFitRecipe.nameFitRecipe.fithooksFitRecipe._constraintsFitRecipe._oconstraintsFitRecipe._calculatorsFitRecipe._contributionsFitRecipe._parametersFitRecipe._parsetsFitRecipe._eqfactoryFitRecipe._restraintlistFitRecipe._restraintsFitRecipe._readyFitRecipe._tagmanagerFitRecipe._weightsFitRecipe._fixedtagFitRecipe.namesFitRecipe.valuesFitRecipe.fixednamesFitRecipe.fixedvaluesFitRecipe.boundsFitRecipe.bounds2FitRecipe.addContribution()FitRecipe.addParameterSet()FitRecipe.addVar()FitRecipe.boundsFitRecipe.bounds2FitRecipe.boundsToRestraints()FitRecipe.clearFitHooks()FitRecipe.constrain()FitRecipe.delVar()FitRecipe.fix()FitRecipe.fixednamesFitRecipe.fixedvaluesFitRecipe.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
ContributionResultsContributionResults.yContributionResults.dyContributionResults.xContributionResults.ycalcContributionResults.residualContributionResults.chi2ContributionResults.cumchi2ContributionResults.rwContributionResults.cumrwContributionResults.weightContributionResults.conlocsContributionResults.convalsContributionResults.conunc
FitResultsFitResults.recipeFitResults.covFitResults.conresultsFitResults.derivstepFitResults.varnamesFitResults.varvalsFitResults.varuncFitResults.showfixedFitResults.fixednamesFitResults.fixedvalsFitResults.showconFitResults.connamesFitResults.convalsFitResults.conuncFitResults.residualFitResults.penaltyFitResults.chi2FitResults.cumchi2FitResults.rchi2FitResults.rwFitResults.cumrwFitResults.messagesFitResults.precisionFitResults._dconFitResults.formatResults()FitResults.printResults()FitResults.saveResults()FitResults.update()
initializeRecipe()
- diffpy.srfit.fitbase.parameter module
ParameterParameterAdapterParameterProxy
- diffpy.srfit.fitbase.parameterset module
ParameterSetParameterSet.nameParameterSet._calculatorsParameterSet._constraintsParameterSet._parametersParameterSet._restraintsParameterSet._parsetsParameterSet._eqfactoryParameterSet.namesParameterSet.valuesParameterSet.addParameter()ParameterSet.addParameterSet()ParameterSet.newParameter()ParameterSet.removeParameter()ParameterSet.removeParameterSet()ParameterSet.setConst()
- diffpy.srfit.fitbase.profile module
ParameterProfileProfile._xobsProfile.xobsProfile._yobsProfile.yobsProfile._dyobsProfile.dyobsProfile.xProfile.yProfile.dyProfile.ycalcProfile.xparProfile.yparProfile.dyparProfile.ycparProfile.metaProfile.dyProfile.dyobsProfile.loadParsedData()Profile.loadtxt()Profile.savetxt()Profile.setCalculationPoints()Profile.setCalculationRange()Profile.setObservedProfile()Profile.xProfile.xobsProfile.yProfile.ycalcProfile.yobs
- diffpy.srfit.fitbase.profilegenerator module
ProfileGeneratorProfileGenerator.nameProfileGenerator.profileProfileGenerator.metaProfileGenerator.eqProfileGenerator._calculatorsProfileGenerator._constraintsProfileGenerator._parametersProfileGenerator._parsetsProfileGenerator._restraintsProfileGenerator._eqfactoryProfileGenerator.argsProfileGenerator.nameProfileGenerator.ninProfileGenerator.noutProfileGenerator.operationProfileGenerator.symbolProfileGenerator._valueProfileGenerator.valueProfileGenerator.namesProfileGenerator.valuesProfileGenerator.ninProfileGenerator.noutProfileGenerator.operation()ProfileGenerator.processMetaData()ProfileGenerator.setProfile()ProfileGenerator.symbol
- diffpy.srfit.fitbase.profileparser module
ProfileParserProfileParser._formatProfileParser._banksProfileParser._xProfileParser._yProfileParser._dxProfileParser._dyProfileParser._metaProfileParser.filenameProfileParser.nbanksProfileParser.bankProfileParser.getData()ProfileParser.getFormat()ProfileParser.getMetaData()ProfileParser.getNumBanks()ProfileParser.parseFile()ProfileParser.parseString()ProfileParser.selectBank()
- diffpy.srfit.fitbase.recipeorganizer module
RecipeContainerRecipeOrganizerRecipeOrganizer.nameRecipeOrganizer._calculatorsRecipeOrganizer._parametersRecipeOrganizer._constraintsRecipeOrganizer._restraintsRecipeOrganizer._eqfactoryRecipeOrganizer.namesRecipeOrganizer.valuesRecipeOrganizer.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
SimpleRecipeSimpleRecipe.profileSimpleRecipe.contributionSimpleRecipe.resultsSimpleRecipe.nameSimpleRecipe.fithookSimpleRecipe._constraintsSimpleRecipe._oconstraintsSimpleRecipe._calculatorsSimpleRecipe._contributionsSimpleRecipe._parametersSimpleRecipe._parsetsSimpleRecipe._eqfactorySimpleRecipe._fixedSimpleRecipe._restraintlistSimpleRecipe._restraintsSimpleRecipe._readySimpleRecipe._tagdictSimpleRecipe._weightsSimpleRecipe.namesSimpleRecipe.valuesSimpleRecipe.loadParsedData()SimpleRecipe.loadtxt()SimpleRecipe.printResults()SimpleRecipe.saveResults()SimpleRecipe.setCalculationPoints()SimpleRecipe.setCalculationRange()SimpleRecipe.setEquation()SimpleRecipe.setObservedProfile()
- diffpy.srfit.fitbase.validatable module
- Module contents
CalculatorCalculator.nameCalculator.metaCalculator._calculatorsCalculator._constraintsCalculator._parametersCalculator._parsetsCalculator._restraintsCalculator._eqfactoryCalculator.argsCalculator.ninCalculator.noutCalculator.operationCalculator.symbolCalculator._valueCalculator.valueCalculator.namesCalculator.valuesCalculator.ninCalculator.noutCalculator.operation()Calculator.symbol
FitContributionFitContribution.nameFitContribution.profileFitContribution._calculatorsFitContribution._constraintsFitContribution._generatorsFitContribution._parametersFitContribution._restraintsFitContribution._parsetsFitContribution._eqfactoryFitContribution._eqFitContribution._reseqFitContribution._xnameFitContribution._ynameFitContribution._dynameFitContribution.namesFitContribution.valuesFitContribution.addProfileGenerator()FitContribution.evaluate()FitContribution.getEquation()FitContribution.getResidualEquation()FitContribution.residual()FitContribution.setEquation()FitContribution.setProfile()FitContribution.setResidualEquation()
FitHookFitRecipeFitRecipe.nameFitRecipe.fithooksFitRecipe._constraintsFitRecipe._oconstraintsFitRecipe._calculatorsFitRecipe._contributionsFitRecipe._parametersFitRecipe._parsetsFitRecipe._eqfactoryFitRecipe._restraintlistFitRecipe._restraintsFitRecipe._readyFitRecipe._tagmanagerFitRecipe._weightsFitRecipe._fixedtagFitRecipe.namesFitRecipe.valuesFitRecipe.fixednamesFitRecipe.fixedvaluesFitRecipe.boundsFitRecipe.bounds2FitRecipe.addContribution()FitRecipe.addParameterSet()FitRecipe.addVar()FitRecipe.boundsFitRecipe.bounds2FitRecipe.boundsToRestraints()FitRecipe.clearFitHooks()FitRecipe.constrain()FitRecipe.delVar()FitRecipe.fix()FitRecipe.fixednamesFitRecipe.fixedvaluesFitRecipe.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()
FitResultsFitResults.recipeFitResults.covFitResults.conresultsFitResults.derivstepFitResults.varnamesFitResults.varvalsFitResults.varuncFitResults.showfixedFitResults.fixednamesFitResults.fixedvalsFitResults.showconFitResults.connamesFitResults.convalsFitResults.conuncFitResults.residualFitResults.penaltyFitResults.chi2FitResults.cumchi2FitResults.rchi2FitResults.rwFitResults.cumrwFitResults.messagesFitResults.precisionFitResults._dconFitResults.formatResults()FitResults.printResults()FitResults.saveResults()FitResults.update()
PlotFitHookProfileProfile._xobsProfile.xobsProfile._yobsProfile.yobsProfile._dyobsProfile.dyobsProfile.xProfile.yProfile.dyProfile.ycalcProfile.xparProfile.yparProfile.dyparProfile.ycparProfile.metaProfile.dyProfile.dyobsProfile.loadParsedData()Profile.loadtxt()Profile.savetxt()Profile.setCalculationPoints()Profile.setCalculationRange()Profile.setObservedProfile()Profile.xProfile.xobsProfile.yProfile.ycalcProfile.yobs
ProfileGeneratorProfileGenerator.nameProfileGenerator.profileProfileGenerator.metaProfileGenerator.eqProfileGenerator._calculatorsProfileGenerator._constraintsProfileGenerator._parametersProfileGenerator._parsetsProfileGenerator._restraintsProfileGenerator._eqfactoryProfileGenerator.argsProfileGenerator.nameProfileGenerator.ninProfileGenerator.noutProfileGenerator.operationProfileGenerator.symbolProfileGenerator._valueProfileGenerator.valueProfileGenerator.namesProfileGenerator.valuesProfileGenerator.ninProfileGenerator.noutProfileGenerator.operation()ProfileGenerator.processMetaData()ProfileGenerator.setProfile()ProfileGenerator.symbol
SimpleRecipeSimpleRecipe.profileSimpleRecipe.contributionSimpleRecipe.resultsSimpleRecipe.nameSimpleRecipe.fithookSimpleRecipe._constraintsSimpleRecipe._oconstraintsSimpleRecipe._calculatorsSimpleRecipe._contributionsSimpleRecipe._parametersSimpleRecipe._parsetsSimpleRecipe._eqfactorySimpleRecipe._fixedSimpleRecipe._restraintlistSimpleRecipe._restraintsSimpleRecipe._readySimpleRecipe._tagdictSimpleRecipe._weightsSimpleRecipe.namesSimpleRecipe.valuesSimpleRecipe.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
BasePDFGeneratorBasePDFGenerator._calcBasePDFGenerator._phaseBasePDFGenerator.struBasePDFGenerator._lastrBasePDFGenerator._poolBasePDFGenerator.scaleBasePDFGenerator.delta1BasePDFGenerator.delta2BasePDFGenerator.qbroadBasePDFGenerator.qdampBasePDFGenerator.stypeBasePDFGenerator.qmaxBasePDFGenerator.qminBasePDFGenerator.scaleBasePDFGenerator.delta1BasePDFGenerator.delta2BasePDFGenerator.qbroadBasePDFGenerator.qdampBasePDFGenerator.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
DebyePDFGeneratorDebyePDFGenerator._calcDebyePDFGenerator._phaseDebyePDFGenerator.struDebyePDFGenerator._lastrDebyePDFGenerator.scaleDebyePDFGenerator.delta1DebyePDFGenerator.delta2DebyePDFGenerator.qbroadDebyePDFGenerator.qdampDebyePDFGenerator.stypeDebyePDFGenerator.qmaxDebyePDFGenerator.qminDebyePDFGenerator.scaleDebyePDFGenerator.delta1DebyePDFGenerator.delta2DebyePDFGenerator.qbroadDebyePDFGenerator.qdampDebyePDFGenerator.setPhase()DebyePDFGenerator.setStructure()
- diffpy.srfit.pdf.pdfcontribution module
PDFContributionPDFContribution.namePDFContribution.profilePDFContribution._metaPDFContribution._calculatorsPDFContribution._constraintsPDFContribution._generatorsPDFContribution._parametersPDFContribution._restraintsPDFContribution._parsetsPDFContribution._eqfactoryPDFContribution._eqPDFContribution._reseqPDFContribution._xnamePDFContribution._ynamePDFContribution._dynamePDFContribution.scalePDFContribution.qbroadPDFContribution.qdampPDFContribution.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
PDFGeneratorPDFGenerator._calcPDFGenerator._phasePDFGenerator._lastrPDFGenerator.scalePDFGenerator.delta1PDFGenerator.delta2PDFGenerator.qbroadPDFGenerator.qdampPDFGenerator.stypePDFGenerator.qmaxPDFGenerator.qminPDFGenerator.scalePDFGenerator.delta1PDFGenerator.delta2PDFGenerator.qbroadPDFGenerator.qdamp
- diffpy.srfit.pdf.pdfparser module
PDFParserPDFParser._formatPDFParser._banksPDFParser._xPDFParser._yPDFParser._dxPDFParser._dyPDFParser._metaPDFParser.filenamePDFParser.nbanksPDFParser.bankPDFParser.stypePDFParser.qminPDFParser.qmaxPDFParser.qdampPDFParser.qbroadPDFParser.spdiameterPDFParser.scalePDFParser.temperaturePDFParser.dopingPDFParser.parseString()
- Module contents
DebyePDFGeneratorDebyePDFGenerator._calcDebyePDFGenerator._phaseDebyePDFGenerator.struDebyePDFGenerator._lastrDebyePDFGenerator.scaleDebyePDFGenerator.delta1DebyePDFGenerator.delta2DebyePDFGenerator.qbroadDebyePDFGenerator.qdampDebyePDFGenerator.stypeDebyePDFGenerator.qmaxDebyePDFGenerator.qminDebyePDFGenerator.scaleDebyePDFGenerator.delta1DebyePDFGenerator.delta2DebyePDFGenerator.qbroadDebyePDFGenerator.qdampDebyePDFGenerator.setPhase()DebyePDFGenerator.setStructure()
PDFContributionPDFContribution.namePDFContribution.profilePDFContribution._metaPDFContribution._calculatorsPDFContribution._constraintsPDFContribution._generatorsPDFContribution._parametersPDFContribution._restraintsPDFContribution._parsetsPDFContribution._eqfactoryPDFContribution._eqPDFContribution._reseqPDFContribution._xnamePDFContribution._ynamePDFContribution._dynamePDFContribution.scalePDFContribution.qbroadPDFContribution.qdampPDFContribution.addPhase()PDFContribution.addStructure()PDFContribution.getQmax()PDFContribution.getQmin()PDFContribution.getScatteringType()PDFContribution.loadData()PDFContribution.savetxt()PDFContribution.setCalculationRange()PDFContribution.setQmax()PDFContribution.setQmin()PDFContribution.setScatteringType()
PDFGeneratorPDFGenerator._calcPDFGenerator._phasePDFGenerator._lastrPDFGenerator.scalePDFGenerator.delta1PDFGenerator.delta2PDFGenerator.qbroadPDFGenerator.qdampPDFGenerator.stypePDFGenerator.qmaxPDFGenerator.qminPDFGenerator.scalePDFGenerator.delta1PDFGenerator.delta2PDFGenerator.qbroadPDFGenerator.qdamp
PDFParserPDFParser._formatPDFParser._banksPDFParser._xPDFParser._yPDFParser._dxPDFParser._dyPDFParser._metaPDFParser.filenamePDFParser.nbanksPDFParser.bankPDFParser.stypePDFParser.qminPDFParser.qmaxPDFParser.qdampPDFParser.qbroadPDFParser.spdiameterPDFParser.scalePDFParser.temperaturePDFParser.dopingPDFParser.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