ByteArrayEncoding#

class biotite.structure.io.pdbx.ByteArrayEncoding(type: ... = None)[source]#

Bases: Encoding

Encoding that encodes an array into bytes.

Parameters:
typedytpe or TypeCode, optional

The data type of the array to be encoded. Either a NumPy dtype or a BinaryCIF type code is accepted. If omitted, the data type is taken from the data the first time encode() is called.

Examples

>>> data = np.arange(3)
>>> print(data)
[0 1 2]
>>> print(ByteArrayEncoding().encode(data))
b'\x00\x00\x00\x00\x01\x00\x00\x00\x02\x00\x00\x00'
Attributes:
typeTypeCode
decode(data)#

Apply the inverse of this encoding to the given data.

Parameters:
datandarray or bytes

The data to be decoded.

Returns:
decoded_datandarray

The decoded data.

classmethod deserialize(content)#

Create this component by deserializing the given content.

Parameters:
contentstr or dict

The content to be deserialized. The type of this parameter depends on the file format. In case of CIF files, this is the text of the lines that represent this component. In case of BinaryCIF files, this is a dictionary parsed from the MessagePack data.

encode(data)#

Apply this encoding to the given data.

Parameters:
datandarray

The data to be encoded.

Returns:
encoded_datandarray or bytes

The encoded data.

serialize()#

Convert this component into a Python object that can be written to a file.

Returns:
contentstr or dict

The content to be serialized. The type of this return value depends on the file format. In case of CIF files, this is the text of the lines that represent this component. In case of BinaryCIF files, this is a dictionary that can be encoded into MessagePack.

static subcomponent_class()#

Get the class of the components that are stored in this component.

Returns:
subcomponent_classtype

The class of the subcomponent. If this component already represents the lowest level, i.e. it does not contain subcomponents, None is returned.

static supercomponent_class()#

Get the class of the component that contains this component.

Returns:
supercomponent_classtype

The class of the supercomponent. If this component present already the highest level, i.e. it is not contained in another component, None is returned.