11. raw

This module is used to read/write raw binary data.

11.1. Overview

load_raw(fn[, size, dtype])	Load a raw binary file.
save_raw(fn, x[, append_info, compress])	Write a raw binary file.

11.2. Example Usage

fn = ilpm.raw.dump_raw('test', my_array)
print "Saved to: %s"

loaded_array = iplm.raw.open_raw(fn)
print "Loaded from: %s" % fn

11.3. Functions

ilpm.raw.load_raw(fn, size=None, dtype=None)

Load a raw binary file. The size and datatype of the array will be determined automatically if specified correctly in the name of the file, for example: my_array.float64.100x100x200.bin, which corresponds to 100x100x200 array of double precision floats. Note that the index ordering is “C” style; the fast axis is last.

Optionally, the binary file may be zipped, in which case the extension should be ".zip".

Parameters

sizetuple (optional)

dtypestring (optional)

The size and data type (numpy format).Should be specified if the file name is not in the required format.

Returns

arraynumpy array

ilpm.raw.save_raw(fn, x, append_info=True, compress=False)

Write a raw binary file.

Parameters

fnstring

The filename base. If append_info is False, it is recommended not to include an extension.

arraynumpy array

The data to save.

append_infobool (default: True)

If true, appends the shape, data type, and ".bin" to the file name.

compressbool (default: False)

Puts the resulting file in a zip archive. Not recommended unless data is exptected to compress well (e.g., a sparse array). Appends ".zip" to the final file name.

Returns

filenamestring

The complete file name, including added info.

class ilpm.raw.TestCases(methodName='runTest')

Bases: unittest.case.TestCase

Methods

__call__(self, \*args, \*\*kwds)	Call self as a function.
addCleanup(self, function, \*args, \*\*kwargs)	Add a function, with arguments, to be called when the test is completed.
addTypeEqualityFunc(self, typeobj, function)	Add a type specific assertEqual style function to compare a type.
assertAlmostEqual(self, first, second[, …])	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.
assertCountEqual(self, first, second[, msg])	An unordered sequence comparison asserting that the same elements, regardless of order.
assertDictContainsSubset(self, subset, …)	Checks whether dictionary is a superset of subset.
assertEqual(self, first, second[, msg])	Fail if the two objects are unequal as determined by the ‘==’ operator.
assertFalse(self, expr[, msg])	Check that the expression is false.
assertGreater(self, a, b[, msg])	Just like self.assertTrue(a > b), but with a nicer default message.
assertGreaterEqual(self, a, b[, msg])	Just like self.assertTrue(a >= b), but with a nicer default message.
assertIn(self, member, container[, msg])	Just like self.assertTrue(a in b), but with a nicer default message.
assertIs(self, expr1, expr2[, msg])	Just like self.assertTrue(a is b), but with a nicer default message.
assertIsInstance(self, obj, cls[, msg])	Same as self.assertTrue(isinstance(obj, cls)), with a nicer default message.
assertIsNone(self, obj[, msg])	Same as self.assertTrue(obj is None), with a nicer default message.
assertIsNot(self, expr1, expr2[, msg])	Just like self.assertTrue(a is not b), but with a nicer default message.
assertIsNotNone(self, obj[, msg])	Included for symmetry with assertIsNone.
assertLess(self, a, b[, msg])	Just like self.assertTrue(a < b), but with a nicer default message.
assertLessEqual(self, a, b[, msg])	Just like self.assertTrue(a <= b), but with a nicer default message.
assertListEqual(self, list1, list2[, msg])	A list-specific equality assertion.
assertLogs(self[, logger, level])	Fail unless a log message of level level or higher is emitted on logger_name or its children.
assertMultiLineEqual(self, first, second[, msg])	Assert that two multi-line strings are equal.
assertNotAlmostEqual(self, 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.
assertNotEqual(self, first, second[, msg])	Fail if the two objects are equal as determined by the ‘!=’ operator.
assertNotIn(self, member, container[, msg])	Just like self.assertTrue(a not in b), but with a nicer default message.
assertNotIsInstance(self, obj, cls[, msg])	Included for symmetry with assertIsInstance.
assertNotRegex(self, text, unexpected_regex)	Fail the test if the text matches the regular expression.
assertRaises(self, expected_exception, …)	Fail unless an exception of class expected_exception is raised by the callable when invoked with specified positional and keyword arguments.
assertRaisesRegex(self, expected_exception, …)	Asserts that the message in a raised exception matches a regex.
assertRegex(self, text, expected_regex[, msg])	Fail the test unless the text matches the regular expression.
assertSequenceEqual(self, seq1, seq2[, msg, …])	An equality assertion for ordered sequences (like lists and tuples).
assertSetEqual(self, set1, set2[, msg])	A set-specific equality assertion.
assertTrue(self, expr[, msg])	Check that the expression is true.
assertTupleEqual(self, tuple1, tuple2[, msg])	A tuple-specific equality assertion.
assertWarns(self, expected_warning, \*args, …)	Fail unless a warning of class warnClass is triggered by the callable when invoked with specified positional and keyword arguments.
assertWarnsRegex(self, expected_warning, …)	Asserts that the message in a triggered warning matches a regexp.
debug(self)	Run the test without collecting errors in a TestResult
doCleanups(self)	Execute all cleanup functions.
fail(self[, msg])	Fail immediately, with the given message.
failureException	alias of builtins.AssertionError
setUp(self)	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(self)	Returns a one-line description of the test, or None if no description has been provided.
skipTest(self, reason)	Skip this test.
subTest(self[, 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(self)	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.

assertAlmostEquals
assertDictEqual
assertEquals
assertNotAlmostEquals
assertNotEquals
assertNotRegexpMatches
assertRaisesRegexp
assertRegexpMatches
assert_
countTestCases
defaultTestResult
failIf
failIfAlmostEqual
failIfEqual
failUnless
failUnlessAlmostEqual
failUnlessEqual
failUnlessRaises
id
run
test_compressed
test_not_compressed

setUp(self)

Hook method for setting up the test fixture before exercising it.

tearDown(self)

Hook method for deconstructing the test fixture after testing it.