Package edu.sc.seis.seisFile.mseed3

Class FDSNSourceId

java.lang.Object

edu.sc.seis.seisFile.mseed3.FDSNSourceId

public class FDSNSourceId
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	bandCode
static java.lang.String	DEFAULT_LOCATION_CODE
static java.lang.String	DEFAULT_NETWORK_CODE
static java.lang.String	DEFAULT_SOURCE_CODE
static java.lang.String	DEFAULT_STATION_CODE
static java.lang.String	DEFAULT_SUBSOURCE_CODE
static java.lang.String	FDSN_PREFIX
protected java.lang.String	locationCode
protected java.lang.String	networkCode
static java.lang.String	SEP
protected java.lang.String	sourceCode
static java.util.regex.Pattern	sourceIdRegEx
static java.lang.String	sourceIdRegExString
protected java.lang.String	stationCode
protected java.lang.String	subsourceCode

Constructor Summary

Constructors

Constructor	Description
FDSNSourceId(java.lang.String networkCode, java.lang.String stationCode, java.lang.String locationCode, java.lang.String bandCode, java.lang.String sourceCode, java.lang.String subsourceCode)

Method Summary

Modifier and Type	Method	Description
static java.lang.String	bandCodeForRate(java.lang.Double sampRate, java.lang.Double response_lb)	Calculates the band code for the given sample rate.
static FDSNSourceId	createUnknown(double sampleRate)
boolean	equals(java.lang.Object o)
static FDSNSourceId	fromNSLC(java.lang.String networkCode, java.lang.String stationCode, java.lang.String locationCode, java.lang.String channelCode)
java.lang.String	getBandCode()
java.lang.String	getChannelCode()	If band, source and subsource are all length 1, returns a 3-char channel code like BHZ.
java.lang.String	getLocationCode()
java.lang.String	getNetworkCode()
java.lang.String	getSourceCode()
java.lang.String	getStationCode()
java.lang.String	getSubsourceCode()
int	hashCode()
static FDSNSourceId	parse(java.lang.String sourceIdUrl)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

FDSN_PREFIX

public static final java.lang.String FDSN_PREFIX

See Also:

Constant Field Values

SEP

public static final java.lang.String SEP

See Also:

Constant Field Values

sourceIdRegExString

public static final java.lang.String sourceIdRegExString

See Also:

Constant Field Values

sourceIdRegEx

public static final java.util.regex.Pattern sourceIdRegEx

DEFAULT_SOURCE_CODE

public static final java.lang.String DEFAULT_SOURCE_CODE

See Also:

Constant Field Values

DEFAULT_NETWORK_CODE

public static final java.lang.String DEFAULT_NETWORK_CODE

See Also:

Constant Field Values

DEFAULT_STATION_CODE

public static final java.lang.String DEFAULT_STATION_CODE

See Also:

Constant Field Values

DEFAULT_LOCATION_CODE

public static final java.lang.String DEFAULT_LOCATION_CODE

See Also:

Constant Field Values

DEFAULT_SUBSOURCE_CODE

public static final java.lang.String DEFAULT_SUBSOURCE_CODE

See Also:

Constant Field Values

networkCode

protected java.lang.String networkCode

stationCode

protected java.lang.String stationCode

locationCode

protected java.lang.String locationCode

bandCode

protected java.lang.String bandCode

sourceCode

protected java.lang.String sourceCode

subsourceCode

protected java.lang.String subsourceCode

Constructor Detail

FDSNSourceId

public FDSNSourceId(java.lang.String networkCode,
                    java.lang.String stationCode,
                    java.lang.String locationCode,
                    java.lang.String bandCode,
                    java.lang.String sourceCode,
                    java.lang.String subsourceCode)

Method Detail

parse

public static FDSNSourceId parse(java.lang.String sourceIdUrl)
                          throws FDSNSourceIdException

Throws:

FDSNSourceIdException

fromNSLC

public static FDSNSourceId fromNSLC(java.lang.String networkCode,
                                    java.lang.String stationCode,
                                    java.lang.String locationCode,
                                    java.lang.String channelCode)
                             throws FDSNSourceIdException

Throws:

FDSNSourceIdException

createUnknown

public static FDSNSourceId createUnknown(double sampleRate)
                                  throws FDSNSourceIdException

Throws:

FDSNSourceIdException

getNetworkCode

public java.lang.String getNetworkCode()

getStationCode

public java.lang.String getStationCode()

getLocationCode

public java.lang.String getLocationCode()

getBandCode

public java.lang.String getBandCode()

getSourceCode

public java.lang.String getSourceCode()

getSubsourceCode

public java.lang.String getSubsourceCode()

getChannelCode

public java.lang.String getChannelCode()

If band, source and subsource are all length 1, returns a 3-char channel code like BHZ. Otherwise, return separated by '_' like B_XY_Z.

Returns:

combination of band, source and subsource code

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

bandCodeForRate

public static java.lang.String bandCodeForRate(java.lang.Double sampRate,
                                               java.lang.Double response_lb)
                                        throws FDSNSourceIdException

Calculates the band code for the given sample rate. Optionally taking into account the lower bound of the response, response_lb, to distinguish broadband from short period in the higher sample rates, where 0.1 hertz/10 seconds is the boundary. Use of negative values implies period in seconds, while positive implies Hz. See http://docs.fdsn.org/projects/source-identifiers/en/v1.0/channel-codes.html#band-code

Parameters:

sampRate - sample rate, Hz if positive, period in seconds if negative

response_lb - response lower bound in Hz if positive, period if negative

Returns:

Throws:

FDSNSourceIdException