virtual_bse_image.py

# Copyright 2019-2022 The kikuchipy developers
#
# This file is part of kikuchipy.
#
# kikuchipy is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# kikuchipy is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with kikuchipy. If not, see <http://www.gnu.org/licenses/>.

from hyperspy._signals.signal2d import Signal2D

from kikuchipy.signals._common_image import CommonImage


class VirtualBSEImage(CommonImage, Signal2D):
    """Virtual backscatter electron (BSE) image(s).

    This class extends HyperSpy's Signal2D class for virtual BSE images.

    Methods inherited from HyperSpy can be found in the HyperSpy user
    guide.

    See the docstring of :class:`hyperspy.signal.BaseSignal` for a list
    of attributes.
    """

    _signal_type = "VirtualBSEImage"
    _alias_signal_types = ["virtual_backscatter_electron_image"]
    _lazy = False

    def __init__(self, *args, **kwargs):
        Signal2D.__init__(self, *args, **kwargs)