BdsApi  2.2.6
This is the Blacknest BDS API.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | Public Attributes | List of all members
Bds::DataBlock Class Reference

This class provides the acual seismic data values contained within a single data block. More...

#include <BdsD.h>

Public Member Functions

 DataBlock (BTimeStamp startTime=BTimeStamp(), BTimeStamp endTime=BTimeStamp(), BUInt32 channelNumber=0, BUInt32 segmentNumber=0, BArray< BArray< BFloat64 > > channelData=BArray< BArray< BFloat64 > >(), BDict< BString > info=BDict< BString >())
 

Public Attributes

BTimeStamp startTime
 The Start Time. More...
 
BTimeStamp endTime
 The End Time the channel was available. More...
 
BUInt32 channelNumber
 The first channel number. (1, 2, 3 ...) More...
 
BUInt32 segmentNumber
 The segment number. (1, 2, 3, ...) More...
 
BArray< BArray< BFloat64 > > channelData
 The raw channel data in a 2 dimensional array, ordered as per channel information in dataInfo. More...
 
BDict< BStringinfo
 Extra information on data or ASCII data. More...
 

Detailed Description

This class provides the acual seismic data values contained within a single data block.

All seismic data is segmented into blocks that have a timestamp and perhaps other metadata. The DataBlock contains an array of actual data samples in a 64bit floating pointer format for one or more channels. If the samples are for multiple channels it is assumed that these are synchronously sampled and are normally from a data file that is in the sample multiplexed format (ie. For each point in time there is a set of samples one for each cahnnel). The startTime comes from the original blocks start time information. The endTime may come from the original blocks end time information, if available in the original data format that the data was imported from or is generated from the startTime and the calculated sample rate of the data. For some data types where the sampling rate is a bit varible, the endTime fields may be lined up with the next blocks startTime field to ensure contiguous data segments. The info field contains extra, free string format, metadata on the block if available. This could be quality information from the TapeDigitiser system for example.

Constructor & Destructor Documentation

Bds::DataBlock::DataBlock ( BTimeStamp  startTime = BTimeStamp(),
BTimeStamp  endTime = BTimeStamp(),
BUInt32  channelNumber = 0,
BUInt32  segmentNumber = 0,
BArray< BArray< BFloat64 > >  channelData = BArray<BArray<BFloat64 > >(),
BDict< BString info = BDict<BString >() 
)

Member Data Documentation

BArray<BArray<BFloat64 > > Bds::DataBlock::channelData

The raw channel data in a 2 dimensional array, ordered as per channel information in dataInfo.

BUInt32 Bds::DataBlock::channelNumber

The first channel number. (1, 2, 3 ...)

BTimeStamp Bds::DataBlock::endTime

The End Time the channel was available.

BDict<BString > Bds::DataBlock::info

Extra information on data or ASCII data.

BUInt32 Bds::DataBlock::segmentNumber

The segment number. (1, 2, 3, ...)

BTimeStamp Bds::DataBlock::startTime

The Start Time.


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