Class PDFunctionType2
java.lang.Object
org.apache.pdfbox.pdmodel.common.function.PDFunction
org.apache.pdfbox.pdmodel.common.function.PDFunctionType2
- All Implemented Interfaces:
COSObjectable
This class represents a Type 2 (exponential interpolation) function in a PDF
document.
- Author:
- Ben Litchfield
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfloat[]
eval
(float[] input) Performs exponential interpolation Evaluates the function at the given input.getC0()
Returns the C0 values of the function, 0 if empty.getC1()
Returns the C1 values of the function, 1 if empty.int
Returns the function type.float
getN()
Returns the exponent of the function.toString()
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
-
Constructor Details
-
PDFunctionType2
Constructor.- Parameters:
function
- 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 classPDFunction
- Returns:
- the function type.
-
eval
Performs exponential interpolation 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:
IOException
- if something went wrong processing the function.
-
getC0
Returns the C0 values of the function, 0 if empty.- Returns:
- a COSArray with the C0 values
-
getC1
Returns the C1 values of the function, 1 if empty.- Returns:
- a COSArray with the C1 values
-
getN
public float getN()Returns the exponent of the function.- Returns:
- the float value of the exponent
-
toString
- Overrides:
toString
in classPDFunction
-