:py:mod:`secop_ophyd.util` ========================== .. py:module:: secop_ophyd.util .. autodoc2-docstring:: secop_ophyd.util :allowtitles: Module Contents --------------- Classes ~~~~~~~ .. list-table:: :class: autosummary longtable :align: left * - :py:obj:`SECoPDataKey ` - .. autodoc2-docstring:: secop_ophyd.util.SECoPDataKey :summary: * - :py:obj:`Path ` - .. autodoc2-docstring:: secop_ophyd.util.Path :summary: * - :py:obj:`DtypeNP ` - * - :py:obj:`BLOBNP ` - * - :py:obj:`BoolNP ` - * - :py:obj:`EnumNP ` - * - :py:obj:`FloatNP ` - * - :py:obj:`IntNP ` - * - :py:obj:`ScaledIntNP ` - * - :py:obj:`StringNP ` - * - :py:obj:`StructNP ` - * - :py:obj:`TupleNP ` - * - :py:obj:`ArrayNP ` - * - :py:obj:`SECoPdtype ` - .. autodoc2-docstring:: secop_ophyd.util.SECoPdtype :summary: * - :py:obj:`SECoPReading ` - .. autodoc2-docstring:: secop_ophyd.util.SECoPReading :summary: Functions ~~~~~~~~~ .. list-table:: :class: autosummary longtable :align: left * - :py:obj:`deep_get ` - .. autodoc2-docstring:: secop_ophyd.util.deep_get :summary: * - :py:obj:`dt_factory ` - .. autodoc2-docstring:: secop_ophyd.util.dt_factory :summary: Data ~~~~ .. list-table:: :class: autosummary longtable :align: left * - :py:obj:`SCALAR_DATATYPES ` - .. autodoc2-docstring:: secop_ophyd.util.SCALAR_DATATYPES :summary: * - :py:obj:`STR_LEN_DEFAULT ` - .. autodoc2-docstring:: secop_ophyd.util.STR_LEN_DEFAULT :summary: * - :py:obj:`SECOP2DTYPE ` - .. autodoc2-docstring:: secop_ophyd.util.SECOP2DTYPE :summary: API ~~~ .. py:data:: SCALAR_DATATYPES :canonical: secop_ophyd.util.SCALAR_DATATYPES :value: () .. autodoc2-docstring:: secop_ophyd.util.SCALAR_DATATYPES .. py:class:: SECoPDataKey() :canonical: secop_ophyd.util.SECoPDataKey Bases: :py:obj:`event_model.DataKey` .. autodoc2-docstring:: secop_ophyd.util.SECoPDataKey .. rubric:: Initialization .. autodoc2-docstring:: secop_ophyd.util.SECoPDataKey.__init__ .. py:attribute:: dtype_str :canonical: secop_ophyd.util.SECoPDataKey.dtype_str :type: typing_extensions.NotRequired[str] :value: None .. autodoc2-docstring:: secop_ophyd.util.SECoPDataKey.dtype_str .. py:attribute:: dtype_descr :canonical: secop_ophyd.util.SECoPDataKey.dtype_descr :type: typing_extensions.NotRequired[list] :value: None .. autodoc2-docstring:: secop_ophyd.util.SECoPDataKey.dtype_descr .. py:attribute:: SECOP_datainfo :canonical: secop_ophyd.util.SECoPDataKey.SECOP_datainfo :type: str :value: None .. autodoc2-docstring:: secop_ophyd.util.SECoPDataKey.SECOP_datainfo .. py:attribute:: SECoP_dtype :canonical: secop_ophyd.util.SECoPDataKey.SECoP_dtype :type: typing_extensions.NotRequired[str] :value: None .. autodoc2-docstring:: secop_ophyd.util.SECoPDataKey.SECoP_dtype .. py:exception:: NestedRaggedArray() :canonical: secop_ophyd.util.NestedRaggedArray Bases: :py:obj:`Exception` .. autodoc2-docstring:: secop_ophyd.util.NestedRaggedArray .. rubric:: Initialization .. autodoc2-docstring:: secop_ophyd.util.NestedRaggedArray.__init__ .. py:function:: deep_get(dictionary, keys, default=None) -> dict :canonical: secop_ophyd.util.deep_get .. autodoc2-docstring:: secop_ophyd.util.deep_get .. py:class:: Path(parameter_name: str, module_name: str) :canonical: secop_ophyd.util.Path .. autodoc2-docstring:: secop_ophyd.util.Path .. rubric:: Initialization .. autodoc2-docstring:: secop_ophyd.util.Path.__init__ .. py:method:: append(elem: typing.Union[str, int]) -> secop_ophyd.util.Path :canonical: secop_ophyd.util.Path.append .. autodoc2-docstring:: secop_ophyd.util.Path.append .. py:method:: get_param_path() :canonical: secop_ophyd.util.Path.get_param_path .. autodoc2-docstring:: secop_ophyd.util.Path.get_param_path .. py:method:: get_path_tuple() :canonical: secop_ophyd.util.Path.get_path_tuple .. autodoc2-docstring:: secop_ophyd.util.Path.get_path_tuple .. py:method:: get_memberinfo_path() :canonical: secop_ophyd.util.Path.get_memberinfo_path .. autodoc2-docstring:: secop_ophyd.util.Path.get_memberinfo_path .. py:method:: get_signal_name() :canonical: secop_ophyd.util.Path.get_signal_name .. autodoc2-docstring:: secop_ophyd.util.Path.get_signal_name .. py:method:: get_param_desc_path() :canonical: secop_ophyd.util.Path.get_param_desc_path .. autodoc2-docstring:: secop_ophyd.util.Path.get_param_desc_path .. py:method:: get_cmd_desc_path() :canonical: secop_ophyd.util.Path.get_cmd_desc_path .. autodoc2-docstring:: secop_ophyd.util.Path.get_cmd_desc_path .. py:method:: get_leaf() :canonical: secop_ophyd.util.Path.get_leaf .. autodoc2-docstring:: secop_ophyd.util.Path.get_leaf .. py:method:: insert_val(dic: dict, new_val) :canonical: secop_ophyd.util.Path.insert_val .. autodoc2-docstring:: secop_ophyd.util.Path.insert_val .. py:class:: DtypeNP :canonical: secop_ophyd.util.DtypeNP Bases: :py:obj:`abc.ABC` .. py:attribute:: secop_dtype :canonical: secop_ophyd.util.DtypeNP.secop_dtype :type: frappy.datatypes.DataType :value: None .. autodoc2-docstring:: secop_ophyd.util.DtypeNP.secop_dtype .. py:attribute:: name :canonical: secop_ophyd.util.DtypeNP.name :type: str | None :value: None .. autodoc2-docstring:: secop_ophyd.util.DtypeNP.name .. py:attribute:: array_element :canonical: secop_ophyd.util.DtypeNP.array_element :type: bool :value: False .. autodoc2-docstring:: secop_ophyd.util.DtypeNP.array_element .. py:attribute:: max_depth :canonical: secop_ophyd.util.DtypeNP.max_depth :type: int :value: 0 .. autodoc2-docstring:: secop_ophyd.util.DtypeNP.max_depth .. py:method:: make_numpy_dtype() -> tuple :canonical: secop_ophyd.util.DtypeNP.make_numpy_dtype :abstractmethod: .. autodoc2-docstring:: secop_ophyd.util.DtypeNP.make_numpy_dtype .. py:method:: make_concrete_numpy_dtype(value) -> tuple :canonical: secop_ophyd.util.DtypeNP.make_concrete_numpy_dtype :abstractmethod: .. autodoc2-docstring:: secop_ophyd.util.DtypeNP.make_concrete_numpy_dtype .. py:method:: make_numpy_compatible_list(value) -> typing.Any :canonical: secop_ophyd.util.DtypeNP.make_numpy_compatible_list :abstractmethod: .. autodoc2-docstring:: secop_ophyd.util.DtypeNP.make_numpy_compatible_list .. py:method:: make_secop_compatible_object(value) -> typing.Any :canonical: secop_ophyd.util.DtypeNP.make_secop_compatible_object :abstractmethod: .. autodoc2-docstring:: secop_ophyd.util.DtypeNP.make_secop_compatible_object .. py:function:: dt_factory(secop_dt: frappy.datatypes.DataType, name: str = '', array_element: bool = False) -> secop_ophyd.util.DtypeNP :canonical: secop_ophyd.util.dt_factory .. autodoc2-docstring:: secop_ophyd.util.dt_factory .. py:data:: STR_LEN_DEFAULT :canonical: secop_ophyd.util.STR_LEN_DEFAULT :value: 100 .. autodoc2-docstring:: secop_ophyd.util.STR_LEN_DEFAULT .. py:class:: BLOBNP(blob_dt: frappy.datatypes.BLOBType, name: str = '', array_element: bool = False) :canonical: secop_ophyd.util.BLOBNP Bases: :py:obj:`secop_ophyd.util.DtypeNP` .. py:method:: make_numpy_dtype() -> tuple :canonical: secop_ophyd.util.BLOBNP.make_numpy_dtype .. py:method:: make_concrete_numpy_dtype(value) -> tuple :canonical: secop_ophyd.util.BLOBNP.make_concrete_numpy_dtype .. py:method:: make_numpy_compatible_list(value: str) :canonical: secop_ophyd.util.BLOBNP.make_numpy_compatible_list .. py:method:: make_secop_compatible_object(value) -> typing.Any :canonical: secop_ophyd.util.BLOBNP.make_secop_compatible_object .. py:class:: BoolNP(bool_dt: frappy.datatypes.BoolType, name: str = '', array_element: bool = False) :canonical: secop_ophyd.util.BoolNP Bases: :py:obj:`secop_ophyd.util.DtypeNP` .. py:method:: make_numpy_dtype() -> tuple :canonical: secop_ophyd.util.BoolNP.make_numpy_dtype .. py:method:: make_concrete_numpy_dtype(value) -> tuple :canonical: secop_ophyd.util.BoolNP.make_concrete_numpy_dtype .. py:method:: make_numpy_compatible_list(value: bool) :canonical: secop_ophyd.util.BoolNP.make_numpy_compatible_list .. py:method:: make_secop_compatible_object(value) -> typing.Any :canonical: secop_ophyd.util.BoolNP.make_secop_compatible_object .. py:class:: EnumNP(enum_dt: frappy.datatypes.EnumType, name: str = '', array_element: bool = False) :canonical: secop_ophyd.util.EnumNP Bases: :py:obj:`secop_ophyd.util.DtypeNP` .. py:method:: make_numpy_dtype() -> tuple :canonical: secop_ophyd.util.EnumNP.make_numpy_dtype .. py:method:: make_concrete_numpy_dtype(value) -> tuple :canonical: secop_ophyd.util.EnumNP.make_concrete_numpy_dtype .. py:method:: make_numpy_compatible_list(value: int) :canonical: secop_ophyd.util.EnumNP.make_numpy_compatible_list .. py:method:: make_secop_compatible_object(value) -> typing.Any :canonical: secop_ophyd.util.EnumNP.make_secop_compatible_object .. py:class:: FloatNP(float_dt: frappy.datatypes.FloatRange, name: str = '', array_element: bool = False) :canonical: secop_ophyd.util.FloatNP Bases: :py:obj:`secop_ophyd.util.DtypeNP` .. py:method:: make_numpy_dtype() -> tuple :canonical: secop_ophyd.util.FloatNP.make_numpy_dtype .. py:method:: make_concrete_numpy_dtype(value) -> tuple :canonical: secop_ophyd.util.FloatNP.make_concrete_numpy_dtype .. py:method:: make_numpy_compatible_list(value: float) :canonical: secop_ophyd.util.FloatNP.make_numpy_compatible_list .. py:method:: make_secop_compatible_object(value) -> typing.Any :canonical: secop_ophyd.util.FloatNP.make_secop_compatible_object .. py:class:: IntNP(int_dt: frappy.datatypes.IntRange, name: str = '', array_element: bool = False) :canonical: secop_ophyd.util.IntNP Bases: :py:obj:`secop_ophyd.util.DtypeNP` .. py:method:: make_numpy_dtype() -> tuple :canonical: secop_ophyd.util.IntNP.make_numpy_dtype .. py:method:: make_concrete_numpy_dtype(value) -> tuple :canonical: secop_ophyd.util.IntNP.make_concrete_numpy_dtype .. py:method:: make_numpy_compatible_list(value: int) :canonical: secop_ophyd.util.IntNP.make_numpy_compatible_list .. py:method:: make_secop_compatible_object(value) -> typing.Any :canonical: secop_ophyd.util.IntNP.make_secop_compatible_object .. py:class:: ScaledIntNP(scaled_int_dt: frappy.datatypes.ScaledInteger, name: str = '', array_element: bool = False) :canonical: secop_ophyd.util.ScaledIntNP Bases: :py:obj:`secop_ophyd.util.DtypeNP` .. py:method:: make_numpy_dtype() -> tuple :canonical: secop_ophyd.util.ScaledIntNP.make_numpy_dtype .. py:method:: make_concrete_numpy_dtype(value) -> tuple :canonical: secop_ophyd.util.ScaledIntNP.make_concrete_numpy_dtype .. py:method:: make_numpy_compatible_list(value: int) :canonical: secop_ophyd.util.ScaledIntNP.make_numpy_compatible_list .. py:method:: make_secop_compatible_object(value) -> typing.Any :canonical: secop_ophyd.util.ScaledIntNP.make_secop_compatible_object .. py:class:: StringNP(string_dt: frappy.datatypes.StringType, name: str = '', array_element: bool = False) :canonical: secop_ophyd.util.StringNP Bases: :py:obj:`secop_ophyd.util.DtypeNP` .. py:method:: make_numpy_dtype() -> tuple :canonical: secop_ophyd.util.StringNP.make_numpy_dtype .. py:method:: make_concrete_numpy_dtype(value) -> tuple :canonical: secop_ophyd.util.StringNP.make_concrete_numpy_dtype .. py:method:: make_numpy_compatible_list(value: str) :canonical: secop_ophyd.util.StringNP.make_numpy_compatible_list .. py:method:: make_secop_compatible_object(value) -> typing.Any :canonical: secop_ophyd.util.StringNP.make_secop_compatible_object .. py:class:: StructNP(struct_dt: frappy.datatypes.StructOf, name: str = '', array_element: bool = False) :canonical: secop_ophyd.util.StructNP Bases: :py:obj:`secop_ophyd.util.DtypeNP` .. py:method:: make_numpy_dtype() -> tuple :canonical: secop_ophyd.util.StructNP.make_numpy_dtype .. py:method:: make_concrete_numpy_dtype(value) -> tuple :canonical: secop_ophyd.util.StructNP.make_concrete_numpy_dtype .. py:method:: make_numpy_compatible_list(value: dict) :canonical: secop_ophyd.util.StructNP.make_numpy_compatible_list .. py:method:: make_secop_compatible_object(value) -> typing.Any :canonical: secop_ophyd.util.StructNP.make_secop_compatible_object .. py:class:: TupleNP(tuple_dt: frappy.datatypes.TupleOf, name: str = '', array_element: bool = False) :canonical: secop_ophyd.util.TupleNP Bases: :py:obj:`secop_ophyd.util.DtypeNP` .. py:method:: make_numpy_dtype() -> tuple :canonical: secop_ophyd.util.TupleNP.make_numpy_dtype .. py:method:: make_concrete_numpy_dtype(value) -> tuple :canonical: secop_ophyd.util.TupleNP.make_concrete_numpy_dtype .. py:method:: make_numpy_compatible_list(value: tuple) :canonical: secop_ophyd.util.TupleNP.make_numpy_compatible_list .. py:method:: make_secop_compatible_object(value) -> typing.Any :canonical: secop_ophyd.util.TupleNP.make_secop_compatible_object .. py:class:: ArrayNP(array_dt: frappy.datatypes.ArrayOf, name: str = '', array_element: bool = False) :canonical: secop_ophyd.util.ArrayNP Bases: :py:obj:`secop_ophyd.util.DtypeNP` .. py:method:: get_root_np_str() -> str :canonical: secop_ophyd.util.ArrayNP.get_root_np_str .. autodoc2-docstring:: secop_ophyd.util.ArrayNP.get_root_np_str .. py:method:: make_numpy_dtype() -> tuple :canonical: secop_ophyd.util.ArrayNP.make_numpy_dtype .. py:method:: make_concrete_numpy_dtype(value) -> tuple :canonical: secop_ophyd.util.ArrayNP.make_concrete_numpy_dtype .. py:method:: make_numpy_compatible_list(value: list) :canonical: secop_ophyd.util.ArrayNP.make_numpy_compatible_list .. py:method:: make_secop_compatible_object(value: numpy.ndarray) -> typing.Any :canonical: secop_ophyd.util.ArrayNP.make_secop_compatible_object .. py:class:: SECoPdtype(datatype: frappy.datatypes.DataType) :canonical: secop_ophyd.util.SECoPdtype .. autodoc2-docstring:: secop_ophyd.util.SECoPdtype .. rubric:: Initialization .. autodoc2-docstring:: secop_ophyd.util.SECoPdtype.__init__ .. py:method:: get_datakey() -> dict :canonical: secop_ophyd.util.SECoPdtype.get_datakey .. autodoc2-docstring:: secop_ophyd.util.SECoPdtype.get_datakey .. py:method:: secop2val(reading_val) -> typing.Any :canonical: secop_ophyd.util.SECoPdtype.secop2val .. autodoc2-docstring:: secop_ophyd.util.SECoPdtype.secop2val .. py:method:: val2secop(input_val) -> typing.Any :canonical: secop_ophyd.util.SECoPdtype.val2secop .. autodoc2-docstring:: secop_ophyd.util.SECoPdtype.val2secop .. py:method:: update_dtype(input_val) :canonical: secop_ophyd.util.SECoPdtype.update_dtype .. autodoc2-docstring:: secop_ophyd.util.SECoPdtype.update_dtype .. py:class:: SECoPReading(secop_dt: secop_ophyd.util.SECoPdtype, entry: frappy.client.CacheItem | None = None) :canonical: secop_ophyd.util.SECoPReading .. autodoc2-docstring:: secop_ophyd.util.SECoPReading .. rubric:: Initialization .. autodoc2-docstring:: secop_ophyd.util.SECoPReading.__init__ .. py:method:: get_reading() -> bluesky.protocols.Reading :canonical: secop_ophyd.util.SECoPReading.get_reading .. autodoc2-docstring:: secop_ophyd.util.SECoPReading.get_reading .. py:method:: get_value() :canonical: secop_ophyd.util.SECoPReading.get_value .. autodoc2-docstring:: secop_ophyd.util.SECoPReading.get_value .. py:method:: get_secop_value() :canonical: secop_ophyd.util.SECoPReading.get_secop_value .. autodoc2-docstring:: secop_ophyd.util.SECoPReading.get_secop_value .. py:method:: set_reading(value) -> None :canonical: secop_ophyd.util.SECoPReading.set_reading .. autodoc2-docstring:: secop_ophyd.util.SECoPReading.set_reading .. py:data:: SECOP2DTYPE :canonical: secop_ophyd.util.SECOP2DTYPE :value: None .. autodoc2-docstring:: secop_ophyd.util.SECOP2DTYPE