mspass::algorithms::VectorTaper Class Reference

#include <Taper.h>

Inheritance diagram for mspass::algorithms::VectorTaper:

Collaboration diagram for mspass::algorithms::VectorTaper:

Public Member Functions
	VectorTaper (const std::vector< double > taperdata)
int	apply (mspass::seismic::TimeSeries &d)
int	apply (mspass::seismic::Seismogram &d)
void	disable ()
void	enable ()
std::vector< double >	get_taper ()
double	get_t0head () const
double	get_t1head () const
Public Member Functions inherited from mspass::algorithms::BasicTaper
	BasicTaper ()
virtual	~BasicTaper ()
void	enable_head ()
void	disable_head ()
void	enable_tail ()
void	disable_tail ()
bool	head_is_enabled ()
bool	tail_is_enable ()

Friends
class	boost::serialization::access

Additional Inherited Members
Protected Attributes inherited from mspass::algorithms::BasicTaper
bool	head
bool	tail
bool	all

Detailed Description

General taper.

This method provides a simple way to build a taper from a set of uniformly spaced points. The apply methods will dogmatically only accept input data of the same length as the taper defined in the operator.

Constructor & Destructor Documentation

VectorTaper() [1/2]

mspass::algorithms::VectorTaper::VectorTaper

(

)

                         {
  head = false;
  tail = false;
  all = false;
}

VectorTaper() [2/2]

mspass::algorithms::VectorTaper::VectorTaper

(

const std::vector< double >

taperdata

)

Construct from a vector of taper weights.

    : taper(taperdata) {
  /* Really only all needs to be set true here, but need to initialize
  others anyway as good practice.*/
  head = true;
  tail = true;
  all = true;
}

References mspass::algorithms::BasicTaper::all, mspass::algorithms::BasicTaper::head, and mspass::algorithms::BasicTaper::tail.

Member Function Documentation

apply() [1/2]

int mspass::algorithms::VectorTaper::apply ( mspass::seismic::Seismogram &  d )

virtual

Apply the vector taper to a three-component Seismogram.

Implements mspass::algorithms::BasicTaper.

                                    {
  if (all) {
    if (d.npts() != taper.size()) {
      stringstream ss;
      ss << "VectorTaper apply method:  size mismatch with data" << endl
         << "operator taper size=" << taper.size()
         << " but data vector length=" << d.npts() << endl
         << "This operator requires these lengths to match" << endl;
      d.elog.log_error("VectorTaper", ss.str(), ErrorSeverity::Complaint);
      return -1;
    }
    for (int i = 0; i < d.npts(); ++i) {
      double wt = taper[i];
      for (int k = 0; k < 3; ++k) {
        d.u(k, i) *= wt;
      }
    }
    return 0;
  } else
    return -1;
}

References mspass::algorithms::BasicTaper::all, mspass::utility::ProcessingHistory::elog, mspass::utility::ErrorLogger::log_error(), mspass::seismic::BasicTimeSeries::npts(), and mspass::seismic::CoreSeismogram::u.

apply() [2/2]

int mspass::algorithms::VectorTaper::apply ( mspass::seismic::TimeSeries &  d )

virtual

Apply the vector taper to a scalar TimeSeries.

Implements mspass::algorithms::BasicTaper.

                                    {
  if (all) {
    if (d.npts() != taper.size()) {
      stringstream ss;
      ss << "VectorTaper apply method:  size mismatch with data" << endl
         << "operator taper size=" << taper.size()
         << " but data vector length=" << d.npts() << endl
         << "This operator requires these lengths to match" << endl;
      d.elog.log_error("VectorTaper", ss.str(), ErrorSeverity::Complaint);
      return -1;
    }
    for (int i = 0; i < d.npts(); ++i)
      d.s[i] *= taper[i];
    return 0;
  } else
    return -1;
}

References mspass::algorithms::BasicTaper::all, mspass::utility::ProcessingHistory::elog, mspass::utility::ErrorLogger::log_error(), mspass::seismic::BasicTimeSeries::npts(), and mspass::seismic::CoreTimeSeries::s.

disable()

void mspass::algorithms::VectorTaper::disable ( )

inline

Disable this vector taper.

{ all = false; };

References mspass::algorithms::BasicTaper::all.

enable()

void mspass::algorithms::VectorTaper::enable ( )

inline

Enable this vector taper when weights are available.

                {
    if (taper.size() > 0)
      all = true;
  };

References mspass::algorithms::BasicTaper::all.

get_t0head()

double mspass::algorithms::VectorTaper::get_t0head ( ) const

inlinevirtual

Vector tapers do not define a head start time.

Implements mspass::algorithms::BasicTaper.

                            {
    std::cerr << "get_t0head not implemented for VectorTaper";
    return 0.0;
  };

get_t1head()

double mspass::algorithms::VectorTaper::get_t1head ( ) const

inlinevirtual

Vector tapers do not define a head end time.

Implements mspass::algorithms::BasicTaper.

                            {
    std::cerr << "get_t1head not implemented for VectorTaper";
    return 0.0;
  };

get_taper()

std::vector< double > mspass::algorithms::VectorTaper::get_taper ( )

inline

Return a copy of the taper weights.

{ return taper; };

---

The documentation for this class was generated from the following files:

• /home/runner/work/mspass/mspass/cxx/include/mspass/algorithms/Taper.h
• /home/runner/work/mspass/mspass/cxx/src/lib/algorithms/Taper.cc