Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
ObjCryst::AsymmetricUnitThe basic description of spacegroup asymmetric unit
ObjCryst::AtomThe basic atom scatterer, in a crystal
ObjCryst::BBox
ObjCryst::Crystal::BumpMergeParStorage for anti-bump/merge parameters
ObjCryst::WXMolecule::CellAtomStructure to store the Atom parameters
ObjCryst::WXMolecule::CellBondStructure to store the bond current values
ObjCryst::WXMolecule::CellBondAngleStructure to store the bond angles current values
ObjCryst::WXMolecule::CellDihedralAngleStructure to store the dihedral angles current values
ObjCryst::CellExplorerAlgorithm class to find the correct indexing from observed peak positions
ObjCryst::WXMolecule::CellRigidGroup
ChronometerSimple chronometer class, with microsecond precision
ci_char_traitsCase-insensitive string class From: Guru of the Week #29 e.g.: http://gcc.gnu.org/onlinedocs/libstdc++/21_strings/gotw29a.txt
ObjCryst::CIFMain CIF class - parses the stream and separates data blocks, comments, items, loops
ObjCryst::CIFData::CIFAtomAtom record
ObjCryst::CIFDataHolds all the information from a single data_ block from a cif file
ObjCryst::CrystalCrystal class: Unit cell, spacegroup, scatterers
ObjCryst::CrystalPOVRayOptionsClass to store POV-Ray output options
CrystArray3D< T >3D Vector (Blitz++ mimic) for ObjCryst++
CrystMatrix< T >2D Vector library (Blitz++ mimic) for ObjCryst++
CrystVector< T >Vector library (Blitz++ mimic) for ObjCryst++
CubicSplineCubic spline interpolation
ObjCryst::DiffractionDataSingleCrystalDiffractionData object for Single Crystal analysis
ObjCryst::OptimizationObj::DynamicObjWeight
ObjCryst::Molecule::FlipGroupWhen 3(A1..1n) or more atoms are connected to a same atom A, it defines a 'flip' group, where it is possible to rotate bonds to their symmetric with respect to one plane defined by atoms Ai-A-Aj
FormatFloatOutput a number as a formatted float:
FormatHorizVector< T >Format vector as horiz array:
FormatIntOutput a number as a formatted integer:
FormatStringOutput a string with a fixed length (adding necessary space or removing excess characters) :
FormatVertVector< T >Output one or several vectors as (a) column(s):
FormatVertVectorHKLFloats< T >Output vectors as column arrays, with the first 3 columns printed as integers
ObjCryst::GlobalScatteringPowerGlobal Scattering Power
ObjCryst::WXMultiGraph::GraphData
ObjCryst::PeakList::hklOne observed diffraction line, to be indexed
ObjCryst::PeakList::hkl0One set of Miller indices, a possible indexation for a reflection
CrystMatrix< T >::ListInitializer
CrystMatrix< T >::ListInitializerSwitch
ObjCryst::OptimizationObj::LogLikelihoodStatsStatistics about each object contributing to the overall Log(likelihood)
ObjCryst::LorentzCorrLorentz Correction
ObjCryst::LSQNumObj(Quick & dirty) Least-Squares Refinement Object with Numerical derivatives
ObjCryst::MainTrackerA class to hold all trackers
ObjCryst::MDAtomGroupGroups of atoms that can be moved using molecular dynamics principles, taking a list of restraints as ptential
ObjCryst::MolAtomMolAtom : atom inside a Molecule
ObjCryst::MolBondBond between two atoms, also a restraint on the associated bond length
ObjCryst::MolBondAngleBond angle restraint between 3 atoms
ObjCryst::MolDihedralAngleDihedral angle restraint between 4 atoms
ObjCryst::MoleculeMolecule : class for complex scatterer descriptions using cartesian coordinates with bond length/angle restraints, and moves either of individual atoms or using torsion bonds
ObjCryst::MolRingRing class
ObjCryst::MolZAtomLight-weight representation of an atom in the molecule, as a part of a Z-matrix
ObjCryst::MonteCarloObjBase object for Monte-Carlo Global Optimization methods
mp4Vector
mpVector
ObjCryst::Crystal::NeighbourInteratomic distance for a given neighbour
ObjCryst::Crystal::NeighbourHoodTable of neighbours for a given unique atom
ObjCryst::NiftyStaticGlobalObjectsInitializer_Crystal
ObjCryst::NiftyStaticGlobalObjectsInitializer_RefinableObj
ObjCryst::NiftyStaticGlobalObjectsInitializer_Scatterer
ObjCryst::NiftyStaticGlobalObjectsInitializer_ScatteringData
ObjCryst::NiftyStaticGlobalObjectsInitializer_ScatteringPower
ObjCryst::NiftyStaticGlobalObjectsInitializer_UnitCell
ObjCryst::ObjCrystExceptionException class for ObjCryst++ library
ObjCryst::ObjRegistry< T >Object Registry
ObjCryst::OptimizationObjBase object for Optimization methods
ObjCryst::PeakListClass to store positions of observed reflections
ObjCryst::PolarizationCorrPolarization Correction
POVRayColours
ObjCryst::PowderPatternPowder pattern class, with an observed pattern and several calculated components to modelize the pattern
ObjCryst::PowderPatternBackgroundPhase to compute a background contribution to a powder pattern using an interpolation
ObjCryst::PowderPatternBackgroundBayesianMinimiserThis object is used to estimate the background in a powder pattern, using a Bayesian approach (David & Sivia, Acta Cryst A50 (1994), 703)
ObjCryst::PowderPatternComponentGeneric class to compute components (eg the contribution of a given phase, or background) of a powder pattern
ObjCryst::PowderPatternDiffractionClass to compute the contribution to a powder pattern from a crystalline phase
ObjCryst::PowderSlitApertureCorrSlit aperture correction (for powder)
ObjCryst::QuaternionA quaternion class, used to represent the orientation of the molecule
ObjCryst::RadiationClass to define the radiation (type, monochromaticity, wavelength(s)) of an experiment
ObjCryst::RecUnitCellLightweight class describing the reciprocal unit cell, for the fast computation of d*_hkl^2
ObjCryst::RefinableObjGeneric Refinable Object
ObjCryst::RefinableObjClockWe need to record exactly when refinable objects have been modified for the last time (to avoid re-computation), and to do that we need a precise time. Since the clock() function is not precise enough (and is architecture-dependant), we use a custom time, which records the number of events in the program which uses the library. This is purely internal, so don't worry about it..
ObjCryst::RefinableParGeneric class for parameters of refinable objects
ObjCryst::ReflectionProfileAbstract base class for reflection profiles
ObjCryst::ReflectionProfileDoubleExponentialPseudoVoigtDouble-Exponential Pseudo-Voigt profile for TOF
ObjCryst::ReflectionProfilePseudoVoigtPseudo-Voigt reflection profile
ObjCryst::PowderPatternDiffraction::ReflProfileProfile of a single reflection
ObjCryst::RefObjOptBase class for options
ObjCryst::RefObjOption< T >Class for options of RefinableObj, templated so that we can warn the object that something has been changed
ObjCryst::RefParTypeClass of refinable parameter types
ObjCryst::RestraintRestraint: generic class for a restraint of a given model
ObjCryst::RigidGroupRigid groups of atoms inside a molecule
ObjCryst::Molecule::RotorGroupDefines a group of atoms which can be rotated around an axis defined by two other atoms
ObjCryst::WXCrystal::RowScattPowStructure to store the scattering power parameters
ObjCryst::ScattererGeneric type of scatterer: can be an atom, or a more complex assembly of atoms
ObjCryst::ScatteringComponentA scattering position in a crystal, associated with the corresponding occupancy and a pointer to the ScatteringPower
ObjCryst::ScatteringComponentListList of scattering positions in a crystal, associated with the corresponding occupancy and a pointer to the ScatteringPower
ObjCryst::ScatteringCorrBase class to compute all kind of corrections to intensities: Lorentz, Polar, absorption, texcture, extinction, etc
ObjCryst::ScatteringDataClass to compute structure factors for a set of reflections and a Crystal
ObjCryst::ScatteringPowerAbstract Base Class to describe the scattering power of any Scatterer component in a crystal
ObjCryst::ScatteringPowerAtomThe Scattering Power for an Atom
ObjCryst::ScatteringPowerSphere\ brief ScatteringPower for a spherical particule
ObjCryst::SimplexObjConjugate Gradient Algorithm object
ObjCryst::SpaceGroup::SMxStruct to store rot+trans matrix
ObjCryst::SpaceGroupThe crystallographic space group, and the cell choice
ObjCryst::SpeedTestReportStructure to hold the results of a speedtest (see ObjCryst::SpeedTest())
ObjCryst::StretchModeAbstract base Stretch Mode for Molecule objects
ObjCryst::StretchModeBondAngleAtoms moved when changing a bond angle
ObjCryst::StretchModeBondLengthGroup of atoms for random moves changing a bond length
ObjCryst::Molecule::StretchModeGroupGroup of concurrent StretchModes (affecting common restraints) A given stretch mode can only belong to one group
ObjCryst::StretchModeTorsionAtoms moved when rotated around a bond at0-at1-at2-at3
ObjCryst::StretchModeTwistAtoms moved *between* two other atoms, using a "twist" of their positions - only small twists of their positions are allowed to avoid breaking restraints too much
ObjCryst::SymmetricPairCompare< T >Class to compare pairs of objects, with the two objects playing a symmetric role
ObjCryst::TextureMarchDollaseTexture correction using the March-Dollase model
ObjCryst::TexturePhaseMarchDollaseOne texture phase for the March-Dollase model
ObjCryst::TOFCorrTime-Of-Flight Correction
ObjCryst::TrackerA class to track the variation of parameters as a function of a number of cycles/trials
ObjCryst::TrackerObject< T >Tracker for objects (RefinableObj, Crystal, PowderPattern, RefPar,
TRIANGLE
ObjCryst::Triple
ObjCryst::SpaceGroup::TRxStruct to store trans matrix
ObjCryst::UnitCellUnit Cell class: Unit cell with spacegroup information
ObjCryst::WXAtomWxCryst class for Atoms
ObjCryst::WXCRYST_IDClass to automatically assign a unique wxID to each window
ObjCryst::WXCrystalWxCryst class for Crystals
ObjCryst::WXCrystalScrolledGridWindow
ObjCryst::WXCrystMenuBarOur own local menu bar, using buttons and Popup menus
ObjCryst::WXCrystObjBase class for all displayed ObjCryst objects (with a title, and a sizer to stack objects)
ObjCryst::WXCrystObjBasicAbstract base class for all objects in wxCryst
ObjCryst::WXCrystObjBasicListA List of WXCrystObjBasic
ObjCryst::WXDiffractionSingleCrystalWX Class for DiffractionDataSingleCrystal objects
ObjCryst::WXFieldThis is the abstract base class for all fields, wether they contain a floating-point parameter, or a string,
ObjCryst::WXFieldChoiceClass to pick one choice... Choice change/update is handled by the WXCrystObj owner, who should grab the incoming event. Useful, for example, to change the scattering power associated to an atom
ObjCryst::WXFieldNameA field with the name of a WXCrystObj
ObjCryst::WXFieldOptionWX representation of a RefObj option. This displays the names of the different choices
ObjCryst::WXFieldPar< T >A field for a parameter. Template version. If the parameter is a RefinablePar, use WXFieldRefPar instead
ObjCryst::WXFieldParBaseA field for a parameter. This is a an abstract bas class, which can handle events (the real classes to use is the templated WXFieldPar class). If the parameter is a RefinablePar, use WXFieldRefPar
ObjCryst::WXFieldRefParA field for a RefinablePar. This shows the 'human' value of the parameter, and allows the modification of the parameter. A button allows to fix/unfix the parameter
ObjCryst::WXFieldStringA field which directly links to a string
ObjCryst::WXGlobalOptimRunThreadClass for a GlobalOptimization thread
ObjCryst::WXLSQ
ObjCryst::WXMolAtomWx class for MolAtom objects
ObjCryst::WXMolBondWx class for MolBond objects
ObjCryst::WXMolBondAngleWx class for MolBondAngle objects
ObjCryst::WXMolDihedralAngleWx class for MolDihedralAngle objects
ObjCryst::WXMoleculeWxCryst class for Molecule objects
ObjCryst::WXMolScrolledWindow
ObjCryst::WXMonteCarloObjClass for Graphical interface to Monte-Carlo objects (Simulated Annealing, Parallel Tempering)
ObjCryst::wxMultiChoiceDialog_ListBoxProvides the same functionnality as wxMultiChoiceDialog, but always using a wxListBox, which is much easier when selecting a large number of successive choices (using shift-click)
ObjCryst::WXMultiGraph
ObjCryst::WXOptimizationObjWX Class for a Global Optimization objects
ObjCryst::WXPowderPatternWX Class for PowderPattern objects
ObjCryst::WXPowderPatternBackgroundClass to display a Powder Pattern Background
ObjCryst::WXPowderPatternDiffractionClass to display a Powder Pattern for a crystalline phase
ObjCryst::WXPowderPatternGraphClass to display a Powder Pattern (calc,obs) in a graphic window
ObjCryst::WXProfileDoubleExponentialPseudoVoigtClass to display a Powder Pattern Pseudo-Voigt Profile
ObjCryst::WXProfilePseudoVoigtClass to display a Powder Pattern Pseudo-Voigt Profile
ObjCryst::WXRadiationWX Class for Radiation
ObjCryst::WXRefinableObjThe base wxCryst class for all RefinableObj objects. This shows the title, a menu for XMLInput/XMLOutput, and all RefObjOpt
ObjCryst::WXRegistry< T >This displays all components of a ObjCryst++ Registry
ObjCryst::WXScattererBase wxCryst class for Scatterers
ObjCryst::WXScatteringPowerAtomWxCryst class for ScatteringPowerAtom
ObjCryst::WXScatteringPowerSphereWxCryst class for ScatteringPowerSphere
ObjCryst::WXTextureMarchDollaseClass to display the Preferred Orientation Correction using the March-Dollase parametrization
ObjCryst::WXTexturePhaseMarchDollaseClass to display one Preferred Orientation phase using the March-Dollase parametrization
ObjCryst::WXTrackerGraph
ObjCryst::WXZAtom
ObjCryst::WXZScattererWxCryst class for ZScatterer objects
ObjCryst::XMLCrystTagClass to input or output a well-formatted xml beginning or ending tag
ObjCryst::XYZStructure holding 3 coordinates, or deriviatives with respect to each of these coordinates
ObjCryst::ZAtomClass for individual atoms in a ZScatterer Object. This class is purely internal to ZScatterer, so should not be used for any other purpose..
ObjCryst::ZMoveMinimizerClass to minimize conformation changes for random moves
ObjCryst::ZPolyhedronZPolyhedron: a Scatterer to describe polyhedras such as octahedron, tetrahedron, square plane, etc... These are ZScatterer objects, so that even if they are initialized with constraints, these can be removed to make any configuration
ObjCryst::ZScattererZScatterer: the basic type of complex scatterers, where atom positions are defined using a standard "Z-Matrix" description. This is used to describe inorganic polyhedras, as well as molecules

Generated on Mon Dec 7 23:05:43 2009 for FOX/ObjCryst++ by  doxygen 1.6.1