CDPL.Shape.GaussianShapeOverlapFunction Class Reference

Inheritance diagram for CDPL.Shape.GaussianShapeOverlapFunction:

Public Member Functions
None	__init__ ()
	Initializes the GaussianShapeOverlapFunction instance.
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
None	setShapeFunction (GaussianShapeFunction func, bool is_ref)
GaussianShapeFunction	getShapeFunction (bool ref)
None	setColorMatchFunction (Pharm.BoolSizeType2Functor func)
Pharm.BoolSizeType2Functor	getColorMatchFunction ()
None	setColorFilterFunction (BoolSizeTypeFunctor func)
BoolSizeTypeFunctor	getColorFilterFunction ()
float	calcSelfOverlap (bool ref)
float	calcColorSelfOverlap (bool ref)
float	calcOverlap ()
float	calcOverlap (Math.Vector3DArray coords)
float	calcColorOverlap ()
float	calcColorOverlap (Math.Vector3DArray coords)
float	calcOverlapGradient (Math.Vector3DArray coords, Math.Vector3DArray grad)

Properties
	objectID = property(getObjectID)
	colorMatchFunction = property(getColorMatchFunction, setColorMatchFunction)
	colorFilterFunction = property(getColorFilterFunction, setColorFilterFunction)

Member Function Documentation

getObjectID()

int CDPL.Shape.GaussianShapeOverlapFunction.getObjectID

(

)

Returns the numeric identifier (ID) of the wrapped C++ class instance.

Different Python GaussianShapeOverlapFunction instances may reference the same underlying C++ class instance. The commonly used Python expression a is not b thus cannot tell reliably whether the two GaussianShapeOverlapFunction instances a and b reference different C++ objects. The numeric identifier returned by this method allows to correctly implement such an identity test via the simple expression a.getObjectID() != b.getObjectID().

Returns

The numeric ID of the internally referenced C++ class instance.

setShapeFunction()

None CDPL.Shape.GaussianShapeOverlapFunction.setShapeFunction	(	GaussianShapeFunction	func,
		bool	is_ref
	)

Parameters

func
is_ref

getShapeFunction()

GaussianShapeFunction CDPL.Shape.GaussianShapeOverlapFunction.getShapeFunction

(

bool

ref

)

Parameters

ref

Returns

setColorMatchFunction()

None CDPL.Shape.GaussianShapeOverlapFunction.setColorMatchFunction

(

Pharm.BoolSizeType2Functor

func

)

Parameters

func

getColorMatchFunction()

Pharm.BoolSizeType2Functor CDPL.Shape.GaussianShapeOverlapFunction.getColorMatchFunction

(

)

Returns

setColorFilterFunction()

None CDPL.Shape.GaussianShapeOverlapFunction.setColorFilterFunction

(

BoolSizeTypeFunctor

func

)

Parameters

func

getColorFilterFunction()

BoolSizeTypeFunctor CDPL.Shape.GaussianShapeOverlapFunction.getColorFilterFunction

(

)

Returns

calcSelfOverlap()

float CDPL.Shape.GaussianShapeOverlapFunction.calcSelfOverlap

(

bool

ref

)

Parameters

ref

Returns

calcColorSelfOverlap()

float CDPL.Shape.GaussianShapeOverlapFunction.calcColorSelfOverlap

(

bool

ref

)

Parameters

ref

Returns

calcOverlap() [1/2]

float CDPL.Shape.GaussianShapeOverlapFunction.calcOverlap

(

)

Returns

calcOverlap() [2/2]

float CDPL.Shape.GaussianShapeOverlapFunction.calcOverlap

(

Math.Vector3DArray

coords

)

Parameters

coords

Returns

calcColorOverlap() [1/2]

float CDPL.Shape.GaussianShapeOverlapFunction.calcColorOverlap

(

)

Returns

calcColorOverlap() [2/2]

float CDPL.Shape.GaussianShapeOverlapFunction.calcColorOverlap

(

Math.Vector3DArray

coords

)

Parameters

coords

Returns

calcOverlapGradient()

float CDPL.Shape.GaussianShapeOverlapFunction.calcOverlapGradient	(	Math.Vector3DArray	coords,
		Math.Vector3DArray	grad
	)

Parameters

coords
grad

Returns