MsPASS Schema#

Many seismologists think of a database schema as the specification of tables and attributes in a relational database. The standard relational schema in seismology is CSS3.0, which is used by systems such as Antelope. In computer science, however, the term has a broader meaning: it describes the structure, types, and constraints of data. MsPASS uses that broader meaning because its primary database backend is MongoDB rather than a relational database.

This section documents the MongoDB collections and metadata keys recognized by MsPASS. Each table is generated from data/yaml/mspass.yaml during the Sphinx build, so the published tables track the same schema used by the Python database layer.

The tables below are organized in four ways:

The database collection schemas defined in the YAML Database section.
A complete alphabetical catalog of valid metadata keys and aliases.
Groups of keys that are normalized into master MongoDB collections, such as receiver and source coordinates.
Groups of keys that have a practical or conceptual relationship, such as ObsPy Trace attributes, three-component orientation metadata, and file storage metadata.

Database Collections#

These tables describe the MongoDB collections defined by the YAML schema. They include operational collections such as elog, cemetery, and abortions that are populated by the database and dead-data handling code.

wf_TimeSeries Collection#

Table 10 **wf_TimeSeries collection schema**#
key	aliases	type	constraint	reference	concept
_id		ObjectId	required		ObjectId used to define a data object
npts	nsamp : wfdisc.nsamp	int	required		Number of data samples
nbytes		int	optional		Number of bytes for storage of sample data - required for some formats
delta	dt	double	required		Data sample interval in seconds
sampling_rate		double	optional		Data sampling frequency in Hz=1/s
starttime	t0 : time	double	required		Time of first sample of data (epoch time or relative to some other time mark)
starttime_shift	t0shift	double	required		Time shift applied to define relative time of 0.0
endtime		double	optional		Time of last sample of data (epoch time or relative to some other time mark)
utc_convertible		boolean	required		When true starttime_shift can be used to convert relative time to UTC.
time_standard		string	required		Defines time standard for meaning of t0 (default should be UTC)
calib		double	normal		Nominal conversion factor for changing sample data to ground motion units.
storage_mode		string	required		The storage mode of the saved data (‘file’, ‘url’ or ‘gridfs’)
format		string	optional		The file format of the saved data (e.g., ‘MSEED’, ‘SAC’, …).
dir	file.dir : wfdisc.dir : wfprocess.dir	string	optional		Directory path to an external file (always used with dfile)
dfile	file.dfile : wfdisc.dfile : wfprocess.dfile	string	optional		External data file name.
foff	file.foff : wfdisc.foff : wfprocess.foff	int	optional		Offset in bytes from beginning of a file to first data sample.
url		string	optional		Url to external data file.
gridfs_id		ObjectId	optional		The _id of data file in the fs.files collection.
source_id		ObjectId	xref_key	source	ObjectId used to define a particular seismic source
site_id		ObjectId	xref_key	site	ObjectId used to define a particular instrument/seismic station
history_object_id		ObjectId	xref_key	history_object	ObjectId of this document - standard MongoDB attribute
elog_id		ObjectId	xref_key	elog	ObjectID used to define an unique entry in elog collection.
data_tag		string	optional		Used as a tag for data at a particular stage of processing. Used in save_data.
channel_id		ObjectId	xref_key	channel	ObjectId used to define a particular component of data

wf_Seismogram Collection#

