intarsys PDF library API

de.intarsys.pdf.pd
Class PDSampledFunction

java.lang.Object
  extended by de.intarsys.pdf.cos.COSBasedObject
      extended by de.intarsys.pdf.pd.PDObject
          extended by de.intarsys.pdf.pd.PDFunction
              extended by de.intarsys.pdf.pd.PDSampledFunction
All Implemented Interfaces:
ICOSObjectListener, IAttributeSupport

public class PDSampledFunction
extends PDFunction

Function implementation based on samples.


Nested Class Summary
static class PDSampledFunction.MetaClass
          The meta class implementation
 
Field Summary
static COSName DK_BitsPerSample
           
static COSName DK_Decode
           
static COSName DK_Encode
           
static COSName DK_Order
           
static COSName DK_Size
           
static PDSampledFunction.MetaClass META
          The meta class instance
 
Fields inherited from class de.intarsys.pdf.pd.PDFunction
DK_Domain, DK_FunctionType, DK_Range
 
Fields inherited from class de.intarsys.pdf.pd.PDObject
DK_Subtype, DK_Type
 
Method Summary
 COSArray cosGetDecode()
          Return the Decode value array.
 COSDictionary cosGetDict()
          Get the base object as a COSDictionary.
 COSArray cosGetEncode()
          Return the Encode value array
 float[] evaluate(float[] input)
          Evaluate the function for each of the input values in turn.
 int getBitsPerSample()
          Return the BitsPerSample value.
 float getDecodeMax(int dimension)
          Return the max value of the Decode array for the given dimension.
 float getDecodeMin(int dimension)
          Return the min value of the Decode array for the given dimension.
 float getEncodeMax(int dimension)
          Return the max value of the Encode array for the given dimension.
 float getEncodeMin(int dimension)
          Return the min value of the Encode array for the given dimension.
 int getOutputSize()
          Return the number of output values for one input value.
 COSArray getSize()
          Return the Size value array.
 int getSize(int dimension)
          Return the size value for the given dimension.
 
Methods inherited from class de.intarsys.pdf.pd.PDFunction
cosGetDomain, getDomainMax, getDomainMin, getInputSize, getRange, getRangeMax, getRangeMin
 
Methods inherited from class de.intarsys.pdf.pd.PDObject
cosGetFieldDescendant, cosGetFieldInheritable, cosGetFieldInherited, cosGetSubtype, cosGetType, cosRemoveFieldInheritable, cosSetFieldInheritable, cosSetSubtype, cosSetType, getDoc, getGenericChildren, getGenericParent, setGenericParent, toString
 
Methods inherited from class de.intarsys.pdf.cos.COSBasedObject
changed, cosGetArray, cosGetDoc, cosGetField, cosGetObject, cosGetStream, cosHasField, cosRemoveField, cosSetField, getAttribute, getFieldBoolean, getFieldDate, getFieldFixed, getFieldFixedArray, getFieldInt, getFieldMLString, getFieldString, invalidateCaches, removeAttribute, setAttribute, setFieldBoolean, setFieldFixed, setFieldInt, setFieldMLString, setFieldName, setFieldObject, setFieldString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DK_BitsPerSample

public static final COSName DK_BitsPerSample

DK_Decode

public static final COSName DK_Decode

DK_Encode

public static final COSName DK_Encode

DK_Order

public static final COSName DK_Order

DK_Size

public static final COSName DK_Size

META

public static final PDSampledFunction.MetaClass META
The meta class instance

Method Detail

cosGetDict

public COSDictionary cosGetDict()
Description copied from class: COSBasedObject
Get the base object as a COSDictionary.

This will throw a ClassCastException if the base type is not appropriate!

Overrides:
cosGetDict in class COSBasedObject
Returns:
Get the base object as a COSDictionary.

evaluate

public float[] evaluate(float[] input)
Evaluate the function for each of the input values in turn. The output values are stored in an array and returned.

Specified by:
evaluate in class PDFunction
Parameters:
input - input values to evaluate
Returns:
an array of output values

getBitsPerSample

public int getBitsPerSample()
Return the BitsPerSample value.

Returns:
the BitsPerSample value

cosGetDecode

public COSArray cosGetDecode()
Return the Decode value array.

Returns:
the Decode value array

getDecodeMax

public float getDecodeMax(int dimension)
Return the max value of the Decode array for the given dimension.

Parameters:
dimension - the dimension to get the max value for
Returns:
the max value of the Decode array for the given dimension

getDecodeMin

public float getDecodeMin(int dimension)
Return the min value of the Decode array for the given dimension.

Parameters:
dimension - the dimension to get the min value for
Returns:
the min value of the Decode array for the given dimension

cosGetEncode

public COSArray cosGetEncode()
Return the Encode value array

Returns:
the Encode value array

getEncodeMax

public float getEncodeMax(int dimension)
Return the max value of the Encode array for the given dimension.

Parameters:
dimension - the dimension to get the max value for
Returns:
the max value of the Encode array for the given dimension

getEncodeMin

public float getEncodeMin(int dimension)
Return the min value of the Encode array for the given dimension.

Parameters:
dimension - the dimension to get the min value for
Returns:
the min value of the Encode array for the given dimension

getOutputSize

public int getOutputSize()
Return the number of output values for one input value.

Specified by:
getOutputSize in class PDFunction
Returns:
the number of output values for one input value

getSize

public COSArray getSize()
Return the Size value array.

Returns:
the Size value array

getSize

public int getSize(int dimension)
Return the size value for the given dimension.

Parameters:
dimension - the dimension to get the size value for
Returns:
the size value for the given dimension

intarsys PDF library API

Copyright © 2006 intarsys consulting GmbH. All Rights Reserved.