Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   Related Pages  

ObjCryst::PowderPatternBackground Class Reference

Phase to compute a background contribution to a powder pattern using an interpolation. Currently only linear interpolation is available. (in the works: cubic spline interpolation background). More...

#include <PowderPattern.h>

Inheritance diagram for ObjCryst::PowderPatternBackground::

ObjCryst::PowderPatternComponent ObjCryst::RefinableObj List of all members.

Public Methods

 PowderPatternBackground ()
 PowderPatternBackground (const PowderPatternBackground &)
virtual ~PowderPatternBackground ()
virtual const string GetClassName () const
 Name for this class ("RefinableObj", "Crystal",...). This is only useful to distinguish different classes when picking up objects from the RefinableObj Global Registry.

virtual void SetParentPowderPattern (const PowderPattern &)
  Set the PowderPattern object which uses this component. This sets all necessary spectrum parameters (2theta range, wavelength, radiation type...) accordingly.

virtual const CrystVector_double & GetPowderPatternCalc () const
 Get the calculated powder spectrum for this component. Note that the spectrum is not scaled.

void ImportUserBackground (const string &filename)
 Import background points from a file (with two columns 2theta, intensity).

void SetUseFastLessPreciseFunc (const bool useItOrNot)
 Use faster, less precise functions ? Good for global optimizations. Currently does nothing.

virtual void SetUseOnlyLowAngleData (const bool useOnlyLowAngle, const double angle=0)
 Set an option so that only low-angle reflections (theta < angle) are used. See DiffractionData::mUseOnlyLowAngleData
Deprecated:
Do not use, as this will probably be removed eventually.


virtual void XMLOutput (ostream &os, int indent=0) const
 Output to stream in well-formed XML. More...

virtual void XMLInput (istream &is, const XMLCrystTag &tag)
 Input From stream. More...


Protected Methods

virtual void CalcPowderPattern () const
 Calc the powder spectrum. As always, recomputation is only done if necessary (ie if a parameter has changed since the last computation).

virtual void SetRadiation (const Radiation &rad)
  Set the radiation. This is called by PowderPattern.

virtual void Prepare ()
  This will be called by the parent PowderPattern object, before calculating the first powder spectrum. Or maybe it should be called automatically by the object itself...


Protected Attributes

PowderBackgroundInterpType mBackgroundType
 The kind of interpolation used.

int mBackgroundNbPoint
 Number of fitting points for background.

CrystVector_double mBackgroundInterpPoint2Theta
 Vector of 2theta values for the fitting points of the background.

CrystVector_double mBackgroundInterpPointIntensity
 Values of background at interpolating points.

RefinableObjClock mClockBackgroundPoint
 Modification of the interpolated points.

RefinableObjClock mClockBackgroundSpline
 Last time Splines were generated.

bool mUseOnlyLowAngleData
 Use only low-angle data ? \deprecated.

double mUseOnlyLowAngleDataLimit
 Limit (theta angle, in radian) for the above option. \deprecated.


Friends

class PowderPattern

Detailed Description

Phase to compute a background contribution to a powder pattern using an interpolation. Currently only linear interpolation is available. (in the works: cubic spline interpolation background).


Member Function Documentation

virtual void XMLInput istream &    is,
const XMLCrystTag   tag
[virtual]
 

Input From stream.

Todo:
Add an bool XMLInputTag(is,tag) function to recognize all the tags from the stream. So that each inherited class can use the XMLInputTag function from its parent (ie take advantage of inheritance). The children class would first try to interpret the tag, then if unsuccessful would pass it to its parent (thus allowing overloading), etc...

Reimplemented from ObjCryst::RefinableObj.

virtual void XMLOutput ostream &    os,
int    indent = 0
const [virtual]
 

Output to stream in well-formed XML.

Todo:
Use inheritance.. as for XMLInputTag()...

Reimplemented from ObjCryst::RefinableObj.


The documentation for this class was generated from the following file:
Generated on Wed Nov 14 19:48:37 2001 for ObjCryst++ by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001