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 :func:laddu.io.read_parquet, :func:laddu.io.read_root, and :func:laddu.io.read_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.

Examples

from laddu import Dataset, Event, Vec3 # doctest: +SKIP event = Event( # doctest: +SKIP … [Vec3(0.0, 0.0, 1.0).with_mass(0.0), Vec3(0.0, 0.0, -1.0).with_mass(0.938)], … [0.4, 0.3], … 1.0, … ) dataset = Dataset( # doctest: +SKIP … [event], … p4_names=[‘beam’, ‘proton’], … aux_names=[‘pol_magnitude’, ‘pol_angle’], … aliases={‘target’: ‘proton’}, … ) dataset[0].p4(‘target’) # doctest: +SKIP Vec4(px=0.0, py=0.0, pz=-1.0, e=1.371073…)

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

const NAME: &str = "Dataset"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassBaseType for PyDataset

type LayoutAsBase = <PyDataset as PyClassImpl>::Layout

type BaseNativeType = <PyDataset as PyClassImpl>::BaseNativeType

type Initializer = PyClassInitializer<PyDataset>

type PyClassMutability = <PyDataset as PyClassImpl>::PyClassMutability

type Layout<T: PyClassImpl> = <<PyDataset as PyClassBaseType>::BaseNativeType as PyClassBaseType>::Layout<T>

The type of object layout to use for ancestors or descendants of this type.

impl PyClassImpl for PyDataset

const MODULE: Option<&str>

Module which the class will be associated with.

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 :func:`laddu.io.read_parquet`, :func:`laddu.io.read_root`, and /// :func:`laddu.io.read_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. /// /// Examples /// -------- /// >>> from laddu import Dataset, Event, Vec3 # doctest: +SKIP /// >>> event = Event( # doctest: +SKIP /// ... [Vec3(0.0, 0.0, 1.0).with_mass(0.0), Vec3(0.0, 0.0, -1.0).with_mass(0.938)], /// ... [0.4, 0.3], /// ... 1.0, /// ... ) /// >>> dataset = Dataset( # doctest: +SKIP /// ... [event], /// ... p4_names=['beam', 'proton'], /// ... aux_names=['pol_magnitude', 'pol_angle'], /// ... aliases={'target': 'proton'}, /// ... ) /// >>> dataset[0].p4('target') # doctest: +SKIP /// Vec4(px=0.0, py=0.0, pz=-1.0, e=1.371073...) ///

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 = <<PyDataset as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<PyDataset>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

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<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 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<'_>, _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<'_>, _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: &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 PyDataset