|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.fop.pdf.PDFObject
org.apache.fop.pdf.PDFFunction
public class PDFFunction
class representing a PDF Function. PDF Functions represent parameterized mathematical formulas and sampled representations with arbitrary resolution. Functions are used in two areas: device-dependent rasterization information for halftoning and transfer functions, and color specification for smooth shading (a PDF 1.3 feature). All PDF Functions have a FunctionType (0,2,3, or 4), a Domain, and a Range.
Field Summary | |
---|---|
protected int |
bitsPerSample
Required for Type 0: Number of Bits used to represent each sample value. |
protected List |
bounds
Optional for Type 3: An array of (k-1) Doubles that, in combination with Domain, define the intervals to which each function from the Functions array apply. |
protected List |
cOne
Required For Type 2: An Array of n Doubles defining the function result when x=1. |
protected List |
cZero
Required For Type 2: An Array of n Doubles defining the function result when x=0. |
protected List |
decode
Optinoal for Type 0: A 2 * n array of Doubles which provides a linear mapping of sample values to the range. |
protected List |
domain
Required: 2 * m Array of Double numbers which are possible inputs to the function |
protected List |
encode
Optional for Type 0: A 2 * m array of Doubles which provides a linear mapping of input values to the domain. |
protected List |
filter
Required (?) For Type 0: A List of Strings for the various filters to be used to decode the stream. |
protected StringBuffer |
functionDataStream
Required For Type 4: Postscript Calculator function composed of arithmetic, boolean, and stack operators + boolean constants |
protected List |
functions
Required for Type 3: A List of PDFFunctions which form an array of k single input functions making up the stitching function. |
protected int |
functionType
Required: The Type of function (0,2,3,4) default is 0. |
protected double |
interpolationExponentN
Required for Type 2: The interpolation exponent. |
protected int |
order
Optional for Type 0: order of interpolation between samples. |
protected List |
range
Required: 2 * n Array of Double numbers which are possible outputs to the function |
protected List |
size
Required: Array containing the Integer size of the Domain and Range, respectively. |
Fields inherited from class org.apache.fop.pdf.PDFObject |
---|
generation, number |
Constructor Summary | |
---|---|
PDFFunction(int theNumber,
int theFunctionType,
List theDomain,
List theRange,
List theSize,
int theBitsPerSample,
int theOrder,
List theEncode,
List theDecode,
StringBuffer theFunctionDataStream,
List theFilter)
create an complete Function object of Type 0, A Sampled function. |
|
PDFFunction(int theNumber,
int theFunctionType,
List theDomain,
List theRange,
List theCZero,
List theCOne,
double theInterpolationExponentN)
create an complete Function object of Type 2, an Exponential Interpolation function. |
|
PDFFunction(int theNumber,
int theFunctionType,
List theDomain,
List theRange,
List theFunctions,
List theBounds,
List theEncode)
create an complete Function object of Type 3, a Stitching function. |
|
PDFFunction(int theNumber,
int theFunctionType,
List theDomain,
List theRange,
StringBuffer theFunctionDataStream)
create an complete Function object of Type 4, a postscript calculator function. |
Method Summary | |
---|---|
byte[] |
toPDF()
represent as PDF. |
Methods inherited from class org.apache.fop.pdf.PDFObject |
---|
getNumber, output, referencePDF |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected int functionType
protected List domain
protected List range
protected List size
protected int bitsPerSample
protected int order
protected List encode
protected List decode
protected StringBuffer functionDataStream
protected List filter
protected List cZero
protected List cOne
protected double interpolationExponentN
protected List functions
protected List bounds
Constructor Detail |
---|
public PDFFunction(int theNumber, int theFunctionType, List theDomain, List theRange, List theSize, int theBitsPerSample, int theOrder, List theEncode, List theDecode, StringBuffer theFunctionDataStream, List theFilter)
theDomain
- List objects of Double objects.
This is the domain of the function.
See page 264 of the PDF 1.3 Spec.theRange
- List objects of Double objects.
This is the Range of the function.
See page 264 of the PDF 1.3 Spec.theSize
- A List object of Integer objects.
This is the number of samples in each input dimension.
I can't imagine there being more or less than two input dimensions,
so maybe this should be an array of length 2.
See page 265 of the PDF 1.3 Spec.theBitsPerSample
- An int specifying the number of bits user to represent each sample value.
Limited to 1,2,4,8,12,16,24 or 32.
See page 265 of the 1.3 PDF Spec.theOrder
- The order of interpolation between samples. Default is 1 (one). Limited
to 1 (one) or 3, which means linear or cubic-spline interpolation.
This attribute is optional.
See page 265 in the PDF 1.3 spec.theEncode
- List objects of Double objects.
This is the linear mapping of input values intop the domain
of the function's sample table. Default is hard to represent in
ascii, but basically [0 (Size0 1) 0 (Size1 1)...].
This attribute is optional.
See page 265 in the PDF 1.3 spec.theDecode
- List objects of Double objects.
This is a linear mapping of sample values into the range.
The default is just the range.
This attribute is optional.
Read about it on page 265 of the PDF 1.3 spec.theFunctionDataStream
- The sample values that specify the function are provided in a stream.
This is optional, but is almost always used.
Page 265 of the PDF 1.3 spec has more.theFilter
- This is a List of String objects which are the various filters that
have are to be applied to the stream to make sense of it. Order matters,
so watch out.
This is not documented in the Function section of the PDF 1.3 spec,
it was deduced from samples that this is sometimes used, even if we may never
use it in FOP. It is added for completeness sake.theNumber
- The object number of this PDF object.theFunctionType
- This is the type of function (0,2,3, or 4).
It should be 0 as this is the constructor for sampled functions.public PDFFunction(int theNumber, int theFunctionType, List theDomain, List theRange, List theCZero, List theCOne, double theInterpolationExponentN)
theNumber
- the object's numbertheDomain
- List objects of Double objects.
This is the domain of the function.
See page 264 of the PDF 1.3 Spec.theRange
- List of Doubles that is the Range of the function.
See page 264 of the PDF 1.3 Spec.theCZero
- This is a List of Double objects which defines the function result
when x=0.
This attribute is optional.
It's described on page 268 of the PDF 1.3 spec.theCOne
- This is a List of Double objects which defines the function result
when x=1.
This attribute is optional.
It's described on page 268 of the PDF 1.3 spec.theInterpolationExponentN
- This is the inerpolation exponent.
This attribute is required.
PDF Spec page 268theFunctionType
- The type of the function, which should be 2.public PDFFunction(int theNumber, int theFunctionType, List theDomain, List theRange, List theFunctions, List theBounds, List theEncode)
theNumber
- the object's numbertheDomain
- List objects of Double objects.
This is the domain of the function.
See page 264 of the PDF 1.3 Spec.theRange
- List objects of Double objects.
This is the Range of the function.
See page 264 of the PDF 1.3 Spec.theFunctions
- A List of the PDFFunction objects that the stitching function stitches.
This attributed is required.
It is described on page 269 of the PDF spec.theBounds
- This is a List of Doubles representing the numbers that,
in conjunction with Domain define the intervals to which each function from
the 'functions' object applies. It must be in order of increasing magnitude,
and each must be within Domain.
It basically sets how much of the gradient each function handles.
This attributed is required.
It's described on page 269 of the PDF 1.3 spec.theEncode
- List objects of Double objects.
This is the linear mapping of input values intop the domain
of the function's sample table. Default is hard to represent in
ascii, but basically [0 (Size0 1) 0 (Size1 1)...].
This attribute is required.
See page 270 in the PDF 1.3 spec.theFunctionType
- This is the function type. It should be 3,
for a stitching function.public PDFFunction(int theNumber, int theFunctionType, List theDomain, List theRange, StringBuffer theFunctionDataStream)
theDomain
- List object of Double objects.
This is the domain of the function.
See page 264 of the PDF 1.3 Spec.theRange
- List object of Double objects.
This is the Range of the function.
See page 264 of the PDF 1.3 Spec.theFunctionDataStream
- This is a stream of arithmetic, boolean, and stack operators and boolean constants.
I end up enclosing it in the '{' and '}' braces for you, so don't do it
yourself.
This attribute is required.
It's described on page 269 of the PDF 1.3 spec.theNumber
- The object number of this PDF object.theFunctionType
- The type of function which should be 4, as this is
a Postscript calculator functionMethod Detail |
---|
public byte[] toPDF()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |