Skip to content

Latest commit

 

History

History
120 lines (95 loc) · 2.77 KB

LocMoFit.modelLibrary.rst

File metadata and controls

120 lines (95 loc) · 2.77 KB
Raw

Model library

All the names of the models follow the rule: '[geometry][dimension][p]_[parameterization]_[...]_[model form]', with the simplest case as '[geometry][dimension]' (e.g., ring3D<models.ring3D>). For example, dualEllipse3D_avgR_discrete<models.dualEllipse3D_avgR_discrete> means a dual-ellipse geometry in 3D, parametrized by the average radius, in a discrete form.

Note

The individual components of the names

  • [geometry]: the geometry.
  • [dimension]: the model dimension.
  • [p]: (optional) when it is mentioned, the model is parametric, otherwise not.
  • [parameterization]: (optional) when multiple parameterizations exist, this is added to identify the specific parameterization. When the [parameterization] is not mentioned, the model is assumed to be with the default parameterization.
  • [...]: (optional) if the [parameterization] itself is not sufficient to differentiate the implementations, extra labels are added here.
  • [model form]: (optional) the form of how the model is implemented. When it is not provided, the model is in the continuous form.

models

Arc

arc2D

arc2D_arcLen

Bucket

bucket2D

Ring

ring2D

ellipse3D

ring3D

Spline

cspline3D_midPoint

Tube and derivitives

csplineClosedTube3D_midPoint

csplineTube3D_midPoint

csplineTube3D_xyz

Dual rings and derivitives

dualEllipse3D_discrete

dualEllipse3D_avgR_discrete

dualRing3D_discrete

Sperical model and derivitives

sphericalCap3D_surfaceArea

sphericalCap3Dp_surfaceArea

spheroid3Dp_surfaceArea

spheroidCap3Dp_surfaceArea

2D projection of 3D geometry

hemispheroid2D

thickRing2D

Random geometry

locsBG3D

gaussianCluster2D