Surface generation and manipulation (slippy.surface)

This package contains functions and classes for reading surfaces from file, manipulating, generating and analysing surfaces.

The Surface class for experimental surfaces

The Surface class contains methods for reading surfaces from files including .mat, .txt, .csv and .al3d files. It also contains methods for analysing surface roughness and other parameters.

Surface([profile, grid_spacing, shape, ...])

Object for reading, manipulating and plotting surfaces

Analytical Surfaces

Surfaces which can be described by a mathematical function, these can be combined, rotated or shifted with no loss in resolution.

FlatSurface([slope, rotation, shift, ...])

Flat surface can be angled in any direction by changing slope

RoundSurface(radius[, rotation, shift, ...])

Round surfaces with any radii

PyramidSurface(lengths[, rotation, shift, ...])

Pyramid surface with any slopes

DiscFreqSurface(frequencies[, amplitudes, ...])

Surfaces with discrete frequency components

HurstFractalSurface(sigma, hurst_exponent[, ...])

Hurst fractal surfaces

Random Surfaces

Surfaces based on transformations of random surfaces or probabilistic descriptions of the FFT.

RandomPerezSurface(target_psd[, ...])

Surfaces with set height distribution and PSD found by the Perez method

RandomFilterSurface([target_acf, ...])

Surfaces based on transformations of random sequences by a filter

ProbFreqSurface(H, qr, qs)

Generates a surface with all possible frequencies in the fft represented with amplitudes described by the probability distribution given as input.

Functions

Functional interfaces for common tasks, these are all aliased by class methods in the surface class, apart from surface_like.

assurface(profile[, grid_spacing])

make a surface from a profile

read_surface(file_name, **kwargs)

Read a surface from a file

alicona_read(full_path)

Reads .al3d and associated files made by alicona measurement machines

read_tst_file(filename)

Reads a .tst file from a bruker UMT machine

roughness(profile_in, parameter_name[, ...])

Find 3d surface roughness parameters

get_height_of_mat_vr(ratio, profile[, void, ...])

Finds the cut off height of a specified material or void volume ratio

get_mat_vr(height, profile[, void, mask, ...])

Finds the material or void volume ratio

subtract_polynomial(profile[, order, mask])

Flattens the surface by fitting and subtracting a polynomial