skued.Selection

class skued.Selection(shape, *args, **kwargs)

Abstract base class for time-series selection masks.

In the context of ultrafast electron/x-ray scattering, time-series are assembled by integrating over a portion of scattering patterns for each time-delay. This class is the generalization of selecting a rectangular area of scattering patterns to arbitrary patterns, e.g. disks, torii, etc.

New in version 2.0.2.

Parameters:

shape (2-tuple) – Shape of scattering patterns on which the selection will be applied.

See also

RectSelection

rectangular selection

DiskSelection

circular disk selection

RingSelection

ring selection, i.e. 2-torus

ArbitrarySelection

arbitrary selection

__init__(shape, *args, **kwargs)

Methods

__array__(*args, **kwargs)	Cast as a NumPy array.
__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__(shape, *args, **kwargs)
__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().
mpatch(*args, **kwargs)	Matplotlib patch associated with this selection.

Attributes

__abstractmethods__
__annotations__
_abc_impl
bounding_box	Returns the array bounding box.