Mondaic Documentation
www.mondaic.com
Mondaic
Version:
No results found.
python_api
/
salvus
/
flow
/
collections
/
data_proxies
/
hdf5_data_proxy

salvus.flow.collections.data_proxies.hdf5_data_proxy

salvus.flow.collections.data_proxies.hdf5_data_proxy salvus flow collections data_proxies hdf5_data_proxy
HDF5 data proxy.

Classes

HDF5DataProxy

Helper class that provides a standard way to create an ABC using inheritance.
Init.
SIGNATURE
class HDF5DataProxy(salvus.flow.collections.data_proxies.BaseDataProxy):
    def __init__(self, config: dict): ...
ARGUMENTS
Required
config
Type:dict
Description:
The configuration dictionary.

Properties

  • available_fields(list[str])-The receiver fields contained in the HDF5 file.
  • contents(dict)-The contents of the file as a dictionary.

Methods

HDF5DataProxy.compute_hash()
Compute a hash to uniquely identify the data proxy.
SIGNATURE
def compute_hash(self) -> str: ...
HDF5DataProxy.get_data()
Get data for one event/shot from the HDF5 data format.
SIGNATURE
def get_data(self, event_name: str, receiver_field: str) -> xr.Dataset: ...
ARGUMENTS
Required
event_name
Type:str
Description:
The event name.
Required
receiver_field
Type:str
Description:
The receiver field to retrieve.
HDF5DataProxy.write_h5()
Write the contents to an HDF5 file.
SIGNATURE
def write_h5(self, filename: str | pathlib.Path) -> None: ...
ARGUMENTS
Required
filename
Type:str | pathlib.Path
Description:
Path to write to.
Previous
data_proxies
Next
seis_io_data_proxy
We use cookies to analyze our traffic, but won't track you until explicit consent is given. Using our contact form will create relevant cookies and transmit data to third party services to keep track of your request. Read more about how we use personal information in our Privacy Policy.
PAGE CONTENTS