mcstasscript.tests.test_Plotter.TestPlotterHelpers¶

class mcstasscript.tests.test_Plotter.TestPlotterHelpers(methodName='runTest')¶

Tests of plotter help functions

__init__(methodName='runTest')¶: Create an instance of the class that will use the named test method when executed. Raises a ValueError if the instance does not have a method with the specified name.

Methods

`__init__`([methodName])	Create an instance of the class that will use the named test method when executed.
`addClassCleanup`(function, /, args, *kwargs)	Same as addCleanup, except the cleanup items are called even if setUpClass fails (unlike tearDownClass).
`addCleanup`(function, /, args, *kwargs)	Add a function, with arguments, to be called when the test is completed.
`addTypeEqualityFunc`(typeobj, function)	Add a type specific assertEqual style function to compare a type.
`assertAlmostEqual`(first, second[, places, ...])	Fail if the two objects are unequal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero, or by comparing that the difference between the two objects is more than the given delta.
`assertAlmostEquals`(**kwargs)
`assertCountEqual`(first, second[, msg])	Asserts that two iterables have the same elements, the same number of times, without regard to order.
`assertDictContainsSubset`(subset, dictionary)	Checks whether dictionary is a superset of subset.
`assertDictEqual`(d1, d2[, msg])
`assertEqual`(first, second[, msg])	Fail if the two objects are unequal as determined by the '==' operator.
`assertEquals`(**kwargs)
`assertFalse`(expr[, msg])	Check that the expression is false.
`assertGreater`(a, b[, msg])	Just like self.assertTrue(a > b), but with a nicer default message.
`assertGreaterEqual`(a, b[, msg])	Just like self.assertTrue(a >= b), but with a nicer default message.
`assertIn`(member, container[, msg])	Just like self.assertTrue(a in b), but with a nicer default message.
`assertIs`(expr1, expr2[, msg])	Just like self.assertTrue(a is b), but with a nicer default message.
`assertIsInstance`(obj, cls[, msg])	Same as self.assertTrue(isinstance(obj, cls)), with a nicer default message.
`assertIsNone`(obj[, msg])	Same as self.assertTrue(obj is None), with a nicer default message.
`assertIsNot`(expr1, expr2[, msg])	Just like self.assertTrue(a is not b), but with a nicer default message.
`assertIsNotNone`(obj[, msg])	Included for symmetry with assertIsNone.
`assertLess`(a, b[, msg])	Just like self.assertTrue(a < b), but with a nicer default message.
`assertLessEqual`(a, b[, msg])	Just like self.assertTrue(a <= b), but with a nicer default message.
`assertListEqual`(list1, list2[, msg])	A list-specific equality assertion.
`assertLogs`([logger, level])	Fail unless a log message of level level or higher is emitted on logger_name or its children.
`assertMultiLineEqual`(first, second[, msg])	Assert that two multi-line strings are equal.
`assertNotAlmostEqual`(first, second[, ...])	Fail if the two objects are equal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero, or by comparing that the difference between the two objects is less than the given delta.
`assertNotAlmostEquals`(**kwargs)
`assertNotEqual`(first, second[, msg])	Fail if the two objects are equal as determined by the '!=' operator.
`assertNotEquals`(**kwargs)
`assertNotIn`(member, container[, msg])	Just like self.assertTrue(a not in b), but with a nicer default message.
`assertNotIsInstance`(obj, cls[, msg])	Included for symmetry with assertIsInstance.
`assertNotRegex`(text, unexpected_regex[, msg])	Fail the test if the text matches the regular expression.
`assertNotRegexpMatches`(**kwargs)
`assertRaises`(expected_exception, args, *kwargs)	Fail unless an exception of class expected_exception is raised by the callable when invoked with specified positional and keyword arguments.
`assertRaisesRegex`(expected_exception, ...)	Asserts that the message in a raised exception matches a regex.
`assertRaisesRegexp`(**kwargs)
`assertRegex`(text, expected_regex[, msg])	Fail the test unless the text matches the regular expression.
`assertRegexpMatches`(**kwargs)
`assertSequenceEqual`(seq1, seq2[, msg, seq_type])	An equality assertion for ordered sequences (like lists and tuples).
`assertSetEqual`(set1, set2[, msg])	A set-specific equality assertion.
`assertTrue`(expr[, msg])	Check that the expression is true.
`assertTupleEqual`(tuple1, tuple2[, msg])	A tuple-specific equality assertion.
`assertWarns`(expected_warning, args, *kwargs)	Fail unless a warning of class warnClass is triggered by the callable when invoked with specified positional and keyword arguments.
`assertWarnsRegex`(expected_warning, ...)	Asserts that the message in a triggered warning matches a regexp.
`assert_`(**kwargs)
`countTestCases`()
`debug`()	Run the test without collecting errors in a TestResult
`defaultTestResult`()
`doClassCleanups`()	Execute all class cleanup functions.
`doCleanups`()	Execute all cleanup functions.
`fail`([msg])	Fail immediately, with the given message.
`failIf`(**kwargs)
`failIfAlmostEqual`(**kwargs)
`failIfEqual`(**kwargs)
`failUnless`(**kwargs)
`failUnlessAlmostEqual`(**kwargs)
`failUnlessEqual`(**kwargs)
`failUnlessRaises`(**kwargs)
`id`()
`run`([result])
`setUp`()	Hook method for setting up the test fixture before exercising it.
`setUpClass`()	Hook method for setting up class fixture before running tests in the class.
`shortDescription`()	Returns a one-line description of the test, or None if no description has been provided.
`skipTest`(reason)	Skip this test.
`subTest`([msg])	Return a context manager that will return the enclosed block of code in a subtest identified by the optional message and keyword parameters.
`tearDown`()	Hook method for deconstructing the test fixture after testing it.
`tearDownClass`()	Hook method for deconstructing the class fixture after running all tests in the class.
`test_find_min_max_I_cut_max_1D_case`()	test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set.
`test_find_min_max_I_cut_max_2D_case`()	test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set.
`test_find_min_max_I_cut_min_1D_case`()	test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set.
`test_find_min_max_I_cut_min_2D_case`()	test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set.
`test_find_min_max_I_fail_case`()	test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set.
`test_find_min_max_I_log_cut_max_1D_case`()	test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set.
`test_find_min_max_I_log_cut_max_2D_case`()	test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set.
`test_find_min_max_I_log_cut_min_1D_case`()	test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set.
`test_find_min_max_I_log_cut_min_2D_case`()	test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set.
`test_find_min_max_I_log_orders_of_mag_1D_case`()	test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set.
`test_find_min_max_I_log_orders_of_mag_1D_with_zero_case`()	test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set.
`test_find_min_max_I_log_orders_of_mag_2D_case`()	test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set.
`test_find_min_max_I_log_orders_of_mag_2D_with_zero_case`()	test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set.
`test_find_min_max_I_log_with_zero_2D_case`()	test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set.
`test_find_min_max_I_log_with_zero_case`()	test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set.
`test_find_min_max_I_simple_1D_case`()	test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set
`test_find_min_max_I_simple_2D_case`()	test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set
`test_handle_kwargs_all_simple`()	Tests handle_kwargs with all simple options option
`test_handle_kwargs_bottom_lim`()	Tests handle_kwargs with bottom_lim option
`test_handle_kwargs_figsize_default`()	Tests handle_kwargs delivers default figsize
`test_handle_kwargs_figsize_list`()	Tests handle_kwargs with figsize keyword argument, here using tuple as input
`test_handle_kwargs_figsize_tuple`()	Tests handle_kwargs with figsize keyword argument, here using tuple as input
`test_handle_kwargs_left_lim`()	Tests handle_kwargs with left_lim option
`test_handle_kwargs_log`()	Tests handle_kwargs with log option
`test_handle_kwargs_oders_of_mag`()	Tests handle_kwargs with orders_of_mag option
`test_handle_kwargs_right_lim`()	Tests handle_kwargs with right_lim option
`test_handle_kwargs_single_element_to_list`()	Test handle_kwargs will grab a single McStasData element and turn it into a list.
`test_handle_kwargs_top_lim`()	Tests handle_kwargs with top_lim option
`test_plot_function_1D_log`()	Run the plot function with 1D data set without showing the result.
`test_plot_function_1D_normal`()	Run the plot function with 1D data set without showing the result.
`test_plot_function_2D_log`()	Run the plot function with 2D data set without showing the result.
`test_plot_function_2D_normal`()	Run the plot function with 2D data set without showing the result.

