secop_ophyd.util

Module Contents

Classes

SECoPDataKey	A DataKey that is used to describe the SECoP Datatype.
Path
DtypeNP
BLOBNP
BoolNP
EnumNP
FloatNP
IntNP
ScaledIntNP
StringNP
StructNP
TupleNP
ArrayNP
SECoPdtype
SECoPReading

Functions

deep_get
dt_factory

Data

SCALAR_DATATYPES
STR_LEN_DEFAULT
SECOP2DTYPE

API

secop_ophyd.util.SCALAR_DATATYPES = ()

class secop_ophyd.util.SECoPDataKey

Bases: event_model.DataKey

A DataKey that is used to describe the SECoP Datatype.

Initialization

Initialize self. See help(type(self)) for accurate signature.

dtype_str: typing_extensions.NotRequired[str] = None

The array-protocol typestring of the data-type object.

dtype_descr: typing_extensions.NotRequired[list] = None

String representation of the numpy structured array dtype.

SECOP_datainfo: str = None

String representation of the original secop datatype.

SECoP_dtype: typing_extensions.NotRequired[str] = None

The SECoP datatype of the data.

exception secop_ophyd.util.NestedRaggedArray

Bases: Exception

The Datatype contains nested ragged arrays

Initialization

Initialize self. See help(type(self)) for accurate signature.

secop_ophyd.util.deep_get(dictionary, keys, default=None) → dict

class secop_ophyd.util.Path(parameter_name: str, module_name: str)

Initialization

append(elem: Union[str, int]) → secop_ophyd.util.Path

get_param_path()

get_path_tuple()

get_memberinfo_path()

get_signal_name()

get_param_desc_path()

get_cmd_desc_path()

get_leaf()

insert_val(dic: dict, new_val)

class secop_ophyd.util.DtypeNP

Bases: abc.ABC

secop_dtype: frappy.datatypes.DataType = None

name: str | None = None

array_element: bool = False

max_depth: int = 0

abstractmethod make_numpy_dtype() → tuple

Create Numpy Compatible structured Datatype

abstractmethod make_concrete_numpy_dtype(value) → tuple

Create Numpy Compatible structured Datatype from a concrete data value

abstractmethod make_numpy_compatible_list(value) → Any

make a make a list that is ready for numpy array import

abstractmethod make_secop_compatible_object(value) → Any

make a make an SECoP Compatible Object

secop_ophyd.util.dt_factory(secop_dt: frappy.datatypes.DataType, name: str = '', array_element: bool = False) → secop_ophyd.util.DtypeNP

secop_ophyd.util.STR_LEN_DEFAULT = 100

class secop_ophyd.util.BLOBNP(blob_dt: frappy.datatypes.BLOBType, name: str = '', array_element: bool = False)

Bases: secop_ophyd.util.DtypeNP

make_numpy_dtype() → tuple

make_concrete_numpy_dtype(value) → tuple

make_numpy_compatible_list(value: str)

make_secop_compatible_object(value) → Any

class secop_ophyd.util.BoolNP(bool_dt: frappy.datatypes.BoolType, name: str = '', array_element: bool = False)

Bases: secop_ophyd.util.DtypeNP

make_numpy_dtype() → tuple

make_concrete_numpy_dtype(value) → tuple

make_numpy_compatible_list(value: bool)

make_secop_compatible_object(value) → Any

class secop_ophyd.util.EnumNP(enum_dt: frappy.datatypes.EnumType, name: str = '', array_element: bool = False)

Bases: secop_ophyd.util.DtypeNP

make_numpy_dtype() → tuple

make_concrete_numpy_dtype(value) → tuple

make_numpy_compatible_list(value: int)

make_secop_compatible_object(value) → Any

class secop_ophyd.util.FloatNP(float_dt: frappy.datatypes.FloatRange, name: str = '', array_element: bool = False)

Bases: secop_ophyd.util.DtypeNP

make_numpy_dtype() → tuple

make_concrete_numpy_dtype(value) → tuple

make_numpy_compatible_list(value: float)

make_secop_compatible_object(value) → Any

class secop_ophyd.util.IntNP(int_dt: frappy.datatypes.IntRange, name: str = '', array_element: bool = False)

Bases: secop_ophyd.util.DtypeNP

make_numpy_dtype() → tuple

make_concrete_numpy_dtype(value) → tuple

make_numpy_compatible_list(value: int)

make_secop_compatible_object(value) → Any

class secop_ophyd.util.ScaledIntNP(scaled_int_dt: frappy.datatypes.ScaledInteger, name: str = '', array_element: bool = False)

Bases: secop_ophyd.util.DtypeNP

make_numpy_dtype() → tuple

make_concrete_numpy_dtype(value) → tuple

make_numpy_compatible_list(value: int)

make_secop_compatible_object(value) → Any

class secop_ophyd.util.StringNP(string_dt: frappy.datatypes.StringType, name: str = '', array_element: bool = False)

Bases: secop_ophyd.util.DtypeNP

make_numpy_dtype() → tuple

make_concrete_numpy_dtype(value) → tuple

make_numpy_compatible_list(value: str)

make_secop_compatible_object(value) → Any

class secop_ophyd.util.StructNP(struct_dt: frappy.datatypes.StructOf, name: str = '', array_element: bool = False)

Bases: secop_ophyd.util.DtypeNP

make_numpy_dtype() → tuple

make_concrete_numpy_dtype(value) → tuple

make_numpy_compatible_list(value: dict)

make_secop_compatible_object(value) → Any

class secop_ophyd.util.TupleNP(tuple_dt: frappy.datatypes.TupleOf, name: str = '', array_element: bool = False)

Bases: secop_ophyd.util.DtypeNP

make_numpy_dtype() → tuple

make_concrete_numpy_dtype(value) → tuple

make_numpy_compatible_list(value: tuple)

make_secop_compatible_object(value) → Any

class secop_ophyd.util.ArrayNP(array_dt: frappy.datatypes.ArrayOf, name: str = '', array_element: bool = False)

Bases: secop_ophyd.util.DtypeNP

get_root_np_str() → str

make_numpy_dtype() → tuple

make_concrete_numpy_dtype(value) → tuple

make_numpy_compatible_list(value: list)

make_secop_compatible_object(value: numpy.ndarray) → Any

class secop_ophyd.util.SECoPdtype(datatype: frappy.datatypes.DataType)

Initialization

get_datakey() → dict

secop2val(reading_val) → Any

val2secop(input_val) → Any

update_dtype(input_val)

class secop_ophyd.util.SECoPReading(secop_dt: secop_ophyd.util.SECoPdtype, entry: frappy.client.CacheItem | None = None)

Initialization

get_reading() → bluesky.protocols.Reading

get_value()

get_secop_value()

set_reading(value) → None

secop_ophyd.util.SECOP2DTYPE = None