Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.common.function

public Class PDFunctionType3

extends PDFunction
Class Inheritance
Imports
org.apache.pdfbox.cos.COSArray, .COSBase, .COSName, org.apache.pdfbox.pdmodel.common.PDRange, java.io.IOException
This class represents a Type 3 (stitching) function in a PDF document.
Author
Ben Litchfield

Field Summary

Modifier and TypeField and Description
private COSArray
bounds

private float[]
boundsValues

private COSArray
encode

private COSArray
functions

private PDFunction[]
functionsArray

Constructor Summary

AccessConstructor and Description
public
PDFunctionType3(COSBase
The function .
functionStream)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public float[]
eval(float[]
The array of input values for the function. In many cases will be an array of a single value, but not always.
input)

Implements abstract org.apache.pdfbox.pdmodel.common.function.PDFunction.eval.

Evaluates the function at the given input.

public COSArray

Returns:

the bounds array.
getBounds()

Returns all bounds values as COSArray.

public COSArray

Returns:

the encode array.
getEncode()

Returns all encode values as COSArray.

private PDRange

Returns:

The encode parameter range or null if none is set.
getEncodeForParameter(int
The function parameter number.
n)

Get the encode for the input parameter.

public COSArray

Returns:

the functions array.
getFunctions()

Returns all functions values as COSArray.

public int
getFunctionType()

Implements abstract org.apache.pdfbox.pdmodel.common.function.PDFunction.getFunctionType.

Returns the function type.

Inherited from org.apache.pdfbox.pdmodel.common.function.PDFunction:
clipToRangeclipToRangecreategetCOSObjectgetDomainForInputgetNumberOfInputParametersgetNumberOfOutputParametersgetPDStreamgetRangeForOutputgetRangeValuesinterpolatesetDomainValuessetRangeValuestoString

Field Detail

boundsback to summary
private COSArray bounds
boundsValuesback to summary
private float[] boundsValues
encodeback to summary
private COSArray encode
functionsback to summary
private COSArray functions
functionsArrayback to summary
private PDFunction[] functionsArray

Constructor Detail

PDFunctionType3back to summary
public PDFunctionType3(COSBase functionStream)

Constructor.

Parameters
functionStream:COSBase

The function .

Method Detail

evalback to summary
public float[] eval(float[] input) throws IOException

Implements abstract org.apache.pdfbox.pdmodel.common.function.PDFunction.eval.

Doc from org.apache.pdfbox.pdmodel.common.function.PDFunction.eval.

Evaluates the function at the given input. ReturnValue = f(input)

Parameters
input:float[]

The array of input values for the function. In many cases will be an array of a single value, but not always.

Returns:float[]

The of outputs the function returns based on those inputs. In many cases will be an array of a single value, but not always.

Annotations
@Override
Exceptions
IOException:
if something went wrong processing the function.
getBoundsback to summary
public COSArray getBounds()

Returns all bounds values as COSArray.

Returns:COSArray

the bounds array.

getEncodeback to summary
public COSArray getEncode()

Returns all encode values as COSArray.

Returns:COSArray

the encode array.

getEncodeForParameterback to summary
private PDRange getEncodeForParameter(int n)

Get the encode for the input parameter.

Parameters
n:int

The function parameter number.

Returns:PDRange

The encode parameter range or null if none is set.

getFunctionsback to summary
public COSArray getFunctions()

Returns all functions values as COSArray.

Returns:COSArray

the functions array.

getFunctionTypeback to summary
public int getFunctionType()

Implements abstract org.apache.pdfbox.pdmodel.common.function.PDFunction.getFunctionType.

Doc from org.apache.pdfbox.pdmodel.common.function.PDFunction.getFunctionType.

Returns the function type. Possible values are: 0 - Sampled function 2 - Exponential interpolation function 3 - Stitching function 4 - PostScript calculator function

Returns:int

the function type.

Annotations
@Override