IDOMSampledFunction Class Reference

Interface for sampled functions. See section 3.9.1 of the PDF 1.7 Reference. Default values are as per described in that reference. More...

#include <idomfunction.h>

Inheritance diagram for IDOMSampledFunction:

Classes
class	Data
	Initialization data. More...

Public Types
enum	eInterpolationMethod
	Enum for interpolation types.
Public Types inherited from IDOMFunction
enum	eFunctionType
	An enum for the various types of functions.

Public Member Functions
virtual uint32	getTableDimension (uint32 inputNum) const =0
	Get the dimension of the sample table for a given input number.
virtual uint8	getBitsPerSample () const =0
	Get the bits per sample for the sample table.
virtual eInterpolationMethod	getInterpolationMethod () const =0
	Get the interpolation method used for sample lookup.
virtual void	getInputEncode (uint32 inputNum, float &low, float &high) const =0
	Get the input encode range for a given input to the function.
virtual void	getOutputDecode (uint32 outputNum, float &low, float &high) const =0
	Get the output range for a given input to the function.
virtual const CEDLVector< uint8 > &	getTableData () const =0
	Get a pointer to the sample table. Values in this table are stored in the same format as described by the PostScript and PDF references. The memory is owned by the instance and must not be modified or freed.
Public Member Functions inherited from IDOMFunction
virtual eFunctionType	getFunctionType () const =0
	Retrieves function type.
virtual uint32	getNumInputValues () const =0
	Get the number of input values that this function will operate on.
virtual uint32	getNumOutputValues () const =0
	Get the number of output values that this function will produce.
virtual void	getInputDomain (uint32 inputNum, float &low, float &high) const =0
	Get the input domain for a given input to the function.
virtual bool	getOutputRange (uint32 outputNum, float &low, float &high) const =0
	Get the output range for a given input to the function.
virtual void	evaluate (const float *inputValues, float *outputValues) const =0
	Evaluate the input through the function and return the result.
virtual void	evaluate (const int32 *inputValues, float *outputValues) const =0
	Evaluate the input through the function and return the result.
Public Member Functions inherited from IEDLObject
virtual const CClassID &	getClassID () const =0
	Returns class ID of IEDLObject.
virtual bool	init (CClassParams *pData)
	The init() method is called to perform any post-construction initialization of an IEDLObject that has been created by the EDL class factory, before it is actually returned by the factory.
virtual bool	clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory)
	Create a copy of EDLObject.
Public Member Functions inherited from IRCObject
virtual void	addRef () const =0
	Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
virtual bool	decRef () const =0
	Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.
virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to.
Public Member Functions inherited from IDOMHashable
virtual	~IDOMHashable ()
	Virtual destructor.
virtual bool	hash (uint64 &hash)=0
	Retrieve a hash for this object.
virtual uint64	hashE ()
	As hash(), but throws an exception if the operation fails.

Static Public Member Functions
static const CClassID &	classID ()
	Retrieves class id of IDOM.

Additional Inherited Members
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

Interface for sampled functions. See section 3.9.1 of the PDF 1.7 Reference. Default values are as per described in that reference.

Member Function Documentation

classID()

static const CClassID & IDOMSampledFunction::classID ( )

inlinestatic

Retrieves class id of IDOM.

Returns

CClassID class id of the element

getBitsPerSample()

virtual uint8 IDOMSampledFunction::getBitsPerSample ( ) const

pure virtual

Get the bits per sample for the sample table.

Returns

bitsPerSample The bits per sample

getInputEncode()

virtual void IDOMSampledFunction::getInputEncode ( uint32 inputNum, float & low, float & high ) const

pure virtual

Get the input encode range for a given input to the function.

Parameters

inputNum	The 0-indexed input number
low	A reference to receive the low encode bound for the given inputNum
high	A reference to receive the high encode bound for the given inputNum

getInterpolationMethod()

virtual eInterpolationMethod IDOMSampledFunction::getInterpolationMethod ( ) const

pure virtual

Get the interpolation method used for sample lookup.

Returns

eInterpolationMethod The interpolation method

getOutputDecode()

virtual void IDOMSampledFunction::getOutputDecode ( uint32 outputNum, float & low, float & high ) const

pure virtual

Get the output range for a given input to the function.

Parameters

outputNum	The 0-indexed output number
low	A reference to receive the low decode bound for the given outputNum
high	A reference to receive the high decode bound for the given outputNum

getTableData()

virtual const CEDLVector< uint8 > & IDOMSampledFunction::getTableData ( ) const

pure virtual

Get a pointer to the sample table. Values in this table are stored in the same format as described by the PostScript and PDF references. The memory is owned by the instance and must not be modified or freed.

Returns

CEDLVector<uint8> A reference to the table data.

getTableDimension()

virtual uint32 IDOMSampledFunction::getTableDimension ( uint32 inputNum ) const

pure virtual

Get the dimension of the sample table for a given input number.

Parameters

inputNum

The 0-indexed input number

Returns

uint32 The dimension

---

The documentation for this class was generated from the following file:

• idomfunction.h