Application: gvSIG desktop

/* gvSIG. Desktop Geographic Information System.

 *

 * Copyright ? 2007-2017 gvSIG Association

 *

 * This program 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 2

 * of the License, or (at your option) any later version.

 *

 * This program 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 this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.raster.lib.legend.impl.operations.equalization;

import java.util.ArrayList;

import java.util.Iterator;

import java.util.List;

import org.gvsig.fmap.geom.exception.CreateEnvelopeException;

import org.gvsig.raster.lib.buffer.api.Band;

import org.gvsig.raster.lib.buffer.api.BufferLocator;

import org.gvsig.raster.lib.buffer.api.BufferManager;

import org.gvsig.raster.lib.buffer.api.NoData;

import org.gvsig.raster.lib.buffer.api.exceptions.BandException;

import org.gvsig.raster.lib.buffer.api.exceptions.BufferException;

import org.gvsig.raster.lib.buffer.api.exceptions.BufferOperationException;

import org.gvsig.raster.lib.buffer.api.operations.OperationFactory;

import org.gvsig.raster.lib.buffer.api.statistics.HistogramBand;

import org.gvsig.raster.lib.buffer.api.statistics.Statistics;

import org.gvsig.raster.lib.buffer.spi.exceptions.ProcessingOperationException;

import org.gvsig.raster.lib.legend.api.RasterLegendLocator;

import org.gvsig.raster.lib.legend.api.RasterLegendManager;

import org.gvsig.raster.lib.legend.api.colorinterpretation.ColorInterpretation;

import org.gvsig.raster.lib.legend.spi.AbstractColoredOperation;

import org.gvsig.tools.locator.LocatorException;

/**

 * @author fdiaz

 *

 */

public class EqualizationOperation extends AbstractColoredOperation{

    static public String STATISTICS_PARAM = "statistics";

    private Statistics statistics;

    private List<Integer> bandsToProcess;

    private RowProcessor[] rowProcessors;

    private HistogramBand[] histogramBands;

    private Integer dataType;

    private long[][] lahe;

    private long[][] laheNegative;

    private int nElements;

    /**

     * @param factory

     *

     */

    public EqualizationOperation(OperationFactory factory) {

        super(factory);

    }

    @Override

