algorithms.h

#ifndef _MSPASS_ALGORITHMS_H_
#define _MSPASS_ALGORITHMS_H_
/* This file should contain function protypes for all simple function
   algorithms that are to be part of mspass.
   *
   */
#include "mspass/algorithms/TimeWindow.h"
#include "mspass/seismic/Ensemble.h"
#include "mspass/seismic/Seismogram.h"
#include "mspass/seismic/TimeSeries.h"
#include "mspass/seismic/TimeSeriesWGaps.h"
namespace mspass::algorithms {
/* \brief Apply agc operator to three component seismogram data.
 
   Automatic gain control (agc) is a standard operation in seismic
reflection processing.  The algorithm used her is a variant of that in
seismic unix but applied to vector data.   That is scaling is no
determined by absolute value of each sample but th vector amplitude of
each sample.  Scaling is determined by the average vector amplitude
over a specified time window length.  There isa  ramp in and ramp off
range of size equal to the window length.   agc was notorious in the
early days of seismic processing for making it impossible to recover
true amplitude.   We remove that problem here by returning a TimeSeries
object whose contents contain the gain applied to each sample of the
original data.
 
\param d - data to apply the operator to.  Note it is altered.
\param twin - length of the agc operator in seconds
 
\return TimeSeries object with the same number of samples as d. The
  value of each sample is the gain applied at the comparable sample in d.
 
This function does not throw an exception, but can post errors to the
ErrorLogger object that is a member of Seismogram.
*/
mspass::seismic::TimeSeries agc(mspass::seismic::Seismogram &d,
                                const double twin);
mspass::seismic::Seismogram
WindowData(const mspass::seismic::Seismogram &parent,
           const mspass::algorithms::TimeWindow &tw);
mspass::seismic::CoreSeismogram
WindowData(const mspass::seismic::CoreSeismogram &parent,
           const mspass::algorithms::TimeWindow &tw);
 
mspass::seismic::TimeSeries
WindowData(const mspass::seismic::TimeSeries &parent,
           const mspass::algorithms::TimeWindow &tw);
mspass::seismic::CoreTimeSeries
WindowData(const mspass::seismic::CoreTimeSeries &parent,
           const mspass::algorithms::TimeWindow &tw);
 
/* This set of procedures are ancessors of seismogram_helpers.   They
 * were moved to algorithms June 2020 for mspass */
std::shared_ptr<mspass::seismic::Seismogram>
ArrivalTimeReference(mspass::seismic::Seismogram &din, std::string key,
                     mspass::algorithms::TimeWindow tw);
mspass::seismic::TimeSeries
ExtractComponent(const mspass::seismic::Seismogram &tcs,
                 const unsigned int component);
/* Enemble algorithms */
std::shared_ptr<mspass::seismic::ThreeComponentEnsemble>
ArrivalTimeReference(mspass::seismic::ThreeComponentEnsemble &din,
                     std::string key, mspass::algorithms::TimeWindow tw);
mspass::seismic::Ensemble<mspass::seismic::TimeSeries> ExtractComponent(
    const mspass::seismic::Ensemble<mspass::seismic::Seismogram> &d,
    const unsigned int comp);
mspass::seismic::CoreSeismogram
sparse_convolve(const mspass::seismic::CoreTimeSeries &wavelet,
                const mspass::seismic::CoreSeismogram &d);
mspass::seismic::Seismogram
BundleSEEDGroup(const std::vector<mspass::seismic::TimeSeries> &d,
                const size_t i0, const size_t iend);
mspass::seismic::LoggingEnsemble<mspass::seismic::Seismogram> bundle_seed_data(
    mspass::seismic::LoggingEnsemble<mspass::seismic::TimeSeries> &d);
void seed_ensemble_sort(
    mspass::seismic::LoggingEnsemble<mspass::seismic::TimeSeries> &d);
mspass::seismic::TimeSeriesWGaps
splice_segments(std::vector<mspass::seismic::TimeSeries> &segments,
                bool save_history);
std::vector<mspass::seismic::TimeSeries>
repair_overlaps(std::vector<mspass::seismic::TimeSeries> &segments);
} // namespace mspass::algorithms
#endif