LiberTEM Logo

User manual

  • Installation
  • GUI usage
  • Applications
  • Loading data
  • Sample Datasets
  • Python API
  • User-defined functions (UDFs)
  • Dask integration
  • Changelog
  • Citing
  • Acknowledgments

Reference

  • Python API reference
    • LiberTEM Context API
    • UDF API reference
    • Data Set API
    • I/O Backends
    • Application-specific APIs
    • Mask creation and manipulation
    • Sparse array utils
    • Internal API
    • Dask API
    • Corrections
    • Visualization
    • Progress bar support
    • Indices and tables
  • Tips and tricks
  • Package overview
  • Concepts
  • Performance
  • Why Python?

For developers

  • Setting up a development environment
  • Contributing
  • Debugging
  • Architecture
  • How does I/O work in LiberTEM?
  • LiberTEM executors
  • Authorship policy
LiberTEM
  • Python API reference
  • View page source

Python API reference

  • LiberTEM Context API
    • Context
    • Analysis API
  • UDF API reference
    • Defining UDFs
    • Running UDFs
    • Buffers
    • Included utility UDFs
  • Data Set API
    • Formats
    • Converters
    • Internal DataSet API
  • I/O Backends
    • Available I/O backends
  • Application-specific APIs
    • Amorphous materials reference
    • Correlation-based peak finding and strain mapping reference
    • Phase-change materials reference
  • Mask creation and manipulation
    • background_subtraction()
    • balance()
    • bounding_radius()
    • circular()
    • gradient_x()
    • gradient_y()
    • polar_map()
    • radial_bins()
    • radial_gradient()
    • radial_gradient_background_subtraction()
    • rectangular()
    • ring()
    • sparse_circular_multi_stack()
    • sparse_template_multi_stack()
  • Sparse array utils
    • assert_sparse()
    • is_sparse()
    • sparse_to_coo()
    • to_dense()
    • to_sparse()
  • Internal API
    • MaskContainer
    • Shapes and slices
    • CPU and CUDA devices
  • Dask API
    • make_dask_array()
    • Dask result buffer
  • Corrections
    • CorrectionSet
  • Visualization
    • Matplotlib
    • bqplot
    • GMS
    • Base classes and functions
  • Progress bar support
    • ProgressReporter
    • ProgressState

Indices and tables

  • Index

  • Module Index

  • Search Page

Previous Next

© Copyright 2021, LiberTEM Authors.

Built with Sphinx using a theme provided by Read the Docs.