Struct PyDataset 

pub struct PyDataset(pub Arc<Dataset>);

A set of Events

Datasets can be created from lists of Events or by using the constructor helpers such as :meth:laddu.Dataset.from_parquet, :meth:laddu.Dataset.from_root, and :meth:laddu.Dataset.from_amptools

Datasets can also be indexed directly to access individual Events

Parameters

events : list of Event p4_names : list of str, optional Names assigned to each four-momentum; enables name-based lookups if provided. aux_names : list of str, optional Names for auxiliary scalars stored alongside the events. aliases : dict of {str: str or liststr}, optional Additional particle identifiers that override aliases stored on the Events.

Notes

Explicit metadata provided here takes precedence over metadata embedded in the input Events.

Tuple Fields

0: Arc<Dataset>

Implementations

impl PyDataset

pub fn filter(&self, expression: &PyVariableExpression) -> PyResult<PyDataset>

Filter the Dataset by a given VariableExpression, selecting events for which the expression returns True.

Parameters

expression : VariableExpression The expression with which to filter the Dataset

Returns

Dataset The filtered Dataset

Examples

from laddu.utils.variables import Mass # doctest: +SKIP heavy = dataset.filter(Mass([‘kshort1’]) > 1.0) # doctest: +SKIP

pub fn boost_to_rest_frame_of(&self, names: Vec<String>) -> PyDataset

Boost all the four-momenta in all events to the rest frame of the given set of named four-momenta.

Parameters

names : list of str The names of the four-momenta defining the rest frame

Returns

Dataset The boosted dataset

Examples

dataset.boost_to_rest_frame_of([‘kshort1’, ‘kshort2’]) # doctest: +SKIP

Trait Implementations

impl Clone for PyDataset

fn clone(&self) -> PyDataset

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'py> IntoPyObject<'py> for PyDataset

type Target = PyDataset

The Python output type

type Output = Bound<'py, <PyDataset 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 PyClass for PyDataset

type Frozen = False

Whether the pyclass is frozen.

impl PyClassBaseType for PyDataset

type LayoutAsBase = PyClassObject<PyDataset>

type BaseNativeType = <PyDataset as PyClassImpl>::BaseNativeType

type Initializer = PyClassInitializer<PyDataset>

type PyClassMutability = <PyDataset as PyClassImpl>::PyClassMutability

impl PyClassImpl for PyDataset

const IS_BASETYPE: bool = true

#[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 set of Events /// /// Datasets can be created from lists of Events or by using the constructor helpers /// such as :meth:`laddu.Dataset.from_parquet`, :meth:`laddu.Dataset.from_root`, and /// :meth:`laddu.Dataset.from_amptools` /// /// Datasets can also be indexed directly to access individual Events /// /// Parameters /// ---------- /// events : list of Event /// p4_names : list of str, optional /// Names assigned to each four-momentum; enables name-based lookups if provided. /// aux_names : list of str, optional /// Names for auxiliary scalars stored alongside the events. /// aliases : dict of {str: str or list[str]}, optional /// Additional particle identifiers that override aliases stored on the Events. /// /// Notes /// ----- /// Explicit metadata provided here takes precedence over metadata embedded in the /// input Events. ///

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 BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<PyDataset>

This handles following two situations:

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<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for PyDataset

const TEXT_SIGNATURE: &'static str = "(events, *, p4_names=None, aux_names=None, aliases=None)"

impl PyClass__add__SlotFragment<PyDataset> for PyClassImplCollector<PyDataset>

unsafe fn __add__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyClass__radd__SlotFragment<PyDataset> for PyClassImplCollector<PyDataset>

unsafe fn __radd__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyMethods<PyDataset> for PyClassImplCollector<PyDataset>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PyDataset

const NAME: &'static str = "Dataset"

Class name.

const MODULE: Option<&'static str>

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 PyDataset

impl ExtractPyClassWithClone for PyDataset