001/*******************************************************************************
002 * This software is provided as a supplement to the authors' textbooks on digital
003 * image processing published by Springer-Verlag in various languages and editions.
004 * Permission to use and distribute this software is granted under the BSD 2-Clause
005 * "Simplified" License (see http://opensource.org/licenses/BSD-2-Clause).
006 * Copyright (c) 2006-2023 Wilhelm Burger, Mark J. Burge. All rights reserved.
007 * Visit https://imagingbook.com for additional details.
008 ******************************************************************************/
009package imagingbook.common.image.access;
010
011import ij.process.ByteProcessor;
012import ij.process.ImageProcessor;
013import imagingbook.common.image.OutOfBoundsStrategy;
014import imagingbook.common.image.interpolation.InterpolationMethod;
015
016/**
017 * Image accessor for scalar images with 8-bit (byte) values.
018 * 
019 * @author WB
020 * @version 2022/09/22
021 */
022public class ByteAccessor extends ScalarAccessor {
023        private final byte[] pixels;
024
025        /**
026         * Constructor. See also the factory method
027         * {@link ScalarAccessor#create(ImageProcessor, OutOfBoundsStrategy, InterpolationMethod)}.
028         *
029         * @param ip an instance of {@link ByteProcessor}
030         * @param obs the out-of-bounds strategy to be used (use {@code null} for default settings)
031         * @param ipm the interpolation method to be used (use {@code null} for default settings)
032         */
033        public ByteAccessor(ByteProcessor ip, OutOfBoundsStrategy obs, InterpolationMethod ipm) {
034                super(ip, obs, ipm);
035                this.pixels = (byte[]) this.ip.getPixels();
036        }
037
038        @Override
039        public float getVal(int u, int v) {
040                final int i = indexer.getIndex(u, v);
041                if (i < 0)
042                        return this.defaultValue;
043                else {
044                        return (0xff & pixels[i]);
045                }
046        }
047
048        @Override
049        public void setVal(int u, int v, float val) {
050                int i = indexer.getIndex(u, v);
051                if (i >= 0) {
052                        int vali = Math.round(val);
053                        if (vali < 0) vali = 0;
054                        if (vali > 255) vali = 255;
055                        pixels[i] = (byte) (0xFF & vali);
056                }
057        }
058}