arpes.xarray_extensions.ARPESFitToolsAccessor¶
- class arpes.xarray_extensions.ARPESFitToolsAccessor(xarray_obj: Union[xarray.core.dataarray.DataArray, xarray.core.dataset.Dataset])[source]¶
Utilities related to examining curve fits.
- __init__(xarray_obj: Union[xarray.core.dataarray.DataArray, xarray.core.dataset.Dataset])[source]¶
Initialization hook for xarray.
This should never need to be called directly.
- Parameters
xarray_obj – The parent object which this is an accessor for
Methods
__delattr__
(name, /)Implement delattr(self, name).
__dir__
()Default dir() implementation.
__eq__
(value, /)Return self==value.
__format__
(format_spec, /)Default object formatter.
__ge__
(value, /)Return self>=value.
__getattribute__
(name, /)Return getattr(self, name).
__gt__
(value, /)Return self>value.
__hash__
()Return hash(self).
__init__
(xarray_obj)Initialization hook for xarray.
__init_subclass__
This method is called when a class is subclassed.
__le__
(value, /)Return self<=value.
__lt__
(value, /)Return self<value.
__ne__
(value, /)Return self!=value.
__new__
(**kwargs)__reduce__
()Helper for pickle.
__reduce_ex__
(protocol, /)Helper for pickle.
__repr__
()Return repr(self).
__setattr__
(name, value, /)Implement setattr(self, name, value).
__sizeof__
()Size of object in memory, in bytes.
__str__
()Return str(self).
__subclasshook__
Abstract classes can override this to customize issubclass().
best_fits
()Orders the fits into a raveled array by the MSE error.
mean_square_error
()Calculates the mean square error of the fit across fit axes.
order_stacked_fits
([ascending])Produces an ordered collection of lmfit.ModelResult instances.
p
(param_name)Collects the value of a parameter from curve fitting.
param_as_dataset
(param_name)Maps from lmfit.ModelResult to a Dict parameter summary.
plot_param
(param_name, **kwargs)Creates a scatter plot of a parameter from a multidimensional curve fit.
s
(param_name)Collects the standard deviation of a parameter from fitting.
show
([detached])Opens a Bokeh based interactive fit inspection tool.
worst_fits
()Orders the fits into a raveled array by the MSE error.
Attributes
__dict__
__doc__
__module__
__weakref__
list of weak references to the object (if defined)
_obj
band_names
Collects the names of the bands from a multiband fit.
bands
Collects bands after a multiband fit.
parameter_names
Collects the parameter names for a multidimensional fit.