// Catalano Imaging Library
// The Catalano Framework
//
// Copyright © Diego Catalano, 2012-2016
// diego.catalano at live.com
//
// Copyright © Andrew Kirillov, 2007-2008
// andrew.kirillov@gmail.com
//
//    This library is free software; you can redistribute it and/or
//    modify it under the terms of the GNU Lesser General Public
//    License as published by the Free Software Foundation; either
//    version 2.1 of the License, or (at your option) any later version.
//
//    This library 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
//    Lesser General Public License for more details.
//
//    You should have received a copy of the GNU Lesser General Public
//    License along with this library; if not, write to the Free Software
//    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
//

package Catalano.Imaging.Filters;

import Catalano.Imaging.FastBitmap;
import Catalano.Imaging.IApplyInPlace;

/**
 * Binary Top-hat operator from Mathematical Morphology.
 * 
 Binary Top-hat morphological operator subtracts result of morphological opening on the input image from the input image itself.
 * 
 Applied to binary image, the filter allows to get all those object (their parts) which were removed by opening filter, but never restored.
 * @author Diego Catalano
 */
public class BinaryTopHat implements IApplyInPlace{
    private int[][] kernel;
    private int radius;
    

    /**
     * Initialize a new instance of the BottomHat class.
     */
    public BinaryTopHat() {
        this.radius = 1;
    }
    
    /**
     * Initialize a new instance of the BottomHat class.
     * @param se Structuring element.
     */
    public BinaryTopHat(int[][] se) {
        this.kernel = se;
    }
    
    /**
     * Initialize a new instance of the BottomHat class.
     * @param radius Radius.
     */
    public BinaryTopHat(int radius) {
        radius = radius < 1 ? 1 : radius;
        this.radius = radius;
    }
    
    @Override
    public void applyInPlace(FastBitmap fastBitmap){
        if (radius != 0) {
            ApplyInPlace(fastBitmap, radius);
        }
        else{
            ApplyInPlace(fastBitmap, kernel);
        }
    }
    
    private void ApplyInPlace(FastBitmap fastBitmap, int radius){
        
        FastBitmap l = new FastBitmap(fastBitmap);
        
        BinaryOpening open = new BinaryOpening(radius);
        open.applyInPlace(l);
        
        Subtract sub = new Subtract(l);
        sub.applyInPlace(fastBitmap);
    }
    
    private void ApplyInPlace(FastBitmap fastBitmap, int[][] se){

        FastBitmap l = new FastBitmap(fastBitmap);
        
        BinaryOpening open = new BinaryOpening(se);
        open.applyInPlace(l);
        
        Subtract sub = new Subtract(l);
        sub.applyInPlace(fastBitmap);
    }
}