v_sim.DataDiff

Subclasses:

None

Methods

Inherited:

v_sim.NodeValuesVector (9), v_sim.NodeValuesFarray (15), v_sim.NodeValues (16), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class	new (dataRef, data, reorder, label)
	applyWithFinder (finder, tol)
	export ()
	isEmpty ()

Virtual Methods

Inherited:

v_sim.NodeValuesVector (1), v_sim.NodeValuesFarray (1), v_sim.NodeValues (4), GObject.Object (7)

Properties

Inherited:

v_sim.NodeValuesFarray (5), v_sim.NodeValues (6)

Signals

Inherited:

v_sim.NodeValues (1), GObject.Object (1)

Fields

Inherited:

v_sim.NodeValues (1), GObject.Object (1)

Name	Type	Access	Description
parent	v_sim.NodeValuesVector	r

Class Details

class v_sim.DataDiff(**kwargs)

Bases:

v_sim.NodeValuesVector

Abstract:

No

Structure:

v_sim.DataDiffClass

Common name to refer to a v_sim.DataDiff.

classmethod new(dataRef, data, reorder, label)

Parameters:

• dataRef (v_sim.Data) – a v_sim.Data object.

• data (v_sim.Data) – a v_sim.Data object.

• reorder (bool) – a boolean.

• label (str) – a label.

Returns:

a newly created v_sim.DataDiff object.

Return type:

v_sim.DataDiff

Compute the node per node position differences between dataRef and data. If reorder is True, the node in data are reordered to minimize the distance with dataRef. If dataRef and data are incompatible, the returned object will be empty, see v_sim.DataDiff.isEmpty().

New in version 3.8.

applyWithFinder(finder, tol)

Parameters:

• finder (v_sim.NodeFinder) – a v_sim.NodeFinder to apply the displacement on.

• tol (float) – a tolerance.

For each node displacement of self, if a matching node in finder is found within the tolerance tol, then the displacement is applied.

New in version 3.8.

export()

Returns:

a new string that should be freed after use.

Return type:

str

Create a string with differences of coordinates stored in self in cartesian coordinates.

New in version 3.6.

isEmpty()

Returns:

True if there is no difference data stored.

Return type:

bool

When creating a v_sim.DataDiff, if the reference and the data don’t have the same number of types or atoms, the difference cannot be computed and the created object is empty.

New in version 3.8.