mspass::algorithms::LinearTaper Class Reference

Used to construct an operator to apply a linear taper to either end. More...

#include <Taper.h>

Inheritance diagram for mspass::algorithms::LinearTaper:

Public Member Functions
	LinearTaper (const double t0head, const double t1head, const double t1tail, const double t0tail)
	primary constructor. More...
int	apply (mspass::seismic::TimeSeries &d)
int	apply (mspass::seismic::Seismogram &d)
double	get_t0head () const
double	get_t1head () const
double	get_t0tail () const
double	get_t1tail () const
Public Member Functions inherited from mspass::algorithms::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

Used to construct an operator to apply a linear taper to either end.

Linear tapers are defined here as a time spanning a ramp running from 0 to 1. Data will be zeroed on each end of a 0 mark and a linear weight applied between 0 points and 1 points. Postive ramp slope on left and negative slope ramp on right.

Constructor & Destructor Documentation

LinearTaper()

mspass::algorithms::LinearTaper::LinearTaper	(	const double	t0head,
		const double	t1head,
		const double	t1tail,
		const double	t0tail
	)

primary constructor.

Defines linear taper for front and/or back end of a time range. Zero times before t0head and after t0tail. Linear ramp between t0head and t1head and in opposite sense from t1tail to t0tail. Setting 0 value = 1 value should be used as a signal to disable.

{
  t0head=t0h;
  t1head=t1h;
  t0tail=t0t;
  t1tail=t1t;
  if(t1head>t0head)
    head=true;
  else
    head=false;
  if(t1tail<t0tail)
    tail=true;
  else
    tail=false;
  if(head&&tail)
    all=true;
  else
    all=false;
  if(!(head || tail))
  {
    stringstream ss;
    ss << "LinearTaper constructor:  illegal input.  No valid taper parameters"<<endl
       << "Input defines front end ramp defined as 0 at "<<t0h<<" rising to 1 at "<<t1h<<endl
       << "Tail end ramp defined with 1 at "<<t1t<<" dropping to 0 at "<<t0t<<endl;
    throw MsPASSError(ss.str(),ErrorSeverity::Invalid);
  }
}

---

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