pygrenade_vx.common.Recorder

class pygrenade_vx.common.Recorder

Bases: pygrenade_common.PartitionedVertex

__init__(*args, **kwargs)

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

Methods

__init__(*args, **kwargs)

Initialize self.

create_empty_results(self, batch_size)

Create empty results of recorder.

get_section(self, sequence)

Get section of recorder.

get_shape(self)

get_time_domain(self)

Get time domain.

set_shape(self, value)

set_time_domain(self, value)

Set time domain.

class Results

Bases: pygrenade_common.BatchedPortData

set_section(self: pygrenade_common.Recorder.Results, results: pygrenade_common.Recorder.Results, sequence: pygrenade_common.MultiIndexSequence)None

Set section of results. The sequence is required to be included in the interval [0, size()).

size(self: pygrenade_common.Recorder.Results)int

Number of results per batch entry.

create_empty_results(self: pygrenade_common.Recorder, batch_size: int)pygrenade_common.Recorder.Results

Create empty results of recorder. The results can then be filled e.g. using set_section.

get_section(self: pygrenade_common.Recorder, sequence: pygrenade_common.MultiIndexSequence)pygrenade_common.Recorder

Get section of recorder. The sequence is required to be included in the shape of the recorder.

get_shape(self: pygrenade_common.Recorder)pygrenade_common.MultiIndexSequence
get_time_domain(self: pygrenade_common.Recorder)Optional[pygrenade_common.TimeDomainOnTopology]

Get time domain. A recorder is always part of the time domain from which it records signals.

set_shape(self: pygrenade_common.Recorder, value: pygrenade_common.MultiIndexSequence)None
set_time_domain(self: pygrenade_common.Recorder, value: pygrenade_common.TimeDomainOnTopology)None

Set time domain.