SampledFunction Class

Apitron PDF Kit help
Apitron.PDF.Kit library for .NET
This class represents a sampled function. Sampled functions use a sequence of sample values (contained in a stream) to provide an approximation for functions whose domains and ranges are bounded. The samples are organized as an m-dimensional table in which each entry has n components.
Inheritance Hierarchy


Namespace:  Apitron.PDF.Kit.FixedLayout.Resources.Functions
Assembly:  Apitron.PDF.Kit (in Apitron.PDF.Kit.dll) Version: (

public sealed class SampledFunction : Function

The SampledFunction type exposes the following members.


Public methodSampledFunction
Initializes a new instance of the SampledFunction class.

Public propertyBitsPerSample
Gets the bits per sample. The bits per sample is a number of bits that shall represent each sample. (If the function has multiple output values, each one shall occupy BitsPerSample bits.) Valid values shall be 1, 2, 4, 8, 12, 16, 24, and 32.
Public propertyCanBeExported
Gets a value indicating whether this instance can be exported.
(Inherited from Resource.)
Public propertyDecode
Gets the decode. The decode is an array of 2 × 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.
Public propertyDomain
Gets the domain. The domain is an array of 2 × m numbers, where m shall be the number of input values. For each i from 0 to m − 1, Domain2i shall be less than or equal to Domain2i+1, and the ith input value, xi, shall lie in the interval Domain2i ≤ xi ≤ Domain2i+1. Input values outside the declared domain shall be clipped to the nearest boundary value.
(Inherited from Function.)
Public propertyEncode
Gets the encode. The encode is an array of 2 × 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) …].
Public propertyFunctionType
Gets the function type.
(Overrides FunctionFunctionType.)
Public propertyOrder
Gets the interpolation order.
Public propertyRange
Gets the range. (Required for FunctionType.Sampled and FunctionType.PostScript functions, optional otherwise) An array of 2 × n numbers, where n shall be the number of output values. For each j from 0 to n − 1, Range2j shall be less than or equal to Range2j+1, and the jth output value, yj , shall lie in the interval Range2j ≤ yj ≤ Range2j+1. Output values outside the declared range shall be clipped to the nearest boundary value. If this entry is absent, no clipping shall be done.
(Inherited from Function.)
Public propertyResourceType
Gets the resource type.
(Inherited from Resource.)
Public propertySize
Gets the size. The size is an array of m positive integers that shall specify the number of samples in each input dimension of the sample table.
See Also