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
    • Memory-mapped files
    • File modes
    • Permissive read mode
  • Using MrcFile objects
    • Accessing the header and data
    • Voxel size
    • Keeping the header and data in sync
    • Data dimensionality
    • Data types
  • Validating MRC files
  • Command line usage
    • Validation
    • Examining MRC headers
  • API overview
    • Class hierarchy
    • MrcFile attributes and methods
• Source documentation
  • mrcfile – Main package
    • mrcfile
  • Submodules
  • mrcfile.bzip2mrcfile module
    • bzip2mrcfile
  • mrcfile.command_line module
    • command_line
  • mrcfile.constants module
    • constants
  • mrcfile.dtypes module
    • dtypes
  • mrcfile.gzipmrcfile module
    • gzipmrcfile
  • mrcfile.load_functions module
    • load_functions
  • mrcfile.mrcfile module
    • mrcfile
  • mrcfile.mrcinterpreter module
    • mrcinterpreter
  • mrcfile.mrcmemmap module
    • mrcmemmap
  • mrcfile.mrcobject module
    • mrcobject
  • mrcfile.utils module
    • utils
    • Functions
  • mrcfile.validator module
    • validator