user_parameter

Contents

user_parameter#

pulserver.mrd.user_parameter()[source]#

Return an MRD header user parameter by name, or default when absent.

The long, double, string and base64 collections are searched in that order; the value is returned as the XML binding typed it.

Examples

>>> from types import SimpleNamespace
>>> import pulserver.mrd as mrd
>>> metadata = SimpleNamespace(
...     userParameters=SimpleNamespace(
...         userParameterLong=[SimpleNamespace(name="EchoTrainLength", value=8)],
...         userParameterDouble=[],
...         userParameterString=[],
...     )
... )
>>> mrd.user_parameter(metadata, "EchoTrainLength")
8
>>> mrd.user_parameter(metadata, "NotThere", 0)
0
Contents