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

public Class PDFunctionTypeIdentity

extends PDFunction
Class Inheritance
Imports
java.io.IOException, org.apache.pdfbox.cos.COSArray, .COSBase
The identity function.
Author
Tilman Hausherr

Constructor Summary

AccessConstructor and Description
public
PDFunctionTypeIdentity(COSBase function)

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 int
getFunctionType()

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

Returns the function type.

protected COSArray
getRangeValues()

Overrides org.apache.pdfbox.pdmodel.common.function.PDFunction.getRangeValues.

Returns all ranges for the output values as COSArray .

public String
toString()

Overrides org.apache.pdfbox.pdmodel.common.function.PDFunction.toString.

Returns a string representation of the object.

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

Constructor Detail

PDFunctionTypeIdentityback to summary
public PDFunctionTypeIdentity(COSBase 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.
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
getRangeValuesback to summary
protected COSArray getRangeValues()

Overrides org.apache.pdfbox.pdmodel.common.function.PDFunction.getRangeValues.

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

Returns all ranges for the output values as COSArray . Required for type 0 and type 4 functions

Returns:COSArray

the ranges array.

Annotations
@Override
toStringback to summary
public String toString()

Overrides org.apache.pdfbox.pdmodel.common.function.PDFunction.toString.

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

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

Annotations
@Override