Modifier and Type	Class and Description
private class	PDFunctionType0.Rinterpol Inner class do to an interpolation in the Nth dimension by comparing the content size of N-1 dimensional objects.

Modifier and Type	Field and Description
private COSArray	decode An array of 2 x n numbers specifying the linear mapping of sample values into the range appropriate for the function's output values.
private COSArray	encode An array of 2 x m numbers specifying the linear mapping of input values into the domain of the function's sample table.
private static final Log	LOG Log instance.
private int[][]	samples The samples of the function.
private COSArray	size An array of m positive integers specifying the number of samples in each input dimension of the sample table.

Access	Constructor and Description
public	PDFunctionType0(COSBase The function. function) Constructor.

Method Summary

Modifier and Type	Method 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	Returns: Number of bits for each output value. getBitsPerSample() Get the number of bits that the output value will take up.
public PDRange	Returns: The decode parameter range or null if none is set. getDecodeForParameter(int The function parameter number. paramNum) Get the decode for the input parameter.
private COSArray	Returns: the decode array. getDecodeValues() Returns all decode values as COSArray.
public PDRange	Returns: The encode parameter range or null if none is set. getEncodeForParameter(int The function parameter number. paramNum) Get the encode for the input parameter.
private COSArray	Returns: the encode array. getEncodeValues() Returns all encode values as COSArray.
public int	getFunctionType() Implements abstract org.apache.pdfbox.pdmodel.common.function.PDFunction.getFunctionType. Returns the function type.
public int	Returns: order of interpolation. getOrder() Get the order of interpolation between samples.
public COSArray	Returns: A List of java.lang.Integer objects. getSize() The "Size" entry, which is the number of samples in each input dimension of the sample table.
public void	setBitsPerSample(int The number of bits for each output value. bps) Set the number of bits that the output value will take up.
public void	setDecodeValues(COSArray The new decode values. decodeValues) This will set the decode values.
public void	setEncodeValues(COSArray The new encode values. encodeValues) This will set the encode values.

Inherited from org.apache.pdfbox.pdmodel.common.function.PDFunction:: clipToRange clipToRange create getCOSObject getDomainForInput getNumberOfInputParameters getNumberOfOutputParameters getPDStream getRangeForOutput getRangeValues interpolate setDomainValues setRangeValues toString

Field Detail

decode	back to summary
private COSArray decode An array of 2 x n numbers specifying the linear mapping of sample values into the range appropriate for the function's output values. Default value: same as the value of Range

encode	back to summary
private COSArray encode An array of 2 x m numbers specifying the linear mapping of input values into the domain of the function's sample table. Default value: [ 0 (Size0 - 1) 0 (Size1 - 1) ...].

LOG	back to summary
private static final Log LOG Log instance.

samples	back to summary
private int[][] samples The samples of the function.

size	back to summary
private COSArray size An array of m positive integers specifying the number of samples in each input dimension of the sample table.

PDFunctionType0	back to summary
public PDFunctionType0(COSBase function) Constructor. Parameters function:COSBase The function.

Method Detail

eval	back 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.

eval

back 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.

getBitsPerSample	back to summary
public int getBitsPerSample() Get the number of bits that the output value will take up. Valid values are 1,2,4,8,12,16,24,32. Returns:int Number of bits for each output value.

getBitsPerSample

back to summary

public int getBitsPerSample()

Get the number of bits that the output value will take up. Valid values are 1,2,4,8,12,16,24,32.

Returns:int: Number of bits for each output value.

getDecodeForParameter	back to summary
public PDRange getDecodeForParameter(int paramNum) Get the decode for the input parameter. Parameters paramNum:int The function parameter number. Returns:PDRange The decode parameter range or null if none is set.

getDecodeForParameter

back to summary

public PDRange getDecodeForParameter(int paramNum)

Get the decode for the input parameter.

Parameters

paramNum:int: The function parameter number.

Returns:PDRange

The decode parameter range or null if none is set.

getDecodeValues	back to summary
private COSArray getDecodeValues() Returns all decode values as COSArray. Returns:COSArray the decode array.

getDecodeValues

back to summary

private COSArray getDecodeValues()

Returns all decode values as COSArray.

Returns:COSArray: the decode array.

getEncodeForParameter	back to summary
public PDRange getEncodeForParameter(int paramNum) Get the encode for the input parameter. Parameters paramNum:int The function parameter number. Returns:PDRange The encode parameter range or null if none is set.

getEncodeForParameter

back to summary

public PDRange getEncodeForParameter(int paramNum)

Get the encode for the input parameter.

Parameters

paramNum:int: The function parameter number.

Returns:PDRange

The encode parameter range or null if none is set.

getEncodeValues	back to summary
private COSArray getEncodeValues() Returns all encode values as COSArray. Returns:COSArray the encode array.

getEncodeValues

back to summary

private COSArray getEncodeValues()

Returns all encode values as COSArray.

Returns:COSArray: the encode array.

getFunctionType	back 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

getFunctionType

back 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

getOrder	back to summary
public int getOrder() Get the order of interpolation between samples. Valid values are 1 and 3, specifying linear and cubic spline interpolation, respectively. Default is 1. See p.170 in PDF spec 1.7. Returns:int order of interpolation.

getOrder

back to summary

public int getOrder()

Get the order of interpolation between samples. Valid values are 1 and 3, specifying linear and cubic spline interpolation, respectively. Default is 1. See p.170 in PDF spec 1.7.

Returns:int: order of interpolation.

getSize	back to summary
public COSArray getSize() The "Size" entry, which is the number of samples in each input dimension of the sample table. Returns:COSArray A List of java.lang.Integer objects.

