Package edu.sc.seis.seisFile.sac

Class SacHeader

  • public class SacHeader
extends java.lang.Object
    Class that represents a sac file heder. All headers are have the same names as within the Sac program. This reflects the sac header as of version 101.4 in utils/sac.h Notes: Key to comment flags describing each field: Column 1: R required by SAC (blank) optional Column 2: A = settable from a priori knowledge D = available in data F = available in or derivable from SEED fixed data header T = available in SEED header tables (blank) = not directly available from SEED data, header tables, or elsewhere

    • Constructor Detail

      • SacHeader

        public SacHeader()

      • SacHeader

        public SacHeader​(java.lang.String filename)
          throws java.io.IOException
        Throws:
        java.io.IOException

      • SacHeader

        public SacHeader​(java.io.DataInput indis)
          throws java.io.IOException
        Throws:
        java.io.IOException

      • SacHeader

        public SacHeader​(java.io.File sacFile)
          throws java.io.IOException
        reads just the sac header specified by the filename. Limited checks are made to be sure the file really is a sac file.
        Throws:
        java.io.IOException

    • Method Detail

      • createEmptyEvenSampledTimeSeriesHeader

        public static SacHeader createEmptyEvenSampledTimeSeriesHeader()

      • writeHeader

        public void writeHeader​(java.io.File file)
                 throws java.io.FileNotFoundException,
                        java.io.IOException
        writes this object out as a sac file.
        Throws:
        java.io.FileNotFoundException
        java.io.IOException

      • writeHeader

        public void writeHeader​(java.io.DataOutput dos)
                 throws java.io.IOException
        Throws:
        java.io.IOException

      • getSourceId

        public FDSNSourceId getSourceId()
                         throws FDSNSourceIdException
        Create source id from knetwk, kstnm, khole and kcmpnm header values. Default values for network "XX" station "ABC" and location "" are used if the corresponding header is empty.
        Returns:
        Channel identifier as an FDSN SourceId.
        Throws:
        FDSNSourceIdException

      • setSourceId

        public void setSourceId​(FDSNSourceId sid)
        Sets the knetwk, kstnm, khole and kcmpnm header values using the given source id.
        Parameters:
        sid -

      • setLittleEndian

        public final void setLittleEndian()
        Sets the byte order when writing to output. Does not change the internal representation of the data.

      • setBigEndian

        public final void setBigEndian()
        Sets the byte order when writing to output. Does not change the internal representation of the data.

      • swapBytes

        public static final short swapBytes​(short val)

      • swapBytes

        public static final int swapBytes​(int val)

      • swapBytes

        public static final long swapBytes​(long val)

      • trimLen

        public static java.lang.String trimLen​(java.lang.String s,
                                       int len)

      • format

        public static java.lang.String format​(java.lang.String label,
                                      float f,
                                      java.text.DecimalFormat decimalFormat)

      • format

        public static java.lang.String format​(java.lang.String label,
                                      int val)

      • format

        public static java.lang.String format​(java.lang.String label,
                                      java.lang.String val,
                                      int labelWidth,
                                      int valWidth)

      • formatLine

        public static java.lang.String formatLine​(java.lang.String s1,
                                          float f1,
                                          java.lang.String s2,
                                          float f2,
                                          java.lang.String s3,
                                          float f3,
                                          java.lang.String s4,
                                          float f4,
                                          java.lang.String s5,
                                          float f5,
                                          java.text.DecimalFormat decimalFormat)

      • printHeader

        public void printHeader()

      • printHeader

        public void printHeader​(java.io.PrintWriter out)

      • getByteOrder

        public boolean getByteOrder()

      • getDelta

        public float getDelta()

      • setDelta

        public void setDelta​(float delta)

      • getSampleRate

        public float getSampleRate()
        Gets the sample rate in hertz, 1/delta.
        Returns:
        1/delta

      • getSamplePeriod

        public float getSamplePeriod()
        Gets the sample period, eg the delta header.
        Returns:
        delta

      • getDepmin

        public float getDepmin()

      • setDepmin

        public void setDepmin​(float depmin)

      • getDepmax

        public float getDepmax()

      • setDepmax

        public void setDepmax​(float depmax)

      • getScale

        public float getScale()

      • setScale

        public void setScale​(float scale)

      • getOdelta

        public float getOdelta()

      • setOdelta

        public void setOdelta​(float odelta)

      • getB

        public float getB()

      • setB

        public void setB​(float b)

      • getE

        public float getE()

      • setE

        public void setE​(float e)

      • getO

        public float getO()

      • setO

        public void setO​(float o)

      • getA

        public float getA()

      • setA

        public void setA​(float a)

      • getFmt

        public float getFmt()

      • setFmt

        public void setFmt​(float fmt)

      • getTHeader

        public float getTHeader​(int index)

      • setTHeader

        public void setTHeader​(int index,
                       float val)

      • setTHeader

        public void setTHeader​(int index,
                       float val,
                       java.lang.String kLabel)
        Sets T header specified by the index to val, and sets the corresponding KT header to be the label. indices 0-9 map to T0-T9 and index 10 maps to the A header.

      • getKTHeader

        public java.lang.String getKTHeader​(int index)

      • setKtHeader

        public void setKtHeader​(int index,
                        java.lang.String val)

      • getT0

        public float getT0()

      • setT0

        public void setT0​(float t0)

      • getT1

        public float getT1()

      • setT1

        public void setT1​(float t1)

      • getT2

        public float getT2()

      • setT2

        public void setT2​(float t2)

      • getT3

        public float getT3()

      • setT3

        public void setT3​(float t3)

      • getT4

        public float getT4()

      • setT4

        public void setT4​(float t4)

      • getT5

        public float getT5()

      • setT5

        public void setT5​(float t5)

      • getT6

        public float getT6()

      • setT6

        public void setT6​(float t6)

      • getT7

        public float getT7()

      • setT7

        public void setT7​(float t7)

      • getT8

        public float getT8()

      • setT8

        public void setT8​(float t8)

      • getT9

        public float getT9()

      • setT9

        public void setT9​(float t9)

      • getF

        public float getF()

      • setF

        public void setF​(float f)

      • getResp0

        public float getResp0()

      • setResp0

        public void setResp0​(float resp0)

      • getResp1

        public float getResp1()

      • setResp1

        public void setResp1​(float resp1)

      • getResp2

        public float getResp2()

      • setResp2

        public void setResp2​(float resp2)

      • getResp3

        public float getResp3()

      • setResp3

        public void setResp3​(float resp3)

      • getResp4

        public float getResp4()

      • setResp4

        public void setResp4​(float resp4)

      • getResp5

        public float getResp5()

      • setResp5

        public void setResp5​(float resp5)

      • getResp6

        public float getResp6()

      • setResp6

        public void setResp6​(float resp6)

      • getResp7

        public float getResp7()

      • setResp7

        public void setResp7​(float resp7)

      • getResp8

        public float getResp8()

      • setResp8

        public void setResp8​(float resp8)

      • getResp9

        public float getResp9()

      • setResp9

        public void setResp9​(float resp9)

      • getStla

        public float getStla()

      • setStla

        public void setStla​(float stla)

      • getStlo

        public float getStlo()

      • setStlo

        public void setStlo​(float stlo)

      • getStel

        public float getStel()

      • setStel

        public void setStel​(float stel)

      • getStdp

        public float getStdp()

      • setStdp

        public void setStdp​(float stdp)

      • getEvla

        public float getEvla()

      • setEvla

        public void setEvla​(float evla)

      • getEvlo

        public float getEvlo()

      • setEvlo

        public void setEvlo​(float evlo)

      • getEvel

        public float getEvel()

      • setEvel

        public void setEvel​(float evel)

      • getEvdp

        public float getEvdp()

      • setEvdp

        public void setEvdp​(float evdp)

      • getEvdpkm

        public float getEvdpkm()
        Gets event depth in kilometers. Default unit for header is meters.
        Returns:

      • setEvdpkm

        public void setEvdpkm​(float evdpkm)
        Sets evdp in kilometers. Default unit for header is meters.
        Parameters:
        evdpkm - event depth in kilometers

      • getMag

        public float getMag()

      • setMag

        public void setMag​(float mag)

      • getUserHeader

        public float getUserHeader​(int index)

      • setUserHeader

        public void setUserHeader​(int index,
                          float val)

      • getUser0

        public float getUser0()

      • setUser0

        public void setUser0​(float user0)

      • getUser1

        public float getUser1()

      • setUser1

        public void setUser1​(float user1)

      • getUser2

        public float getUser2()

      • setUser2

        public void setUser2​(float user2)

      • getUser3

        public float getUser3()

      • setUser3

        public void setUser3​(float user3)

      • getUser4

        public float getUser4()

      • setUser4

        public void setUser4​(float user4)

      • getUser5

        public float getUser5()

      • setUser5

        public void setUser5​(float user5)

      • getUser6

        public float getUser6()

      • setUser6

        public void setUser6​(float user6)

      • getUser7

        public float getUser7()

      • setUser7

        public void setUser7​(float user7)

      • getUser8

        public float getUser8()

      • setUser8

        public void setUser8​(float user8)

      • getUser9

        public float getUser9()

      • setUser9

        public void setUser9​(float user9)

      • getDist

        public float getDist()

      • setDist

        public void setDist​(float dist)

      • getAz

        public float getAz()

      • setAz

        public void setAz​(float az)

      • getBaz

        public float getBaz()

      • setBaz

        public void setBaz​(float baz)

      • getGcarc

        public float getGcarc()

      • setGcarc

        public void setGcarc​(float gcarc)

      • getSb

        public float getSb()

      • setSb

        public void setSb​(float sb)

      • getSdelta

        public float getSdelta()

      • setSdelta

        public void setSdelta​(float sdelta)

      • getDepmen

        public float getDepmen()

      • setDepmen

        public void setDepmen​(float depmen)

      • getCmpaz

        public float getCmpaz()

      • setCmpaz

        public void setCmpaz​(float cmpaz)

      • getCmpinc

        public float getCmpinc()

      • setCmpinc

        public void setCmpinc​(float cmpinc)

      • getXminimum

        public float getXminimum()

      • setXminimum

        public void setXminimum​(float xminimum)

      • getXmaximum

        public float getXmaximum()

      • setXmaximum

        public void setXmaximum​(float xmaximum)

      • getYminimum

        public float getYminimum()

      • setYminimum

        public void setYminimum​(float yminimum)

      • getYmaximum

        public float getYmaximum()

      • setYmaximum

        public void setYmaximum​(float ymaximum)

      • getUnused6

        public float getUnused6()

      • setUnused6

        public void setUnused6​(float unused6)

      • getUnused7

        public float getUnused7()

      • setUnused7

        public void setUnused7​(float unused7)

      • getUnused8

        public float getUnused8()

      • setUnused8

        public void setUnused8​(float unused8)

      • getUnused9

        public float getUnused9()

      • setUnused9

        public void setUnused9​(float unused9)

      • getUnused10

        public float getUnused10()

      • setUnused10

        public void setUnused10​(float unused10)

      • getUnused11

        public float getUnused11()

      • setUnused11

        public void setUnused11​(float unused11)

      • getUnused12

        public float getUnused12()

      • setUnused12

        public void setUnused12​(float unused12)

      • getNzyear

        public int getNzyear()

      • setNzyear

        public void setNzyear​(int nzyear)

      • getNzjday

        public int getNzjday()

      • setNzjday

        public void setNzjday​(int nzjday)

      • getNzhour

        public int getNzhour()

      • setNzhour

        public void setNzhour​(int nzhour)

      • getNzmin

        public int getNzmin()

      • setNzmin

        public void setNzmin​(int nzmin)

      • getNzsec

        public int getNzsec()

      • setNzsec

        public void setNzsec​(int nzsec)

      • getNzmsec

        public int getNzmsec()

      • setNzmsec

        public void setNzmsec​(int nzmsec)

      • setNzTime

        public void setNzTime​(java.time.ZonedDateTime start)

      • setNzTime

        public void setNzTime​(java.time.Instant start)

      • getNzTime

        public java.time.ZonedDateTime getNzTime()

      • getNvhdr

        public int getNvhdr()

      • setNvhdr

        public void setNvhdr​(int nvhdr)

      • getNorid

        public int getNorid()

      • setNorid

        public void setNorid​(int norid)

      • getNevid

        public int getNevid()

      • setNevid

        public void setNevid​(int nevid)

      • getNpts

        public int getNpts()

      • setNpts

        public void setNpts​(int npts)

      • getNsnpts

        public int getNsnpts()

      • setNsnpts

        public void setNsnpts​(int nsnpts)

      • getNwfid

        public int getNwfid()

      • setNwfid

        public void setNwfid​(int nwfid)

      • getNxsize

        public int getNxsize()

      • setNxsize

        public void setNxsize​(int nxsize)

      • getNysize

        public int getNysize()

      • setNysize

        public void setNysize​(int nysize)

      • getUnused15

        public int getUnused15()

      • setUnused15

        public void setUnused15​(int unused15)

      • getIftype

        public int getIftype()

      • setIftype

        public void setIftype​(int iftype)

      • getIdep

        public int getIdep()

      • setIdep

        public void setIdep​(int idep)

      • getIztype

        public int getIztype()

      • setIztype

        public void setIztype​(int iztype)

      • getUnused16

        public int getUnused16()

      • setUnused16

        public void setUnused16​(int unused16)

      • getIinst

        public int getIinst()

      • setIinst

        public void setIinst​(int iinst)

      • getIstreg

        public int getIstreg()

      • setIstreg

        public void setIstreg​(int istreg)

      • getIevreg

        public int getIevreg()

      • setIevreg

        public void setIevreg​(int ievreg)

      • getIevtyp

        public int getIevtyp()

      • setIevtyp

        public void setIevtyp​(int ievtyp)

      • getIqual

        public int getIqual()

      • setIqual

        public void setIqual​(int iqual)

      • getIsynth

        public int getIsynth()

      • setIsynth

        public void setIsynth​(int isynth)

      • getImagtyp

        public int getImagtyp()

      • setImagtyp

        public void setImagtyp​(int imagtyp)

      • getMagnitudeType

        public java.lang.String getMagnitudeType()

      • getImagsrc

        public int getImagsrc()

      • setImagsrc

        public void setImagsrc​(int imagsrc)

      • getUnused19

        public int getUnused19()

      • setUnused19

        public void setUnused19​(int unused19)

      • getUnused20

        public int getUnused20()

      • setUnused20

        public void setUnused20​(int unused20)

      • getUnused21

        public int getUnused21()

      • setUnused21

        public void setUnused21​(int unused21)

      • getUnused22

        public int getUnused22()

      • setUnused22

        public void setUnused22​(int unused22)

      • getUnused23

        public int getUnused23()

      • setUnused23

        public void setUnused23​(int unused23)

      • getUnused24

        public int getUnused24()

      • setUnused24

        public void setUnused24​(int unused24)

      • getUnused25

        public int getUnused25()

      • setUnused25

        public void setUnused25​(int unused25)

      • getUnused26

        public int getUnused26()

      • setUnused26

        public void setUnused26​(int unused26)

      • getLeven

        public int getLeven()

      • setLeven

        public void setLeven​(int leven)

      • getLpspol

        public int getLpspol()

      • setLpspol

        public void setLpspol​(int lpspol)

      • getLovrok

        public int getLovrok()

      • setLovrok

        public void setLovrok​(int lovrok)

      • getLcalda

        public int getLcalda()

      • setLcalda

        public void setLcalda​(int lcalda)

      • getUnused27

        public int getUnused27()

      • setUnused27

        public void setUnused27​(int unused27)

      • getKstnm

        public java.lang.String getKstnm()

      • setKstnm

        public void setKstnm​(java.lang.String kstnm)

      • getKevnm

        public java.lang.String getKevnm()

      • setKevnm

        public void setKevnm​(java.lang.String kevnm)

      • getKhole

        public java.lang.String getKhole()

      • setKhole

        public void setKhole​(java.lang.String khole)

      • getKo

        public java.lang.String getKo()

      • setKo

        public void setKo​(java.lang.String ko)

      • getKa

        public java.lang.String getKa()

      • setKa

        public void setKa​(java.lang.String ka)

      • getKt0

        public java.lang.String getKt0()

      • setKt0

        public void setKt0​(java.lang.String kt0)

      • getKt1

        public java.lang.String getKt1()

      • setKt1

        public void setKt1​(java.lang.String kt1)

      • getKt2

        public java.lang.String getKt2()

      • setKt2

        public void setKt2​(java.lang.String kt2)

      • getKt3

        public java.lang.String getKt3()

      • setKt3

        public void setKt3​(java.lang.String kt3)

      • getKt4

        public java.lang.String getKt4()

      • setKt4

        public void setKt4​(java.lang.String kt4)

      • getKt5

        public java.lang.String getKt5()

      • setKt5

        public void setKt5​(java.lang.String kt5)

      • getKt6

        public java.lang.String getKt6()

      • setKt6

        public void setKt6​(java.lang.String kt6)

      • getKt7

        public java.lang.String getKt7()

      • setKt7

        public void setKt7​(java.lang.String kt7)

      • getKt8

        public java.lang.String getKt8()

      • setKt8

        public void setKt8​(java.lang.String kt8)

      • getKt9

        public java.lang.String getKt9()

      • setKt9

        public void setKt9​(java.lang.String kt9)

      • getKf

        public java.lang.String getKf()

      • setKf

        public void setKf​(java.lang.String kf)

      • getKuser0

        public java.lang.String getKuser0()

      • setKuser0

        public void setKuser0​(java.lang.String kuser0)

      • getKuser1

        public java.lang.String getKuser1()

      • setKuser1

        public void setKuser1​(java.lang.String kuser1)

      • getKuser2

        public java.lang.String getKuser2()

      • setKuser2

        public void setKuser2​(java.lang.String kuser2)

      • getKcmpnm

        public java.lang.String getKcmpnm()

      • setKcmpnm

        public void setKcmpnm​(java.lang.String kcmpnm)

      • getKnetwk

        public java.lang.String getKnetwk()

      • setKnetwk

        public void setKnetwk​(java.lang.String knetwk)

      • getKdatrd

        public java.lang.String getKdatrd()

      • setKdatrd

        public void setKdatrd​(java.lang.String kdatrd)

      • getKinst

        public java.lang.String getKinst()

      • setKinst

        public void setKinst​(java.lang.String kinst)

      • setByteOrder

        public void setByteOrder​(boolean byteOrder)