version  0.0.1
Defines the C++ API for MsPASS
Public Member Functions | List of all members
mspass::seismic::SeismogramWGaps Class Reference
Inheritance diagram for mspass::seismic::SeismogramWGaps:
mspass::seismic::Seismogram mspass::seismic::DataGap mspass::seismic::CoreSeismogram mspass::utility::ProcessingHistory mspass::seismic::BasicTimeSeries mspass::utility::Metadata mspass::utility::BasicProcessingHistory mspass::utility::BasicMetadata

Public Member Functions

 SeismogramWGaps ()
 Constructor. More...
 
 SeismogramWGaps (const SeismogramWGaps &parent)
 
SeismogramWGapsoperator= (const SeismogramWGaps &parent)
 
void zero_gaps ()
 
- Public Member Functions inherited from mspass::seismic::Seismogram
 Seismogram ()
 
 Seismogram (const size_t nsamples)
 
 Seismogram (const mspass::seismic::CoreSeismogram &d)
 Construct from lower level CoreSeismogram. More...
 
 Seismogram (const mspass::seismic::CoreSeismogram &d, const std::string alg)
 
 Seismogram (const mspass::seismic::BasicTimeSeries &bts, const mspass::utility::Metadata &md)
 Partial constructor from base classes. More...
 
 Seismogram (const mspass::seismic::BasicTimeSeries &b, const mspass::utility::Metadata &m, const mspass::utility::ProcessingHistory &his, const bool card, const bool ortho, const mspass::utility::dmatrix &tm, const mspass::utility::dmatrix &uin)
 Construct from all pieces. More...
 
 Seismogram (const Metadata &md, const std::string jobname=std::string("test"), const std::string jobid=std::string("UNDEFINED"), const std::string readername=std::string("load3C"), const std::string algid=std::string("0"))
 
 Seismogram (const Metadata &md, bool load_data)
 Construct from Metadata definition that includes data path. More...
 
 Seismogram (const Seismogram &parent)
 
Seismogramoperator= (const Seismogram &parent)
 
void load_history (const mspass::utility::ProcessingHistory &h)
 Load just the ProcessingHistory data from another data source. More...
 
size_t memory_use () const
 
- Public Member Functions inherited from mspass::seismic::CoreSeismogram
 CoreSeismogram ()
 
 CoreSeismogram (const size_t nsamples)
 
 CoreSeismogram (const std::vector< mspass::seismic::CoreTimeSeries > &ts, const unsigned int component_to_clone=0)
 
 CoreSeismogram (const mspass::utility::Metadata &md, const bool load_data=true)
 Construct from Metadata definition that includes data path. More...
 
 CoreSeismogram (const CoreSeismogram &)
 
void set_dt (const double sample_interval)
 Set the sample interval. More...
 
void set_npts (const size_t npts)
 Set the number of samples attribute for data. More...
 
void sync_npts ()
 Sync the number of samples attribute with actual data size. More...
 
void set_t0 (const double t0in)
 Set the data start time. More...
 
CoreSeismogramoperator= (const CoreSeismogram &)
 
CoreSeismogramoperator+= (const CoreSeismogram &d)
 Summation operator. More...
 
const CoreSeismogram operator+ (const CoreSeismogram &other) const
 
CoreSeismogramoperator*= (const double)
 
CoreSeismogramoperator-= (const CoreSeismogram &d)
 Subtraction operator. More...
 
const CoreSeismogram operator- (const CoreSeismogram &other) const
 
std::vector< double > operator[] (const int sample) const
 
std::vector< double > operator[] (const double time) const
 Overloaded version of operator[] for time. More...
 
virtual ~CoreSeismogram ()
 
void rotate_to_standard ()
 
void rotate (mspass::utility::SphericalCoordinate &sc)
 
void rotate (const double nu[3])
 
void rotate (const double phi)
 Rotate horizontals by a simple angle in degrees. More...
 
void transform (const double a[3][3])
 
void free_surface_transformation (const mspass::seismic::SlownessVector u, const double vp0, const double vs0)
 
mspass::utility::dmatrix get_transformation_matrix () const
 
bool set_transformation_matrix (const mspass::utility::dmatrix &A)
 Define the transformaton matrix. More...
 
bool set_transformation_matrix (const double a[3][3])
 Define the transformaton matrix with a C style 3x3 matrix. More...
 
bool set_transformation_matrix (pybind11::object a)
 Define the transformaton matrix with a python object. More...
 
bool cardinal () const
 
bool orthogonal () const
 
double endtime () const noexcept
 
- Public Member Functions inherited from mspass::seismic::BasicTimeSeries
 BasicTimeSeries ()
 
 BasicTimeSeries (const BasicTimeSeries &)
 
virtual ~BasicTimeSeries ()
 Virtual destructor. More...
 
double time (const int i) const
 
int sample_number (double t) const
 
double endtime () const noexcept
 
bool shifted () const
 
double time_reference () const
 
void force_t0_shift (const double t)
 Force a t0 shift value on data. More...
 
virtual void ator (const double tshift)
 
virtual void rtoa ()
 
virtual void shift (const double dt)
 
bool live () const
 
bool dead () const
 
void kill ()
 
void set_live ()
 
double dt () const
 
bool time_is_UTC () const
 
bool time_is_relative () const
 
TimeReferenceType timetype () const
 
double samprate () const
 
size_t npts () const
 
double t0 () const
 
void set_tref (const TimeReferenceType newtref)
 Force the time standard. More...
 
BasicTimeSeriesoperator= (const BasicTimeSeries &parent)
 
