Class Hierarchy

diffpy.srrietveld.buildfit.BuildFit: BuildFit class is to build fit object based on the GUI inputs.
diffpy.srrietveld.convert.datafile.DataFile: The data file class
diffpy.srrietveld.addon.datafile.DataFileConverter: Unify to convert input data file to engine file and save the XYSigma into data dictionary.
diffpy.srrietveld.convert.gsasinstparser.GSASInstFile: Class to parse the instrument info from GSAS instrument file.
diffpy.srrietveld.addon.mcsampling.MonteCarloSampling: Monte Carlo Sampling for diffraction pattern.
diffpy.srrietveld.objectinfo.ObjectInfo: ObjectInfo uses the info in the engine definition to define what is allowed to be set in an object, namely the legal content of an object.
trunk.diffpy.srrietveld.applications.refine.ReadInput: Parse input options and read xml files
diffpy.srrietveld.convert.strategyfile.StrategyFile: Parse the strategy file into a list of dictionaries for later refinement [{method: [[fullpath, value, constrain formula], ...]}, {...
diffpy.srrietveld.addon.structurefile.StructureFileConverter: Convert input structure file to a dictionary
diffpy.srrietveld.utility.UTF8Recoder: Iterator that reads an encoded stream and reencodes the input to UTF-8
diffpy.srrietveld.utility.UnicodeReader: A CSV reader which will iterate over lines in the CSV file "f", which is encoded in the given encoding.
diffpy.srrietveld.utility.UnicodeWriter: A CSV writer which will write rows to CSV file "f", which is encoded in the given encoding.
diffpy.srrietveld.convert.xmlparser.XMLFile: Parser XML file
object: The most base type
- exceptions.BaseException: Common base class for all exceptions
  - exceptions.Exception: Common base class for all non-exit exceptions.
    - diffpy.srrietveld.exceptions.SrrError: Basic SrRietveld exception class.
      - diffpy.srrietveld.exceptions.SrrConfigError: SrRietveld config exception.
      - diffpy.srrietveld.exceptions.SrrFileError: SrRietveld file exception
      - diffpy.srrietveld.exceptions.SrrIOError: SrRietveld input / output exception
      - diffpy.srrietveld.exceptions.SrrInputError: SrRietveld exception by user input
      - diffpy.srrietveld.exceptions.SrrRunTimeError: SrRietveld run time exception
      - diffpy.srrietveld.exceptions.SrrValueError: SrRietveld value exception
- diffpy.srrietveld.addon.debyefitting.DebyeFitting: Class to perform Debye fitting
- diffpy.srrietveld.fitrt.FitRT: FitRT provides the runtime control of refinements.
- diffpy.srrietveld.convert.listfilereader.ListFileReader: Object for loading datafiles and temperatures from a list file.
  - diffpy.srrietveld.convert.listfilereader.CSVListFileReader: ListFileReader specialized for comma-separated-values (CSV) format.
- diffpy.refinementdata.hdf5.object.Object: Object provides the HDF5 storage support to all refinement components, such as parameters, models, patterns, as well as refinements themselves.
  - diffpy.refinementdata.project.Project: Project is the top level class of diffpy.refinementdata.
    - diffpy.srrietveld.project.Project: Project class defines a SrRietveld refinement project.
  - diffpy.refinementdata.refinable.Refinable: A Refinable object contains a number of refinable parameters, as well as other Refinable objects.
    - diffpy.srrietveld.atom.Atom: Atom is a Refinable component which contains multiple parameters.
    - diffpy.srrietveld.pattern.ExcludedRegion: This is a script interface of the excluded region, with access functions to the begin and end parameters in the object
    - diffpy.refinementdata.function.Function: Function is a refinable component which contains multiple parameters.
      - diffpy.srrietveld.profile.Profile: Profile is a Function component which contains multiple parameters.
    - diffpy.refinementdata.pattern.Pattern: Pattern inherits the Refinable class.
      - diffpy.srrietveld.pattern.Pattern: Pattern inherits the Pattern class in diffpy.refinementdata.
    - diffpy.refinementdata.refinement.Refinement: Refinement class contains all the information about a refinement.
      - diffpy.srrietveld.refinement.Refinement: The refinement (fit) class for SrRietveld.
    - diffpy.refinementdata.structure.Structure: A Structure object saves the structure to be refined.
      - diffpy.srrietveld.phase.Phase: A Phase object saves the structure to be refined.