Struct PyCosTheta 

pub struct PyCosTheta(pub CosTheta);

The cosine of the polar decay angle in the rest frame of the given resonance

This Variable is calculated by forming the given frame (helicity or Gottfried-Jackson) and calculating the spherical angles according to one of the decaying daughter particles.

The helicity frame is defined in terms of the following Cartesian axes in the rest frame of the resonance:

.. math:: \hat{z} \propto -\vec{p}’{\text{recoil}} .. math:: \hat{y} \propto \vec{p}{\text{beam}} \times (-\vec{p}_{\text{recoil}}) .. math:: \hat{x} = \hat{y} \times \hat{z}

where primed vectors are in the rest frame of the resonance and unprimed vectors are in the center-of-momentum frame.

The Gottfried-Jackson frame differs only in the definition of :math:\hat{z}:

.. math:: \hat{z} \propto \vec{p}’_{\text{beam}}

Parameters

beam : int The index of the beam particle recoil : list of int Indices of particles which are combined to form the recoiling particle (particles which are not beam or part of the resonance) daughter : list of int Indices of particles which are combined to form one of the decay products of the resonance resonance : list of int Indices of particles which are combined to form the resonance frame : {‘Helicity’, ‘HX’, ‘HEL’, ‘GottfriedJackson’, ‘Gottfried Jackson’, ‘GJ’, ‘Gottfried-Jackson’} The frame to use in the calculation

Raises

ValueError If frame is not one of the valid options

See Also

laddu.utils.vectors.Vec3.costheta

Tuple Fields

0: CosTheta

Trait Implementations

impl Clone for PyCosTheta

fn clone(&self) -> PyCosTheta

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for PyCosTheta

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'py> IntoPyObject<'py> for PyCosTheta

type Target = PyCosTheta

The Python output type

type Output = Bound<'py, <PyCosTheta 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 PyCosTheta

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for PyCosTheta

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 = /// The cosine of the polar decay angle in the rest frame of the given `resonance` /// /// This Variable is calculated by forming the given frame (helicity or Gottfried-Jackson) and /// calculating the spherical angles according to one of the decaying `daughter` particles. /// /// The helicity frame is defined in terms of the following Cartesian axes in the rest frame of /// the `resonance`: /// /// .. math:: \hat{z} \propto -\vec{p}'_{\text{recoil}} /// .. math:: \hat{y} \propto \vec{p}_{\text{beam}} \times (-\vec{p}_{\text{recoil}}) /// .. math:: \hat{x} = \hat{y} \times \hat{z} /// /// where primed vectors are in the rest frame of the `resonance` and unprimed vectors are in /// the center-of-momentum frame. /// /// The Gottfried-Jackson frame differs only in the definition of :math:`\hat{z}`: /// /// .. math:: \hat{z} \propto \vec{p}'_{\text{beam}} /// /// Parameters /// ---------- /// beam : int /// The index of the `beam` particle /// recoil : list of int /// Indices of particles which are combined to form the recoiling particle (particles which /// are not `beam` or part of the `resonance`) /// daughter : list of int /// Indices of particles which are combined to form one of the decay products of the /// `resonance` /// resonance : list of int /// Indices of particles which are combined to form the `resonance` /// frame : {'Helicity', 'HX', 'HEL', 'GottfriedJackson', 'Gottfried Jackson', 'GJ', 'Gottfried-Jackson'} /// The frame to use in the calculation /// /// Raises /// ------ /// ValueError /// If `frame` is not one of the valid options /// /// See Also /// -------- /// laddu.utils.vectors.Vec3.costheta ///

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

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 PyCosTheta

const TEXT_SIGNATURE: &'static str = "(beam, recoil, daughter, resonance, frame=\"Helicity\")"

impl PyClass__eq__SlotFragment<PyCosTheta> for PyClassImplCollector<PyCosTheta>

unsafe fn __eq__( 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__ge__SlotFragment<PyCosTheta> for PyClassImplCollector<PyCosTheta>

unsafe fn __ge__( 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__gt__SlotFragment<PyCosTheta> for PyClassImplCollector<PyCosTheta>

unsafe fn __gt__( 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__le__SlotFragment<PyCosTheta> for PyClassImplCollector<PyCosTheta>

unsafe fn __le__( 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__lt__SlotFragment<PyCosTheta> for PyClassImplCollector<PyCosTheta>

unsafe fn __lt__( 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<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder PyCosTheta

type Holder = Option<PyClassGuard<'a, PyCosTheta>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'holder mut Self::Holder, ) -> PyResult<Self>

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder mut PyCosTheta

type Holder = Option<PyClassGuardMut<'a, PyCosTheta>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'holder mut Self::Holder, ) -> PyResult<Self>

impl PyMethods<PyCosTheta> for PyClassImplCollector<PyCosTheta>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PyCosTheta

const NAME: &'static str = "CosTheta"

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 Serialize for PyCosTheta

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl DerefToPyAny for PyCosTheta