TestVariableUtilities Class Reference

Inheritance diagram for TestVariableUtilities:

Collaboration diagram for TestVariableUtilities:

Public Member Functions
def	assertAliases (self, decaystring, expected, **argk)
def	test_wrong_decaystring (self)
	to add to the tests here, please add a test_something_something for you favourite complicated decay string
def	test_no_particle_selected (self)
def	test_number_of_prefix_mismatch (self)
def	test_prefixes_repeated (self)
def	test_named_daughter (self)
def	test_named_mother_and_daughters (self)
def	test_unnamed_daughter (self)
def	test_unnamed_mother (self)
def	test_autonamed_granddaughter (self)
def	test_multiple_autoname_granddaughters (self)
def	test_autoindex (self)
def	test_autoindex_relative (self)
def	test_autoindex_allindexed (self)
def	test_autoindex_allindexed_relative (self)
def	test_indexed (self)
def	test_indexed_relativeignored (self)
def	test_threedkp (self)
def	test_fourdkp (self)
def	test_ohsomany_autonamed (self)
def	test_ohsomany_autonamed_relative (self)
def	test_ohsomany_indexed (self)
def	test_inclusive (self)
def	test_zfinal (self)

Protected Member Functions
def	_expand_expected (self, expected)

Static Protected Attributes
list	_list_of_variables = ['M', 'p']
	list of variables to test

Detailed Description

Test case for the variables.utils functions

Definition at line 16 of file test_variables_utils.py.

Member Function Documentation

_expand_expected()

def _expand_expected (   self,   expected  )

protected

Expand the list of expected aliases by appending _{name} for each variable in the _list_of_variables

Definition at line 22 of file test_variables_utils.py.

    def _expand_expected(self, expected):
        """Expand the list of expected aliases by appending _{name} for each variable in the _list_of_variables"""
        result = []
        for p in expected:
            if p:
                result += [f"{p}_{e}" for e in self._list_of_variables]
            else:
                result += self._list_of_variables
        return result
 

assertAliases()

def assertAliases	(		self,
			decaystring,
			expected,
		**	argk
	)

Make sure the aliases created for given decaystring are as expected
Also, pass any additional keyword arguments to the create_aliases_for_selected function

Definition at line 32 of file test_variables_utils.py.

    def assertAliases(self, decaystring, expected, **argk):
        """Make sure the aliases created for given decaystring are as expected
        Also, pass any additional keyword arguments to the create_aliases_for_selected function
        """
        expected = self._expand_expected(expected)
        actual = create_aliases_for_selected(self._list_of_variables, decaystring, **argk)
        self.assertEqual(expected, actual, f"decaystring: {decaystring}, arguments: {argk}")
 

test_autoindex()

def test_autoindex

(

self

)

 check decay-string-of-doom with automatic names 

Definition at line 100 of file test_variables_utils.py.

    def test_autoindex(self):
        """ check decay-string-of-doom with automatic names """
        self.assertAliases(
            "^B0 -> [D0 -> ^pi+ ^pi-] [D+ -> ^pi+ pi0] [D0 -> ^pi+ ^pi-] [K- -> ^pi+ ^pi-] ^pi+ ^pi- pi0",
            [
                "",
                "D0_0_pi_0",
                "D0_0_pi_1",
                "D_pi",
                "D0_2_pi_0",
                "D0_2_pi_1",
                "K_pi_0",
                "K_pi_1",
                "pi_4",
                "pi_5",
            ])
 

test_autoindex_allindexed()

def test_autoindex_allindexed

(

self

)

 check decay-string-of-doom with automatic names and forced indices

Definition at line 134 of file test_variables_utils.py.

    def test_autoindex_allindexed(self):
        """ check decay-string-of-doom with automatic names and forced indices"""
        self.assertAliases(
            "^B0 -> [D0 -> ^pi+ ^pi-] [D+ -> ^pi+ pi0] [D0 -> ^pi+ ^pi-] [K- -> ^pi+ ^pi-] ^pi+ ^pi- pi0",
            [
                "",
                "D0_0_pi_0",
                "D0_0_pi_1",
                "D_1_pi_0",
                "D0_2_pi_0",
                "D0_2_pi_1",
                "K_3_pi_0",
                "K_3_pi_1",
                "pi_4",
                "pi_5",
            ], always_include_indices=True)
 

