Trees       Indices       Help   
diffpy.srrietveld
Package diffpy :: Package srrietveld :: Module profile :: Class Profile
[frames] | no frames]

Class Profile

source code

                       object --+            
                                |            
refinementdata.hdf5.object.Object --+        
                                    |        
   refinementdata.refinable.Refinable --+    
                                        |    
         refinementdata.function.Function --+
                                            |
                                           Profile

Profile is a Function component which contains multiple parameters.
A composite function may also contain other functions.

data member:
    
    formula: a string of the function definition in C style
    variables: a space separated string of all variables in the formula
Instance Methods
 
__init__(self, owner, name=None, handle=None, formula=None, variables=None, shape=None)
Initialization.		 source code
 
getCutOff(self)
Get the peak cut off factors from GSAS and the cut-off of the peak profile tails for FullProf (Wdt)		 source code
 
getEngineType(self)
Get the engine type for this refinement		 source code
 
getNumOfCoefficients(self)
Get number of profile coefficients		 source code
 
getProfileType(self)
Get the profile type number.		 source code
 
listCoefficientNames(self)
List the names of the profile function coefficients		 source code

Inherited from refinementdata.refinable.Refinable: addHistory, addHistoryByPath, addSigma, addSigmaByPath, findRefinement, getHistory, getHistoryByPath, getSigma, getSigmaByPath, listHistories, listRefined, loadLocalObjects, removeHistory, update

Inherited from refinementdata.hdf5.object.Object: addObject, copy, copyMeta, delete, exportFile, get, getAttr, getByPath, getFlatIndex, getMetaData, getMultiDimIndex, getObject, getPyObj, hasAttr, hasMeta, importFile, isDescendant, list, listAttrs, listNames, listObjects, load, loadLocalData, loadObject, move, range, readStr, removeObject, rename, repeat, replicate, reshape, save, set, setAttr, setByPath, setLabels, setPyObj, unset, unsetAttr, writeStr

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties

Inherited from refinementdata.hdf5.object.Object: labels, name, ndim, path

Inherited from object: __class__

Method Details

__init__(self, owner, name=None, handle=None, formula=None, variables=None, shape=None)
(Constructor)

source code 

Initialization.

Parameters:
  • owner (a data project) - the owner, which is usually a refinement.
  • handle (a HDF5Handle object) - a HDF5Handle pointing to the underlying HDF5 node.
  • formula (string) - a string of the function definition in C style
  • variables (a space separated string) - a space separated string of all variables

    A name is passed to the initialization method when creating a node.

    A handle is passed to the inialization method in two cases:

    1. when loading from a HDF5 file;
    2. when creating a HDF5 file but the object is a hard link to a preexisiting one.

    In the case when both name and handle are given, name will be simply ignored. In the case when neither name nor handle is given, an exception will be raised.

    Generally, in the scripting interface, users do not have to call this constructor directly

  • name (string @param name the name of the pattern)
Overrides: object.__init__

getCutOff(self)

source code 

Get the peak cut off factors from GSAS and the cut-off of the peak profile tails for FullProf (Wdt)

Returns:
cut off related values

getEngineType(self)

source code 

Get the engine type for this refinement

Returns:
the string of the engine type, for example "gsas" or "fullprof"

getNumOfCoefficients(self)

source code 

Get number of profile coefficients

Returns:
number of profile coefficients

getProfileType(self)

source code 

Get the profile type number. This number is different in engines. User has to refer to the manual of the engine program for meanings of this id number. Since the profile type should be the same for all the single refinements in the series. So only a single number is returned.

Returns:
the profile function identification number

listCoefficientNames(self)

source code 

List the names of the profile function coefficients

Returns:
a list of coefficient names

   Trees       Indices       Help   
diffpy.srrietveld
Generated by Epydoc 3.0.1 on Sun Aug 28 23:35:57 2011 http://epydoc.sourceforge.net