clickDetector

Class RainbowFile

java.lang.Object

clickDetector.RainbowFile

All Implemented Interfaces:

ClickFileStorage

public class RainbowFile
extends java.lang.Object
implements ClickFileStorage

Author:

Doug Gillespie

Creates a file in the RainbowClick file format. Required Rainbowclick structures are subclasses of RainbowFile. The class is also responsible for holding the file handle, etc.

Not all RainbowClick structures are implemented since may of them contain no useful data. Parameter settings will be added to other Pam storage as that developes.

Field Summary

Fields

Modifier and Type	Field and Description
static int	HEADER_CLICK
static int	HEADER_GPSDATA
static int	HEADER_NOISE
static int	HEADER_NOISEWAVE
static int	HEADER_SECTION
static int	HEADER_SEISMIC

Constructor Summary

Constructors

Constructor and Description
RainbowFile(ClickDetector clickDetector)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkStorage()
static boolean	checkStorage(java.lang.String dirName)
void	closeClickStorage()
long	getFileEndTime()
long	getFileStartTime()
int	getNClicksInFile()
ClickDetection	getNextClick() Get the next clicks from the file.
int	getNumSections()
java.io.File	getRainbowFile() Get the current File object
float	getSampleRate()
java.lang.String	getStorageName()
boolean	gotoSectionData(int iSection)
boolean	gotoSectionHead(int iSection)
boolean	moveToClicks()
boolean	openClickStorage(java.io.File oldFile) Open an old rainbowclick file to reload data for viewing or for batch conversion into binary files.
boolean	openClickStorage(long sampleOffset) Open a new rainbowFile for storage.
boolean	readClickStructure(int structId, ClickParameters clickParameters)
boolean	readClickStructures(ClickParameters clickParameters)
boolean	readClickStructures(ClickParameters clickParameters, boolean fromStart) Read click head structures from a rainbowclick file.
boolean	readSCSettings(ClickParameters clickParameters)
boolean	reWriteClick(ClickDetection click)
boolean	writeClick(ClickDetection click)
boolean	writeClickHeader(ClickDetection click)
boolean	writeClickStructure(int structId, ClickParameters clickParameters)
boolean	writeClickStructures(ClickParameters clickParameters)
boolean	writeSCSettings(ClickParameters clickParameters)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HEADER_CLICK

public static final int HEADER_CLICK

See Also:

Constant Field Values

HEADER_SECTION

public static final int HEADER_SECTION

See Also:

Constant Field Values

HEADER_GPSDATA

public static final int HEADER_GPSDATA

See Also:

Constant Field Values

HEADER_NOISE

public static final int HEADER_NOISE

See Also:

Constant Field Values

HEADER_SEISMIC

public static final int HEADER_SEISMIC

See Also:

Constant Field Values

HEADER_NOISEWAVE

public static final int HEADER_NOISEWAVE

See Also:

Constant Field Values

Constructor Detail

RainbowFile

public RainbowFile(ClickDetector clickDetector)

Method Detail

openClickStorage

public boolean openClickStorage(long sampleOffset)

Open a new rainbowFile for storage.

Specified by:

openClickStorage in interface ClickFileStorage

openClickStorage

public boolean openClickStorage(java.io.File oldFile)

Open an old rainbowclick file to reload data for viewing or for batch conversion into binary files.

gotoSectionHead

public boolean gotoSectionHead(int iSection)

gotoSectionData

public boolean gotoSectionData(int iSection)

closeClickStorage

public void closeClickStorage()

Specified by:

closeClickStorage in interface ClickFileStorage

getNumSections

public int getNumSections()

Returns:

the number of sections in an old style RC file.

writeClickStructures

public boolean writeClickStructures(ClickParameters clickParameters)

Specified by:

writeClickStructures in interface ClickFileStorage

readClickStructures

public boolean readClickStructures(ClickParameters clickParameters)

readClickStructures

public boolean readClickStructures(ClickParameters clickParameters,
                          boolean fromStart)

Read click head structures from a rainbowclick file.

Parameters:

clickParameters -

Returns:

true if read ok, false otherwise

moveToClicks

public boolean moveToClicks()

getNextClick

public ClickDetection getNextClick()

Get the next clicks from the file. Assume that the file pointer is in the right place, etc.

Returns:

next click, or null if EOF.

writeClickStructure

public boolean writeClickStructure(int structId,
                          ClickParameters clickParameters)

readClickStructure

public boolean readClickStructure(int structId,
                         ClickParameters clickParameters)

writeSCSettings

public boolean writeSCSettings(ClickParameters clickParameters)

readSCSettings

public boolean readSCSettings(ClickParameters clickParameters)

writeClickHeader

public boolean writeClickHeader(ClickDetection click)

Specified by:

writeClickHeader in interface ClickFileStorage

reWriteClick

public boolean reWriteClick(ClickDetection click)

writeClick

public boolean writeClick(ClickDetection click)

Specified by:

writeClick in interface ClickFileStorage

getStorageName

public java.lang.String getStorageName()

Specified by:

getStorageName in interface ClickFileStorage

checkStorage

public boolean checkStorage()

Specified by:

checkStorage in interface ClickFileStorage

checkStorage

public static boolean checkStorage(java.lang.String dirName)

getFileStartTime

public long getFileStartTime()

Returns:

the file start time in standard Java milliseconds

getFileEndTime

public long getFileEndTime()

Returns:

the file end time in standard Java milliseconds

getSampleRate

public float getSampleRate()

Returns:

the files sample rate in Hz

getRainbowFile

public java.io.File getRainbowFile()

Get the current File object

Returns:

File object.

getNClicksInFile

public int getNClicksInFile()

Returns:

the nClicksInFile