test_autoindex_allindexed_relative()

def test_autoindex_allindexed_relative

(

self

)

 check decay-string-of-doom with automatic names, relative indexing and forced indices

Definition at line 151 of file test_variables_utils.py.

    def test_autoindex_allindexed_relative(self):
        """ check decay-string-of-doom with automatic names, relative indexing and forced indices"""
        self.assertAliases(
            "^B0 -> [D0 -> ^pi+ ^pi-] [D+ -> ^pi+ pi0] [D0 -> ^pi+ ^pi-] [K- -> ^pi+ ^pi-] ^pi+ ^pi- pi0",
            [
                "",
                "D0_0_pi_0",
                "D0_0_pi_1",
                "D_0_pi_0",
                "D0_1_pi_0",
                "D0_1_pi_1",
                "K_0_pi_0",
                "K_0_pi_1",
                "pi_0",
                "pi_1",
            ], use_relative_indices=True, always_include_indices=True)
 

test_autoindex_relative()

def test_autoindex_relative

(

self

)

 check decay-string-of-doom with automatic names and relative indexing

Definition at line 117 of file test_variables_utils.py.

    def test_autoindex_relative(self):
        """ check decay-string-of-doom with automatic names and relative indexing"""
        self.assertAliases(
            "^B0 -> [D0 -> ^pi+ ^pi-] [D+ -> ^pi+ pi0] [D0 -> ^pi+ ^pi-] [K- -> ^pi+ ^pi-] ^pi+ ^pi- pi0",
            [
                "",
                "D0_0_pi_0",
                "D0_0_pi_1",
                "D_pi",
                "D0_1_pi_0",
                "D0_1_pi_1",
                "K_pi_0",
                "K_pi_1",
                "pi_0",
                "pi_1",
            ], use_relative_indices=True)
 

test_autonamed_granddaughter()

def test_autonamed_granddaughter

(

self

)

Check granddaughter can be selected for an automatic name alias

Definition at line 85 of file test_variables_utils.py.

    def test_autonamed_granddaughter(self):
        """Check granddaughter can be selected for an automatic name alias"""
        self.assertAliases('B0 -> [D0 -> ^pi+ K-] pi0', ['D0_pi'])
 

test_fourdkp()

def test_fourdkp

(

self

)

 check if the indexing works with more than two ... 

Definition at line 212 of file test_variables_utils.py.

    def test_fourdkp(self):
        """ check if the indexing works with more than two ... """
        self.assertAliases(
            "B0 -> [D+ -> [K+ -> ^pi+]] [D+ -> [K+ -> ^pi+]] [D+ -> [K+ -> ^pi+]] [D+ -> [K+ -> ^pi+]]",
            [
                "D_0_K_pi",
                "D_1_K_pi",
                "D_2_K_pi",
                "D_3_K_pi",
            ])
        self.assertAliases(
            "B0 -> [D+ -> [K+ -> pi+]] [D+ -> [K+ -> ^pi+]] [D+ -> [^K+ -> pi+]] [D+ -> [K+ -> ^pi+]]",
            [
                "D_1_K_pi",
                "D_2_K",
                "D_3_K_pi",
            ])
        self.assertAliases(
            "B0 -> [D+ -> [K+ -> pi+]] [D+ -> [K+ -> ^pi+]] [D+ -> [^K+ -> pi+]] [D+ -> [K+ -> ^pi+]]",
            [
                "D_0_K_pi",
                "D_1_K",
                "D_2_K_pi",
            ], use_relative_indices=True)
 

test_inclusive()

def test_inclusive

(

self

)

Select a decay with the inclusive particle marker

Definition at line 284 of file test_variables_utils.py.

    def test_inclusive(self):
        """Select a decay with the inclusive particle marker"""
        self.assertAliases("B0 -> ^Xsd e+:loose e-:loose", ["Xsd"])
 

test_indexed()

def test_indexed

(

self

)

 check decay-string-of-doom w/o automatic names 

Definition at line 168 of file test_variables_utils.py.

    def test_indexed(self):
        """ check decay-string-of-doom w/o automatic names """
        self.assertAliases(
            "^B0 -> [D0 -> ^pi+ ^pi-] [D+ -> ^pi+ pi0] [D0 -> ^pi+ ^pi-] [K- -> ^pi+ ^pi-] ^pi+ ^pi- pi0",
            [
                "",
                "d0_d0",
                "d0_d1",
                "d1_d0",
                "d2_d0",
                "d2_d1",
                "d3_d0",
                "d3_d1",
                "d4",
                "d5",
            ], use_names=False)
 

