DASCore (0.1.4)
Introduction
Tutorial
Recipes
Notes
Contributing
API
dascore
io
pickle
core
PickleIO
read
dascore
version
clients
dirspool
DirectorySpool
get_contents
update
filespool
FileSpool
update
compat
array
is_array
constants
ExecutorType
map
core
schema
attrs
PatchAttrs
coords_from_dims
drop_private
flat_dump
from_dict
get
items
parse_coord_attributes
rename_dimension
update
coordmanager
get_coord_manager
CoordManager
convert_units
coord_range
coord_size
decimate
disassociate_coord
drop_coords
drop_disassociated_coords
drop_private_coords
equals
get_array
get_coord
get_coord_tuple_map
keys
make_broadcastable_to
max
min
new
order
rename_coord
select
set_dims
set_units
simplify_units
snap
sort
squeeze
step
to_summary_dict
transpose
update
update_from_attrs
validate_data
coords
ensure_consistent_dtype
get_compatible_values
get_coord
BaseCoord
align_to
approx_equal
change_length
check_time_units
convert_units
coord_range
empty
get_attrs_dict
get_next_index
get_sample_count
get_slice_tuple
index
max
min
new
order
select
set_units
simplify_units
snap
sort
to_summary
update
update_data
update_limits
CoordArray
check_time_units
convert_units
select
snap
sort
update_limits
validate_start_stop_step_len
CoordMonotonicArray
check_time_units
select
validate_start_stop_step_len
CoordPartial
change_length
check_time_units
convert_units
order
select
sort
to_summary
CoordRange
change_length
check_time_units
convert_units
select
sort
update_limits
validate_start_stop_step_len
CoordSummary
get_correct_dtype_cast_values
ser_model
to_coord
patch
Patch
assign_coords
iresample
iselect
spool
MemorySpool
spool
BaseSpool
chunk
concatenate
get_contents
map
select
sort
split
update
DataFrameSpool
chunk
get_contents
new_from_df
select
sort
split
examples
chirp
deformation_rate_event_1
dispersion_event
diverse_spool
example_event_1
example_event_2
forge_dss
forge_dts
get_example_patch
get_example_spool
patch_with_null
random_patch
random_patch_lat_lon
random_patch_xyz
random_spool
ricker_moveout
sin_wave_patch
spool_to_directory
wacky_dim_coord_patch
exceptions
AttributeMergeError
ChunkError
CoordDataError
CoordError
CoordMergeError
CoordSortError
DASCoreError
FilterValueError
IncompatiblePatchError
InvalidFiberFileError
InvalidFiberIOError
InvalidFileHandlerError
InvalidIndexVersionError
InvalidSpoolError
InvalidTimeRangeError
MissingOptionalDependencyError
ParameterError
PatchAttributeError
PatchBroadcastError
PatchConversionError
PatchCoordinateError
PatchError
TimeError
UnitError
UnknownExampleError
UnknownFiberFormatError
UnsupportedKeywordError
io
PatchIO
ap_sensing
utils
core
APSensingPatchAttrs
APSensingV10
get_format
read
scan
core
get_format
read
scan
scan_to_df
write
FiberIO
get_format
get_supported_io_table
read
scan
write
PatchFileSummary
flat_dump
translate_d_to_step
dasdae
utils
core
DASDAEV1
get_format
index
read
scan
write
dashdf5
utils
core
ProdMLPatchAttrs
DASHDF5
get_format
read
scan
febus
utils
core
Febus2
FebusPatchAttrs
Febus1
get_format
read
scan
h5simple
utils
core
H5Simple
get_format
read
scan
indexer
AbstractIndexer
update
DirectoryIndexer
clear_cache
get_contents
get_index_metadata
update
neubrex
utils_das
utils_rfs
core
NeubrexDASPatchAttrs
NeubrexRFSPatchAttrs
NeubrexDASV1
get_format
read
scan
NeubrexRFSV1
get_format
read
scan
optodas
utils
core
OptoDASPatchAttrs
OptoDASV8
get_format
read
scan
pickle
core
PickleIO
get_format
read
write
prodml
utils
core
ProdMLPatchAttrs
ProdMLV2_1
ProdMLV2_0
get_format
read
scan
rsf
core
RSFV1
write
segy
utils
core
SegyV2
get_format
read
scan
sentek
utils
core
SentekV5
get_format
read
scan
silixah5
utils
core
SilixaPatchAttrs
SilixaH5V1
get_format
read
scan
tdms
core
TDMSFormatterV4713
get_format
read
scan
utils
parse_time_stamp
type_not_supported
terra15
utils
core
Terra15FormatterV5
Terra15FormatterV6
Terra15FormatterV4
get_format
read
scan
wav
core
WavIO
write
xml_binary
core
BinaryPatchAttrs
XMLBinaryV1
get_format
read
scan
utils
XMLBinaryInfo
XMLLaserZones
proc
aggregate
aggregate
first
last
max
mean
median
min
std
sum
basic
abs
angle
apply_operator
conj
dropna
equals
fillna
imag
normalize
pad
pipe
real
roll
set_dims
standardize
update
update_attrs
coords
add_distance_to
append_dims
coords_from_df
drop_coords
drop_private_coords
get_array
get_coord
make_broadcastable_to
order
rename_coords
select
snap_coords
sort_coords
squeeze
transpose
update_coords
correlate
correlate
correlate_shift
detrend
detrend
filter
gaussian_filter
median_filter
notch_filter
pass_filter
savgol_filter
slope_filter
sobel_filter
resample
decimate
interpolate
resample
rolling
rolling
taper
taper
taper_range
units
convert_units
set_units
simplify_units
whiten
whiten
transform
differentiate
differentiate
dispersion
dispersion_phase_shift
fft
rfft
fourier
dft
idft
integrate
integrate
spectro
spectrogram
strain
velocity_to_strain_rate
velocity_to_strain_rate_edgeless
taup
tau_p
units
assert_dtype_compatible_with_units
convert_units
get_factor_and_unit
get_filter_units
get_inverted_quant
get_quantity
get_quantity_str
get_registry
get_unit
invert_quantity
utils
plotting
attrs
combine_patch_attrs
decompose_attrs
separate_coord_info
chunk
get_intervals
ChunkManager
chunk
get_instruction_df
coordmanager
merge_coord_managers
display
array_to_text
attrs_to_text
get_dascore_text
get_nice_text
docs
compose_docstring
format_dtypes
objs_to_doc_df
downloader
fetch
get_registry_df
hdf5
open_hdf5_file
unpack_scalar_h5_dataset
H5Reader
get_handle
H5Writer
get_handle
HDF5Reader
get_handle
HDF5Writer
get_handle
HDFPatchIndexManager
decode_table
encode_table
get_index
validate_version
write_update
io
get_handle_from_resource
obspy_to_patch
patch_to_obspy
patch_to_xarray
xarray_to_patch
BinaryReader
get_handle
BinaryWriter
get_handle
IOResourceManager
close_all
get_resource
jit
maybe_numba_jit
mapping
FrozenDict
new
misc
CacheDescriptor
MethodNameSpace
all_close
all_diffs_close_enough
broadcast_for_index
cached_method
check_filter_kwargs
check_filter_range
check_filter_sequence
get_middle_value
get_parent_code_name
get_stencil_coefs
is_valid_coord_str
iterate
maybe_get_items
optional_import
register_func
sanitize_range_param
suppress_warnings
to_object_array
to_str
unbyte
warn_or_raise
yield_sub_sequences
models
sensible_model_equals
DascoreBaseModel
get_summary_df
new
patch
align_patch_coords
check_coords
check_dims
check_patch_attrs
check_patch_coords
concatenate_patches
get_default_patch_name
get_dim_axis_value
get_dim_sampling_rate
get_start_stop_step
merge_compatible_coords_attrs
merge_patches
patch_function
patches_to_df
scan_patches
stack_patches
pd
adjust_segments
dataframe_to_patch
fill_defaults_from_pydantic
filter_df
get_column_names_from_dim
get_dim_names_from_columns
get_interval_columns
get_regex
list_ser_to_str
patch_to_dataframe
rolling_df
split_df_query
yield_range_tuple_from_kwargs
progress
get_progress_instance
track
time
dtype_time_like
get_max_min_times
is_datetime64
is_timedelta64
to_datetime64
to_float
to_int
to_timedelta64
transformatter
FourierTransformatter
BaseTransformatter
rename_dims
xml
xml_to_dict
viz
VizPatchNameSpace
map_fiber
map_fiber
spectrogram
spectrogram
waterfall
waterfall
wiggle
wiggle
On this page
read
Edit this page
read
method
of
dascore.io.pickle.core.PickleIO
source
read
(
self ,
resource:
BinaryReader
,
**kwargs ,
)
Read a Patch/Spool from disk.
get_format
write