obsvects class

obsvects class#

class pycif.utils.classes.obsvects.ObsVect(**kwargs)[source]#

Bases: Plugin

Plugin type for observation vectors.

Manages the observation datastore and provides the R-matrix inverse-product operation (rinvprod) along with serialisation (dump / read) and initialisation (init_y0, init_invprod) interfaces.

Concrete implementations live in pycif/plugins/obsvects/.

initiate_template()[source]#

Initialise the ObsVect plugin template.

Loads the registered obs-vector module and attaches init_y0, init_invprod, rinvprod, dump and read as bound methods on this instance.

init_y0(*args, **kwargs)[source]#

Default empty init_y0 method

init_invprod(*args, **kwargs)[source]#

Default empty init_invprod method

rinvprod(*args, **kwargs)[source]#

Default empty rinvprod method

dump(*args, **kwargs)[source]#

Default empty dump method

read(*args, **kwargs)[source]#

Default empty read method

classmethod register_plugin(name, version, module, subtype='', **kwargs)[source]#

Register a module for a plugin and version with possibly options

Parameters:

  • name (str) – name of the plugin

  • version (str) – version of the plugin

  • module (types.ModuleType) – module defining the interface between pyCIF and the plugin

  • plugin_type (str) – type of plugin

  • **kwargs (dictionary) – default options for module