test_indexed_relativeignored()

def test_indexed_relativeignored

(

self

)

 check decay-string-of-doom w/o automatic names and make sure relative indexing is **not** honored

Definition at line 185 of file test_variables_utils.py.

    def test_indexed_relativeignored(self):
        """ check decay-string-of-doom w/o automatic names and make sure relative indexing is **not** honored"""
        self.assertAliases(
            "^B0 -> [D0 -> ^pi+ ^pi-] [D+ -> ^pi+ pi0] [D0 -> ^pi+ ^pi-] [K- -> ^pi+ ^pi-] ^pi+ ^pi- pi0",
            [
                "",
                "d0_d0",
                "d0_d1",
                "d1_d0",
                "d2_d0",
                "d2_d1",
                "d3_d0",
                "d3_d1",
                "d4",
                "d5",
            ], use_names=False, use_relative_indices=True)
 

test_multiple_autoname_granddaughters()

def test_multiple_autoname_granddaughters

(

self

)

Check multiple granddaughters can be selected for automatic name aliases

Definition at line 89 of file test_variables_utils.py.

    def test_multiple_autoname_granddaughters(self):
        """Check multiple granddaughters can be selected for automatic name aliases"""
        self.assertAliases(
            'B0 -> [D0 -> ^pi+ ^pi- ^pi0] ^pi0',
            [
                'D0_pi_0',
                'D0_pi_1',
                'D0_pi0',
                'pi0',
            ])
 

test_named_daughter()

def test_named_daughter

(

self

)

Check daughter can be selected for an specific named alias

Definition at line 67 of file test_variables_utils.py.

    def test_named_daughter(self):
        """Check daughter can be selected for an specific named alias"""
        self.assertAliases('B0 -> [^D0 -> pi+ K-] pi0', ['dzero'], prefix='dzero')
 

test_named_mother_and_daughters()

def test_named_mother_and_daughters

(

self

)

Check mother and daughter can be selected for an specific named alias

Definition at line 71 of file test_variables_utils.py.

    def test_named_mother_and_daughters(self):
        """Check mother and daughter can be selected for an specific named alias"""
        self.assertAliases('^B0 -> [^D0 -> pi+ ^K-] pi0', ['MyB', 'MyD', 'MyK'], prefix=['MyB', 'MyD', 'MyK'])
 

test_no_particle_selected()

def test_no_particle_selected

(

self

)

Make sure we get an error if o particle is selected

Definition at line 49 of file test_variables_utils.py.

    def test_no_particle_selected(self):
        """Make sure we get an error if o particle is selected"""
        with self.assertRaises(ValueError):
            create_aliases_for_selected(["p"], "B0 -> pi0")
 

test_number_of_prefix_mismatch()

def test_number_of_prefix_mismatch

(

self

)

Make sure we get an error if the number of supplied prefixes doesn't
match the number of selected particles

Definition at line 54 of file test_variables_utils.py.

    def test_number_of_prefix_mismatch(self):
        """Make sure we get an error if the number of supplied prefixes doesn't
        match the number of selected particles"""
        with self.assertRaises(ValueError):
            create_aliases_for_selected(["p"], "^B0 -> ^pi0", prefix="one")
        with self.assertRaises(ValueError):
            create_aliases_for_selected(["p"], "B0 -> ^pi0", prefix=["one", "two"])
 

test_ohsomany_autonamed()

def test_ohsomany_autonamed

(

self

)

Test many many children

Definition at line 237 of file test_variables_utils.py.

    def test_ohsomany_autonamed(self):
        """Test many many children"""
        self.assertAliases(
            "B0 -> e+:0 ^e+:1 ^e+:2 e+:3 ^e+:4 e+:5 ^e+:6 mu+:7 ^mu+:8 mu+:9 ^mu+:10 ^mu+:11 mu+:12",
            [
                "e_1",
                "e_2",
                "e_4",
                "e_6",
                "mu_8",
                "mu_10",
                "mu_11",
            ])
 

test_ohsomany_autonamed_relative()

def test_ohsomany_autonamed_relative

(

self

)

Test many many children with relative indices

