Package openalea :: Package plantgl :: Package scenegraph :: Module _pglsg :: Class QuantisedFunction

Class QuantisedFunction

 object --+    
          |    
??.instance --+
              |
             QuantisedFunction

A 2D quantised injective function (homomorphism) defined on the range [firstx,lastx].

Instance Methods

__call__(...)
__call__( (QuantisedFunction)arg1, (float)x) -> float :

__init__(...)
__init__( (object)arg1, (Curve2D)curve [, (int)sampling]) -> None : QuantisedFunction(curve[,sampling,clamped]) : Quantised 2D function.

__reduce__(...)
helper for pickle

build(...)
build( (QuantisedFunction)arg1, (Curve2D)curve, (int)sampling) -> bool :

findX(...)
findX( (QuantisedFunction)arg1, (float)y) -> object :

getValue(...)
getValue( (QuantisedFunction)arg1, (float)x) -> float :

inverse(...)
inverse( (QuantisedFunction)arg1) -> QuantisedFunction :

isClampedToDefault(...)
isClampedToDefault( (QuantisedFunction)arg1) -> bool :

isDecreasing(...)
isDecreasing( (QuantisedFunction)arg1 [, (bool)arg2]) -> bool :

isIncreasing(...)
isIncreasing( (QuantisedFunction)arg1 [, (bool)arg2]) -> bool :

isMonotonous(...)
isMonotonous( (QuantisedFunction)arg1 [, (bool)arg2]) -> bool :

isValid(...)
isValid( (QuantisedFunction)arg1) -> bool :

Inherited from unreachable.instance: __new__

Inherited from object: __delattr__, __getattribute__, __hash__, __reduce_ex__, __repr__, __setattr__, __str__

Static Methods

checkQuantisableFunction(...)
checkQuantisableFunction( (Curve2D)arg1) -> bool :

Class Variables
	__instance_size__ = `12`

Properties
	DEFAULT_CLAMPED
	clamped
	firstx
	lastx
	sampling
Inherited from `object`: `__class__`

Method Details

call(...)
(Call operator)


__call__( (QuantisedFunction)arg1, (float)x) -> float :

    C++ signature :
        double __call__(class PGL::QuantisedFunction *,double)

init(...)
(Constructor)


__init__( (object)arg1, (Curve2D)curve [, (int)sampling]) -> None :
    QuantisedFunction(curve[,sampling,clamped]) : Quantised 2D function.
    If clamped parameter is set to False, if a x value is out of range, first or last value is returned.
    Otherwise an exception is raised.

    C++ signature :
        void __init__(struct _object *,class TOOLS::RefCountPtr<class PGL::Curve2D> [,unsigned int])

__init__( (object)arg1, (Point2Array)points [, (int)sampling]) -> None :
    Function(points [,sampling])

    C++ signature :
        void __init__(struct _object *,class TOOLS::RefCountPtr<class PGL::Point2Array> [,unsigned int])

Overrides: object.__init__

reduce(...)

helper for pickle

Overrides: object.__reduce__: (inherited documentation)

build(...)


build( (QuantisedFunction)arg1, (Curve2D)curve, (int)sampling) -> bool :

    C++ signature :
        bool build(class PGL::QuantisedFunction {lvalue},class TOOLS::RefCountPtr<class PGL::Curve2D>,unsigned int)

build( (QuantisedFunction)arg1, (Curve2D)arg2) -> bool :

    C++ signature :
        bool build(class PGL::QuantisedFunction {lvalue},class TOOLS::RefCountPtr<class PGL::Curve2D>)

checkQuantisableFunction(...)
Static Method


checkQuantisableFunction( (Curve2D)arg1) -> bool :

    C++ signature :
        bool checkQuantisableFunction(class TOOLS::RefCountPtr<class PGL::Curve2D>)

findX(...)


findX( (QuantisedFunction)arg1, (float)y) -> object :

    C++ signature :
        class boost::python::api::object findX(class PGL::QuantisedFunction *,double)

findX( (QuantisedFunction)arg1, (float)y, (float)startingX) -> object :
    findX(y[,startingX]) : find the first x value such as f(x) = y.

    C++ signature :
        class boost::python::api::object findX(class PGL::QuantisedFunction *,double,double)

getValue(...)


getValue( (QuantisedFunction)arg1, (float)x) -> float :

    C++ signature :
        double getValue(class PGL::QuantisedFunction *,double)

inverse(...)


inverse( (QuantisedFunction)arg1) -> QuantisedFunction :

    C++ signature :
        class TOOLS::RefCountPtr<class PGL::QuantisedFunction> inverse(class PGL::QuantisedFunction {lvalue})

isClampedToDefault(...)


isClampedToDefault( (QuantisedFunction)arg1) -> bool :

    C++ signature :
        bool isClampedToDefault(class PGL::QuantisedFunction {lvalue})

isDecreasing(...)


isDecreasing( (QuantisedFunction)arg1 [, (bool)arg2]) -> bool :

    C++ signature :
        bool isDecreasing(class PGL::QuantisedFunction {lvalue} [,bool])

isIncreasing(...)


isIncreasing( (QuantisedFunction)arg1 [, (bool)arg2]) -> bool :

    C++ signature :
        bool isIncreasing(class PGL::QuantisedFunction {lvalue} [,bool])

isMonotonous(...)


isMonotonous( (QuantisedFunction)arg1 [, (bool)arg2]) -> bool :

    C++ signature :
        bool isMonotonous(class PGL::QuantisedFunction {lvalue} [,bool])

isValid(...)


isValid( (QuantisedFunction)arg1) -> bool :

    C++ signature :
        bool isValid(class PGL::QuantisedFunction {lvalue})

Property Details

DEFAULT_CLAMPED

Get Method:: unreachable(...)

clamped

Get Method:: unreachable(...)
Set Method:: unreachable(...)

firstx

Get Method:: unreachable(...)

lastx

Get Method:: unreachable(...)

sampling

Get Method:: unreachable(...)