Table 11 **wf_Seismogram collection schema**#
key	aliases	type	constraint	reference	concept
_id		ObjectId	required		ObjectId used to define a data object
npts	nsamp : wfdisc.nsamp	int	required		Number of data samples
nbytes		int	optional		Number of bytes for storage of sample data - required for some formats
delta	dt	double	required		Data sample interval in seconds
sampling_rate		double	optional		Data sampling frequency in Hz=1/s
starttime	t0 : time	double	required		Time of first sample of data (epoch time or relative to some other time mark)
starttime_shift	t0shift	double	required		Time shift applied to define relative time of 0.0
endtime		double	optional		Time of last sample of data (epoch time or relative to some other time mark)
utc_convertible		boolean	required		When true starttime_shift can be used to convert relative time to UTC.
time_standard		string	required		Defines time standard for meaning of t0 (default should be UTC)
calib		double	normal		Nominal conversion factor for changing sample data to ground motion units.
storage_mode		string	required		The storage mode of the saved data (‘file’, ‘url’ or ‘gridfs’)
format		string	optional		The file format of the saved data (e.g., ‘MSEED’, ‘SAC’, …).
dir	file.dir : wfdisc.dir : wfprocess.dir	string	optional		Directory path to an external file (always used with dfile)
dfile	file.dfile : wfdisc.dfile : wfprocess.dfile	string	optional		External data file name.
foff	file.foff : wfdisc.foff : wfprocess.foff	int	optional		Offset in bytes from beginning of a file to first data sample.
url		string	optional		Url to external data file.
gridfs_id		ObjectId	optional		The _id of data file in the fs.files collection.
source_id		ObjectId	xref_key	source	ObjectId used to define a particular seismic source
site_id		ObjectId	xref_key	site	Linking id to site collection
history_object_id		ObjectId	xref_key	history_object	ObjectId of this document - standard MongoDB attribute
elog_id		ObjectId	xref_key	elog	ObjectID used to define an unique entry in elog collection.
data_tag		string	optional		Used as a tag for data at a particular stage of processing. Used in save_data.
tmatrix		list	required		Three-component data’s transformation matrix
cardinal		boolean	required		When true the data stored are orthogonal and in cardinal (ENZ) geographic directions.
orthogonal		boolean	required		When true the transformation matrix is orthogonal (inverse can then be constructed from transpose instead of inversion).
channel_id_list		list	optional

wf_miniseed Collection#

Table 12 **wf_miniseed collection schema**#
key	aliases	type	constraint	reference	concept
_id		ObjectId	required		ObjectId used to define a data object
npts	nsamp : wfdisc.nsamp	int	required		Number of data samples
nbytes		int	required		number of bytes in a group of time ordered miniseed packets
delta	dt	double	required		Data sample interval in seconds
sampling_rate		double	optional		Data sampling frequency in Hz=1/s
starttime	t0 : time	double	required		Time of first sample of data (epoch time or relative to some other time mark)
starttime_shift	t0shift	double	required		Time shift applied to define relative time of 0.0
endtime		double	optional		Time of last sample of data (epoch time or relative to some other time mark)
utc_convertible		boolean	required		When true starttime_shift can be used to convert relative time to UTC.
time_standard		string	required		Defines time standard for meaning of t0 (default should be UTC)
calib		double	normal		Nominal conversion factor for changing sample data to ground motion units.
storage_mode		string	required		The storage mode of the saved data (‘file’, ‘url’ or ‘gridfs’)
format		string	optional		The file format of the saved data (e.g., ‘MSEED’, ‘SAC’, …).
dir	file.dir : wfdisc.dir : wfprocess.dir	string	required		Directory path to an external file (always used with dfile)
dfile	file.dfile : wfdisc.dfile : wfprocess.dfile	string	required		External data file name.
foff	file.foff : wfdisc.foff : wfprocess.foff	int	required		Offset in bytes from beginning of a file to first data sample.
url		string	optional		Url to external data file.
gridfs_id		ObjectId	optional		The _id of data file in the fs.files collection.
source_id		ObjectId	xref_key	source	ObjectId used to define a particular seismic source
site_id		ObjectId	xref_key	site	ObjectId used to define a particular instrument/seismic station
history_object_id		ObjectId	xref_key	history_object	ObjectId of this document - standard MongoDB attribute
elog_id		ObjectId	xref_key	elog	ObjectID used to define an unique entry in elog collection.
data_tag		string	optional		Used as a tag for data at a particular stage of processing. Used in save_data.
last_packet_time		double	normal		Time tag on the last packet of a contiguous block of miniseed packets
net	channel.net : network : site.net : site_net : wfdisc.net	string	normal	site	network code (net component of SEED net:sta:chan)
sta	KSTNM : channel.sta : site.sta : station : wfdisc.sta	string	normal	site	station code assigned to a spot on Earth (sta component of SEED net:sta:chan)
loc	channel.loc : location : site.loc	string	normal	channel	location code assigned to an instrument (loc component of SEED net:sta:chan)
chan	KCMPNM : channel : channel.chan : wfdisc.chan	string	normal	channel	channel name (e.g. HHZ, BHE, etc.) - normally a SEED channel code
channel_id		ObjectId	xref_key	channel	ObjectId used to define a particular component of data

