Python API
The MsPASS Python API is organized into the following modules.
- mspasspy.algorithms
- MCXcorStacking
- MTPowerSpectrumEngine
- RFdeconProcessor
RFdecon()RFdeconProcessorRFdeconProcessor.QCMetrics()RFdeconProcessor.actual_output()RFdeconProcessor.apply()RFdeconProcessor.change_parameters()RFdeconProcessor.dwinRFdeconProcessor.ideal_output()RFdeconProcessor.inverse_filter()RFdeconProcessor.loaddata()RFdeconProcessor.loadnoise()RFdeconProcessor.loadwavelet()RFdeconProcessor.nwinRFdeconProcessor.uses_noise
- basic
- bundle
- edit
AddAdd2ChangeKeyDivideDivide2ExecutionerFiringSquadIntegerDivideIntegerDivide2MetadataDefinedMetadataEQMetadataGEMetadataGTMetadataIntervalMetadataLEMetadataLTMetadataNEMetadataOperatorMetadataOperatorChainMetadataUndefinedModMod2MultiplyMultiply2SetValueSubtractSubtract2erase_metadata()
- resample
- signals
- snr
- window
- mspasspy.ccore
- utility
AntelopePfAtomicTypeBasicMetadataBasicProcessingHistoryErrorLoggerErrorSeverityLogDataMDDefFormatMDtypeMetadataMetadata.Metadata_keyIteratorMetadata.append_chain()Metadata.change_key()Metadata.clear_modified()Metadata.erase()Metadata.get()Metadata.get_bool()Metadata.get_double()Metadata.get_long()Metadata.get_string()Metadata.is_defined()Metadata.keys()Metadata.modified()Metadata.put()Metadata.put_bool()Metadata.put_double()Metadata.put_long()Metadata.put_string()Metadata.todict()Metadata.type()
MetadataDefinitionsMetadataDefinitions.add()MetadataDefinitions.add_alias()MetadataDefinitions.aliases()MetadataDefinitions.apply_aliases()MetadataDefinitions.clear_aliases()MetadataDefinitions.collection()MetadataDefinitions.concept()MetadataDefinitions.has_alias()MetadataDefinitions.is_alias()MetadataDefinitions.is_defined()MetadataDefinitions.is_normalized()MetadataDefinitions.keys()MetadataDefinitions.normalize_data()MetadataDefinitions.readonly()MetadataDefinitions.set_readonly()MetadataDefinitions.set_writeable()MetadataDefinitions.type()MetadataDefinitions.unique_id_key()MetadataDefinitions.unique_name()MetadataDefinitions.writeable()
Metadata_typedefMsPASSErrorNodeDataProcessingHistoryProcessingHistory.accumulate()ProcessingHistory.add_many_inputs()ProcessingHistory.add_one_input()ProcessingHistory.clear_history()ProcessingHistory.created_by()ProcessingHistory.current_nodedata()ProcessingHistory.elogProcessingHistory.get_nodes()ProcessingHistory.id()ProcessingHistory.inputs()ProcessingHistory.is_empty()ProcessingHistory.is_origin()ProcessingHistory.is_raw()ProcessingHistory.is_saved()ProcessingHistory.is_volatile()ProcessingHistory.map_as_saved()ProcessingHistory.new_ensemble_process()ProcessingHistory.new_map()ProcessingHistory.newid()ProcessingHistory.number_inputs()ProcessingHistory.number_of_stages()ProcessingHistory.set_as_origin()ProcessingHistory.set_as_raw()ProcessingHistory.set_id()ProcessingHistory.stage()
ProcessingStatusSphericalCoordinatealgorithm_history()algorithm_outputs()dmatrixerror_says_data_bad()error_severity()error_severity_string()get_mdlist()pfread()
- seismic
- algorithms
- basic
- amplitudes
- deconvolution
CNR3CDeconCNR3CDecon.QCMetrics()CNR3CDecon.actual_output()CNR3CDecon.change_parameters()CNR3CDecon.data_noise_spectrum()CNR3CDecon.data_spectrum()CNR3CDecon.ideal_output()CNR3CDecon.inverse_wavelet()CNR3CDecon.loaddata()CNR3CDecon.loadnoise_data()CNR3CDecon.loadnoise_wavelet()CNR3CDecon.loadwavelet()CNR3CDecon.process()CNR3CDecon.wavelet_noise_spectrum()CNR3CDecon.wavelet_spectrum()
DoubleVectorFFTDeconOperatorLeastSquareDeconMTPowerSpectrumEngineMultiTaperSpecDivDeconMultiTaperSpecDivDecon.QCMetrics()MultiTaperSpecDivDecon.actual_output()MultiTaperSpecDivDecon.changeparameter()MultiTaperSpecDivDecon.get_number_tapers()MultiTaperSpecDivDecon.get_taperlen()MultiTaperSpecDivDecon.get_time_bandwidth_product()MultiTaperSpecDivDecon.inverse_wavelet()MultiTaperSpecDivDecon.load()MultiTaperSpecDivDecon.loadnoise()MultiTaperSpecDivDecon.process()
MultiTaperXcorDeconMultiTaperXcorDecon.QCMetrics()MultiTaperXcorDecon.actual_output()MultiTaperXcorDecon.changeparameter()MultiTaperXcorDecon.get_number_tapers()MultiTaperXcorDecon.get_taperlen()MultiTaperXcorDecon.get_time_bandwidth_product()MultiTaperXcorDecon.inverse_wavelet()MultiTaperXcorDecon.load()MultiTaperXcorDecon.loadnoise()MultiTaperXcorDecon.process()
ScalarDeconWaterLevelDeconcircular_shift()
- utility
- mspasspy.client
- mspasspy.db
- client
- database
DatabaseDatabase.clean()Database.clean_collection()Database.create_collection()Database.delete_data()Database.get_collection()Database.get_response()Database.get_seed_channel()Database.get_seed_site()Database.index_mseed_FDSN()Database.index_mseed_file()Database.index_mseed_s3_continuous()Database.index_mseed_s3_event()Database.load_channel_metadata()Database.load_event()Database.load_site_metadata()Database.load_source_metadata()Database.read_data()Database.read_ensemble_data()Database.read_ensemble_data_group()Database.read_inventory()Database.save_catalog()Database.save_data()Database.save_dataframe()Database.save_ensemble_data()Database.save_ensemble_data_binary_file()Database.save_inventory()Database.save_textfile()Database.set_database_schema()Database.set_metadata_schema()Database.set_schema()Database.update_data()Database.update_ensemble_metadata()Database.update_metadata()Database.verify()
doc2md()doclist2mdlist()elog2doc()geoJSON_doc()history2doc()index_mseed_file_parallel()md2doc()parse_normlist()
- normalize
- schema
DBSchemaDefinitionDatabaseSchemaMDSchemaDefinitionMetadataSchemaSchemaBaseSchemaDefinitionBaseSchemaDefinitionBase.add()SchemaDefinitionBase.add_alias()SchemaDefinitionBase.aliases()SchemaDefinitionBase.apply_aliases()SchemaDefinitionBase.clear_aliases()SchemaDefinitionBase.concept()SchemaDefinitionBase.constraint()SchemaDefinitionBase.has_alias()SchemaDefinitionBase.is_alias()SchemaDefinitionBase.is_defined()SchemaDefinitionBase.is_normal()SchemaDefinitionBase.is_optional()SchemaDefinitionBase.is_required()SchemaDefinitionBase.is_xref_key()SchemaDefinitionBase.keys()SchemaDefinitionBase.remove_alias()SchemaDefinitionBase.required_keys()SchemaDefinitionBase.type()SchemaDefinitionBase.unique_name()SchemaDefinitionBase.xref_keys()
- mspasspy.global_history
- mspasspy.graphics
- mspasspy.history
- mspasspy.io
- mspasspy.preprocessing
- css30
DatascopeDatabasecheck_for_ambiguous_sta()extract_unique_css30_sources()find_duplicate_sta()find_null_net_stations()find_unique_sta()force_net()load_css30_arrivals()load_css30_sources()make_css30_composite_sta()parse_snetsta()set_arrival_by_time_interval()set_netcode_from_site()set_netcode_snetsta()set_netcode_time_interval()set_source_id_from_evid()
- seed
- css30
- mspasspy.reduce
- mspasspy.util
- converter
AntelopePf2dict()Metadata2dict()Pf2AttributeNameTbl()Seismogram2Stream()SeismogramEnsemble2Stream()Stream2Seismogram()Stream2SeismogramEnsemble()Stream2TimeSeriesEnsemble()Textfile2Dataframe()TimeSeries2Trace()TimeSeriesEnsemble2Stream()Trace2TimeSeries()dict2Metadata()list2Ensemble()post_ensemble_metadata()
- decorators
- Janitor
- logging_helper
- seismic
- seispp
- Undertaker
- converter
Please refer to Module Index for a complete list.