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 Summary
Fields Modifier and Type Field Description private COSArray
bounds
private float[]
boundsValues
private COSArray
encode
private COSArray
functions
private PDFunction[]
functionsArray
-
Constructor Summary
Constructors Constructor Description PDFunctionType3(COSBase functionStream)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description float[]
eval(float[] input)
Evaluates the function at the given input.COSArray
getBounds()
Returns all bounds values as COSArray.COSArray
getEncode()
Returns all encode values as COSArray.private PDRange
getEncodeForParameter(int n)
Get the encode for the input parameter.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, eval, getCOSObject, getDomainForInput, getNumberOfInputParameters, getNumberOfOutputParameters, getPDStream, getRangeForOutput, getRangeValues, interpolate, setDomainValues, setRangeValues, toString
-
-
-
-
Field Detail
-
functions
private COSArray functions
-
encode
private COSArray encode
-
bounds
private COSArray bounds
-
functionsArray
private PDFunction[] functionsArray
-
boundsValues
private float[] boundsValues
-
-
Constructor Detail
-
PDFunctionType3
public PDFunctionType3(COSBase functionStream)
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 classPDFunction
- Returns:
- the function type.
-
eval
public float[] eval(float[] input) throws java.io.IOException
Evaluates the function at the given input. ReturnValue = f(input)- Specified by:
eval
in classPDFunction
- 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
- 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.
-
-