Definition at line 251 of file test_variables_utils.py.

    def test_ohsomany_autonamed_relative(self):
        """Test many many children with relative indices"""
        self.assertAliases(
            "B0 -> e+:0 ^e+:1 ^e+:2 e+:3 ^e+:4 e+:5 ^e+:6 mu+:7 ^mu+:8 mu+:9 ^mu+:10 ^mu+:11 mu+:12",
            [
                "e_0",
                "e_1",
                "e_2",
                "e_3",
                "mu_0",
                "mu_1",
                "mu_2",
            ], use_relative_indices=True)
 

test_ohsomany_indexed()

def test_ohsomany_indexed

(

self

)

Test many many children without names

Definition at line 265 of file test_variables_utils.py.

    def test_ohsomany_indexed(self):
        """Test many many children without names"""
        for use_relative_indices in True, False:
            for always_include_indices in True, False:
                self.assertAliases(
                    "B0 -> e+:0 ^e+:1 ^e+:2 e+:3 ^e+:4 e+:5 ^e+:6 mu+:7 ^mu+:8 mu+:9 ^mu+:10 ^mu+:11 mu+:12",
                    [
                        "d1",
                        "d2",
                        "d4",
                        "d6",
                        "d8",
                        "d10",
                        "d11",
                    ], use_names=False,
                    use_relative_indices=use_relative_indices,
                    always_include_indices=always_include_indices,
                )
 

test_prefixes_repeated()

def test_prefixes_repeated

(

self

)

Make sure we got an error if the supplied provided prefixes are not unique

Definition at line 62 of file test_variables_utils.py.

    def test_prefixes_repeated(self):
        """Make sure we got an error if the supplied provided prefixes are not unique"""
        with self.assertRaises(ValueError):
            create_aliases_for_selected(["p"], "^B0 -> ^pi0", prefix=["mine", "mine"])
 

test_threedkp()

def test_threedkp

(

self

)

 check if the indexing works with more than two ... 

Definition at line 202 of file test_variables_utils.py.

    def test_threedkp(self):
        """ check if the indexing works with more than two ... """
        self.assertAliases(
            "B0 -> [D+ -> [K+ -> ^pi+]] [D+ -> [K+ -> ^pi+]] [D+ -> [K+ -> ^pi+]]",
            [
                "D_0_K_pi",
                "D_1_K_pi",
                "D_2_K_pi",
            ])
 

test_unnamed_daughter()

def test_unnamed_daughter

(

self

)

Check daughter can be selected w/o an specific named alias

Definition at line 75 of file test_variables_utils.py.

    def test_unnamed_daughter(self):
        """Check daughter can be selected w/o an specific named alias"""
        self.assertAliases('B0 -> [^D0 -> ^pi+ ^K-] pi0',  ['d0', 'd0_d0', 'd0_d1'], use_names=False)
 

test_unnamed_mother()

def test_unnamed_mother

(

self

)

Check daughter can be selected w/o an specific named alias

Definition at line 79 of file test_variables_utils.py.

    def test_unnamed_mother(self):
        """Check daughter can be selected w/o an specific named alias"""
        self.assertAliases('^B0 -> pi0 ^pi0',  ['', 'd1'], use_names=False)
        # also make sure we ignore ``use_relative_indices``
        self.assertAliases('^B0 -> pi0 ^pi0',  ['', 'd1'], use_names=False, use_relative_indices=True)
 

test_wrong_decaystring()

def test_wrong_decaystring

(

self

)

to add to the tests here, please add a test_something_something for you favourite complicated decay string

Make sure we get an error if the decaystring is not valid

Definition at line 44 of file test_variables_utils.py.

    def test_wrong_decaystring(self):
        """Make sure we get an error if the decaystring is not valid"""
        with self.assertRaises(ValueError):
            create_aliases_for_selected(["p"], "eeh <- ok")
 

test_zfinal()

def test_zfinal

(

self

)

Print all aliases as a final check

Definition at line 288 of file test_variables_utils.py.

    def test_zfinal(self):
        """Print all aliases as a final check"""
        vm.printAliases()
 
 

Member Data Documentation

_list_of_variables

list _list_of_variables = ['M', 'p']

staticprotected

list of variables to test

Definition at line 20 of file test_variables_utils.py.

---

The documentation for this class was generated from the following file:

• analysis/tests/test_variables_utils.py