com.github.ojil.algorithm.Gray16LinComb Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ojil-core Show documentation
Open Java Imaging Library.
There is a newer version: 0.0.11
/*
 * Gray16LinComb.java
 *
 * Created on September 9, 2006, 10:25 AM
 *
 * To change this template, choose Tools | Template Manager
 * and open the template in the editor.
 *
 * Copyright 2007 by Jon A. Webb
 *     This program 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 3 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 Lesser General Public License for more details.
 *
 *    You should have received a copy of the Lesser GNU General Public License
 *    along with this program.  If not, see .
 *
 */

package com.github.ojil.algorithm;

import com.github.ojil.core.Gray16Image;
import com.github.ojil.core.Image;
import com.github.ojil.core.ImageError;
import com.github.ojil.core.Ladder;

/**
 * Forms the linear combination of two Gray16Images. Designed to be used as a
 * combining stage in a Ladder. Calculates (nA * left image + nB * right image)
 * / nC
 * 
 * @author webb
 */
public class Gray16LinComb implements Ladder.Join {
    private final int nA, nB, nC;
    
    /**
     * Creates a new instance of Gray16LinComb which will form the linear
     * combination of two images by calculating (nA * first image + nB * second
     * image) / nC.
     * 
     * @param nA
     *            the multiplier for the first image.
     * @param nB
     *            the multiplier for the second image.
     * @param nC
     *            the divisor.
     */
    public Gray16LinComb(final int nA, final int nB, final int nC) {
        this.nA = nA;
        this.nB = nB;
        this.nC = nC;
    }
    
    /**
     * Form the linear combination of two Gray16Images. Output replaces the
     * first input.
     * 
     * @param imageFirst
     *            the left-hand image image (and output)
     * @param imageSecond
     *            the right-hand image image
     * @throws ImageError
     *             if either image is not a gray 16-bit image.
     * @return the resulting Gray16Image.
     */
    @Override
    public Image doJoin(final Image imageFirst, final Image imageSecond) throws ImageError {
        if (!(imageFirst instanceof Gray16Image)) {
            throw new ImageError(ImageError.PACKAGE.ALGORITHM, AlgorithmErrorCodes.IMAGE_NOT_GRAY16IMAGE, imageFirst.toString(), null, null);
        }
        if (!(imageSecond instanceof Gray16Image)) {
            throw new ImageError(ImageError.PACKAGE.ALGORITHM, AlgorithmErrorCodes.IMAGE_NOT_GRAY16IMAGE, imageSecond.toString(), null, null);
        }
        if ((imageFirst.getWidth() != imageSecond.getWidth()) || (imageFirst.getHeight() != imageSecond.getHeight())) {
            throw new ImageError(ImageError.PACKAGE.ALGORITHM, AlgorithmErrorCodes.IMAGE_SIZES_DIFFER, imageFirst.toString(), imageSecond.toString(), null);
        }
        final Short[] dataFirst = ((Gray16Image) imageFirst).getData();
        final Short[] dataSecond = ((Gray16Image) imageSecond).getData();
        for (int i = 0; i < dataFirst.length; i++) {
            dataFirst[i] = (short) (((nA * dataFirst[i]) + (nB * dataSecond[i])) / nC);
        }
        return imageFirst;
    }
}