hyperspy._signals package

Submodules

hyperspy._signals.common_signal1d module

class hyperspy._signals.common_signal1d.CommonSignal1D

Bases: object

Common functions for 1-dimensional signals.

to_signal2D(optimize=True)

Returns the one dimensional signal as a two dimensional signal.

By default ensures the data is stored optimally, hence often making a copy of the data. See transpose for a more general method with more options.

optimize : bool, default is True
If True, the location of the data in memory is optimised for the fastest iteration over the navigation axes. This operation can cause a peak of memory usage and requires considerable processing times for large datasets and/or low specification hardware. See the transposing section of the HyperSpy user guide for more information. When operating on lazy signals, if True the chunks are optimised for the new axes configuration.

See also

transpose(), as_signal1D(), as_signal2D(), hs.transpose()

Raises:DataDimensionError: when data.ndim < 2

hyperspy._signals.common_signal2d module

class hyperspy._signals.common_signal2d.CommonSignal2D

Bases: object

Common functions for 2-dimensional signals.

to_signal1D(optimize=True)

Returns the image as a spectrum.

optimize : bool, default is True
If True, the location of the data in memory is optimised for the fastest iteration over the navigation axes. This operation can cause a peak of memory usage and requires considerable processing times for large datasets and/or low specification hardware. See the transposing section of the HyperSpy user guide for more information. When operating on lazy signals, if True the chunks are optimised for the new axes configuration.

See also

as_signal1D()
a method for the same purpose with more options.
signals.Signal1D.to_signal1D()
performs the inverse operation on one

dimensional(), as_signal2D(), transpose(), hs.transpose()

hyperspy._signals.complex_signal module

hyperspy._signals.complex_signal1d module

hyperspy._signals.complex_signal2d module

hyperspy._signals.dielectric_function module

hyperspy._signals.eds module

hyperspy._signals.eds_sem module

hyperspy._signals.eds_tem module

hyperspy._signals.eels module

hyperspy._signals.hologram_image module

hyperspy._signals.lazy module

hyperspy._signals.signal1d module

hyperspy._signals.signal2d module

Module contents