Show / Hide Table of Contents

Class Function

Although PDF is not a programming language it provides several types of function object that represent parameterized classes of functions, including mathematical formulas and sampled representations with arbitrary resolution. Functions are used in various ways in PDF, including device-dependent rasterization information for high-quality printing (halftone spot functions and transfer functions), color transform functions for certain color spaces, and specification of colors as a function of position for smooth shadings. Functions in PDF represent static, self-contained numerical transformations.

PDF::Function represents a single, flat interface around all PDF function types.

Inheritance
System.Object
Function
Implements
System.IDisposable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.MemberwiseClone()
Namespace: pdftron.PDF
Assembly: PDFNet.dll
Syntax
public class Function : IDisposable

Methods

Create(Obj)

Create a PDF::Function object from an existing SDF function dictionary.

Declaration
public static Function Create(Obj function)
Parameters
Type Name Description
Obj function

the funct_dict

Returns
Type Description
Function

newly created Function object

Dispose()

Releases all resources used by the Function

Declaration
public override sealed void Dispose()

Dispose(Boolean)

Declaration
[HandleProcessCorruptedStateExceptions]
protected virtual void Dispose(bool A_0)
Parameters
Type Name Description
System.Boolean A_0

Eval(Double[], Double[])

Evaluate the function at a given point.

Declaration
public virtual void Eval(double[] in, double[] out)
Parameters
Type Name Description
System.Double[] in

the in

System.Double[] out

the double[]

Remarks

that size of 'in' array must be greater than or equal to function input cardinality.

Exceptions
Type Condition
PDFNetException

PDFNetException the PDFNet exception

Finalize()

Allows a Function to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

Declaration
protected void Finalize()

GetInputCardinality()

Gets the input cardinality.

Declaration
public int GetInputCardinality()
Returns
Type Description
System.Int32

the number of input components required by the function

Exceptions
Type Condition
PDFNetException

PDFNetException the PDFNet exception

GetOutputCardinality()

Gets the output cardinality.

Declaration
public int GetOutputCardinality()
Returns
Type Description
System.Int32

the number of output components returned by the function

Exceptions
Type Condition
PDFNetException

PDFNetException the PDFNet exception

GetSDFObj()

Gets the SDFObj.

Declaration
public Obj GetSDFObj()
Returns
Type Description
Obj

the underlying SDF/Cos object

GetType()

Gets the type.

Declaration
public virtual Function.Type GetType()
Returns
Type Description
Function.Type

The function type

Exceptions
Type Condition
PDFNetException

PDFNetException the PDFNet exception

Implements

System.IDisposable
Back to top Generated by DocFX