Skip to content

Latest commit

 

History

History
77 lines (60 loc) · 9.01 KB

File metadata and controls

77 lines (60 loc) · 9.01 KB


Contents
Classes
AmoebaFitter AnnealingAmoeba ArctanModel AstropyModel BSplinesModel BaseFitter
BaseModel BasicSplinesModel BernoulliErrorDistribution BfgsFitter BirthEngine Biweight
BracketModel Brackets CauchyErrorDistribution CauchyPrior ChebyshevPolynomialModel ChordEngine
CircularUniformPrior ClassicProblem CobylaFitter CombiModel ConjugateGradientFitter ConstantModel
ConvergenceError CosSquare Cosine CurveFitter DeathEngine DecisionTreeModel
DistanceCostFunction DoglegFitter Dynamic EclipsingStarModel Engine ErrorDistribution
ErrorsInXandYProblem EtalonDriftModel EtalonModel EvidenceProblem ExpModel Explorer
ExponentialErrorDistribution ExponentialPrior Fitter FixedModel FlippedDataProblem FootballModel
Formatter FreeShapeModel GalileanEngine Gauss Gauss2dErrorDistribution GaussErrorDistribution
GaussModel GaussPrior GibbsEngine HarmonicDynamicModel HarmonicModel Huber
HyperParameter ImageAssistant IterationPlotter IterativeFitter JeffreysPrior Kepplers2ndLaw
Kernel Kernel2dModel KernelModel LaplaceErrorDistribution LaplacePrior LbfgsbFitter
LevenbergMarquardtFitter LinearModel LogFactorial LogisticModel LoopEngine Lorentz
LorentzModel MaxLikelihoodFitter MixedErrorDistribution Model ModelDistribution Modifiable
MonteCarlo MoveEngine MultipleOutputProblem NearEngine NelderMeadFitter NestedSampler
NestedSolver NeuralNetUtilities NewtonCgFitter NoiseScale NonLinearModel OrderEngine
OrderProblem OrthonormalBasis PadeModel Parabola PeriodicScout PhantomCollection
PhantomSampler Plotter PoissonErrorDistribution PolySineAmpModel PolySurfaceModel PolynomialDynamicModel
PolynomialModel PowellFitter PowerLawModel PowerModel Prior Problem
ProductModel PseudoVoigtModel QRFitter RadialVelocityModel RandomEngine RepeatingModel
ReverseEngine RobustShell SalesmanProblem Sample SampleList SampleMovie
ScaledErrorDistribution ScipyFitter ShuffleEngine Sinc SincModel SineAmpModel
SineDriftModel SineModel SineSplineDriftModel SineSplineModel SlsqpFitter SoftMaxModel
SplinesDynamicModel SplinesModel StartEngine StartOrderEngine StellarOrbitModel StepEngine
StructureEngine SurfaceSplinesModel SwitchEngine TncFitter Tools Tophat
Triangle Tricube Triweight TrustNcgFitter Uniform UniformErrorDistribution
UniformPrior UniformRatioPrior UserModel VoigtModel Walker WalkerList

 

Reference Manual

The reference manual for BayesicFitting contains documentation on all classes and on the methods pertaining to the clases. Almost all software of BayesicFitting is in the form of classes: Models, Fitters etc.

All classes are listed under the dropdown button "Contents". Selecting one presents a reference manual page for that class.

Each reference page contains pink headers for the class and its constructor and subsequently light-green header lines for all its public methods. At the end, the inherited methods are presented, headed by a pink line with the class they are defined in.

In a Python session they are called as:

## import some class
from BayesicFitting import SomeClass
## construct an instantiation of SomeClass
sc = SomeClass( some, arguments )
## obtain an attribute from the class
a = sc.someAttribute
## run a method of the class
r = sc.someMethod( more, arguments )

Documentation on classes, methods, arguments and attributes are found in this reference manual.