#==============================================================================
#
# Project:   SharpImage
# Module:    MorphologicalOpen.py
# Language:  IronPython
# Author:    Dan Mueller
# Date:      $Date: 2007-07-13 06:30:23 +1000 (Fri, 13 Jul 2007) $
# Revision:  $Revision: 8 $
#
# Copyright (c) Queensland University of Technology (QUT) 2007.
# All rights reserved.
#
# This software is distributed WITHOUT ANY WARRANTY; without even
# the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
# PURPOSE.  See the above copyright notices for more information.
#
#==============================================================================

# Import the base script class
import ImageToImageScript
from ImageToImageScript import *

# Add reference and import Morphology library
clr.AddReference("ManagedITK.MorphologicalFilters")
from itk import *

class MorphologicalOpenScript(ImageToImageScriptObject):
    # -------------------------------------------------------------------------
    Name = "MorphologicalOpen"
    Help = """Computes the greyscale morphological opening of an image.
              This filter preserves regions, in the foreground, that can completely
              contain the binary ball structuring element. At the same time, this filter
              eliminates all other regions of foreground pixels. The morphological opening
              of an image "I" is defined as:
              \tOpening(I) = Dilate( Erode(I) )"""
    Parameters = """(itkSize) KernelRadius = the radius of the ball. (itkSize(1,1,.))
                    (itkFlatStructuringElement) Kernel = the structuring element. (Ball)
                    (string) Operation = either "Binary" or "Grayscale". ("Grayscale")
                    (pixel) ForegroundValue = for Operation="Binary", sets the value considered as foreground.
                    (pixel) BackgroundValue = for Operation="Binary", sets the value considered as background."""
    KernelRadius = None
    Kernel = None
    Operation = "Grayscale"
    ForegroundValue = None
    BackgroundValue = None
    # -------------------------------------------------------------------------

    def ThreadedDoWork(self):
        """ Perform the main functions of the script on a background thread. """
        try:
            self.StartedWork()
            self.WriteInputName()
            filterOpen = None
            if (String.Compare( self.Operation, "Binary", True ) == 0):
                filterOpen = itkBinaryOpeningImageFilter.New( self.Input, self.Output )
                if (self.ForegroundValue != None):
                    filterOpen.ForegroundValue = self.ForegroundValue
                    self.WriteLineToConsole( "ForegroundValue=" + filterOpen.ForegroundValue.ToString() )
                if (self.BackgroundValue != None):
                    filterOpen.BackgroundValue = self.BackgroundValue
                    self.WriteLineToConsole( "BackgroundValue=" + filterOpen.BackgroundValue.ToString() )
            else:
                filterOpen = itkGrayscaleMorphologicalOpeningImageFilter.New( self.Input, self.Output )
            self.AddEventHandlersToProcessObject( filterOpen )
            filterOpen.SetInput( self.Input )
            if (self.KernelRadius == None):
                self.KernelRadius = itkSize( self.Input.Dimension )
                self.KernelRadius.Fill( 1 )
            if (self.Kernel == None):
                self.Kernel = itkFlatStructuringElement.Ball( self.KernelRadius );
            self.WriteLineToConsole( "Kernel=" + self.Kernel.ToString() )
            filterOpen.Kernel = self.Kernel
            filterOpen.UpdateLargestPossibleRegion()
            filterOpen.GetOutput( self.Output )
            self.DisconnectInputAndOutput()
            self.DisposeOfObject( filterOpen )
            self.WriteOutputName()
            self.FinishedWork( True )
        except Exception, ex:
            self.HandleException( ex )
            self.FinishedWork( False )
            self.Finalise( )