.. _`udf reference`: UDF API reference ----------------- .. _`define udf ref`: Defining UDFs ~~~~~~~~~~~~~ See :ref:`user-defined functions` for an introduction and in-depth explanation. Mixins for processing methods ############################# .. autoclass:: libertem.udf.base.UDFFrameMixin :members: .. autoclass:: libertem.udf.base.UDFTileMixin :members: .. autoclass:: libertem.udf.base.UDFPartitionMixin :members: Base UDF classes ################ .. autoclass:: libertem.udf.base.UDF :members: :inherited-members: .. autoenum:: libertem.common.udf.UDFMethod Alternative merging for Dask arrays ################################### .. autoclass:: libertem.udf.base.UDFMergeAllMixin :members: Meta information ################ .. autoclass:: libertem.udf.base.UDFMeta :members: Pre- and postprocessing ####################### .. autoclass:: libertem.udf.base.UDFPreprocessMixin :members: .. autoclass:: libertem.udf.base.UDFPostprocessMixin :members: Exceptions ########## .. autoclass:: libertem.common.exceptions.UDFException .. _`run udf ref`: Running UDFs ~~~~~~~~~~~~ Three methods of :class:`libertem.api.Context` are relevant for running user-defined functions: .. autoclass:: libertem.api.Context :members: run_udf,run_udf_iter,map :noindex: Result type for UDF result iterators: .. autoclass:: libertem.udf.base.UDFResults :members: Exception for cancelled UDF run: .. autoclass:: libertem.common.exceptions.UDFRunCancelled .. _`buffer udf ref`: Buffers ~~~~~~~ :class:`~libertem.common.buffers.BufferWrapper` objects are used to manage data in the context of user-defined functions. .. automodule:: libertem.common.buffers :members: :undoc-members: .. _`utilify udfs`: Included utility UDFs ~~~~~~~~~~~~~~~~~~~~~ Some generally useful UDFs are included with LiberTEM: .. note:: See :ref:`application api` for application-specific UDFs and analyses. .. _`sum udf`: Sum of frames ############# .. autoclass:: libertem.udf.sum.SumUDF :members: .. _`logsum udf`: Sum of log-scaled frames ######################## .. autoclass:: libertem.udf.logsum.LogsumUDF :members: .. _`stddev udf`: Standard deviation ################## .. autoclass:: libertem.udf.stddev.StdDevUDF :members: .. autofunction:: libertem.udf.stddev.run_stddev .. autofunction:: libertem.udf.stddev.consolidate_result .. _`sumsig udf`: Sum per frame ############# .. autoclass:: libertem.udf.sumsigudf.SumSigUDF :members: .. _`com udf`: Centre-of-Mass ############## .. autoclass:: libertem.udf.com.CoMUDF :members: with_params The :code:`CoMUDF` has two helper classes used to parametrise it: .. autonamedtuple:: libertem.udf.com.CoMParams .. autoenum:: libertem.udf.com.RegressionOptions There is also a function available to guess sensible CoM parameters: .. autofunction:: libertem.udf.com.guess_corrections .. autonamedtuple:: libertem.udf.com.GuessResult .. _`masks udf`: Apply masks ########### .. autoclass:: libertem.udf.masks.ApplyMasksUDF :members: .. _`pick udf`: Load data ######### .. autoclass:: libertem.udf.raw.PickUDF :members: .. _`record udf`: Save data ######### .. autoclass:: libertem.udf.record.RecordUDF :members: NoOp #### .. autoclass:: libertem.udf.base.NoOpUDF :members: