darfix.tests.test_dataset.TestHDF5Dataset#

class darfix.tests.test_dataset.TestHDF5Dataset(methodName='runTest')[source]#

Bases: _BaseDatasetTest, TestCase

classmethod 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. Functions added are called on a LIFO basis and are called after tearDown on test failure or success.

Cleanup items are called even if setUp fails (unlike tearDown).

addTypeEqualityFunc(typeobj, function)#

Add a type specific assertEqual style function to compare a type.

This method is for use by TestCase subclasses that need to register their own type equality functions to provide nicer error messages.

Args:

typeobj: The data type to call this function on when both values: are of the same type in assertEqual().
function: The callable taking two arguments and an optional: msg= argument that raises self.failureException with a useful error message when the two arguments are not equal.

assertAlmostEqual(first, second, places=None, msg=None, delta=None)#

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.

Note that decimal places (from zero) are usually not the same as significant digits (measured from the most significant digit).

If the two objects compare equal then they will automatically compare almost equal.

assertAlmostEquals(**kwargs)#

assertCountEqual(first, second, msg=None)#

Asserts that two iterables have the same elements, the same number of times, without regard to order.

self.assertEqual(Counter(list(first)),
Counter(list(second)))

Example:

[0, 1, 1] and [1, 0, 1] compare equal.

[0, 0, 1] and [0, 1] compare unequal.

assertDictContainsSubset(subset, dictionary, msg=None)#: Checks whether dictionary is a superset of subset.

assertDictEqual(d1, d2, msg=None)#

assertEqual(first, second, msg=None)#: Fail if the two objects are unequal as determined by the ‘==’ operator.

assertEquals(**kwargs)#

assertFalse(expr, msg=None)#: Check that the expression is false.

assertGreater(a, b, msg=None)#: Just like self.assertTrue(a > b), but with a nicer default message.

assertGreaterEqual(a, b, msg=None)#: Just like self.assertTrue(a >= b), but with a nicer default message.

assertIn(member, container, msg=None)#: Just like self.assertTrue(a in b), but with a nicer default message.

assertIs(expr1, expr2, msg=None)#: Just like self.assertTrue(a is b), but with a nicer default message.

assertIsInstance(obj, cls, msg=None)#: Same as self.assertTrue(isinstance(obj, cls)), with a nicer default message.

assertIsNone(obj, msg=None)#: Same as self.assertTrue(obj is None), with a nicer default message.

assertIsNot(expr1, expr2, msg=None)#: Just like self.assertTrue(a is not b), but with a nicer default message.

assertIsNotNone(obj, msg=None)#: Included for symmetry with assertIsNone.

assertLess(a, b, msg=None)#: Just like self.assertTrue(a < b), but with a nicer default message.

assertLessEqual(a, b, msg=None)#: Just like self.assertTrue(a <= b), but with a nicer default message.

assertListEqual(list1, list2, msg=None)#

A list-specific equality assertion.

Args:: list1: The first list to compare. list2: The second list to compare. msg: Optional message to use on failure instead of a list of

differences.

assertLogs(logger=None, level=None)#

Fail unless a log message of level level or higher is emitted on logger_name or its children. If omitted, level defaults to INFO and logger defaults to the root logger.

This method must be used as a context manager, and will yield a recording object with two attributes: output and records. At the end of the context manager, the output attribute will be a list of the matching formatted log messages and the records attribute will be a list of the corresponding LogRecord objects.

Example:

with self.assertLogs('foo', level='INFO') as cm:
    logging.getLogger('foo').info('first message')
    logging.getLogger('foo.bar').error('second message')
self.assertEqual(cm.output, ['INFO:foo:first message',
                             'ERROR:foo.bar:second message'])

assertMultiLineEqual(first, second, msg=None)#: Assert that two multi-line strings are equal.

assertNotAlmostEqual(first, second, places=None, msg=None, delta=None)#

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.

Note that decimal places (from zero) are usually not the same as significant digits (measured from the most significant digit).

Objects that are equal automatically fail.

assertNotAlmostEquals(**kwargs)#

assertNotEqual(first, second, msg=None)#: Fail if the two objects are equal as determined by the ‘!=’ operator.

assertNotEquals(**kwargs)#

assertNotIn(member, container, msg=None)#: Just like self.assertTrue(a not in b), but with a nicer default message.

assertNotIsInstance(obj, cls, msg=None)#: Included for symmetry with assertIsInstance.

assertNotRegex(text, unexpected_regex, msg=None)#: 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. If a different type of exception is raised, it will not be caught, and the test case will be deemed to have suffered an error, exactly as for an unexpected exception.

If called with the callable and arguments omitted, will return a context object used like this:

with self.assertRaises(SomeException):
    do_something()

An optional keyword argument ‘msg’ can be provided when assertRaises is used as a context object.

The context manager keeps a reference to the exception as the ‘exception’ attribute. This allows you to inspect the exception after the assertion:

with self.assertRaises(SomeException) as cm:
    do_something()
the_exception = cm.exception
self.assertEqual(the_exception.error_code, 3)

assertRaisesRegex(expected_exception, expected_regex, *args, **kwargs)#

Asserts that the message in a raised exception matches a regex.

Args:

expected_exception: Exception class expected to be raised. expected_regex: Regex (re.Pattern object or string) expected

to be found in error message.

args: Function to be called and extra positional args. kwargs: Extra kwargs. msg: Optional message used in case of failure. Can only be used

when assertRaisesRegex is used as a context manager.

assertRaisesRegexp(**kwargs)#

assertRegex(text, expected_regex, msg=None)#: Fail the test unless the text matches the regular expression.

assertRegexpMatches(**kwargs)#

assertSequenceEqual(seq1, seq2, msg=None, seq_type=None)#

An equality assertion for ordered sequences (like lists and tuples).

For the purposes of this function, a valid ordered sequence type is one which can be indexed, has a length, and has an equality operator.

Args:

seq1: The first sequence to compare. seq2: The second sequence to compare. seq_type: The expected datatype of the sequences, or None if no

datatype should be enforced.

msg: Optional message to use on failure instead of a list of: differences.

assertSetEqual(set1, set2, msg=None)#

A set-specific equality assertion.

Args:: set1: The first set to compare. set2: The second set to compare. msg: Optional message to use on failure instead of a list of

differences.

assertSetEqual uses ducktyping to support different types of sets, and is optimized for sets specifically (parameters must support a difference method).

assertTrue(expr, msg=None)#: Check that the expression is true.

assertTupleEqual(tuple1, tuple2, msg=None)#

A tuple-specific equality assertion.

Args:: tuple1: The first tuple to compare. tuple2: The second tuple to compare. msg: Optional message to use on failure instead of a list of

differences.

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. If a different type of warning is triggered, it will not be handled: depending on the other warning filtering rules in effect, it might be silenced, printed out, or raised as an exception.

If called with the callable and arguments omitted, will return a context object used like this:

with self.assertWarns(SomeWarning):
    do_something()

An optional keyword argument ‘msg’ can be provided when assertWarns is used as a context object.

The context manager keeps a reference to the first matching warning as the ‘warning’ attribute; similarly, the ‘filename’ and ‘lineno’ attributes give you information about the line of Python code from which the warning was triggered. This allows you to inspect the warning after the assertion:

with self.assertWarns(SomeWarning) as cm:
    do_something()
the_warning = cm.warning
self.assertEqual(the_warning.some_attribute, 147)

assertWarnsRegex(expected_warning, expected_regex, *args, **kwargs)#

Asserts that the message in a triggered warning matches a regexp. Basic functioning is similar to assertWarns() with the addition that only warnings whose messages also match the regular expression are considered successful matches.

Args:

expected_warning: Warning class expected to be triggered. expected_regex: Regex (re.Pattern object or string) expected

to be found in error message.

args: Function to be called and extra positional args. kwargs: Extra kwargs. msg: Optional message used in case of failure. Can only be used

when assertWarnsRegex is used as a context manager.

assert_(**kwargs)#

property backend#

countTestCases()#

createRandomDataset(dims, nb_frames, in_memory=True, metadata=False)[source]#

debug()#: Run the test without collecting errors in a TestResult

defaultTestResult()#

classmethod doClassCleanups()#: Execute all class cleanup functions. Normally called for you after tearDownClass.

doCleanups()#: Execute all cleanup functions. Normally called for you after tearDown.

fail(msg=None)#: Fail immediately, with the given message.

failIf(**kwargs)#

failIfAlmostEqual(**kwargs)#

failIfEqual(**kwargs)#

failUnless(**kwargs)#

failUnlessAlmostEqual(**kwargs)#

failUnlessEqual(**kwargs)#

failUnlessRaises(**kwargs)#

failureException#: alias of AssertionError

id()#

longMessage = True#

maxDiff = 640#

run(result=None)#

setUp()[source]#: Hook method for setting up the test fixture before exercising it.

classmethod 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.

The default implementation of this method returns the first line of the specified test method’s docstring.

skipTest(reason)#: Skip this test.

subTest(msg=<object object>, **params)#: Return a context manager that will return the enclosed block of code in a subtest identified by the optional message and keyword parameters. A failure in the subtest marks the test case as failed but resumes execution at the end of the enclosed block, allowing further test code to be executed.

tearDown()#: Hook method for deconstructing the test fixture after testing it.

classmethod tearDownClass()#: Hook method for deconstructing the class fixture after running all tests in the class.

test_apply_fit_in_memory()#: Tests fitting data in memory

test_apply_fit_on_disk()#: Tests fitting data on disk

test_apply_rsm_on_disk()#: Tests fitting data on disk

test_apply_shift()#: Tests the shift correction

test_bs_in_memory()#: Tests the background subtraction function with data in memory

test_bs_mean_on_disk()#: Tests the correct subtraction of the background with data on disk and mean method

test_bs_median_on_disk()#: Tests the correct subtraction of the background with data on disk and median method

test_bs_on_disk()#: Tests the background subtraction function with data on disk

test_compute_rsm_in_memory()#: Tests fitting data in memory

test_data_load()#: Tests the correct load of the data

test_deepcopy()#: Tests the correct deepcopy of the object

test_filter_data()#: Tests the correct separation of empty frames and data frames

test_find_shift()#: Tests the shift detection

test_hp_in_memory()#: Tests the hot pixel removal function with data in memory

test_hp_on_disk()#: Tests the hot pixel removal function with data on disk

test_nframes()#: Tests the nframes method

test_nica_in_memory()#: Tests NICA with data in memory

test_nica_on_disk()#: Tests NICA with data on disk

test_nmf_in_memory()#: Tests NMF with data in memory

test_nmf_on_disk()#: Tests NMF with data on disk

test_pca_in_memory()#: Tests PCA with data in memory

test_pca_on_disk()#: Tests PCA with data on disk

test_recover_weak_beam_in_memory()#: Tests the recover weak beam function with data in memory Consider that threshold removal is already well tested

test_recover_weak_beam_on_disk()#: Tests the threshold removal function with data on disk

test_roi_bs_in_memory()#: Tests the background subtraction function with data on disk

test_roi_bs_on_disk()#: Tests the background subtraction function with data on disk

test_roi_hp_in_memory()#: Tests the background subtraction function with data on disk

test_roi_hp_on_disk()#: Tests the background subtraction function with data on disk

test_roi_in_memory()#: Tests the roi function with data in memory

test_roi_on_disk()#: Tests the roi function with data on disk

test_roi_threshold_in_memory()#: Tests the threshold removal function with data in memory

test_roi_threshold_on_disk()#: Tests the threshold removal function with data on disk

test_threshold_in_memory()#: Tests the threshold removal function with data in memory

test_threshold_on_disk()#: Tests the threshold removal function with data on disk

test_zsum_in_memory()#

test_zsum_on_disk()#