scine_puffin.utilities.transfer_helper

Classes

TransferHelper()

An abstract base class to transfer properties from one or more structures to one or more other structures.

class scine_puffin.utilities.transfer_helper.TransferHelper

An abstract base class to transfer properties from one or more structures to one or more other structures.

static simple_transfer(old_structure: db.Structure, new_structure: db.Structure, property_to_transfer: str) → None

Transfer a single property from one structure to another.

Parameters:

old_structuredb.Structure

The structure holding the properties

new_structuredb.Structure

The structure receiving the properties

property_to_transferstr

The name of the property to transfer

static simple_transfer_all(old_structure: db.Structure, new_structure: db.Structure, properties: List[str]) → None

Simply set the id of the given properties from one structure to another one

Parameters:

old_structuredb.Structure

The structure holding the properties

new_structuredb.Structure

The structure receiving the properties

propertiesList[str]

The names of the properties to transfer

abstract transfer_properties(old_structure: db.Structure, new_structure: db.Structure, properties_to_transfer: List[str]) → None

Transfer properties between individual structures based on given property names

Parameters:

old_structuredb.Structure

The structure holding the properties

new_structuredb.Structure

The structure receiving the properties

properties_to_transferList[str]

The names of the properties to transfer

abstract transfer_properties_between_multiple(old_structures: List[db.Structure], new_structures: List[db.Structure], properties_to_transfer: List[str]) → None

Transfer properties between multiple structures based on given property names

Parameters:

old_structuresList[db.Structure]

The structures holding the properties

new_structuresList[db.Structure]

The structures receiving the properties

properties_to_transfer: List[str]

The names of the properties to transfer