    public void preProcess() throws BufferOperationException {

        super.preProcess();

        BufferManager manager = BufferLocator.getBufferManager();

        RasterLegendManager legendManager = RasterLegendLocator.getRasterLegendManager();

        statistics = (Statistics) this.getParameter(STATISTICS_PARAM,null);

        if (statistics==null) {

            statistics = this.getInputBuffer().getStatistics(null);

        }

        histogramBands = statistics.getHistogram();

        int bands = this.getInputBuffer().getBandCount();

        NoData[] noData = this.getInputBuffer().getBandNoData();

        if (mustCopyUnprocessedBands()) {

            this.setParameter(OUTPUT_COLOR_INTERPRETATION_PARAM, getInputColorInterpretation());

            noData = this.getInputBuffer().getBandNoData();

            try {

                this.setOutputBuffer(

                    manager.createBuffer(

                            this.getInputBuffer().getRows(), 

                            this.getInputBuffer().getColumns(), 

                            this.getInputBuffer().getBandTypes(),

                            this.getInputBuffer().getBandNoData(), 

                            this.getInputBuffer().getProjection(), 

                            this.getInputBuffer().getEnvelope()));

            } catch (LocatorException | BufferException | CreateEnvelopeException e) {

                throw new ProcessingOperationException(e);

            }

        } else {

            List<String> colorInterpretations = new ArrayList<>();

            List<NoData> noDatas = new ArrayList<>();

            List<Integer> types = new ArrayList<>();

            for (int band = 0; band < bands; band++) {

                if (isProcessableBand(band)) {

                    colorInterpretations.add(getInputColorInterpretation().get(band));

                    noDatas.add(this.getInputBuffer().getBandNoData()[band]);

                    types.add(this.getInputBuffer().getBandTypes()[band]);

                }

            }

            if (getInputColorInterpretation().hasAlphaBand()) {

                colorInterpretations.add(ColorInterpretation.ALPHA_BAND);

            }

            setOutputColorInterpretation(

                    legendManager.createColorInterpretation(colorInterpretations));

            this.setParameter(OUTPUT_COLOR_INTERPRETATION_PARAM, getOutputColorInterpretation());

            try {

                this.setOutputBuffer(

                    manager.createBuffer(

                            this.getInputBuffer().getRows(), 

                            this.getInputBuffer().getColumns(), 

                            this.getTypesAsArray(types),

                            this.getNoDatasAsArray(noDatas), 

                            this.getInputBuffer().getProjection(), 

                            this.getInputBuffer().getEnvelope()));

            } catch (Exception e) {

                throw new ProcessingOperationException(e);

            }

        }

        rowProcessors = new RowProcessor[bands];

        dataType = null;

        if(getBandsToProcess().isEmpty()){

            throw new ProcessingOperationException("There is no RGB band.", null);

        }

        for (Iterator<Integer> iterator = getBandsToProcess().iterator(); iterator.hasNext();) {

            Integer band = iterator.next();

            int bandType = this.getInputBuffer().getBand(band).getDataType();

            if(dataType!=null) {

                if(dataType!=bandType){

                    throw new IllegalArgumentException("All bands must be of same data type.");

                }

            } else {

                dataType=bandType;

            }

            switch (bandType) {

            case BufferManager.TYPE_BYTE:

                rowProcessors[band] = new ByteRowProcessor(band);

                break;

            case BufferManager.TYPE_USHORT:

                rowProcessors[band] = new UShortRowProcessor(band);

                break;

            case BufferManager.TYPE_SHORT:

                rowProcessors[band] = new ShortRowProcessor(band);

                break;

            case BufferManager.TYPE_INT:

                rowProcessors[band] = new IntRowProcessor(band);

                break;

            case BufferManager.TYPE_FLOAT: //Can't process float band

                rowProcessors[band] = null; //new FloatRowProcessor(band);

                break;

            case BufferManager.TYPE_DOUBLE: //Can't process double band

                rowProcessors[band] = null; //new DoubleRowProcessor(band);

                break;

            default:

                throw new IllegalArgumentException("Can't process type of band '" + band + "'");

            }

        }

        double[][] accumNormalize = convertTableToNormalizeAccumulate(getHistogramTable());

        double[][] accumNormalizeNeg = convertTableToNormalizeAccumulate(getNegativeHistogramTable());

        int maxValue = 255;

        switch (dataType) {

        case BufferManager.TYPE_BYTE:

            maxValue = 255;

            break;

        case BufferManager.TYPE_SHORT:

            maxValue = Short.MAX_VALUE;

            break;

        case BufferManager.TYPE_USHORT:

            maxValue = Math.abs(Short.MIN_VALUE) + Short.MAX_VALUE;

            break;

        case BufferManager.TYPE_INT:

            maxValue = Integer.MAX_VALUE;

            break;

        default:

            throw new IllegalArgumentException("Can't process type '" + dataType + "'");

        }

        lahe = lahe(accumNormalize, maxValue);

        laheNegative = lahe(accumNormalizeNeg, maxValue);

        nElements = (laheNegative[0].length - 1); //FIXME: ???

    }

    /**

     * Obtiene la tabla completa del histograma

     * @return long[][]

     */

    private long[][] getHistogramTable() {

        int size;

        int rangeMin;

        int rangeMax;

        switch (dataType) {

        case BufferManager.TYPE_BYTE:

            rangeMin = 0;

            rangeMax = 255;

            size = 256;

            break;

        case BufferManager.TYPE_SHORT:

            rangeMin = Short.MIN_VALUE;

            rangeMax = Short.MAX_VALUE;

            size = rangeMax-rangeMin+1;

            break;

        case BufferManager.TYPE_USHORT:

            rangeMin = 0;

            rangeMax = Math.abs(Short.MIN_VALUE) + Short.MAX_VALUE;

            size = rangeMax-rangeMin+1;

            break;

        case BufferManager.TYPE_INT:

            rangeMin = Integer.MIN_VALUE;

            rangeMax = Integer.MAX_VALUE;

            size = rangeMax-rangeMin+1;

            break;

        default:

            throw new IllegalArgumentException("Can't process type '" + dataType + "'");

        }

        long[][] table = new long[getBandsToProcess().size()][size];

        for (int i = 0; i < table.length; i++) {

            System.arraycopy(histogramBands[getBandsToProcess().get(i)].getFrequencies(), 0, table[i], 0, size);

        }

        return table;

    }

    /**

     * Obtiene el histograma de la imagen negativa.

     * @return long[][]

     */

    private long[][] getNegativeHistogramTable() {

        long[][] table = getHistogramTable();

        long[][] tableNeg = new long[table.length][table[0].length];

        for (int i = 0; i < tableNeg.length; i++){

            for (int j = 0; j < tableNeg[i].length; j++){

                tableNeg[i][table[i].length - j - 1] = table[i][j];

            }

        }

        return tableNeg;

    }

    /**

     * Obtiene la tabla de valores normalizada. Divide todos los elementos por el n?mero de

     * pixeles total.

     * @return tabla de valores normalizada

     */

    private static double[][] convertToNormalizeHistogram(long[][] tableToConvert) {

        long[] nValues = new long[tableToConvert.length];

        for (int i = 0; i < tableToConvert.length; i++) {

            for (int j = 0; j < tableToConvert[i].length; j++) {

                nValues[i] += tableToConvert[i][j];

            }

        }

        double[][] res = new double[tableToConvert.length][tableToConvert[0].length];

        for (int i = 0; i < tableToConvert.length; i++) {

            for (int j = 0; j < tableToConvert[i].length; j++) {

                res[i][j] = (double)((double)tableToConvert[i][j] / (double)nValues[i]);

            }

        }

        return res;

    }

    /**

     * Obtiene la tabla de valores normalizada y acumulada. Divide todos los elementos por el n?mero de

     * pixeles total.

     * @return tabla de valores normalizada

     */

    private static double[][] convertTableToNormalizeAccumulate(long[][] tableToConvert) {

        double[][] res = convertToNormalizeHistogram(tableToConvert);

        for (int i = 0; i < tableToConvert.length; i++) {

            for (int j = 0; j < tableToConvert[i].length; j++) {

                if(j > 0) {

                    res[i][j] += res[i][j - 1];

                }

            }

        }

        return res;

    }

    @Override

    public void process() throws ProcessingOperationException {

        super.process();

        for (int band=0; band<this.getInputBuffer().getBandCount(); band++){

            if (getBandsToProcess().contains(band)) {

                Band bufferBand = this.getInputBuffer().getBand(band);

                Band outputBufferBand = this.getOutputBuffer().getBand(band);

                for (int row = 0; row < this.getInputBuffer().getRows(); row++) {

                    Object rowBuffer = bufferBand.createRowBuffer();

                    bufferBand.fetchRow(row, rowBuffer);

                    Object outputRowBuffer = outputBufferBand.createRowBuffer();

                    outputBufferBand.fetchRow(row, outputRowBuffer);

                    rowProcessors[band].processRow(rowBuffer, outputRowBuffer);

                    outputBufferBand.putRow(row, outputRowBuffer);

                }

            } else {

                try {

                    this.getOutputBuffer().getBand(band).copyFrom(this.getInputBuffer().getBand(band));

                } catch (BandException e) {

                    throw new ProcessingOperationException(e);

                }

            }

        }

    }

    @Override

    public void postProcess() throws BufferOperationException {

        super.postProcess();

    }

    /**

     * M?todo lahe para la ecualizaci?n. Cada posici?n del array resultante tendr? el valor de salida para

     * un valor de entrada dado.

     * @param accumNorm Histograma acumulado

     * @param value Valor m?ximo

     * @return

     */

    private long[][] lahe(double[][] accumNorm, int value) {

        long[][] res = new long[accumNorm.length][accumNorm[0].length];

        for (int i = 0; i < res.length; i++){

              for (int j = 0; j < res[i].length; j++){

                  res[i][j] = Math.round(accumNorm[i][j] * value);

              }

        }

        return res;

    }

    /**

     * @param band

     * @return

     */

    private List<Integer> getBandsToProcess() {

        if(bandsToProcess == null){

            int bands = this.getInputBuffer().getBandCount();

            bandsToProcess = new ArrayList<>();

            for (int band = 0; band < bands; band++) {

                if (isProcessableBand(band)) {

                    bandsToProcess.add(band);

                }

            }

        }

        return bandsToProcess;

    }

    /**

     * @param band

     * @return

     */

    @Override

    protected boolean isProcessableBand(int band) {

        return isRGBBand(band) && (this.getInputBuffer().getBandTypes()[band] == BufferManager.TYPE_BYTE

            || this.getInputBuffer().getBandTypes()[band] == BufferManager.TYPE_SHORT

            || this.getInputBuffer().getBandTypes()[band] == BufferManager.TYPE_USHORT

            || this.getInputBuffer().getBandTypes()[band] == BufferManager.TYPE_INT

        );

    }

    private boolean isRGBBand(int band) {

        String bandColorInterpretation = getInputColorInterpretation().get(band);

        return (bandColorInterpretation.equals(ColorInterpretation.RED_BAND) ||

            bandColorInterpretation.equals(ColorInterpretation.GREEN_BAND) ||

            bandColorInterpretation.equals(ColorInterpretation.BLUE_BAND));

    }

    interface RowProcessor {

        void processRow(Object inputRow, Object outputRow);

        Number processValue(Object value);

    };

    private abstract class AbstractRowProcessor implements RowProcessor {

        protected int band;

        protected HistogramBand histogram;

        protected NoData noData;

