iText 8.0.2 API
iText.Kernel.Pdf.Function.PdfType3Function Class Reference

This class represents Pdf type 3 function that defines a stitching of the subdomains of several 1-input functions to produce a single new 1-input function. More...

Inheritance diagram for iText.Kernel.Pdf.Function.PdfType3Function:
iText.Kernel.Pdf.Function.AbstractPdfFunction< PdfDictionary >

Public Member Functions

  PdfType3Function (PdfDictionary dict)
  Instantiates a new PdfType3Function instance based on passed PdfDictionary instance. More...
 
  PdfType3Function (double[] domain, double[] range, IList< AbstractPdfFunction< PdfDictionary >> functions, double[] bounds, double[] encode)
  (see ISO-320001 Table 41). More...
 
  PdfType3Function (float[] domain, float[] range, IList< AbstractPdfFunction< PdfDictionary >> functions, float[] bounds, float[] encode)
  (see ISO-320001 Table 41). More...
 
virtual ICollection< IPdfFunction GetFunctions ()
  (Required) An array of k 1-input functions that shall make up the stitching function. More...
 
virtual void  SetFunctions (IEnumerable< AbstractPdfFunction< PdfDictionary >> value)
  (Required) An array of k 1-input functions that shall make up the stitching function. More...
 
virtual double[]  GetBounds ()
  An array of k − 1 numbers that, in combination with Domain, shall define the intervals to which each function from the Functions array shall apply. More...
 
virtual void  SetBounds (double[] value)
  (Required) An array of k − 1 numbers that, in combination with Domain, shall define the intervals to which each function from the Functions array shall apply. More...
 
virtual double[]  GetEncode ()
  An array of 2 × k numbers that, taken in pairs, shall map each subset of the domain defined by Domain and the Bounds array to the domain of the corresponding function. More...
 
virtual void  SetEncode (double[] value)
  (Required) An array of 2 × k numbers that, taken in pairs, shall map each subset of the domain defined by Domain and the Bounds array to the domain of the corresponding function. More...
 
override bool  CheckCompatibilityWithColorSpace (PdfColorSpace alternateSpace)
 
override int  GetOutputSize ()
  Gets output size of function. More...
 
override double[]  Calculate (double[] input)
  Calculates one set of input components to one set of output components. More...
 
- Public Member Functions inherited from iText.Kernel.Pdf.Function.AbstractPdfFunction< PdfDictionary >
virtual int  GetFunctionType ()
  The function type, (see ISO-320001 Table 38). More...
 
virtual bool  CheckCompatibilityWithColorSpace (PdfColorSpace alternateSpace)
  Chacks wether the output of the function matches in components with the passed by color space. More...
 
virtual int  GetInputSize ()
  The number of input components. More...
 
virtual double[]  GetDomain ()
  The valid input domain, input will be clipped to this domain contains a min max pair per input component. More...
 
virtual void  SetDomain (double[] value)
  The valid input domain, input will be clipped to this domain contains a min max pair per input component. More...
 
virtual double[]  GetRange ()
  the valid output range, output will be clipped to this range contains a min max pair per output component. More...
 
virtual void  SetRange (double[] value)
  the valid output range, output will be clipped to this range contains a min max pair per output component. More...
 
virtual byte[]  CalculateFromByteArray (byte[] bytes, int offset, int length, int wordSizeInputLength, int wordSizeOutputLength)
  Performs the calculation in bulk on a set of raw data and returns a new set of raw data. More...
 
virtual byte[]  CalculateFromByteArray (byte[] bytes, int offset, int length, int wordSizeInputLength, int wordSizeOutputLength, BaseInputOutPutConvertors.IInputConversionFunction inputConvertor, BaseInputOutPutConvertors.IOutputConversionFunction outputConvertor)
  Performs the calculation in bulk on a set of raw data and returns a new set of raw data. More...
 
virtual double[]  ClipInput (double[] input)
  Clip input values to the allowed domain. More...
 
virtual double[]  ClipOutput (double[] input)
  Clip output values to the allowed range, if there is a range. More...
 
virtual PdfObject  GetAsPdfObject ()
 

Detailed Description

This class represents Pdf type 3 function that defines a stitching of the subdomains of several 1-input functions to produce a single new 1-input function.

This class represents Pdf type 3 function that defines a stitching of the subdomains of several 1-input functions to produce a single new 1-input function.

For more info see ISO 32000-1, section 7.10.4 "Type 3 (Stitching) Functions".

Constructor & Destructor Documentation

◆ PdfType3Function() [1/3]

iText.Kernel.Pdf.Function.PdfType3Function.PdfType3Function ( PdfDictionary  dict )
inline

Instantiates a new PdfType3Function instance based on passed PdfDictionary instance.

Parameters
dict the function dictionary

◆ PdfType3Function() [2/3]

iText.Kernel.Pdf.Function.PdfType3Function.PdfType3Function ( double[]  domain,
double[]  range,
IList< AbstractPdfFunction< PdfDictionary >>  functions,
double[]  bounds,
double[]  encode 
)
inline

(see ISO-320001 Table 41).

