x3cflux.get_parameters

class x3cflux.get_parameters(*args, **kwargs)

Overloaded function.

1. get_parameters(parameter_space: x3cflux.lib.core.StationaryParameterSpace, parameter_entries: collections.abc.Sequence[x3cflux.lib.core.ParameterEntry]) -> typing.Annotated[numpy.typing.NDArray[numpy.float64], “[m, 1]”]

   Gets parameter configuration from x3cflux.FluxMLData object.

   Intended to use with a simulator object to generate a valid parameter vector from previous configuration. Unset flux parameters will be set to 0, unset pool size parameters will be set to 1.

   param x3cflux.StationaryParameterSpace parameter_space:

   parameter space of the simulator

   param List[x3cflux.ParameterEntry] parameter_entries:

   the names, types and values of specified parameters

   return:

   parameter vector

2. get_parameters(parameter_space: x3cflux.lib.core.NonStationaryParameterSpace, parameter_entries: collections.abc.Sequence[x3cflux.lib.core.ParameterEntry]) -> typing.Annotated[numpy.typing.NDArray[numpy.float64], “[m, 1]”]

   Gets parameter configuration from x3cflux.FluxMLData object.

   Intended to use with a simulator object to generate a valid parameter vector from previous configuration. Unset flux parameters will be set to 0, unset pool size parameters will be set to 1.

   param x3cflux.NonStationaryParameterSpace parameter_space:

   parameter space of the simulator

   param List[x3cflux.ParameterEntry] parameter_entries:

   the names, types and values of specified parameters

   return:

   parameter vector