newModel

aquila_borg.forward.models.newModel(arg0: str, arg1: aquila_borg._borg.forward.BoxModel, arg2: dict) → aquila_borg._borg.forward.BORGForwardModel

Builds a new forward model object from its named.

This is a very generic tool to build any forward model built in the borg library. Being generic means there are some limitations. It relies on the arguments available to the INI configuration file to build those models.

Parameters
  • name (str) – name of the model

  • box (aquila_borg.forward.BoxModel) – Input box for the model

  • arguments (dict) – A key-value pair dictionary. Its context matches the INI file specification

Returns

a constructed forward model element

Return type

aquila_borg.forward.BORGForwardModel