get_example_spool

function of dascore.examples source

get_example_spool(
    example_name = random_das,
    **kwargs ,
)-> ‘dc.BaseSpool’

Load an example Spool.

Supported example spools are:

Name Description
random_das Several random patches in the spool.
diverse_das A spool with a diverse set of patch metadata for testing.

Using an entry from the data_registry file is also supported. These include:

name
terra15_das_1_trimmed.hdf5
terra15_das_unfinished.hdf5
terra15_v5_test_file.hdf5
terra15_v6_test_file.hdf5
iDAS005_hdf5_example.626.h5
iDAS005_tdms_example.626.tdms
sample_tdms_file_v4713.tdms
example_dasdae_event_1.h5
opta_sense_quantx_v2.h5
prodml_2.0.h5
prodml_2.1.h5
h5_simple_1.h5
h5_simple_2.h5
conoco_segy_1.sgy
brady_hs_DAS_DTS_coords.csv
dispersion_event.h5
PoroTomo_iDAS_1.h5
DASDMSShot00_20230328155653619.das
opto_das_1.hdf5
whale_1.hdf5
febus_1.h5
ap_sensing_1.hdf5
silixa_h5_1.hdf5
deformation_rate_event_1.hdf5
neubrex_dss_forge.h5
neubrex_dts_forge.h5
decimated_optodas.hdf5
neubrex_das_1.h5
UoU_lf_urban.hdf5

Parameters

Parameter Description
example_name The name of the example to load. Options are:
**kwargs Passed to the corresponding functions to generate data.

Raises

(UnknownExampleError)[’dascore.examples.UnknownExampleError`] if unregistered patch is requested.