Documentation for mrcfile.py

Get started by reading the Overview of mrcfile.py and the Usage Guide.

You can also look at the Source documentation.

Table of Contents:

• Overview of mrcfile.py
  • Key Features
  • Installation
  • Basic usage
  • Documentation
  • Citing mrcfile
  • Contributing
  • Licence
• Usage Guide
  • Opening MRC files
    • Normal file access
    • Simple data access
    • Handling compressed files
    • Closing files and writing to disk
    • MrcFile subclasses
    • File modes
    • Permissive read mode
    • A note on axis ordering
  • Using MrcFile objects
    • Accessing the header and data
    • Indexing the extended header
    • Voxel size
    • Keeping the header and data in sync
    • Data dimensionality
    • Data types
  • Dealing with large files
    • Memory-mapped files
    • Asynchronous opening
  • Validating MRC files
  • Command line usage
    • Validation
    • Examining MRC headers
  • API overview
    • Class hierarchy
    • MrcFile attributes and methods
• Source documentation
  • mrcfile -- Main package
    • mrcfile
    • Members
  • Submodules
  • mrcfile.bzip2mrcfile module
    • bzip2mrcfile
    • Bzip2MrcFile
  • mrcfile.command_line module
    • command_line
    • print_headers()
  • mrcfile.constants module
    • constants
  • mrcfile.dtypes module
    • dtypes
    • get_ext_header_dtype()
  • mrcfile.future_mrcfile module
    • future_mrcfile
    • FutureMrcFile
  • mrcfile.gzipmrcfile module
    • gzipmrcfile
    • GzipMrcFile
  • mrcfile.load_functions module
    • load_functions
    • new()
    • open()
    • read()
    • write()
    • open_async()
    • mmap()
    • new_mmap()
  • mrcfile.mrcfile module
    • mrcfile
    • MrcFile
  • mrcfile.mrcinterpreter module
    • mrcinterpreter
    • MrcInterpreter
  • mrcfile.mrcmemmap module
    • mrcmemmap
    • MrcMemmap
  • mrcfile.mrcobject module
    • mrcobject
    • MrcObject
  • mrcfile.utils module
    • utils
    • Functions
    • data_dtype_from_header()
    • data_shape_from_header()
    • mode_from_dtype()
    • dtype_from_mode()
    • pretty_machine_stamp()
    • byte_order_from_machine_stamp()
    • machine_stamp_from_byte_order()
    • byte_orders_equal()
    • normalise_byte_order()
    • spacegroup_is_volume_stack()
    • is_printable_ascii()
    • printable_string_from_bytes()
    • bytes_from_string()
  • mrcfile.validator module
    • validator
    • main()
    • validate_all()
    • validate()