# /*#########################################################################
# Copyright (C) 2004-2022 European Synchrotron Radiation Facility
#
# This file is part of the PyMca X-ray Fluorescence Toolkit developed at
# the ESRF.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
# ###########################################################################*/
"""
This plugin opens a stack ROI window providing alternative views:

 - Usual sum of counts in the region
 - Channel/Energy at data Max in the region.
 - Channel/Energy at data Min in the region.
 - Map of the counts at the first channel of the region
 - Map of the counts at the middle cahnnel of the region
 - Map of the counts at the last channel of the region
 - Background counts

The background image can be subtracted from the other images to show
a net count.

If positioner data is available, the values corresponding to the mouse cursor
position in the plot are displayed in a widget underneath the plot.

If an external background images, such as a photo of the sample, has been
loaded using the external images plugin, it is displayed on the background
layer. A slider allows to increase the transparency of the foreground data
image to view this background image.

This window also provides a median filter tool, with a configurable filter
width, to smooth the stack image.

The mask of the plot widget is synchronized with the primary stack widget.
"""

__authors__ = ["V.A. Sole", "P. Knobel"]
__contact__ = "sole@esrf.fr"
__license__ = "MIT"


from PyMca5 import StackPluginBase
from PyMca5.PyMcaGui.plotting import SilxMaskImageWidget
from PyMca5.PyMcaGui import PyMca_Icons as PyMca_Icons


class SilxRoiStackPlugin(StackPluginBase.StackPluginBase):
    def __init__(self, stackWindow):
        StackPluginBase.StackPluginBase.__init__(self, stackWindow)
        self.methodDict = {'Show': [self._showWidget,
                                    "Show ROIs",
                                    PyMca_Icons.brushselect]}
        self.__methodKeys = ['Show']
        self.widget = None

    def _getStackOriginScale(self):
        """Return origin and scale, as defined in silx plot addImage method
        """
        info = self.getStackInfo()

        xscale = info.get("xScale", [0.0, 1.0])
        yscale = info.get("yScale", [0.0, 1.0])

        origin = xscale[0], yscale[0]
        scale = xscale[1], yscale[1]

        return origin, scale

    def _getStackImageShape(self):
        """Return 2D stack image shape"""
        image_shape = list(self.getStackOriginalImage().shape)
        return image_shape

    def stackUpdated(self):
        if self.widget is None:
            return
        if self.widget.isHidden():
            return
        images, names = self.getStackROIImagesAndNames()

        image_shape = self._getStackImageShape()
        origin, scale = self._getStackOriginScale()

        info = {"positioners": self.getStackInfo().get("positioners", {})}
        if info["positioners"]:
            self.widget.setMotorPositionsVisible(True)
        else:
            self.widget.setMotorPositionsVisible(False)

        infos = [info] # for _img in images]

        h = scale[1] * image_shape[0]
        w = scale[0] * image_shape[1]

        self.widget.setImages(images, labels=names,
                              origin=origin, width=w, height=h,
                              infos=infos)

        self.widget.setSelectionMask(self.getStackSelectionMask())
        self._updateBgImages()

    def _updateBgImages(self):
        bgimages = self.getStackInfo().get("bgimages", {})

        if bgimages:
            datas, labels, origins, heights, widths = [], [], [], [], []
            for lab, bgimg in bgimages.items():
                labels.append(lab)
                datas.append(bgimg["data"])
                origins.append(bgimg["origin"])
                heights.append(bgimg["height"])
                widths.append(bgimg["width"])

            self.widget.setBackgroundImages(datas, labels, origins, heights, widths)

    def selectionMaskUpdated(self):
        if self.widget is None:
            return
        if self.widget.isHidden():
            return
        mask = self.getStackSelectionMask()
        self.widget.setSelectionMask(mask)

    def stackROIImageListUpdated(self):
        self.stackUpdated()

    def stackClosed(self):
        if self.widget is not None:
            self.widget.close()

    def mySlot(self, ddict):
        if ddict['event'] == "selectionMaskChanged":
            mask = ddict["current"]
            self.setStackSelectionMask(mask)
        elif ddict['event'] == "addImageClicked":
            self.addImage(ddict['image'], ddict['title'])
        elif ddict['event'] == "removeImageClicked":
            self.removeImage(ddict['title'])
        elif ddict['event'] == "replaceImageClicked":
            self.replaceImage(ddict['image'], ddict['title'])
        elif ddict['event'] == "resetSelection":
            self.setStackSelectionMask(None)

    #Methods implemented by the plugin
    def getMethods(self):
        return self.__methodKeys

    def getMethodToolTip(self, name):
        return self.methodDict[name][1]

    def getMethodPixmap(self, name):
        return self.methodDict[name][2]

    def applyMethod(self, name):
        return self.methodDict[name][0]()

    def _showWidget(self):
        if self.widget is None:
            self.widget = SilxMaskImageWidget.SilxMaskImageWidget()
            self.widget.setMedianFilterWidgetVisible(True)
            self.widget.setBackgroundActionVisible(True)
            self.widget.setProfileToolbarVisible(True)
            self.widget.setAlphaSliderVisible(True)
            self.widget.sigMaskImageWidget.connect(self.mySlot)

        # Show
        self.widget.show()
        self.widget.raise_()

        self.stackUpdated()


MENU_TEXT = "Silx Alternative ROI Options"


def getStackPluginInstance(stackWindow):
    ob = SilxRoiStackPlugin(stackWindow)
    return ob
