Struct Measurement 

pub struct Measurement {
    pub tracker: String,
    pub epoch: Epoch,
    pub data: IndexMap<MeasurementType, f64>,
    pub rejected: bool,
}

A type-agnostic simultaneous measurement storage structure. Allows storing any number of simultaneous measurement of a given taker.

Note that two measurements are considered equal if the tracker and epoch match exactly, and if both have the same measurement types, and those measurements are equal to within 1e-10 (this allows for some leeway in TDM producers).

Fields

tracker: String

Tracker alias which made this measurement

epoch: Epoch

Epoch of the measurement

data: IndexMap<MeasurementType, f64>

All measurements made simultaneously

rejected: bool

Whether this measurement has been manually rejected

Implementations

impl Measurement

pub fn correct(&mut self, msr_type: MeasurementType, correction: f64)

Correct the provided measurement type with the provided correction, if that measurement type is available

pub fn push(&mut self, msr_type: MeasurementType, msr_value: f64)

impl Measurement

pub fn new(tracker: String, epoch: Epoch) -> Self

pub fn with(self, msr_type: MeasurementType, msr_value: f64) -> Self

pub fn observation<S: DimName>( &self, types: &IndexSet<MeasurementType>, ) -> OVector<f64, S>

where DefaultAllocator: Allocator<S>,

Builds an observation vector for this measurement provided a set of measurement types. If the requested measurement type is not available, then that specific row is set to zero. The caller must set the appropriate sensitivity matrix rows to zero.

pub fn availability(&self, types: &IndexSet<MeasurementType>) -> Vec<bool>

Returns a vector specifying which measurement types are available.

Trait Implementations

impl Clone for Measurement

fn clone(&self) -> Measurement

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Measurement

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Measurement

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a, 'py> FromPyObject<'a, 'py> for Measurement

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for Measurement

type Target = Measurement

The Python output type

type Output = Bound<'py, <Measurement as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PartialEq for Measurement

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PyClass for Measurement

const NAME: &str = "Measurement"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Measurement

const MODULE: Option<&str>

Module which the class will be associated with.

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// A type-agnostic simultaneous measurement storage structure. Allows storing any number of simultaneous measurement of a given taker. /// /// Note that two measurements are considered equal if the tracker and epoch match exactly, and if both have the same measurement types, /// and those measurements are equal to within 1e-10 (this allows for some leeway in TDM producers).

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<Measurement as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<Measurement>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForMeasurement

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for Measurement

const TEXT_SIGNATURE: &'static str = "(tracker, epoch)"

impl PyTypeInfo for Measurement

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for Measurement