pyecsca.sca.trace_set.inspector module

Provides a traceset implementation based on Riscure’s Inspector traceset format (.trs).

class SampleCoding(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: IntEnum

Int8 = 1

Int16 = 2

Int32 = 4

Float8 = 17

Float16 = 18

Float32 = 20

dtype()

conjugate()

Returns self, the complex conjugate of any int.

bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

to_bytes(length=1, byteorder='big', *, signed=False)

Return an array of bytes representing an integer.

length

Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes. Default is length 1.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value. Default is to use ‘big’.

signed

Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

from_bytes(byteorder='big', *, signed=False)

Return the integer represented by the given array of bytes.

bytes

Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value. Default is to use ‘big’.

signed

Indicates whether two’s complement is used to represent the integer.

as_integer_ratio()

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

real

the real part of a complex number

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

denominator

the denominator of a rational number in lowest terms

class Parsers

Bases: object

static read_int(bytes)

static read_bool(bytes)

static read_float(bytes)

static read_str(bytes)

static write_int(i, length=1)

static write_bool(b, length=1)

static write_float(f, length=None)

static write_str(s, length=None)

class InspectorTraceSet(*traces, **kwargs)

Bases: TraceSet

Riscure Inspector trace set format (.trs).

num_traces: int

num_samples: int

sample_coding: SampleCoding

data_space: int = 0

title_space: int = 0

global_title: str = 'title'

description: Optional[str] = None

x_offset: int = 0

x_label: Optional[str] = None

y_label: Optional[str] = None

x_scale: float = 1

y_scale: float = 1

trace_offset: int = 0

log_scale: int = 0

scope_range: float = 0

scope_coupling: int = 0

scope_offset: float = 0

scope_impedance: float = 0

scope_id: Optional[str] = None

filter_type: int = 0

filter_frequency: float = 0

filter_range: float = 0

external_clock: bool = False

external_clock_threshold: float = 0

external_clock_multiplier: int = 0

external_clock_phase_shift: int = 0

external_clock_resampler_mask: int = 0

external_clock_resampler_enabled: bool = False

external_clock_frequencty: float = 0

external_clock_time_base: int = 0

classmethod read(input, **kwargs)

Read Inspector trace set from file path, bytes or file-like object.

Parameters:

input (Union[str, Path, bytes, BinaryIO]) – Input file path, bytes or file-like object.

Return type:

InspectorTraceSet

Returns:

classmethod inplace(input, **kwargs)

Return type:

InspectorTraceSet

write(output)

Save this trace set into a file.

Parameters:

output (Union[str, Path, BinaryIO]) – An output path or file-like object.

property sampling_frequency: int

Return the sampling frequency of the trace set.