from_marock(path, voxel_size=1, project=None)[source]#

Load data from a 3DMA-Rock extracted network. This format consists of two files: ‘rockname.np2th’ and ‘rockname.th2pn’. They should be stored together in a folder which is referred to by the path argument. These files are binary and therefore not human readable.

  • path (str) – The location of the ‘np2th’ and ‘th2np’ files. This can be an absolute path or relative to the current working directory.

  • network (GenericNetwork) – If an Network object is recieved, this method will add new data to it but NOT overwrite anything that already exists. This can be used to append data from different sources.

  • voxel_size (scalar) – The resolution of the image on which 3DMA-Rock was run, in terms of the linear length of eac voxel. The default is 1. This is used to scale the voxel counts to actual dimension. It is recommended that this value be in SI units [m] to work well with OpenPNM.

  • project (Project) – A GenericNetwork is created and added to the specified Project. If no Project is supplied then one will be created and returned.