Parameters
domain the valid input domain, input will be clipped to this domain contains a min max pair per input component
range the valid output range, oputput will be clipped to this range contains a min max pair per output component
functions The list of functions to stitch
bounds (Required) An array of k − 1 numbers that, in combination with Domain, shall define the intervals to which each function from the Functions array shall apply. Bounds elements shall be in order of increasing value, and each value shall be within the domain defined by Domain.
encode (Required) An array of 2 × k numbers that, taken in pairs, shall map each subset of the domain defined by Domain and the Bounds array to the domain of the corresponding function.

◆ PdfType3Function() [3/3]

iText.Kernel.Pdf.Function.PdfType3Function.PdfType3Function ( float[]  domain,
float[]  range,
IList< AbstractPdfFunction< PdfDictionary >>  functions,
float[]  bounds,
float[]  encode 
)
inline

(see ISO-320001 Table 41).

Parameters
domain the valid input domain, input will be clipped to this domain contains a min max pair per input component
range the valid output range, oputput will be clipped to this range contains a min max pair per output component
functions The list of functions to stitch
bounds (Required) An array of k − 1 numbers that, in combination with Domain, shall define the intervals to which each function from the Functions array shall apply. Bounds elements shall be in order of increasing value, and each value shall be within the domain defined by Domain.
encode (Required) An array of 2 × k numbers that, taken in pairs, shall map each subset of the domain defined by Domain and the Bounds array to the domain of the corresponding function.

Member Function Documentation

◆ Calculate()

override double [] iText.Kernel.Pdf.Function.PdfType3Function.Calculate ( double[]  arg1 )
inlinevirtual

Calculates one set of input components to one set of output components.

Parameters
input The input values size must contain GetInputSize() items
Returns
an array the size of GetOutputSize() items containing the result

Implements iText.Kernel.Pdf.Function.AbstractPdfFunction< PdfDictionary >.

◆ GetBounds()

virtual double [] iText.Kernel.Pdf.Function.PdfType3Function.GetBounds ( )
inlinevirtual

An array of k − 1 numbers that, in combination with Domain, shall define the intervals to which each function from the Functions array shall apply.

An array of k − 1 numbers that, in combination with Domain, shall define the intervals to which each function from the Functions array shall apply. Bounds elements shall be in order of increasing value, and each value shall be within the domain defined by Domain.

(see ISO-320001 Table 41)

Returns
the bounds

◆ GetEncode()

virtual double [] iText.Kernel.Pdf.Function.PdfType3Function.GetEncode ( )
inlinevirtual

An array of 2 × k numbers that, taken in pairs, shall map each subset of the domain defined by Domain and the Bounds array to the domain of the corresponding function.

An array of 2 × k numbers that, taken in pairs, shall map each subset of the domain defined by Domain and the Bounds array to the domain of the corresponding function.

(see ISO-320001 Table 41)

Returns
the encode values

◆ GetFunctions()

virtual ICollection<IPdfFunction> iText.Kernel.Pdf.Function.PdfType3Function.GetFunctions ( )
inlinevirtual

(Required) An array of k 1-input functions that shall make up the stitching function.

(Required) An array of k 1-input functions that shall make up the stitching function. The output dimensionality of all functions shall be the same, and compatible with the value of Range if Range is present.

(see ISO-320001 Table 41)

Returns
the list of functions

◆ GetOutputSize()

override int iText.Kernel.Pdf.Function.PdfType3Function.GetOutputSize ( )
inlinevirtual

Gets output size of function.

Gets output size of function.

If Range field is absent, the output size of functions will be returned.

Returns
output size of function

Reimplemented from iText.Kernel.Pdf.Function.AbstractPdfFunction< PdfDictionary >.

◆ SetBounds()

virtual void iText.Kernel.Pdf.Function.PdfType3Function.SetBounds ( double[]  value )
inlinevirtual

(Required) An array of k − 1 numbers that, in combination with Domain, shall define the intervals to which each function from the Functions array shall apply.

(Required) An array of k − 1 numbers that, in combination with Domain, shall define the intervals to which each function from the Functions array shall apply. Bounds elements shall be in order of increasing value, and each value shall be within the domain defined by Domain.

(see ISO-320001 Table 41)

Parameters
value the new set of bounds

◆ SetEncode()

virtual void iText.Kernel.Pdf.Function.PdfType3Function.SetEncode ( double[]  value )
inlinevirtual

(Required) An array of 2 × k numbers that, taken in pairs, shall map each subset of the domain defined by Domain and the Bounds array to the domain of the corresponding function.

(Required) An array of 2 × k numbers that, taken in pairs, shall map each subset of the domain defined by Domain and the Bounds array to the domain of the corresponding function.

(see ISO-320001 Table 41)

Parameters
value the new set of encodings

◆ SetFunctions()

virtual void iText.Kernel.Pdf.Function.PdfType3Function.SetFunctions ( IEnumerable< AbstractPdfFunction< PdfDictionary >>  value )
inlinevirtual

(Required) An array of k 1-input functions that shall make up the stitching function.

(Required) An array of k 1-input functions that shall make up the stitching function. The output dimensionality of all functions shall be the same, and compatible with the value of Range if Range is present.

(see ISO-320001 Table 41)

Parameters
value the list of functions