Algorithms: the algorithm module

astra.algorithm.clear()[source]

Clear all matrix objects.

astra.algorithm.create(config)[source]

Create algorithm object.

Parameters

config (dict) – Algorithm options.

Returns

int – the ID of the constructed object.

astra.algorithm.delete(ids)[source]

Delete a matrix object.

Parameters

ids (int or list) – ID or list of ID’s to delete.

astra.algorithm.get_plugin_object(i)[source]

Return the Python object instance of a plugin algorithm.

Parameters

i (int) – ID of object corresponding to a plugin algorithm.

Returns

The Python object instance of the plugin algorithm.

astra.algorithm.get_res_norm(i)[source]

Get residual norm of algorithm.

Parameters

i (int) – ID of object.

Returns

float – The residual norm.

astra.algorithm.info()[source]

Print info on matrix objects in memory.

astra.algorithm.run(i, iterations=1)[source]

Run an algorithm.

Parameters
  • i (int) – ID of object.

  • iterations (int) – Number of iterations to run.