        public AbstractRowProcessor(int band) {

            this.band = band;

            this.histogram = statistics.getHistogram()[this.band];

            this.noData = getInputBuffer().getBand(this.band).getNoData();

        }

    }

    private class ByteRowProcessor extends AbstractRowProcessor {

        public ByteRowProcessor(int band) {

            super(band);

        }

        @Override

        public void processRow(Object inputRow, Object outputRow) {

            byte[] inputByteRow = (byte[])inputRow;

            byte[] outputByteRow = (byte[])outputRow;

            for (int i = 0; i < inputByteRow.length; i++) {

                outputByteRow[i] = processValue(inputByteRow[i]).byteValue();

            }

        }

        @Override

        public Number processValue(Object value) {

            if(noData.isDefined() && noData.getValue().equals(value)){

                return (byte)value;

            }

            //M?todo lahe

            int intValue = 0xFF & ((Byte) value);

            int equalizationPositive = (int)lahe[getBandsToProcess().indexOf(band)][intValue % (int)histogram.getNumValues()];

            int equalizationNegative = (int)laheNegative[getBandsToProcess().indexOf(band)][nElements - (intValue % (int)histogram.getNumValues())];

            int resValue = ((nElements - equalizationNegative) + equalizationPositive) / 2;

            return (byte)(resValue & 0x000000ff);

        }

    }

    private class ShortRowProcessor extends AbstractRowProcessor {

        public ShortRowProcessor(int band) {

            super(band);

        }

        @Override

        public void processRow(Object inputRow, Object outputRow) {

            short[] inputByteRow = (short[])inputRow;

            short[] outputByteRow = (short[])outputRow;

            for (int i = 0; i < inputByteRow.length; i++) {

                outputByteRow[i] = processValue(inputByteRow[i]).shortValue();

            }

        }

        @Override

        public Number processValue(Object value) {

            if(noData.isDefined() && noData.getValue().equals(value)){

                return (byte)0;

            }

            //M?todo lahe

            int intValue = ((Short) value).byteValue();

            int equalizationPositive = (int)lahe[getBandsToProcess().indexOf(band)][intValue % (int)histogram.getNumValues()];

            int equalizationNegative = (int)laheNegative[getBandsToProcess().indexOf(band)][nElements - (intValue % (int)histogram.getNumValues())];

            int resValue = ((nElements - equalizationNegative) + equalizationPositive) / 2;

            return (short)resValue;

        }

    }

    private class UShortRowProcessor extends AbstractRowProcessor {

        public UShortRowProcessor(int band) {

            super(band);

        }

        @Override

        public void processRow(Object inputRow, Object outputRow) {

            short[] inputByteRow = (short[])inputRow;

            short[] outputByteRow = (short[])outputRow;

            for (int i = 0; i < inputByteRow.length; i++) {

                outputByteRow[i] = processValue(inputByteRow[i]).shortValue();

            }

        }

        @Override

        public Number processValue(Object value) {

            if(noData.isDefined() && noData.getValue().equals(value)){

                return (byte)0;

            }

            //M?todo lahe

            int intValue = 0xFFFF & ((Short) value).byteValue();

            int equalizationPositive = (int)lahe[getBandsToProcess().indexOf(band)][intValue % (int)histogram.getNumValues()];

            int equalizationNegative = (int)laheNegative[getBandsToProcess().indexOf(band)][nElements - (intValue % (int)histogram.getNumValues())];

            int resValue = ((nElements - equalizationNegative) + equalizationPositive) / 2;

            return (short)resValue;

        }

    }

    private class IntRowProcessor extends AbstractRowProcessor {

        public IntRowProcessor(int band) {

            super(band);

        }

        @Override

        public void processRow(Object inputRow, Object outputRow) {

            int[] inputByteRow = (int[])inputRow;

            int[] outputByteRow = (int[])outputRow;

            for (int i = 0; i < inputByteRow.length; i++) {

                outputByteRow[i] = processValue(inputByteRow[i]).intValue();

            }

        }

        @Override

        public Number processValue(Object value) {

            if(noData.isDefined() && noData.getValue().equals(value)){

                return (byte)0;

            }

            Double dValue = ((Number) value).doubleValue();

            //M?todo lahe

            int intValue = ((Integer) value);

            int equalizationPositive = (int)lahe[getBandsToProcess().indexOf(band)][intValue % (int)histogram.getNumValues()];

            int equalizationNegative = (int)laheNegative[getBandsToProcess().indexOf(band)][nElements - (intValue % (int)histogram.getNumValues())];

            int resValue = ((nElements - equalizationNegative) + equalizationPositive) / 2;

            return (int)resValue;

        }

    }

}