org.apache.pdfbox.pdmodel.common.function
Class PDFunctionType3

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

public class PDFunctionType3
extends PDFunction

This class represents a type 3 function in a PDF document.

Version:
$Revision: 1.2 $
Author:
Ben Litchfield

Constructor Summary
PDFunctionType3(COSBase function)
          Constructor.
 
Method Summary
 COSArray eval(COSArray input)
          Evaluates the function at the given input.
 COSArray getBounds()
          Returns all bounds values as COSArray.
 COSArray getEncode()
          Returns all encode values as COSArray.
 COSArray getFunctions()
          Returns all functions values as COSArray.
 int getFunctionType()
          Returns the function type.
 
Methods inherited from class org.apache.pdfbox.pdmodel.common.function.PDFunction
clipToRange, clipToRange, create, getCOSObject, getDictionary, getDomainForInput, getNumberOfInputParameters, getNumberOfOutputParameters, getPDStream, getRangeForOutput, getRangeValues, interpolate, setDomainValues, setRangeValues
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PDFunctionType3

public PDFunctionType3(COSBase function)
Constructor.

Parameters:
functionStream - The function .
Method Detail

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 COSArray eval(COSArray input)
              throws java.io.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:
java.io.IOException

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.