getSize

back to summary

public COSArray getSize()

The "Size" entry, which is the number of samples in each input dimension of the sample table.

Returns:COSArray: A List of java.lang.Integer objects.

setBitsPerSample	back to summary
public void setBitsPerSample(int bps) Set the number of bits that the output value will take up. Valid values are 1,2,4,8,12,16,24,32. Parameters bps:int The number of bits for each output value.

setBitsPerSample

back to summary

public void setBitsPerSample(int bps)

Set the number of bits that the output value will take up. Valid values are 1,2,4,8,12,16,24,32.

Parameters

bps:int: The number of bits for each output value.

setDecodeValues	back to summary
public void setDecodeValues(COSArray decodeValues) This will set the decode values. Parameters decodeValues:COSArray The new decode values.

setDecodeValues

back to summary

public void setDecodeValues(COSArray decodeValues)

This will set the decode values.

Parameters

decodeValues:COSArray: The new decode values.

setEncodeValues	back to summary
public void setEncodeValues(COSArray encodeValues) This will set the encode values. Parameters encodeValues:COSArray The new encode values.

setEncodeValues

back to summary

public void setEncodeValues(COSArray encodeValues)

This will set the encode values.

Parameters

encodeValues:COSArray: The new encode values.

org.apache.pdfbox.pdmodel.common.function back to summary

private Class PDFunctionType0.Rinterpol

Class Inheritance

extends Object

java.lang.Object
org.apache.pdfbox.pdmodel.common.function.PDFunctionType0.Rinterpol

Inner class do to an interpolation in the Nth dimension by comparing the content size of N-1 dimensional objects. This is done with the help of recursive calls. To understand the algorithm without recursion, here is a bilinear interpolation and here's a trilinear interpolation (external links).

Field Summary

Modifier and Type	Field and Description
private final float[]	in
private final int[]	inNext
private final int[]	inPrev
private final int	numberOfInputValues
private final int	numberOfOutputValues

Constructor Summary

Access	Constructor and Description
pack-priv	Rinterpol(float[] the input coordinates input, int[] coordinate of the "ceil" point inputPrev, int[] coordinate of the "floor" point inputNext) Constructor.

Method Summary

Modifier and Type	Method and Description
private int	Returns: index in flat array calcSampleIndex(int[] with coordinates vector) calculate array index (structure described in p.171 PDF spec 1.7) in multiple dimensions.
private int[][]	Returns: an array with all samples. getSamples() Get all sample values of this function.
private float[]	Returns: interpolated result sample rinterpol(int[] coord partially set coordinate (not set from step upwards); gets fully filled in the last call ("leaf"), where it is used to get the correct sample coord, int between 0 (first call) and dimension - 1 step) Do a linear interpolation if the two coordinates can be known, or call itself recursively twice.
pack-priv float[]	Returns: interpolated result sample rinterpolate() Calculate the interpolation.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

in	back to summary
private final float[] in

inNext	back to summary
private final int[] inNext

inPrev	back to summary
private final int[] inPrev

numberOfInputValues	back to summary
private final int numberOfInputValues

numberOfOutputValues	back to summary
private final int numberOfOutputValues

Constructor Detail

Rinterpol	back to summary
pack-priv Rinterpol(float[] input, int[] inputPrev, int[] inputNext) Constructor. Parameters input:float[] the input coordinates inputPrev:int[] coordinate of the "ceil" point inputNext:int[] coordinate of the "floor" point

Rinterpol

back to summary

pack-priv Rinterpol(float[] input, int[] inputPrev, int[] inputNext)

Constructor.

Parameters

input:float[]: the input coordinates
inputPrev:int[]: coordinate of the "ceil" point
inputNext:int[]: coordinate of the "floor" point

Method Detail

calcSampleIndex	back to summary
private int calcSampleIndex(int[] vector) calculate array index (structure described in p.171 PDF spec 1.7) in multiple dimensions. Parameters vector:int[] with coordinates Returns:int index in flat array

calcSampleIndex

back to summary

private int calcSampleIndex(int[] vector)

calculate array index (structure described in p.171 PDF spec 1.7) in multiple dimensions.

Parameters

vector:int[]: with coordinates

Returns:int

index in flat array

getSamples	back to summary
private int[][] getSamples() Get all sample values of this function. Returns:int[][] an array with all samples.

getSamples

back to summary

private int[][] getSamples()

Get all sample values of this function.

Returns:int[][]: an array with all samples.

rinterpol	back to summary
private float[] rinterpol(int[] coord, int step) Do a linear interpolation if the two coordinates can be known, or call itself recursively twice. Parameters coord:int[] coord partially set coordinate (not set from step upwards); gets fully filled in the last call ("leaf"), where it is used to get the correct sample step:int between 0 (first call) and dimension - 1 Returns:float[] interpolated result sample

rinterpol

back to summary

private float[] rinterpol(int[] coord, int step)

Do a linear interpolation if the two coordinates can be known, or call itself recursively twice.

Parameters

coord:int[]: coord partially set coordinate (not set from step upwards); gets fully filled in the last call ("leaf"), where it is used to get the correct sample
step:int: between 0 (first call) and dimension - 1

Returns:float[]

interpolated result sample

rinterpolate	back to summary
pack-priv float[] rinterpolate() Calculate the interpolation. Returns:float[] interpolated result sample

rinterpolate

back to summary

pack-priv float[] rinterpolate()

Calculate the interpolation.

Returns:float[]: interpolated result sample

public Class PDFunctionType0

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class PDFunctionType0.Rinterpol

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail