Package edu.sc.seis.seisFile.mseed
Class DataHeader
java.lang.Object
edu.sc.seis.seisFile.mseed.ControlHeader
edu.sc.seis.seisFile.mseed.DataHeader
Container class for SEED Fixed Section Data Header information.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected byte
protected byte[]
protected String
protected int
protected int
protected byte
protected byte
protected byte[]
protected String
protected byte[]
protected String
protected byte
protected int
protected int
protected int
protected byte[]
protected byte[]
protected String
protected int
Fields inherited from class edu.sc.seis.seisFile.mseed.ControlHeader
continuationCode, sequenceNum, typeCode
-
Constructor Summary
ConstructorsConstructorDescriptionDataHeader
(int sequenceNum, char typeCode, boolean continuationCode) creates a DataHeader object with listed sequence number, type code, and continuation code boolean. -
Method Summary
Modifier and TypeMethodDescriptionfloat
get the sample rate.static short[]
calcSeedMultipilerFactor
(double sps) byte
Get the value of activityFlags.Get the value of channelIdentifier.getCodes()
int
Get the value of dataBlocketteOffset.int
Get the value of dataOffset.byte
Get the value of dataQualityFlags.byte
Get the value of IOClockFlags.Get the value of locationIdentifier.Get the value of networkCode.byte
Get the value of numBlockettes.int
Get the value of numSamples.char
same as getTypeCode() in ControlHeader, just a convenience method as the type code is called a Data header/quality indicator in the seed documentation for data header.int
Get the value of sampleRateFactor.int
Get the value of sampleRateMultiplier.short
getSize()
Get the value of startTime.Get the value of stationIdentifier.int
Get the value of timeCorrection.protected void
read
(byte[] buf, int offset) populates this object with Fixed Section Data Header info.static DataHeader
Instantiate an object of this class and read an FSDH byte stream into it, parsing the contents into the instance variables of this object, which represent the individual FSDH fields.
Note, first 8 bytes are assumed to already have been read.void
setActivityFlags
(byte v) Set the value of activityFlags.void
Set the value of channelIdentifier.void
setDataBlocketteOffset
(short v) Set the value of dataBlocketteOffset.void
setDataOffset
(short v) Set the value of dataOffset.void
setDataQualityFlags
(byte v) Set the value of dataQualityFlags.void
setIOClockFlags
(byte v) Set the value of IOClockFlags.void
Set the value of locationIdentifier.void
Set the value of networkCode.void
setNumBlockettes
(byte v) Set the value of numBlockettes.void
setNumSamples
(short v) Set the value of numSamples.void
setSampleRate
(double samplePerSecond) void
setSampleRateFactor
(short v) Set the value of sampleRateFactor.void
setSampleRateMultiplier
(short v) Set the value of sampleRateMultiplier.void
setStartBtime
(Btime btime) void
Set the value of stationIdentifier.void
setTimeCorrection
(int v) Set the value of timeCorrection.toString()
Present a default string representation of the contents of this objectprotected void
write
(DataOutput dos) write DataHeader contents to a DataOutput streamvoid
writeASCII
(PrintWriter out) Writes an ASCII version of the record header.void
writeASCII
(PrintWriter out, String indent) Methods inherited from class edu.sc.seis.seisFile.mseed.ControlHeader
getSequenceNum, getTypeCode, isContinuation, main, read, tester
-
Field Details
-
stationIdentifier
protected byte[] stationIdentifier -
stationIdentifierString
-
locationIdentifier
protected byte[] locationIdentifier -
locationIdentifierString
-
channelIdentifier
protected byte[] channelIdentifier -
channelIdentifierString
-
networkCode
protected byte[] networkCode -
networkCodeString
-
startTime
protected byte[] startTime -
numSamples
protected int numSamples -
sampleRateFactor
protected int sampleRateFactor -
sampleRateMultiplier
protected int sampleRateMultiplier -
activityFlags
protected byte activityFlags -
ioClockFlags
protected byte ioClockFlags -
dataQualityFlags
protected byte dataQualityFlags -
numBlockettes
protected byte numBlockettes -
timeCorrection
protected int timeCorrection -
dataOffset
protected int dataOffset -
dataBlocketteOffset
protected int dataBlocketteOffset
-
-
Constructor Details
-
DataHeader
public DataHeader(int sequenceNum, char typeCode, boolean continuationCode) creates a DataHeader object with listed sequence number, type code, and continuation code boolean.- Parameters:
sequenceNum
- sequence number of the record represented by this object.typeCode
- character representing the type of record represented by this objectcontinuationCode
- true if this record is flagged as a continuation from its previous SEED record
-
-
Method Details
-
writeASCII
Writes an ASCII version of the record header. This is not meant to be a definitive ascii representation, merely to give something to print for debugging purposes. Ideally each field of the header should be printed in the order is appears in the header in a visually appealing way.- Overrides:
writeASCII
in classControlHeader
- Parameters:
out
- a Writer- Throws:
IOException
-
writeASCII
- Overrides:
writeASCII
in classControlHeader
- Throws:
IOException
-
read
public static DataHeader read(DataInput in, int sequenceNum, char typeCode, boolean continuationCode) throws IOException, SeedFormatException Instantiate an object of this class and read an FSDH byte stream into it, parsing the contents into the instance variables of this object, which represent the individual FSDH fields.
Note, first 8 bytes are assumed to already have been read.- Parameters:
in
- SEED data stream offset 8 bytes from beginning of record.sequenceNum
- 6 digit ascii sequence tag at the beginning of SEED record.typeCode
- character representing the type of record being readcontinuationCode
- true if this record is flagged as a continuation from its previous SEED record.- Returns:
- an object of this class with fields filled from 'in' parameter
- Throws:
IOException
SeedFormatException
-
read
protected void read(byte[] buf, int offset) populates this object with Fixed Section Data Header info. this routine modified to include byte offset, should the station identifier start at a byte offset (such as 8 from the beginning of a data record).- Parameters:
buf
- data buffer containing FSDH informationoffset
- byte offset to begin reading buf
-
write
write DataHeader contents to a DataOutput stream- Overrides:
write
in classControlHeader
- Parameters:
dos
- DataOutput stream to write to- Throws:
IOException
-
getSize
public short getSize()- Overrides:
getSize
in classControlHeader
-
getQualityIndicator
public char getQualityIndicator()same as getTypeCode() in ControlHeader, just a convenience method as the type code is called a Data header/quality indicator in the seed documentation for data header. -
getStationIdentifier
Get the value of stationIdentifier.- Returns:
- Value of stationIdentifier.
-
setStationIdentifier
Set the value of stationIdentifier.- Parameters:
v
- Value to assign to stationIdentifier.
-
getLocationIdentifier
Get the value of locationIdentifier.- Returns:
- Value of locationIdentifier.
-
setLocationIdentifier
Set the value of locationIdentifier.- Parameters:
v
- Value to assign to locationIdentifier.
-
getChannelIdentifier
Get the value of channelIdentifier.- Returns:
- Value of channelIdentifier.
-
setChannelIdentifier
Set the value of channelIdentifier.- Parameters:
v
- Value to assign to channelIdentifier.
-
getNetworkCode
Get the value of networkCode.- Returns:
- Value of networkCode.
-
setNetworkCode
Set the value of networkCode.- Parameters:
v
- Value to assign to networkCode.
-
getStartBtime
-
setStartBtime
-
getStartTime
Get the value of startTime.- Returns:
- Value of startTime.
-
getNumSamples
public int getNumSamples()Get the value of numSamples.- Returns:
- Value of numSamples.
-
setNumSamples
public void setNumSamples(short v) Set the value of numSamples.- Parameters:
v
- Value to assign to numSamples.
-
getSampleRateFactor
public int getSampleRateFactor()Get the value of sampleRateFactor.- Returns:
- Value of sampleRateFactor.
-
setSampleRateFactor
public void setSampleRateFactor(short v) Set the value of sampleRateFactor.- Parameters:
v
- Value to assign to sampleRateFactor.
-
getSampleRateMultiplier
public int getSampleRateMultiplier()Get the value of sampleRateMultiplier.- Returns:
- Value of sampleRateMultiplier.
-
setSampleRateMultiplier
public void setSampleRateMultiplier(short v) Set the value of sampleRateMultiplier.- Parameters:
v
- Value to assign to sampleRateMultiplier.
-
setSampleRate
public void setSampleRate(double samplePerSecond) -
calcSampleRateFromMultipilerFactor
public float calcSampleRateFromMultipilerFactor()get the sample rate. derived from sample rate factor and the sample rate multiplier. Note this may not be the true sample rate if the record contains a blockette 100. Returns zero if either of the multiplier or factor are zero, usually in the case of log/ascii/opaque data.- Returns:
- sample rate
-
calcSeedMultipilerFactor
public static short[] calcSeedMultipilerFactor(double sps) -
getActivityFlags
public byte getActivityFlags()Get the value of activityFlags.- Returns:
- Value of activityFlags.
-
setActivityFlags
public void setActivityFlags(byte v) Set the value of activityFlags.- Parameters:
v
- Value to assign to activityFlags.
-
getIOClockFlags
public byte getIOClockFlags()Get the value of IOClockFlags.- Returns:
- Value of IOClockFlags.
-
setIOClockFlags
public void setIOClockFlags(byte v) Set the value of IOClockFlags.- Parameters:
v
- Value to assign to IOClockFlags.
-
getDataQualityFlags
public byte getDataQualityFlags()Get the value of dataQualityFlags.- Returns:
- Value of dataQualityFlags.
-
setDataQualityFlags
public void setDataQualityFlags(byte v) Set the value of dataQualityFlags.- Parameters:
v
- Value to assign to dataQualityFlags.
-
getNumBlockettes
public byte getNumBlockettes()Get the value of numBlockettes.- Returns:
- Value of numBlockettes.
-
setNumBlockettes
public void setNumBlockettes(byte v) Set the value of numBlockettes.- Parameters:
v
- Value to assign to numBlockettes.
-
getTimeCorrection
public int getTimeCorrection()Get the value of timeCorrection.- Returns:
- Value of timeCorrection.
-
setTimeCorrection
public void setTimeCorrection(int v) Set the value of timeCorrection.- Parameters:
v
- Value to assign to timeCorrection.
-
getDataOffset
public int getDataOffset()Get the value of dataOffset.- Returns:
- Value of dataOffset.
-
setDataOffset
public void setDataOffset(short v) Set the value of dataOffset.- Parameters:
v
- Value to assign to dataOffset.
-
getDataBlocketteOffset
public int getDataBlocketteOffset()Get the value of dataBlocketteOffset.- Returns:
- Value of dataBlocketteOffset.
-
setDataBlocketteOffset
public void setDataBlocketteOffset(short v) Set the value of dataBlocketteOffset.- Parameters:
v
- Value to assign to dataBlocketteOffset.
-
toString
Present a default string representation of the contents of this object- Overrides:
toString
in classControlHeader
- Returns:
- formatted string of object contents
-
getCodes
-