View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.imaging.formats.tiff.photometricinterpreters;
18  
19  import java.io.IOException;
20  import java.util.Objects;
21  
22  import org.apache.commons.imaging.ImagingException;
23  import org.apache.commons.imaging.common.ImageBuilder;
24  
25  /**
26   * Interpreter for photometric information in TIFF images. The photometric interpretation tag is a requirement for valid TIFF images, and defines the color
27   * space of the image data.
28   *
29   * @see <a href= "https://www.awaresystems.be/imaging/tiff/tifftags/photometricinterpretation.html"> Baseline TIFF Tag PhotometricInterpretation</a>
30   */
31  public abstract class PhotometricInterpreter {
32  
33      protected final int samplesPerPixel;
34      private final int[] bitsPerSample;
35      protected final int predictor;
36      protected final int width;
37      protected final int height;
38  
39      public PhotometricInterpreter(final int samplesPerPixel, final int[] bitsPerSample, final int predictor, final int width, final int height) {
40          this.samplesPerPixel = samplesPerPixel;
41          this.bitsPerSample = Objects.requireNonNull(bitsPerSample, "bitsPerSample");
42          this.predictor = predictor;
43          this.width = width;
44          this.height = height;
45      }
46  
47      protected int getBitsPerSample(final int offset) {
48          return bitsPerSample[offset];
49      }
50  
51      public abstract void interpretPixel(ImageBuilder imageBuilder, int[] samples, int x, int y) throws ImagingException, IOException;
52  }