Main entry point for reading ZGY files. More...
Inheritance diagram for openzgy.api.ZgyReader:
Public Member Functions | |
| def | __init__ (self, filename, *_update=False, iocontext=None) |
| def | __enter__ (self) |
| def | __exit__ (self, type, value, traceback) |
| def | read (self, start, data, *lod=0, verbose=None) |
| Read bulk data into a caller specified buffer. More... | |
| def | readconst (self, start, size, *lod=0, as_float=True, verbose=None) |
| Get hint about all constant region. More... | |
| def | close (self) |
 Public Member Functions inherited from openzgy.api.ZgyMetaAndTools | |
| def | annotToIndex (self, point) |
| def | annotToWorld (self, point) |
| def | indexToAnnot (self, point) |
| def | indexToWorld (self, point) |
| def | worldToAnnot (self, point) |
| def | worldToIndex (self, point) |
| Public Member Functions inherited from openzgy.api.ZgyMeta | |
| def | __init__ (self, meta) |
| def | size (self) |
| def | datatype (self) |
| def | datarange (self) |
| def | zunitdim (self) |
| def | hunitdim (self) |
| def | zunitname (self) |
| def | hunitname (self) |
| def | zunitfactor (self) |
| def | hunitfactor (self) |
| def | zstart (self) |
| def | zinc (self) |
| def | annotstart (self) |
| def | annotinc (self) |
| def | corners (self) |
| def | indexcorners (self) |
| def | annotcorners (self) |
| def | bricksize (self) |
| def | brickcount (self) |
| def | nlods (self) |
| def | meta (self) |
| def | numthreads (self) |
| def | numthreads (self, x) |
| def | dump (self, file=None) |
| def | statistics (self) |
| def | histogram (self) |
Additional Inherited Members | |
| Static Public Member Functions inherited from openzgy.api.ZgyMetaAndTools | |
| def | transform (A, B, data) |
| def | transform1 (A, B, point) |
Detailed Description
Main entry point for reading ZGY files.
Main entry point for reading ZGY files. Obtain a concrete instance by calling the constructor. You can then use the instance to read both meta data and bulk data. It is recommended to explicitly close the file when done with it.
Member Function Documentation
◆ read()
| def openzgy.api.ZgyReader.read | ( | self, | |
| start, | |||
| data, | |||
| * | lod = 0, |
||
verbose = None |
|||
| ) |
Read bulk data into a caller specified buffer.
Read an arbitraty region of bulk data into a caller specified buffer. The buffer's type must be float, short, or char. Any file may be read as float. If the buffer is of type short or char then the file must be of precisely that type. Arguments: (i0,j0,k0), buffer, lod=0
◆ readconst()
| def openzgy.api.ZgyReader.readconst | ( | self, | |
| start, | |||
| size, | |||
| * | lod = 0, |
||
as_float = True, |
|||
verbose = None |
|||
| ) |
Get hint about all constant region.
Get hint about all constant region. Check to see if the specified region is known to have all samples set to the same value. Returns that value, or None if it isn't. The function only makes inexpensive checks so it might return None even if the region was in fact constant. It will not make the opposite mistake. This method is only intended as a hint to improve performance. For int8 and int16 files the caller may specify whether to scale the values or not.
The documentation for this class was generated from the following file:
- openzgy/api.py
