Metadata-Version: 2.1
Name: dm4
Version: 1.0.1
Summary: A Digital Micrograph 4 (DM4) file reader.
Author-email: James Anderson <james.r.anderson@utah.edu>
Description-Content-Type: text/x-rst
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Dist: numpy ; extra == "test"
Project-URL: Home, https://github.com/nornir/dm4
Project-URL: Issues, https://github.com/nornir/dm4/issues
Provides-Extra: test

#########
dm4reader
#########

A simple pure python file reader for Digital Micrograph's DM4 file format

This package would not have been possible without the documentation provided by Dr Chris Boothroyd at http://www.er-c.org/cbb/info/dmformat/ Thank you.

#######
Example
#######
   
Below is a short example of reading the image data from a dm4 file.  A more complete example can be found in the tests.::

   import dm4

   dm4data = dm4.DM4File.open("sample.dm4")

   tags = dm4data.read_directory()

   image_data_tag = tags.named_subdirs['ImageList'].unnamed_subdirs[1].named_subdirs['ImageData']
   image_tag = image_data_tag.named_tags['Data']
   
   XDim = dm4data.read_tag_data(image_data_tag.named_subdirs['Dimensions'].unnamed_tags[0])
   YDim = dm4data.read_tag_data(image_data_tag.named_subdirs['Dimensions'].unnamed_tags[1])
   
   np_array = np.array(dm4data.read_tag_data(image_tag), dtype=np.uint16)
   np_array = np.reshape(np_array, (YDim, XDim))
   
   output_fullpath = "sample.tif"
   image = PIL.Image.fromarray(np_array, 'I;16')
   image.save(output_fullpath)        

####
Todo
####

Reading arrays of groups has not been implemented.

