mspass::algorithms::BasicTaper Class Reference

Abstract base class for taper operators. More...

#include <Taper.h>

Inheritance diagram for mspass::algorithms::BasicTaper:

Public Member Functions
	BasicTaper ()
virtual	~BasicTaper ()
virtual int	apply (mspass::seismic::TimeSeries &d)=0
virtual int	apply (mspass::seismic::Seismogram &d)=0
void	enable_head ()
void	disable_head ()
void	enable_tail ()
void	disable_tail ()
bool	head_is_enabled ()
bool	tail_is_enable ()
virtual double	get_t0head () const =0
virtual double	get_t1head () const =0

Protected Attributes
bool	head
bool	tail
bool	all

Friends
class	boost::serialization::access

Detailed Description

Abstract base class for taper operators.

Derived tapers apply amplitude weights to the head, tail, or full span of scalar and three-component seismic data.

Constructor & Destructor Documentation

BasicTaper()

mspass::algorithms::BasicTaper::BasicTaper ( )

inline

Construct a taper with all regions disabled.

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

References all, head, and tail.

~BasicTaper()

virtual mspass::algorithms::BasicTaper::~BasicTaper ( )

inlinevirtual

Virtual destructor for derived taper operators.

{};

Member Function Documentation

apply() [1/2]

virtual int mspass::algorithms::BasicTaper::apply ( mspass::seismic::Seismogram &  d )

pure virtual

Apply this taper to a three-component Seismogram.

Implemented in mspass::algorithms::LinearTaper, mspass::algorithms::CosineTaper, and mspass::algorithms::VectorTaper.

apply() [2/2]

virtual int mspass::algorithms::BasicTaper::apply ( mspass::seismic::TimeSeries &  d )

pure virtual

Apply this taper to a scalar TimeSeries.

Implemented in mspass::algorithms::LinearTaper, mspass::algorithms::CosineTaper, and mspass::algorithms::VectorTaper.

disable_head()

void mspass::algorithms::BasicTaper::disable_head ( )

inline

Disable tapering on the head of a datum.

                      {
    head = false;
    all = false;
  };

References all, and head.

disable_tail()

void mspass::algorithms::BasicTaper::disable_tail ( )

inline

Disable tapering on the tail of a datum.

                      {
    tail = false;
    all = false;
  };

References all, and tail.

enable_head()

void mspass::algorithms::BasicTaper::enable_head ( )

inline

Enable tapering on the head of a datum.

{ head = true; };

References head.

enable_tail()

void mspass::algorithms::BasicTaper::enable_tail ( )

inline

Enable tapering on the tail of a datum.

{ tail = true; };

References tail.

get_t0head()

virtual double mspass::algorithms::BasicTaper::get_t0head ( ) const

pure virtual

Return the start time of the head taper.

Implemented in mspass::algorithms::LinearTaper, mspass::algorithms::CosineTaper, and mspass::algorithms::VectorTaper.

get_t1head()

virtual double mspass::algorithms::BasicTaper::get_t1head ( ) const

pure virtual

Return the end time of the head taper.

Implemented in mspass::algorithms::LinearTaper, mspass::algorithms::CosineTaper, and mspass::algorithms::VectorTaper.

head_is_enabled()

bool mspass::algorithms::BasicTaper::head_is_enabled ( )

inline

Return true when head tapering is enabled directly or by full tapering.

                         {
    if (head || all) {
      return true;
    }
    return false;
  };

References all, and head.

tail_is_enable()

bool mspass::algorithms::BasicTaper::tail_is_enable ( )

inline

Return true when tail tapering is enabled directly or by full tapering.

                        {
    if (tail || all) {
      return true;
    }
    return false;
  };

References all, and tail.

Member Data Documentation

all

bool mspass::algorithms::BasicTaper::all

protected

True when the whole datum is tapered by one vector.

head

bool mspass::algorithms::BasicTaper::head

protected

True when head tapering is enabled.

tail

bool mspass::algorithms::BasicTaper::tail

protected

True when tail tapering is enabled.

---

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

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