site Collection#

Table 13 **site collection schema**#
key	aliases	type	constraint	reference	concept
_id		ObjectId	required		ObjectId used to define a particular instrument/seismic station
net	channel.net : network : site.net : site_net : wfdisc.net	string	normal		network code (net component of SEED net:sta:chan)
sta	KSTNM : channel.sta : site.sta : station : wfdisc.sta	string	normal		station code assigned to a spot on Earth (sta component of SEED net:sta:chan)
loc	channel.loc : location : site.loc	string	normal	channel	location code assigned to an instrument (loc component of SEED net:sta:chan)
lat	STLA : site.lat : site_lat	double	required		latitude of a seismic station/instrument in degrees
lon	STLO : site.lon : site_lon : stlo	double	required		longitude of a seismic station/instrument in degrees
elev	STEL : site.elev : site_elev : stel	double	required		elevation of a seismic station/instrument in km (subtract emplacement depth for borehole instruments)
starttime	site.starttime : site_starttime	double	normal		Time of seismic station/instrument starts recording
endtime	site.endtime : site_endtime	double	normal		Time of seismic station/instrument ends recording

channel Collection#

Table 14 **channel collection schema**#
key	aliases	type	constraint	reference	concept
_id		ObjectId	required		ObjectId used to define a particular component of data
net	channel.net : network : site.net : site_net : wfdisc.net	string	normal	site	network code (net component of SEED net:sta:chan)
sta	KSTNM : channel.sta : site.sta : station : wfdisc.sta	string	normal	site	station code assigned to a spot on Earth (sta component of SEED net:sta:chan)
loc	channel.loc : location : site.loc	string	normal		location code assigned to an instrument (loc component of SEED net:sta:chan)
chan	KCMPNM : channel : channel.chan : wfdisc.chan	string	normal		channel name (e.g. HHZ, BHE, etc.) - normally a SEED channel code
lat	channel_lat	double	required		latitude of a seismic station/instrument in degrees
lon	channel_lon	double	required		longitude of a seismic station/instrument in degrees
elev	channel_elev	double	required		elevation of a seismic station/instrument in km (subtract emplacement depth for borehole instruments)
edepth	channel_edepth	double	optional		depth of a seismic station/instrument in km
hang	CMPAZ : channel_hang	double	normal		Azimuth (in degree) of a seismometer component - horizontal angle
vang	CMPINC : channel_vang	double	normal		Inclination from +up (in degree) of a seismometer component - vertical angle
starttime	channel_starttime	double	normal		Time of channel starts recording
endtime	channel_endtime	double	normal		Time of channel ends recording

source Collection#

Table 15 **source collection schema**#
key	aliases	type	constraint	concept
_id		ObjectId	required	ObjectId used to define a particular seismic source
lat	EVLA : origin.lat : source.lat : source_lat	double	required	Latitude (in degrees) of the hypocenter of seismic source
lon	EVLO : origin.lon : source.lon : source_lon	double	required	Longitude (in degrees) of the hypocenter of seismic source
depth	EVDP : origin.depth : source.depth : source_depth	double	required	Depth (in km) of the hypocenter of seismic source
time	origin.time : source.time : source_time	double	required	Origin time of the hypocenter of seismic source (epoch time)
magnitude	MAG : source_magnitude	double	normal	Generic magnitude attribute

history_global Collection#

Table 16 **history_global collection schema**#
key	type	constraint	concept
_id	ObjectId	required	ObjectId used to define a global history object
job_id	ObjectId	required	ObjectId used to define a job
job_name	string	required	the name of the job
alg_name	string	required	the name of the algorithm
alg_id	ObjectId	required	ObjectId used to define a unique algorithm(alg_name + parameters)
parameters	string	required	the parameters of the algorithm
time	double	required	timestamp when save the global history record

history_object Collection#

Table 17 **history_object collection schema**#
key	type	constraint	reference	concept
_id	ObjectId	required		ObjectId of this document - standard MongoDB attribute
save_uuid	string	required		unique id string (UUID) of save algorithm that generated this document
save_stage	int	required		Processing stage of save process that generated this document
processing_history	bytes	required		serialized content of actual ProcessingHistory container defining full history
wf_Seismogram_id	ObjectId	xref_key	wf_Seismogram	ObjectId used to define a data object
wf_TimeSeries_id	ObjectId	xref_key	wf_TimeSeries	ObjectId used to define a data object
alg_id	ObjectId	xref_key	history_global	ObjectId used to define a unique algorithm(alg_name + parameters)
alg_name	string	required		the name of the algorithm
job_name	string	optional		Name tag assigned to a specific workflow (job)
job_id	string	optional		Instance name tag of a specific workflow (job). Added qualifier for job_name that can be used to tag multiple common runs (e.g. a parameter test set)

elog Collection#

Table 18 **elog collection schema**#
key	type	constraint	reference	concept
_id	ObjectId	required		ObjectID used to define an unique entry in elog collection.
logdata	list	required		a list of LogData entries.
wf_Seismogram_id	ObjectId	xref_key	wf_Seismogram	ObjectId used to define a data object
wf_TimeSeries_id	ObjectId	xref_key	wf_TimeSeries	ObjectId used to define a data object
wf_miniseed_id	ObjectId	xref_key	wf_miniseed	ObjectId used to define a data object
tombstone	dict	optional		a copy of the Metadata of a dead object.
data_tag	string	optional		tag used to identify the processing stage or job that generated this error log.

cemetery Collection#

Table 19 **cemetery collection schema**#
key	type	constraint	reference	concept
_id	ObjectId	required		ObjectID used to define an unique entry in elog collection.
logdata	list	required		a list of LogData entries.
wf_Seismogram_id	ObjectId	xref_key	wf_Seismogram	ObjectId used to define a data object
wf_TimeSeries_id	ObjectId	xref_key	wf_TimeSeries	ObjectId used to define a data object
wf_miniseed_id	ObjectId	xref_key	wf_miniseed	ObjectId used to define a data object
tombstone	dict	optional		a copy of the Metadata of a dead object.
data_tag	string	optional		tag used to identify the processing stage or job that generated this error log.

abortions Collection#

Table 20 **abortions collection schema**#
key	type	constraint	concept
_id	ObjectId	required	ObjectID used to define a unique entry in abortions collection.
logdata	list	optional	a list of LogData entries recorded while constructing an aborted data object.
tombstone	dict	required	a copy of the Metadata or source document that failed data-object construction.
type	string	required	expected data-object type for the aborted document.
data_tag	string	optional	tag used to identify the processing stage or job that generated this abortion record.

All Valid Attributes#

The table below defines all attributes MsPASS should handle without special treatment. They are arranged in alphabetical order. (Note all keys are case sensitive. In UTF-8 alphabetical order capitals appear before lower case.)

Table 21 **All MsPASS Attributes**#
key	aliases	type	constraint	reference	concept
DEPMAX	depmax	double			Minimum amplitude of a signal
DEPMEN	depmen	double			Mean amplitude of a signal
DEPMIN	depmin	double			Maximum amplitude of a signal
IEVTYP		int			Event type code as used in SAC
IZTYPE	TimeReferenceType	int			Reference time type as used by SAC
KEVNM		string			Event name
_id		ObjectId	required		ObjectId used to define a data object
calib		double	normal		Nominal conversion factor for changing sample data to ground motion units.
cardinal		boolean	required		When true the data stored are orthogonal and in cardinal (ENZ) geographic directions.
chan	KCMPNM : channel : channel.chan : wfdisc.chan	string	normal		channel name (e.g. HHZ, BHE, etc.) - normally a SEED channel code
channel_edepth		double	optional		depth of a seismic station/instrument in km
channel_elev		double	required		elevation of a seismic station/instrument in km (subtract emplacement depth for borehole instruments)
channel_endtime		double	normal		Time of channel ends recording
channel_hang	CMPAZ	double	normal		Azimuth (in degree) of a seismometer component - horizontal angle
channel_id		ObjectId	xref_key	channel	ObjectId used to define a particular component of data
channel_lat		double	required		latitude of a seismic station/instrument in degrees
channel_lon		double	required		longitude of a seismic station/instrument in degrees
channel_starttime		double	normal		Time of channel starts recording
channel_vang	CMPINC	double	normal		Inclination from +up (in degree) of a seismometer component - vertical angle
delta	dt	double	required		Data sample interval in seconds
dfile	file.dfile : wfdisc.dfile : wfprocess.dfile	string	optional		External data file name.
dir	file.dir : wfdisc.dir : wfprocess.dir	string	optional		Directory path to an external file (always used with dfile)
dist	GCARC : assoc.delta	double			Source receiver distance
distance_units		string			Units of dist attribute
esaz	AZ	double			Event to station azimuth
foff	file.foff : wfdisc.foff : wfprocess.foff	int	optional		Offset in bytes from beginning of a file to first data sample.
format		string	optional		The file format of the saved data (e.g., ‘MSEED’, ‘SAC’, …).
gridfs_id		ObjectId	optional		The _id of data file in the fs.files collection.
iphase		string			Indicated phase (from CSS3.0) - phase name from travel time curve association
jdate		int			Julian date string as used in CSS3.0
loc	channel.loc : location : site.loc	string	normal		location code assigned to an instrument (loc component of SEED net:sta:chan)
mb		double			Body wave magnitude
ms		double			Surface wave magnitude
nbytes		int	optional		Number of bytes for storage of sample data - required for some formats
net	channel.net : network : site.net : site_net : wfdisc.net	string	normal		network code (net component of SEED net:sta:chan)
npts	nsamp : wfdisc.nsamp	int	required		Number of data samples
orthogonal		boolean	required		When true the transformation matrix is orthogonal (inverse can then be constructed from transpose instead of inversion).
phase		string			Phase name assigned by an analyst to a pick
sampling_rate		double	optional		Data sampling frequency in Hz=1/s
seaz	BAZ	double			Station to event azimuth
site_elev	STEL : site.elev : stel	double	required		elevation of a seismic station/instrument in km (subtract emplacement depth for borehole instruments)
site_endtime	site.endtime	double	normal		Time of seismic station/instrument ends recording
site_id		ObjectId	xref_key	site	ObjectId used to define a particular instrument/seismic station
site_lat	STLA : site.lat	double	required		latitude of a seismic station/instrument in degrees
site_lon	STLO : site.lon : stlo	double	required		longitude of a seismic station/instrument in degrees
site_starttime	site.starttime	double	normal		Time of seismic station/instrument starts recording
source_depth	EVDP : origin.depth : source.depth	double	required		Depth (in km) of the hypocenter of seismic source
source_id		ObjectId	xref_key	source	ObjectId used to define a particular seismic source
source_lat	EVLA : origin.lat : source.lat	double	required		Latitude (in degrees) of the hypocenter of seismic source
source_lon	EVLO : origin.lon : source.lon	double	required		Longitude (in degrees) of the hypocenter of seismic source
source_magnitude	MAG	double	normal		Generic magnitude attribute
source_time	origin.time : source.time	double	required		Origin time of the hypocenter of seismic source (epoch time)
sta	KSTNM : channel.sta : site.sta : station : wfdisc.sta	string	normal		station code assigned to a spot on Earth (sta component of SEED net:sta:chan)
starttime	t0 : time	double	required		Time of first sample of data (epoch time or relative to some other time mark)
storage_mode		string	required		The storage mode of the saved data (‘file’, ‘url’ or ‘gridfs’)
time_standard		string	required		Defines time standard for meaning of t0 (default should be UTC)
tmatrix		list	required		Three-component data’s transformation matrix
units	IDEP : idep	string			Physical units of sample data (nm/s is normal assumed default)
utc_convertible		boolean	required		When true starttime_shift can be used to convert relative time to UTC.

The key in the master list above is always used as the index to locate an attribute for a particular concept in MongoDB. However, MsPASS also implements a generic alias mechanism that allows a function to fetch an attribute internally (i.e. when the data are in memory for processing) using an alternative name (alias). The table below defines all valid aliases for unique keys with the alias keys separated by colons:

Table 22 **All MsPASS aliases**#
Unique Key	Valid Aliases
DEPMAX	depmax
DEPMEN	depmen
DEPMIN	depmin
IZTYPE	TimeReferenceType
chan	KCMPNM : channel : channel.chan : wfdisc.chan
channel_hang	CMPAZ
channel_vang	CMPINC
delta	dt
dfile	file.dfile : wfdisc.dfile : wfprocess.dfile
dir	file.dir : wfdisc.dir : wfprocess.dir
dist	GCARC : assoc.delta
esaz	AZ
foff	file.foff : wfdisc.foff : wfprocess.foff
loc	channel.loc : location : site.loc
net	channel.net : network : site.net : site_net : wfdisc.net
npts	nsamp : wfdisc.nsamp
seaz	BAZ
site_elev	STEL : site.elev : stel
site_endtime	site.endtime
site_lat	STLA : site.lat
site_lon	STLO : site.lon : stlo
site_starttime	site.starttime
source_depth	EVDP : origin.depth : source.depth
source_lat	EVLA : origin.lat : source.lat
source_lon	EVLO : origin.lon : source.lon
source_magnitude	MAG
source_time	origin.time : source.time
sta	KSTNM : channel.sta : site.sta : station : wfdisc.sta
starttime	t0 : time
units	IDEP : idep

Master Documents for Normalized Attributes#

Site Collection (Receiver coordinates)#

This set of attributes defines the physical location of a seismic sensor on the Earth. It also lists related attributes used for cross-referencing documents in the site collection.

Table 23 **Receiver coordinate (site collection) Attributes**#
key	aliases	type	constraint	reference	concept
net	channel.net : network : site.net : site_net : wfdisc.net	string	normal		network code (net component of SEED net:sta:chan)
sta	KSTNM : channel.sta : site.sta : station : wfdisc.sta	string	normal		station code assigned to a spot on Earth (sta component of SEED net:sta:chan)
loc	channel.loc : location : site.loc	string	normal		location code assigned to an instrument (loc component of SEED net:sta:chan)
site_lat	STLA : site.lat	double	required		latitude of a seismic station/instrument in degrees
site_lon	STLO : site.lon : stlo	double	required		longitude of a seismic station/instrument in degrees
site_elev	STEL : site.elev : stel	double	required		elevation of a seismic station/instrument in km (subtract emplacement depth for borehole instruments)
site_starttime	site.starttime	double	normal		Time of seismic station/instrument starts recording
site_endtime	site.endtime	double	normal		Time of seismic station/instrument ends recording
site_id		ObjectId	xref_key	site	ObjectId used to define a particular instrument/seismic station

Source Collection (Seismic Source coordinates)#

This set of attributes defines location estimates or measured locations of seismic sources. MsPASS does not support the concept of multiple location estimates for the same seismic events that is a major complication in the relational database schema CSS3.0 used, for example, in Antelope. Each source is defined by the unique id source_id listed in the table below.

Table 24 **Source coordinate (source collection) Attributes**#
key	aliases	type	constraint	reference	concept
source_id		ObjectId	xref_key	source	ObjectId used to define a particular seismic source
source_lat	EVLA : origin.lat : source.lat	double	required		Latitude (in degrees) of the hypocenter of seismic source
source_lon	EVLO : origin.lon : source.lon	double	required		Longitude (in degrees) of the hypocenter of seismic source
source_depth	EVDP : origin.depth : source.depth	double	required		Depth (in km) of the hypocenter of seismic source
source_time	origin.time : source.time	double	required		Origin time of the hypocenter of seismic source (epoch time)
source_magnitude	MAG	double	normal		Generic magnitude attribute
mb		double			Body wave magnitude
ms		double			Surface wave magnitude

Attributes with Conceptual Relationship#

ObsPy Trace Object#

The ObsPy package on which MsPASS leans heavily defines a Trace object with a fixed set of required parameters. The names can be aliased but the unique keys of all of the attributes below are identical to the name defined for the ObsPy Trace object.