Attributes

`longMessage`
`maxDiff`

test_find_min_max_I_cut_max_1D_case()¶: test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set. Here cut_max is used to limit the maximum plotted.

test_find_min_max_I_cut_max_2D_case()¶: test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set. Here cut_max is used to limit the maximum plotted.

test_find_min_max_I_cut_min_1D_case()¶: test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set. Here cut_min is used to limit the minimum plotted.

test_find_min_max_I_cut_min_2D_case()¶: test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set. Here cut_min is used to limit the minimum plotted.

test_find_min_max_I_fail_case()¶: test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set. Here orders_of_mag is used to limit the minimum plotted while log mode is enabled. A bin in the data contains zero intensity, which should be ignored.

test_find_min_max_I_log_cut_max_1D_case()¶: test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set. Here cut_max is used to limit the maximum plotted while log mode is enabled.

test_find_min_max_I_log_cut_max_2D_case()¶: test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set. Here cut_max is used to limit the maximum plotted while log mode is enabled.

test_find_min_max_I_log_cut_min_1D_case()¶: test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set. Here cut_min is used to limit the minimum plotted while log mode is enabled.

test_find_min_max_I_log_cut_min_2D_case()¶: test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set. Here cut_min is used to limit the minimum plotted while log mode is enabled.

test_find_min_max_I_log_orders_of_mag_1D_case()¶: test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set. Here orders_of_mag is used to limit the minimum plotted while log mode is enabled.

test_find_min_max_I_log_orders_of_mag_1D_with_zero_case()¶: test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set. Here orders_of_mag is used to limit the minimum plotted while log mode is enabled. A bin in the data contains zero intensity, which should be ignored.

test_find_min_max_I_log_orders_of_mag_2D_case()¶: test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set. Here orders_of_mag is used to limit the minimum plotted while log mode is enabled.

test_find_min_max_I_log_orders_of_mag_2D_with_zero_case()¶: test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set. Here orders_of_mag is used to limit the minimum plotted while log mode is enabled. A bin in the data contains zero intensity, which should be ignored.

test_find_min_max_I_log_with_zero_2D_case()¶: test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set. Here a bin contains zero intensity and log mode is enabled, since log(0) is not allowed, this data point should be ignored.

test_find_min_max_I_log_with_zero_case()¶: test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set. Here a bin contains zero intensity and log mode is enabled, since log(0) is not allowed, this data point should be ignored.

test_find_min_max_I_simple_1D_case()¶: test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set

test_find_min_max_I_simple_2D_case()¶: test _find_min_max_I for a 1D case, it finds the minimum and maximum value to plot for a given McStasData set

test_handle_kwargs_all_simple()¶

Tests handle_kwargs with all simple options option