Class PDFunctionType3

java.lang.Object
org.apache.pdfbox.pdmodel.common.function.PDFunction
org.apache.pdfbox.pdmodel.common.function.PDFunctionType3
All Implemented Interfaces:
COSObjectable

public class PDFunctionType3 extends PDFunction
This class represents a Type 3 (stitching) function in a PDF document.
  • Field Details

    • functions

      private COSArray functions
    • encode

      private COSArray encode
    • bounds

      private COSArray bounds
    • functionsArray

      private PDFunction[] functionsArray
    • boundsValues

      private float[] boundsValues
  • Constructor Details

    • PDFunctionType3

      public PDFunctionType3(COSBase functionStream)
      Constructor.
      Parameters:
      functionStream - The function .
  • Method Details

    • getFunctionType

      public int getFunctionType()
      Returns the function type. Possible values are: 0 - Sampled function 2 - Exponential interpolation function 3 - Stitching function 4 - PostScript calculator function
      Specified by:
      getFunctionType in class PDFunction
      Returns:
      the function type.
    • eval

      public float[] eval(float[] input) throws IOException
      Evaluates the function at the given input. ReturnValue = f(input)
      Specified by:
      eval in class PDFunction
      Parameters:
      input - The array of input values for the function. In many cases will be an array of a single value, but not always.
      Returns:
      The of outputs the function returns based on those inputs. In many cases will be an array of a single value, but not always.
      Throws:
      IOException - if something went wrong processing the function.
    • getFunctions

      public COSArray getFunctions()
      Returns all functions values as COSArray.
      Returns:
      the functions array.
    • getBounds

      public COSArray getBounds()
      Returns all bounds values as COSArray.
      Returns:
      the bounds array.
    • getEncode

      public COSArray getEncode()
      Returns all encode values as COSArray.
      Returns:
      the encode array.
    • getEncodeForParameter

      private PDRange getEncodeForParameter(int n)
      Get the encode for the input parameter.
      Parameters:
      n - The function parameter number.
      Returns:
      The encode parameter range or null if none is set.