STATUS CHECK: jsFileReader public interface

[ericaddison]

Status of the SWIG implementation of the public interface of jsFileReader.
The following table lists all the public methods within jsFileReader. The columns have the following meanings:

• SWIG: has the method been SWIGGED and available in Python?
• delegated: does the method have a corresponding delegation method in jsdataset?
• demo: is the method presented in a demo notebook anywhere?
• unit test: has the method been unit tested? (test/jsFileReaderTest.py)
• notes: anything else to know?

Any methods that don't have delegates in jsdataset should explain themselves in the notes.

Method	SWIG	delegated	demo	unit test	notes
Init()	yes	no	no	yes
isRegular()	yes	yes	no	yes
isSeisPEG()	yes	yes	no	yes
getNtr()	yes	yes	no	yes
getNFrames()	yes	yes	no	yes
getHeaderWords()	yes	no	no	yes	this info is available in the jsdataset.hdrs dictionary
getNumHeaderWords()	yes	yes	no	yes
getNumBytesInHeader()	yes	yes	no	yes
getNumBytesInRawFrame()	yes	yes	no	yes
getHeaderWordsInfo()	yes	yes	no	yes
getIOBufferSize()	yes	yes	no	yes
getNDim()	yes	yes	no	yes
getAxisLen()	yes	no	no	yes	all axis info is available in the jsdataset.axes tuple
getAxisLogicalValues()	yes	no	no	yes	all axis info is available in the jsdataset.axes tuple
getAxisPhysicalValues()	yes	no	no	yes	all axis info is available in the jsdataset.axes tuple
getAxisLabels()	yes	no	no	yes	all axis info is available in the jsdataset.axes tuple
getAxisUnits()	yes	no	no	yes	all axis info is available in the jsdataset.axes tuple
getFrameSizeOnDisk()	yes	yes	no	no
getByteOrder()	yes	yes	no	no
getByteOrderAsString()	yes	yes	no	no
getTraceFormatName()	yes	yes	no	no
getDescriptiveName()	yes	yes	no	no
getDataType()	yes	yes	no	no
getHdrEntry()	yes	no	no	no	all hdr entries are available in the jsdataset.hdrs dictionary
getHdrEntries()	yes	no	no	no	all hdr entries are available in the jsdataset.hdrs dictionary
readTraceHeader(position)	yes	yes	no	no
readTraceHeader(traceIndex)	yes	yes	no	no
readFrameHeader(position)	yes	yes	no	no
readFrameHeader(frameIndex)	yes	yes	no	no
readTrace(position)	yes	yes	no	no
readTrace(traceIndex)	yes	yes	no	no
readTraces()	yes	yes	no	no
readTraceHeaders()	yes	yes	no	no
liveToGlobalTraceIndex()	yes	yes	no	no
readWithinLiveTraces()	yes	yes	no	no
readWithinLiveTraceHeaders()	yes	yes	no	no
readFrame(position)	yes	yes	no	no
readFrame(frameIndex)	yes	yes	no	no
readRawFrames(position)	yes	yes	no	no
readRawFrames(frameIndex)	yes	yes	no	no
uncompressRawFrame()	yes	yes	no	no
getNumOfLiveTraces()	yes	yes	no	no
getVersion()	yes	yes	no	no
getCustomProperty()	yes	yes	no	no
getNumOfExtents()	yes	yes	no	no
getNumOfVirtualFolders()	yes	yes	no	no