Table 25 **Required Attributes for obspy Trace object**#
key	aliases	type	constraint	concept
calib		double	normal	Nominal conversion factor for changing sample data to ground motion units.
chan	KCMPNM : channel : channel.chan : wfdisc.chan	string	normal	channel name (e.g. HHZ, BHE, etc.) - normally a SEED channel code
delta	dt	double	required	Data sample interval in seconds
loc	channel.loc : location : site.loc	string	normal	location code assigned to an instrument (loc component of SEED net:sta:chan)
net	channel.net : network : site.net : site_net : wfdisc.net	string	normal	network code (net component of SEED net:sta:chan)
npts	nsamp : wfdisc.nsamp	int	required	Number of data samples
sampling_rate		double	optional	Data sampling frequency in Hz=1/s
sta	KSTNM : channel.sta : site.sta : station : wfdisc.sta	string	normal	station code assigned to a spot on Earth (sta component of SEED net:sta:chan)
starttime	t0 : time	double	required	Time of first sample of data (epoch time or relative to some other time mark)

Channel Attributes#

Table 26 **Channel attributes**#
key	aliases	type	constraint	reference	concept
channel_id		ObjectId	xref_key	channel	ObjectId used to define a particular component of data
chan	KCMPNM : channel : channel.chan : wfdisc.chan	string	normal		channel name (e.g. HHZ, BHE, etc.) - normally a SEED channel code
loc	channel.loc : location : site.loc	string	normal		location code assigned to an instrument (loc component of SEED net:sta:chan)
channel_lat		double	required		latitude of a seismic station/instrument in degrees
channel_lon		double	required		longitude of a seismic station/instrument in degrees
channel_elev		double	required		elevation of a seismic station/instrument in km (subtract emplacement depth for borehole instruments)
channel_edepth		double	optional		depth of a seismic station/instrument in km
channel_hang	CMPAZ	double	normal		Azimuth (in degree) of a seismometer component - horizontal angle
channel_vang	CMPINC	double	normal		Inclination from +up (in degree) of a seismometer component - vertical angle
channel_starttime		double	normal		Time of channel starts recording
channel_endtime		double	normal		Time of channel ends recording

Three-Component Data Attributes#

These attributes describe the orientation and transformation matrix used by three-component seismic data objects.

Table 27 **Three-component data attributes**#
key	type	constraint	concept
tmatrix	list	required	Three-component data’s transformation matrix
cardinal	boolean	required	When true the data stored are orthogonal and in cardinal (ENZ) geographic directions.
orthogonal	boolean	required	When true the transformation matrix is orthogonal (inverse can then be constructed from transpose instead of inversion).

Seismic Phase Related Attributes#

Table 28 **Phase attributes**#
key	aliases	type	concept
phase		string	Phase name assigned by an analyst to a pick
iphase		string	Indicated phase (from CSS3.0) - phase name from travel time curve association
esaz	AZ	double	Event to station azimuth
seaz	BAZ	double	Station to event azimuth
dist	GCARC : assoc.delta	double	Source receiver distance
distance_units		string	Units of dist attribute

External File Attributes#

Table 29 **File attributes**#
key	aliases	type	constraint	concept
dir	file.dir : wfdisc.dir : wfprocess.dir	string	optional	Directory path to an external file (always used with dfile)
dfile	file.dfile : wfdisc.dfile : wfprocess.dfile	string	optional	External data file name.
foff	file.foff : wfdisc.foff : wfprocess.foff	int	optional	Offset in bytes from beginning of a file to first data sample.
format		string	optional	The file format of the saved data (e.g., ‘MSEED’, ‘SAC’, …).
nbytes		int	optional	Number of bytes for storage of sample data - required for some formats
storage_mode		string	required	The storage mode of the saved data (‘file’, ‘url’ or ‘gridfs’)
gridfs_id		ObjectId	optional	The _id of data file in the fs.files collection.

Indexing Attributes for MongoDB#

Table 30 **MongoDB attributes**#
key	type	constraint	reference	concept
_id	ObjectId	required		ObjectId used to define a data object
site_id	ObjectId	xref_key	site	ObjectId used to define a particular instrument/seismic station
channel_id	ObjectId	xref_key	channel	ObjectId used to define a particular component of data
source_id	ObjectId	xref_key	source	ObjectId used to define a particular seismic source
gridfs_id	ObjectId	optional		The _id of data file in the fs.files collection.
storage_mode	string	required		The storage mode of the saved data (‘file’, ‘url’ or ‘gridfs’)