- Public Member Functions inherited from mspass::utility::ProcessingHistory
 ProcessingHistory ()
 
 ProcessingHistory (const std::string jobnm, const std::string jid)
 
 ProcessingHistory (const ProcessingHistory &parent)
 
bool is_empty () const
 
bool is_raw () const
 
bool is_origin () const
 
bool is_volatile () const
 
bool is_saved () const
 
size_t number_of_stages () override
 Return number of processing stages that have been applied to this object. More...
 
void set_as_origin (const std::string alg, const std::string algid, const std::string uuid, const AtomicType typ, bool define_as_raw=false)
 
std::string new_ensemble_process (const std::string alg, const std::string algid, const AtomicType typ, const std::vector< ProcessingHistory * > parents, const bool create_newid=true)
 
void add_one_input (const ProcessingHistory &data_to_add)
 Add one datum as an input for current data. More...
 
void add_many_inputs (const std::vector< ProcessingHistory * > &d)
 Define several data objects as inputs. More...
 
void merge (const ProcessingHistory &data_to_add)
 Merge the history nodes from another. More...
 
void accumulate (const std::string alg, const std::string algid, const AtomicType typ, const ProcessingHistory &newinput)
 Method to use with a spark reduce algorithm. More...
 
std::string clean_accumulate_uuids ()
 Clean up inconsistent uuids that can be produced by reduce. More...
 
std::string new_map (const std::string alg, const std::string algid, const AtomicType typ, const ProcessingStatus newstatus=ProcessingStatus::VOLATILE)
 Define this algorithm as a one-to-one map of same type data. More...
 
std::string new_map (const std::string alg, const std::string algid, const AtomicType typ, const ProcessingHistory &data_to_clone, const ProcessingStatus newstatus=ProcessingStatus::VOLATILE)
 Define this algorithm as a one-to-one map. More...
 
std::string map_as_saved (const std::string alg, const std::string algid, const AtomicType typ)
 Prepare the current data for saving. More...
 
void clear ()
 
std::multimap< std::string, mspass::utility::NodeDataget_nodes () const
 
int stage () const
 
ProcessingStatus status () const
 
std::string id () const
 
std::pair< std::string, std::string > created_by () const
 
NodeData current_nodedata () const
 
std::string newid ()
 
int number_inputs () const
 
int number_inputs (const std::string uuidstr) const
 
void set_id (const std::string newid)
 
std::list< mspass::utility::NodeDatainputs (const std::string id_to_find) const
 Return a list of data that define the inputs to a give uuids. More...
 
ProcessingHistoryoperator= (const ProcessingHistory &parent)
 
- Public Member Functions inherited from mspass::utility::BasicProcessingHistory
 BasicProcessingHistory (const std::string jobname, const std::string jobid)
 
 BasicProcessingHistory (const BasicProcessingHistory &parent)
 
std::string jobid () const
 
void set_jobid (const std::string &newjid)
 
std::string jobname () const
 
void set_jobname (const std::string jobname)
 
BasicProcessingHistoryoperator= (const BasicProcessingHistory &parent)
 
- Public Member Functions inherited from mspass::seismic::DataGap
 DataGap ()
 
 DataGap (const std::list< mspass::algorithms::TimeWindow > &twlist)
 
 DataGap (const DataGap &parent)
 
bool is_gap (const double ttest)
 
bool has_gap (const mspass::algorithms::TimeWindow twin)
 
bool has_gap ()
 
void add_gap (const mspass::algorithms::TimeWindow tw)
 
std::list< mspass::algorithms::TimeWindowget_gaps () const
 
void clear_gaps ()
 Clear gaps. More...
 
int number_gaps () const
 
DataGap subset (const mspass::algorithms::TimeWindow tw) const
 
void translate_origin (double time_of_new_origin)
 
DataGapoperator= (const DataGap &parent)
 
DataGapoperator+= (const DataGap &other)
 

Additional Inherited Members

- Public Attributes inherited from mspass::seismic::CoreSeismogram
mspass::utility::dmatrix u
 
- Public Attributes inherited from mspass::utility::ProcessingHistory
ErrorLogger elog
 
- Protected Attributes inherited from mspass::seismic::CoreSeismogram
bool components_are_orthogonal
 
bool components_are_cardinal
 
double tmatrix [3][3]
 
- Protected Attributes inherited from mspass::seismic::BasicTimeSeries
bool mlive
 
double mdt
 
double mt0
 
size_t nsamp
 
TimeReferenceType tref
 
bool t0shift_is_valid
 
double t0shift
 
- Protected Attributes inherited from mspass::utility::ProcessingHistory
std::multimap< std::string, mspass::utility::NodeDatanodes
 
- Protected Attributes inherited from mspass::utility::BasicProcessingHistory
std::string jid
 
std::string jnm
 
- Protected Attributes inherited from mspass::seismic::DataGap
std::set< mspass::algorithms::TimeWindow, mspass::algorithms::TimeWindowCmpgaps
 Holds data gap definitions. We use an STL set object to define data gaps for any time series object derived from this base class. The set is keyed by a TimeWindow which allows a simple, fast way to define a time range with invalid data.
 

Constructor & Destructor Documentation

◆ SeismogramWGaps() [1/2]

mspass::seismic::SeismogramWGaps::SeismogramWGaps ( )

Constructor.

Will need a set of conastructors. Requires some thought as how to set gap is an issue.

◆ SeismogramWGaps() [2/2]

mspass::seismic::SeismogramWGaps::SeismogramWGaps ( const SeismogramWGaps parent)

Copy constructor.

Member Function Documentation

◆ zero_gaps()

void mspass::seismic::SeismogramWGaps::zero_gaps ( )

Force all data inside data gaps to zero.


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