pingwyn

Functions

affine_correct(image, vectors_from, lattice_to)	Perform an affine transformation on an image.
align_rows(image[, mask, method])	Perform Gwyddion-like median row alignment of images.
bin(obj[, bins, keep_dims, method])	Bin an object by combining datapoints.
clip(obj[, min, max, relative])	Clip data to cut off extreme values.
copy(obj)	Create an in-memory copy of a pingwyn object.
curve_fix_zero(curve[, strat])	Shift a curve such that the points at x = 0 or y = 0 are set to zero.
curves_to_profiles(curves)	Convert individual curves to line profiles.
differentiate(obj[, method, absolute])	Differentiate the closest thing to dy/dx for the given object.
fix_zero(obj, *args, **kwargs)	Wrapper for pingwyn.image_fix_zero, pingwyn.curve_fix_zero and pingwyn.profile_fix_zero.
image_fix_zero(image[, mask])	Set minimum value of an image to zero.
list_variables(obj, dtype)
load_variable(obj, dtype, name)
normalise(obj[, strat])	Normalise an object.
obj_copy([arg, kwarg])
open(path, *args, **kwargs)	Open a data file.
open_all(path[, force_glob, ...])	Opens multiple data files.
plot(ax, obj, *args, **kwargs)	Wrapper function for plotting PinGwyn objects.
plot_curve(ax, curve, **kwargs)	Plot a curve.
plot_grid(ax, grid[, slice, cbar_ax, mask])	Plot a grid slice of a specified index.
plot_image(ax, image, **kwargs)	Plot an image to a matplotlib axis.
plot_interactive(obj, *args, **kwargs)	Wrapper function for plotting PinGwyn objects.
plot_interactive_curve(*args, **kwargs)
plot_interactive_grid(grid, *args, **kwargs)
plot_interactive_image(*args, **kwargs)
plot_interactive_profile(profile, image, ...)
plot_profile(ax, profile[, image, ax_image, ...])	Plot a profile.
profile_fix_zero(profile[, strat])	Shift a profile such that for each curve in the profile, the points at x = 0 or y = 0 are set to zero.
remove_artefacts(image_trace, image_retrace)	Remove a variety of scanning artefacts using FFT based feature detection.
remove_plane(image[, order, mask])	Remove an n-th order polynomial background from an image
save(path)	This function is not implemented
save_variable(obj, dtype, name[, overwrite])
smooth(obj, n_points[, strat])	Smooth data points.
square_pixels(image)	Resize an image such that the width and height of a pixel are equal (i.e. square).
to_float(obj)	Convert object values to floats.
to_float64(obj)	Convert object values to numpy 64-bit floats.
to_int(obj)	Convert object values to integers between 0 to 255
to_uint8(obj)	Convert object values to numpy unsigned 8-bit integers.

Classes

Curve(arr[, metadata])	A container for a x,y-curve.
Grid(arr[, z, metadata])	A container for a 3D grid.
Image(arr[, metadata])	A container for an image.
Profile(arr[, x, metadata])	A container for a x,y-curve.

Modules

assets
core
file
graph