Abbott-Firestone Curve¶
- class surfalize.abbottfirestone.AbbottFirestoneCurve(surface, nbins=10000)¶
Bases:
CachedInstanceRepresents the Abbott-Firestone curve of a Surface object and provides methods to calculate the functional roughness parameters derived from it.
- Parameters:
- surfaceSurface
Surface object from which to calcualte the Abbott-Firestone curve
- nbinsint, default 10000
Number of bins for the material density histogram. Large numbers result in longer computation time but increased accuracy of results. The default value of 10000 represents a reasonable compromise.
Methods
Sk()Calculates Sk.
Smc(mr)Calculates Smc(mr).
Smr(c)Calculates Smr(c).
Smr1()Calculates Smr1.
Smr2()Calculates Smr2.
Spk()Calculates Spk.
Svk()Calculates Svk.
clear_cache()Clears the cache for the entire instance.
create_cache_entry(method, entry, args, kwargs)Manually creates a cache entry for the specified method.
Vmc
Vmp
Vvc
Vvv
plot
visual_parameter_study
- EQUIVALENCE_LINE_WIDTH = 40¶
- Sk()¶
Calculates Sk.
- Returns:
- float
- Smc(mr)¶
Calculates Smc(mr).
- Parameters:
- mrfloat
Material ratio.
- Returns:
- float
- Smr(c)¶
Calculates Smr(c).
- Parameters:
- cfloat
Material height.
- Returns:
- float
- Smr1()¶
Calculates Smr1.
- Returns:
- float
- Smr2()¶
Calculates Smr2.
- Returns:
- float
- Spk()¶
Calculates Spk.
- Returns:
- float
- Svk()¶
Calculates Svk.
- Returns:
- float
- Vmc(p=10, q=80)¶
- Vmp(p=10)¶
- Vvc(p=10, q=80)¶
- Vvv(q=80)¶
- plot(nbars=20, ax=None)¶
- visual_parameter_study(ax=None)¶