DASCore (0.1.21.dev164)
Introduction
Tutorial
Recipes
Notes
Contributing
API
dascore
io
core
ScanPayload
dascore
version
compat
array
decimate
is_array
is_array_like
resample
resample_poly
config
DascoreConfig
config_attr
config_context
get_config
reset_config
set_config
constants
ExecutorType
map
core
_spool_inventory
PlacedRow
RowEpochs
acquisition_conflicts
attr_owner
check_stampable
combine_inventories
drops_samples
get_attr_values
get_coord_values
get_interrogator
glob_filter
is_unset
map_axis_coords
match_resolved
normalize_enrich_kwargs
readable_on
refuse_rows
report_unconformed
resolution_columns
resolve_channel_pieces
resolve_contexts
resolve_row_epochs
resolve_split_pieces
stated_channels
unsubdividable
validate_enrich_selection
InventoryRef
resolve
attrs
PatchAttrs
drop
drop_private
flat_dump
from_dict
get
items
reject_coordinate_attributes
update
coordmanager
get_coord_manager
CoordManager
convert_units
coord_range
coord_size
decimate
disassociate_coord
drop_coords
drop_disassociated_coords
drop_private_coords
equals
flip
get_array
get_axis
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
validate_data
coords
concat_coords
ensure_consistent_dtype
get_compatible_values
get_coord
BaseCoord
align_to
approx_equal
change_length
check_time_units
convert_units
coord_range
empty
fingerprint
get_discontinuities
get_next_index
get_sample_count
get_slice_tuple
index
max
min
new
order
reduce_coord
select
set_units
simplify
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
update
update_limits
CoordRange
change_length
check_time_units
convert_units
select
sort
update_limits
validate_start_stop_step_len
CoordSegmented
check_time_units
convert_units
from_array
get_discontinuities
new
select
set_units
simplify
snap
sort
update_limits
CoordString
check_time_units
convert_units
coord_range
select
set_units
sort
to_summary
update_limits
CoordSummary
get_correct_dtype_cast_values
to_coord
inventory
Cable
Channel
Connector
CouplingCondition
CreationInfo
Enclosure
ExternalResource
FiberSegment
Interrogator
InventoryNames
OpticalMeasurement
OpticalPathAnnotation
ResolvedContext
Response
Splice
Terminator
Acquisition
channel_to_distance
CoordinateReferenceSystem
axis_index
DistanceMap
map_to_distance
source_values
FiberArray
check
Geometry
interpolate
Inventory
check
from_yaml
get_names
get_resource
replace
resolve
to_yaml
Network
check
OpticalPath
check
component_intervals
coordinates_at
reverse
select
split_at
Station
check
inventory_loader
carries_inventory
find_inventory
inventory
load_directory
patch
Patch
flat_dump
get_patch_name
spool
spool
Spool
attach_inventory
chunk
chunk_plan
concatenate
conform_to_inventory
enrich
expand_by
from_directory
from_file
get_contents
map
remove_inventory
select
sort
split
unselect
update
summary
normalize_source_patch_id
PatchSummary
dump_structured
flat_dump
from_patch
get_coord_summary
examples
chirp
deformation_rate_event_1
delta_patch
dispersion_event
diverse_spool
example_event_1
example_event_2
febus_dss_mine_1
febus_dss_mine_2
forge_dss
forge_dts
get_example_patch
get_example_spool
inventory_patch_pair
nd_patch
patch_with_null
random_directory_spool
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
DASCorePluginError
DASVaderCompatibilityError
DependencyError
FilterValueError
IncompatiblePatchError
InvalidFiberFileError
InvalidFiberIOError
InvalidFileHandlerError
InvalidIndexError
InvalidIndexVersionError
InvalidInventoryError
InvalidModelTagError
InvalidSpoolError
InvalidSpoolQueryError
InvalidTimeRangeError
MissingOptionalDependencyError
MissingPatchError
ParameterError
PatchAttributeError
PatchBroadcastError
PatchConversionError
PatchCoordinateError
PatchError
RemoteCacheError
TimeError
UnitError
UnknownExampleError
UnknownFiberFormatError
UnresolvedPatchError
UnsupportedKeywordError
io
PatchIO
ai4eps
utils
core
AI4EPSPatchAttrs
AI4EPSV1
get_format
read
scan
ap_sensing
utils
core
APSensingPatchAttrs
APSensingV10
get_format
read
scan
core
ScanPayload
get_format
is_directory_format
make_scan_payload
read
scan
scan_payloads
scan_to_df
write
FiberIO
get_format
get_supported_io_table
read
scan
write
dasdae
utils
_compat
strip_legacy_coord_fields
translate_legacy_attrs
core
DASDAEV1
get_format
read
scan
write
dashdf5
utils
core
DASHDF5
get_format
read
scan
dasvader
utils
core
DASVaderV1
get_format
read
scan
febus
a1utils
g1utils
t1utils
core
Febus2
FebusBOTDRStrainAttrs
FebusMTXAttrs
FebusPatchAttrs
Febus1
get_format
read
scan
FebusBSLH5V1
get_format
read
scan
FebusG1CSV1
get_format
read
scan
FebusMTXH5V1
get_format
read
scan
FebusT1V1
get_format
read
scan
gdr
utils_das
core
GDRPatchAttrs
GDR_V1
get_format
read
scan
h5simple
utils
core
H5Simple
get_format
read
scan
hdas
utils
core
HDASV2
HDASV1
get_format
read
scan
index
backend
adapt_params
get_backend
SQLiteIndexBackend
attr_names
attr_stated_ids
attr_units
close
coord_dims_map
coord_meta
coord_names
count
delete_sources
export_records
get_metadata
get_sources
mark_initial_update_done
move_sources
query
query_ids
renumber_ordinals_by_time
source_stats
write_sources
catalog
apply_exact_residuals
CompositeResolver
absorb
live_entries
plan_entries
resolve
FileResolver
live_entries
resolve
LiveResolver
live_entries
resolve
PatchCatalog
add
attr_names
close
coord_names
from_directory
from_file
from_patches
get_metadata
get_patch
order_by
ordered_ids
remove
resolve_row
restrict
select
sources
to_df
transfer_is_lossy
union
update
window
PatchResolver
resolve
indexer
DBDirectoryIndexer
close
ensure_updated
update
ingest
CoordRecord
PatchRecord
SourceRecord
TypedValue
assemble_source_records
attr_column_name
dump_path_attrs
hive_path_attrs
hive_typed_attrs
patch_record
sanitize_attr_name
summaries_to_records
typed_value
planned
collapse_working_df
derived_catalog
PlanResolver
live_entries
plan_entries
resolve
query
Query
apply_residuals
build_attr_clause
build_coord_clause
build_sql
evaluate_attr_predicate
glob_to_regex
resolve_query
schema
AttrMetaRow
AttrsRow
CoordDefRow
MetaDataRow
PatchCoordRow
PatchRow
SourceRow
add_column_sql
create_table_sql
glob_expr
quote
mseed
utils
core
MSeedV3
MSeedV2
get_format
read
scan
netcdf
core
NetCDFCFV18
get_format
read
scan
write
utils
get_cf_version
get_coord_manager_for_coordless_data_var
get_xarray_data_var_name
is_netcdf4_file
parse_cf_version
neubrex
utils_das
utils_rfs
core
NeubrexDASPatchAttrs
NeubrexRFSPatchAttrs
NeubrexDASV1
get_format
read
scan
NeubrexRFSV1
get_format
read
scan
odh4
utils
core
ODH4PatchAttrs
ODH4V1
get_format
read
scan
optodas
utils
core
OptoDASPatchAttrs
OptoDASV11
OptoDASV8
OptoDASV9
OptoDASV10
get_format
read
scan
pickle
core
PickleIO
get_format
read
write
prodml
core
ProdMLV2_0
get_format
read
scan
ProdMLV2_1
write
utils
ProdMLFbePatchAttrs
ProdMLRawPatchAttrs
rsf
core
RSFV1
write
segy
core
SegyV0_100
SegyV1_0
SegyV2_0
SegyV2_1
SegyV0_0
get_format
read
scan
write
utils
twos_comp
sentek
utils
core
SentekV5
get_format
read
scan
silixah5
utils
core
SilixaH5V2
SilixaPatchAttrs
SilixaH5V1
get_format
read
scan
sintela
utils
core
SintelaPatchAttrs
SintelaBinaryV3
get_format
read
scan
SintelaProtobufV1
get_format
read
scan
protobuf_utils
EnvelopeRecord
ParsedMeta
SintelaProtobufAttrs
get_supported_family_tag
read_payload
scan_payload
BandMetadata
decode
from_parsed
scan
FFTMetadata
decode
from_parsed
TimeseriesMetadata
decode
decode_stream
from_parsed
sr4731
core
SR4731V200
get_format
read
scan
utils
Block
SR4731PatchAttrs
tdms
core
TDMSFormatterV4713
get_format
read
scan
utils
parse_time_stamp
type_not_supported
terra15
utils
core
Terra15FormatterV5
Terra15FormatterV6
Terra15FormatterV4
get_format
read
scan
utils
build_patches
convert_attr_units
get_attr_names
get_exact_coord
wav
core
WavIO
write
xml_binary
core
BinaryPatchAttrs
XMLBinaryV1
get_format
read
scan
utils
XMLBinaryInfo
XMLLaserZones
models
types
base
sensible_model_equals
sensible_model_hash
values_equal
DascoreBaseModel
get_summary_df
new
InventoryModel
get_summary_df
new
TimeRangedModel
get_summary_df
is_effective_at
overlaps
registry
check_tag_matches
get_model_tag
register_model
registered_models
resolve_model_tag
resolve_tagged_model
proc
aggregate
aggregate
all
any
first
last
max
mean
median
min
std
sum
align
align_to_coord
basic
abs
angle
bool_patch
conj
demean
demedian
dropna
equals
fillna
flip
full
imag
normalize
pad
pipe
real
roll
set_dims
standardize
update
update_attrs
where
coords
add_distance_to
append_dims
coords_from_df
drop_coords
drop_private_coords
get_array
get_axis
get_coord
make_broadcastable_to
order
rename_coords
select
snap_coords
sort_coords
split_gaps
squeeze
transpose
unselect
update_coords
correlate
correlate
correlate_shift
detrend
detrend
filter
gaussian_filter
median_filter
notch_filter
pass_filter
savgol_filter
slope_filter
sobel_filter
hampel
hampel_filter
inventory
enrich
mute
line_mute
slope_mute
resample
decimate
interpolate
resample
rolling
rolling
taper
taper
taper_range
units
convert_units
set_units
simplify_units
whiten
whiten
wiener
wiener_filter
transform
_kurtosis_kernels
_taup_kernels
differentiate
differentiate
dispersion
dispersion_phase_shift
fbe
fbe
fourier
dft
idft
istft
stft
hilbert
envelope
hilbert
phase_weighted_stack
integrate
integrate
kurtosis
kurtosis
stalta
stalta
strain
radians_to_strain
velocity_to_strain_rate
velocity_to_strain_rate_edgeless
taup
tau_p
units
assert_dtype_compatible_with_units
convert_units
get_byte_count
get_factor_and_unit
get_filter_units
get_inverted_quant
get_quantity
get_quantity_str
get_registry
get_unit
invert_quantity
is_data_size
is_percent
maybe_convert_percent_to_fraction
quant_sequence_to_quant_array
utils
models
plotting
signal
array
apply_array_func
apply_ufunc
convert_bytes_to_strings
convert_strings_to_bytes
hash_array
is_string_byte_serializable_array
patch_array_function
patch_array_ufunc
PatchUFunc
accumulate
reduce
array_api
array_namespace
asarray_like
backend_name
is_foreign
is_numpy
namespace_name
to_numpy
warn_numpy_fallback
attrs
combine_patch_attrs
validate_conflict
chunk
get_intervals
chunk_plan
ChunkPlan
build_chunk_plan
build_subdivision_plan
samples_adjusted_envelopes
subdivision_pieces
coordmanager
merge_coord_managers
deprecate
deprecate
display
array_to_text
attrs_to_text
get_dascore_text
get_nice_text
docs
compose_docstring
format_dtypes
get_docstring
get_plugin_table
objs_to_doc_df
downloader
fetch
get_fetcher
get_registry_df
gaps
get_gap_edges
is_monotonic_and_finite
hdf5
encode_h5_strings
extract_h5_attrs
get_h5py_file
h5_matches_structure
open_h5_resource
unpack_scalar_h5_dataset
H5Reader
get_handle
H5Writer
get_handle
LocalH5Reader
get_handle
imports
lazy_import
intervals
clip_intervals
interval_masks
intervals_overlap
normalize_value
value_kind
io
ensure_local_file
get_handle_from_resource
obspy_to_patch
patch_to_obspy
patch_to_xarray
release_handle
xarray_to_patch
BinaryReader
get_handle
BinaryWriter
get_handle
IOResourceManager
clear_cache
close_all
get_resource
LocalBinaryReader
get_handle
LocalPath
get_handle
TextReader
get_handle
TextWriter
get_handle
jit
maybe_numba_jit
mapping
FrozenDict
new
misc
all_close
all_diffs_close_enough
broadcast_for_index
cached_method
check_code
check_filter_kwargs
check_filter_range
check_filter_sequence
deep_equality_check
express_range_for_coord
get_2d_line_intersection
get_buffer_size
get_middle_value
get_parent_code_name
get_stencil_coefs
is_range
is_strictly_monotonic
iterate
maybe_get_items
maybe_mem_map
optional_import
order_range_tuple
register_func
sanitize_range_param
suppress_warnings
to_object_array
to_str
tukey_fence
unbyte
validate_acquisition_key
validate_warn_level
warn_or_raise
yield_sub_sequences
moving
move_max
move_mean
move_median
move_min
move_std
move_sum
moving_window
namespace
PatchNameSpace
SpoolNameSpace
NamespaceOwner
get_registered_namespaces
patch
align_patch_coords
check_coords
check_dims
check_patch_attrs
check_patch_coords
concatenate_patches
get_dim_axis_value
get_dim_sampling_rate
get_patch_names
get_patch_window_size
get_start_stop_step
get_window_axis_step
merge_compatible_coords_attrs
merge_patches
patch_function
patches_to_df
stack_patches
swap_kwargs_dim_to_axis
patch_assembly
PatchAssembler
paths
coerce_to_local_path
coerce_to_upath
directory_writable
get_path_protocol
is_local_path
is_memory_uri
is_pathlike
parse_hive_path_attrs
quote_path
requires_local_directory
pd
adjust_segments
dataframe_to_patch
drop_selector_names
fill_defaults_from_pydantic
filter_df
get_dim_names_from_columns
get_interval_columns
get_regex
iter_rows
list_ser_to_str
normalize_range_forms
patch_to_dataframe
present_units_columns
relative_offset
relative_ranges_to_absolute
requested_selector_names
resolve_selector_namespaces
rolling_df
selector_spec_names
split_df_query
yield_range_tuple_from_kwargs
plugins
get_entry_point_loaders
maybe_load_entry_point
progress
get_progress_instance
get_track_length
track
validate_progress_level
remote_io
clear_remote_file_cache
ensure_local_file
get_local_handle
get_remote_cache_path
get_remote_cache_scope
is_no_range_http_error
normalize_remote_id
pause_gc
remote_cache_scope
resume_gc
suppress_gc_pause_warning
tables
ordered_rows
parse_cell
read_table
require_columns
require_stated
row_cells
time
dtype_time_like
is_datetime64
is_timedelta64
saturate_add
saturate_subtract
to_datetime64
to_float
to_int
to_timedelta64
transformatter
FourierTransformatter
BaseTransformatter
rename_dims
xml
xml_to_dict
viz
VizPatchNameSpace
map_fiber
map_fiber
specplot
specplot
spectrogram
spectrogram
waterfall
waterfall
wiggle
wiggle
warnings
DASCoreWarning
NumpyFallbackWarning
On this page
ScanPayload
Edit this page
dascore
io
core
ScanPayload
ScanPayload
class
of
dascore.io.core
inherits from: dict
source
The structured payload contract returned by
FiberIO.scan()
.
core
get_format