Trace::Header Class Reference

#include <trace.hpp>

Public Types
enum	AttrId {   TA_NTR = 0, TA_NMGL, TA_NSP, TA_NSL,   TA_NSS, TA_NRP, TA_NRL, TA_NRS,   TA_NDP, TA_XSP, TA_YSP, TA_ZSP,   TA_XOP, TA_YOP, TA_ZOP, TA_L,   TA_HCAB, TA_COMP, TA_TFB, TA_PSC_STRIDE,   TA_PSC_DIR, TA_PSC_QMINNEG, TA_PSC_QMAXPOS, TA_RESERVE_0,   TA_RESERVE_1, TA_RESERVE_2, TA_RESERVE_3, TA_RESERVE_4 }

Public Member Functions
	Header ()
	Header (TimeT i_t0, TimeT i_timestep, OffsetT i_offset)
bool	compatiable (const Header &hdr) const
bool	operator== (const Header &hdr) const
template<typename T >
void	setAttr (AttrId id, const T &value)
template<typename T >
const T &	getAttrValue (AttrId id, bool *result=0x0) const
bool	hasAttr (AttrId id) const
void	clearAttrs ()
bool	hasNAN ()
bool	hasInf ()
bool	hasNANInf ()

Static Public Member Functions
static std::string	toString (const AttrId &attr)

Public Attributes
TimeT	t0
TimeT	timestep
OffsetT	offset
std::map< AttrId, TrHdrAttrVal >	m_attrs

Detailed Description

Header of the trace.

Member Enumeration Documentation

enum Trace::Header::AttrId

Header attributes identifiers.

Enumerator
TA_NTR	Logical number of trace.
TA_NMGL	Logical number of magnetogram.
TA_NSP	Logical shot point number.
TA_NSL	Number of shot line.
TA_NSS	Shot point number on line.
TA_NRP	Logical receiver number.
TA_NRL	Number of receiver line.
TA_NRS	Receiver point number on line.
TA_NDP	Common distance point number.
TA_XSP	Shot point X-coordinate.
TA_YSP	Shot point Y-coordinate.
TA_ZSP	Shot point Z-coordinate.
TA_XOP	Observer point X-coordinate.
TA_YOP	Observer point Y-coordinate.
TA_ZOP	Observer point Z-coordinate.
TA_L	Offset.
TA_HCAB	Cable depth.
TA_COMP	Component.
TA_TFB	First break time.
TA_PSC_STRIDE	Stride value used by POLYCOR algorithm.
TA_PSC_DIR	Correlation direction used by POLYCOR algorithm.
TA_PSC_QMINNEG	Minimal negative quality value used by POLYCOR algorithm.
TA_PSC_QMAXPOS	Maximal positive quality value used by POLYCOR algorithm.
TA_RESERVE_0	Reserved attribute #0.
TA_RESERVE_1	Reserved attribute #1.
TA_RESERVE_2	Reserved attribute #2.
TA_RESERVE_3	Reserved attribute #3.
TA_RESERVE_4	Reserved attribute #4.

Constructor & Destructor Documentation

Trace::Header::Header

(

)

Default constructor (t0, timestep and offset are zero.)

Trace::Header::Header	(	TimeT	i_t0,
		TimeT	i_timestep,
		OffsetT	i_offset
	)

Constructs header with provided parameters.

Member Function Documentation

void Trace::Header::clearAttrs

(

)

Clears all header attributes.

bool Trace::Header::compatiable

(

const Header &

hdr

)

const

Does this header is compatiable to provided. 

Compatiable headers has the same t0 and timestep.

template<typename T >

const T & Trace::Header::getAttrValue	(	AttrId	id,
		bool *	result = 0x0
	)		const

Gets attribute value. Result will be false 

if attribute with provided id absents.

Gets attribute value. Result will be false if attribute with provided id absents.

bool Trace::Header::hasAttr

(

AttrId

id

)

const

True if header has provided attribute.

bool Trace::Header::hasInf

(

)

True if has any Inf in parameters.

bool Trace::Header::hasNAN

(

)

True if has any NAN in parameters.

bool Trace::Header::hasNANInf

(

)

True if has any NAN or Inf in parameters. Zero time of the trace.

bool Trace::Header::operator==

(

const Header &

hdr

)

const

Equality of headers.

template<typename T >

void Trace::Header::setAttr	(	AttrId	id,
		const T &	value
	)

Sets new attribute. Replaces value if attribute 

with such identifier is presents.

Sets new attribute. Replaces value if attribute with such identifier is presents.

static std::string Trace::Header::toString ( const AttrId &  attr )

static

Name of attribute as a string.

Member Data Documentation

OffsetT Trace::Header::offset

Attributes of the header.

TimeT Trace::Header::t0

Step of time.

TimeT Trace::Header::timestep

Offset of the trace.

---

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

• /net/opt/univers/ubp-i-15.3-centos7-x64.urij/include/s2proc/trace.hpp
• /net/opt/univers/ubp-i-15.3-centos7-x64.urij/include/s2proc/trace_inline.hpp