def test_get_coordinates(self):
"""
Test extracting coordinates for SEED and XSEED (including #146)
"""
# SEED
sp = Parser(os.path.join(self.path, 'dataless.seed.BW_RJOB'))
result = {'elevation': 860.0, 'latitude': 47.737166999999999,
'longitude': 12.795714, 'local_depth': 0,
'azimuth': 0.0, 'local_depth': 0, 'dip': -90.0}
paz = sp.get_coordinates("BW.RJOB..EHZ", UTCDateTime("2007-01-01"))
self.assertEqual(sorted(paz.items()), sorted(result.items()))
paz = sp.get_coordinates("BW.RJOB..EHZ", UTCDateTime("2010-01-01"))
self.assertEqual(sorted(paz.items()), sorted(result.items()))
# XSEED
sp2 = Parser(sp.get_xseed())
paz = sp2.get_coordinates("BW.RJOB..EHZ", UTCDateTime("2007-01-01"))
self.assertEqual(sorted(paz.items()), sorted(result.items()))
paz = sp2.get_coordinates("BW.RJOB..EHZ", UTCDateTime("2010-01-01"))
self.assertEqual(sorted(paz.items()), sorted(result.items()))
# Additional test with non-trivial azimuth
sp = Parser(os.path.join(self.path, 'dataless.seed.II_COCO'))
result = {'elevation': 1.0, 'latitude': -12.1901,
'longitude': 96.8349, 'local_depth': 1.3,
'azimuth': 92.0, 'local_depth': 1.3, 'dip': 0.0}
paz = sp.get_coordinates("II.COCO.10.BH2", UTCDateTime("2010-11-11"))
self.assertEqual(sorted(paz.items()), sorted(result.items()))
def test_createRESPFromXSEED(self):
"""
Tests RESP file creation from XML-SEED.
"""
# 1
# parse Dataless SEED
filename = os.path.join(self.path, 'dataless.seed.BW_FURT')
sp1 = Parser(filename)
# write XML-SEED
with NamedTemporaryFile() as fh:
tempfile = fh.name
sp1.write_XSEED(tempfile)
# parse XML-SEED
sp2 = Parser(tempfile)
# create RESP files
sp2.get_RESP()
# 2
# parse Dataless SEED
filename = os.path.join(self.path, 'arclink_full.seed')
sp1 = Parser(filename)
# write XML-SEED
with NamedTemporaryFile() as fh:
tempfile = fh.name
sp1.write_XSEED(tempfile)
# parse XML-SEED
sp2 = Parser(tempfile)
# create RESP files
sp2.get_RESP()
def test_readAndWriteSEED(self):
"""
Reads all SEED records from the Bavarian network and writes them
again.
This should not change them.
There are some differences which will be edited before comparison:
- The written SEED file will always have the version 2.4. BW uses
version 2.3.
The different formating of numbers in the stations blockettes will not
be changed but 'evened'. Both are valid ways to do it - see SEED-Manual
chapter 3 for more informations.
"""
# Loop over all files.
for file in (self.BW_SEED_files[-1], ):
f = open(file, 'rb')
# Original SEED file.
original_seed = f.read()
f.seek(0)
# Parse and write the data.
parser = Parser(f)
f.close()
new_seed = parser.get_SEED()
# compare both SEED strings
compare_SEED(original_seed, new_seed)
del parser
parser1 = Parser(original_seed)
parser2 = Parser(new_seed)
self.assertEqual(parser1.get_SEED(), parser2.get_SEED())
del parser1, parser2
def test_read_resp(self):
"""
Tests reading a respfile by calling Parser(filename)
"""
sts2_resp_file = os.path.join(self.path,
'RESP.XX.NS085..BHZ.STS2_gen3.120.1500')
p = Parser(sts2_resp_file)
# Weak but at least tests that something has been read.
assert set(p.blockettes.keys()) == {34, 50, 52, 53, 54, 57, 58}
rt130_resp_file = os.path.join(self.path,
'RESP.XX.NR008..HHZ.130.1.100')
p = Parser(rt130_resp_file)
# Weak but at least tests that something has been read.
assert set(p.blockettes.keys()) == {34, 50, 52, 53, 54, 57, 58}
def test_issue165(self):
"""
Test cases related to #165:
- number of poles or zeros can be 0
- an unsupported response information somewhere in the metadata should
not automatically raise an Error, if the desired information can
still be retrieved
"""
parser = Parser(strict=True)
file = os.path.join(self.path, "bug165.dataless")
t = UTCDateTime("2010-01-01T00:00:00")
parser.read(file)
paz = parser.get_paz("NZ.DCZ.20.HNZ", t)
result = {
'digitizer_gain':
419430.0,
'gain':
24595700000000.0,
'poles': [(-981 + 1009j), (-981 - 1009j), (-3290 + 1263j),
(-3290 - 1263j)],
'seismometer_gain':
1.01885,
'sensitivity':
427336.0,
'zeros': []
}
self.assertEqual(paz, result)
def dataless2resp(filename, options):
files = []
for item in filename:
files.extend(glob(item))
if options.verbose:
msg = 'Found %s files.' % len(files) + os.linesep
sys.stdout.write(msg)
for file in files:
if not os.path.isfile(file):
continue
f = open(file, 'rb')
if f.read(7)[6:] != b'V':
if options.verbose:
msg = 'Skipping file %s' % file
msg += '\t-- not a Dataless SEED file' + os.linesep
sys.stdout.write(msg)
f.close()
continue
f.close()
if options.verbose:
msg = 'Parsing file %s' % file + os.linesep
sys.stdout.write(msg)
try:
parser = Parser(file, debug=options.debug)
if options.zipped:
folder = os.path.join(os.path.curdir, os.path.basename(file))
parser.write_resp(folder=folder, zipped=True)
else:
parser.write_resp(folder=os.path.curdir, zipped=False)
except Exception as e:
if options.debug:
raise
msg = '\tError parsing file %s' % file + os.linesep
msg += '\t' + str(e) + os.linesep
sys.stderr.write(msg)
def test_issue298b(self):
"""
Second test case for issue #298: blockette size exceeds 9999 bytes.
"""
file = os.path.join(self.path, "AI.ESPZ._.BH_.dataless")
parser = Parser(file)
parser.get_RESP()
def test_invalidStartHeader(self):
"""
A SEED Volume must start with a Volume Index Control Header.
"""
data = b"000001S 0510019~~0001000000"
sp = Parser(strict=True)
self.assertRaises(SEEDParserException, sp.read, data)
def test_invalidStartBlockette(self):
"""
A SEED Volume must start with Blockette 010.
"""
data = b"000001V 0510019~~0001000000"
sp = Parser(strict=True)
self.assertRaises(SEEDParserException, sp.read, data)
def test_blocketteLongerThanRecordLength(self):
"""
If a blockette is longer than the record length it should result in
more than one record.
"""
parser = Parser(strict=True)
# Set record length to 100.
parser.record_length = 100
# Use a blockette 53 string.
SEED_string = b'0530382A01002003+6.00770E+07+2.00000E-02002+0.00000E' \
b'+00+0.00000E+00+0.00000E+00+0.00000E+00+0.00000E+00+0.00000E+0' \
b'0+0.00000E+00+0.00000E+00005-3.70040E-02-3.70160E-02+0.00000E+' \
b'00+0.00000E+00-3.70040E-02+3.70160E-02+0.00000E+00+0.00000E+00' \
b'-2.51330E+02+0.00000E+00+0.00000E+00+0.00000E+00-1.31040E+02-4' \
b'.67290E+02+0.00000E+00+0.00000E+00-1.31040E+02+4.67290E+02+0.0' \
b'0000E+00+0.00000E+00'
blkt_53 = Blockette053()
blkt_53.parse_SEED(SEED_string)
# This just tests an internal SEED method.
records = parser._create_cut_and_flush_record([blkt_53], 'S')
# This should result in five records.
self.assertEqual(len(records), 5)
# Each records should be 100 - 6 = 94 long.
for record in records:
self.assertEqual(len(record), 94)
# Reassemble the String.
new_string = b''
for record in records:
new_string += record[2:]
# Compare the new and the old string.
self.assertEqual(new_string.strip(), SEED_string)
def test_issue_157(self):
"""
Test case for issue #157: re-using parser object.
"""
expected = {
'latitude': 48.162899,
'elevation': 565.0,
'longitude': 11.2752,
'local_depth': 0.0,
'azimuth': 0.0,
'dip': -90.0
}
filename1 = os.path.join(self.path, 'dataless.seed.BW_FURT')
filename2 = os.path.join(self.path, 'dataless.seed.BW_MANZ')
t = UTCDateTime("2010-07-01")
parser = Parser()
parser.read(filename2)
# parsing a second time will raise a UserWarning: Clearing parser
# before every subsequent read()
with warnings.catch_warnings(record=True):
warnings.simplefilter("error", UserWarning)
self.assertRaises(UserWarning, parser.read, filename1)
warnings.simplefilter("ignore", UserWarning)
parser.read(filename1)
result = parser.get_coordinates("BW.FURT..EHZ", t)
self.assertEqual(expected, result)
def test_issue_298a(self):
"""
Test case for issue #298: blockette size exceeds 9999 bytes.
"""
file = os.path.join(self.path, "AI.ESPZ._.BHE.dataless")
parser = Parser(file)
parser.get_resp()
def test_read_resp_data(self):
"""
Tests reading a resp string by calling Parser(string)
"""
sts2_resp_file = os.path.join(self.path,
'RESP.XX.NS085..BHZ.STS2_gen3.120.1500')
with open(sts2_resp_file, "rt") as fh:
p = Parser(fh.read())
# Weak but at least tests that something has been read.
assert set(p.blockettes.keys()) == {34, 50, 52, 53, 54, 57, 58}
rt130_resp_file = os.path.join(self.path,
'RESP.XX.NR008..HHZ.130.1.100')
with open(rt130_resp_file, "rt") as fh:
p = Parser(fh.read())
# Weak but at least tests that something has been read.
assert set(p.blockettes.keys()) == {34, 50, 52, 53, 54, 57, 58}
def test_get_paz_from_xseed(self):
"""
Get PAZ from XSEED file, testcase for #146
"""
filename = os.path.join(self.path, 'dataless.seed.BW_FURT')
sp1 = Parser(filename)
sp2 = Parser(sp1.get_xseed())
paz = sp2.get_paz('EHE')
result = {'gain': 1.00000e+00,
'zeros': [0j, 0j, 0j],
'poles': [(-4.44400e+00 + 4.44400e+00j),
(-4.44400e+00 - 4.44400e+00j),
(-1.08300e+00 + 0.00000e+00j)],
'sensitivity': 6.71140E+08,
'seismometer_gain': 4.00000E+02,
'digitizer_gain': 1677850.0}
self.assertEqual(sorted(paz.items()), sorted(result.items()))
def test_selectDoesNotChangeTheParserFormat(self):
"""
Test that using the _select() method of the Parser object does
not change the _format attribute.
"""
p = Parser(os.path.join(self.path, "dataless.seed.BW_FURT.xml"))
self.assertEqual(p._format, "XSEED")
p._select(p.get_inventory()["channels"][0]["channel_id"])
self.assertEqual(p._format, "XSEED")
def test_issue358(self):
"""
Test case for issue #358.
"""
filename = os.path.join(self.path, 'CL.AIO.dataless')
parser = Parser()
parser.read(filename)
dt = UTCDateTime('2012-01-01')
parser.getPAZ('CL.AIO.00.EHZ', dt)
def test_createReadAssertAndWriteXSEED(self):
"""
This test takes some SEED files, reads them to a Parser object
and converts them back to SEED once. This is done to avoid any
formating issues as seen in test_readAndWriteSEED.
Therefore the reading and writing of SEED files is considered to be
correct.
Finally the resulting SEED gets converted to XSEED and back to SEED
and the two SEED strings are then evaluated to be identical.
This tests also checks for XML validity using a XML schema.
"""
# Loop over all files and versions.
for version in ['1.0', '1.1']:
# Path to XML schema file.
xsd_path = os.path.join(self.path, 'xml-seed-%s.xsd' % version)
# Prepare validator.
f = open(xsd_path, 'rb')
xmlschema_doc = etree.parse(f)
f.close()
xmlschema = etree.XMLSchema(xmlschema_doc)
for file in self.BW_SEED_files:
# Parse the file.
parser1 = Parser(file)
# Convert to SEED once to avoid any issues seen in
# test_readAndWriteSEED.
original_seed = parser1.get_SEED()
del parser1
# Now read the file, parse it, write XSEED, read XSEED and
# write SEED again. The output should be totally identical.
parser2 = Parser(original_seed)
xseed_string = parser2.get_XSEED(version=version)
del parser2
# Validate XSEED.
doc = etree.parse(io.BytesIO(xseed_string))
self.assertTrue(xmlschema.validate(doc))
del doc
parser3 = Parser(xseed_string)
new_seed = parser3.get_SEED()
self.assertEqual(original_seed, new_seed)
del parser3, original_seed, new_seed
def test_underline_in_site_name(self):
"""
Test case for issue #1893.
"""
filename = os.path.join(self.path, 'UP_BACU_HH.dataless')
parser = Parser()
parser.read(filename)
# value given by pdccgg
self.assertEqual(parser.blockettes[50][0].site_name,
'T3930_b A6689 3930')
def test_newline_between_blockettes(self):
"""
A very rare case.
"""
# Handcrafted files.
filename = os.path.join(self.path,
'dataless.seed.newline_between_blockettes')
p = Parser(filename)
self.assertEqual(sorted(list(p.blockettes.keys())),
[10, 11, 30, 33, 34])
def test_resp_round_trip(self):
single_seed = os.path.join(
self.path, '../../../../',
'core/tests/data/IRIS_single_channel_with_response.seed')
# Make parser and get resp from SEED
seed_p = Parser(single_seed)
resp_from_seed = seed_p.get_resp()[0][1]
resp_from_seed.seek(0)
resp_from_seed = resp_from_seed.read()
seed_list = self.clean_unit_string(resp_from_seed)
# make parser from resp made above and make a resp from it
resp_p = Parser(resp_from_seed.decode('ascii'))
resp_from_resp = resp_p.get_resp()[0][1]
resp_from_resp.seek(0)
resp_from_resp = resp_from_resp.read()
resp_list = self.clean_unit_string(resp_from_resp)
# compare
self.assertEqual(seed_list, resp_list)
def is_valid_dataless(file_path):
"""
Check if is a valid dataless file.
:param file_path: The full file's path.
:return: True if path is a valid dataless. False otherwise.
"""
parser = Parser()
try:
parser.read(file_path)
return True
except IOError:
return False
def test_issue319(self):
"""
Test case for issue #319: multiple abbreviation dictionaries.
"""
filename = os.path.join(self.path, 'BN.LPW._.BHE.dataless')
# raises a UserWarning: More than one Abbreviation Dictionary Control
# Headers found!
with warnings.catch_warnings(record=True):
warnings.simplefilter("error", UserWarning)
self.assertRaises(UserWarning, Parser, filename)
warnings.simplefilter("ignore", UserWarning)
parser = Parser(filename)
self.assertEqual(parser.version, 2.3)
def test_getCoordinates(self):
"""
Test extracting coordinates for SEED and XSEED (including #146)
"""
# SEED
sp = Parser(os.path.join(self.path, 'dataless.seed.BW_RJOB'))
result = {
'elevation': 860.0,
'latitude': 47.737166999999999,
'longitude': 12.795714,
'local_depth': 0
}
paz = sp.get_coordinates("BW.RJOB..EHZ", UTCDateTime("2007-01-01"))
self.assertEqual(sorted(paz.items()), sorted(result.items()))
paz = sp.get_coordinates("BW.RJOB..EHZ", UTCDateTime("2010-01-01"))
self.assertEqual(sorted(paz.items()), sorted(result.items()))
# XSEED
sp2 = Parser(sp.get_XSEED())
paz = sp2.get_coordinates("BW.RJOB..EHZ", UTCDateTime("2007-01-01"))
self.assertEqual(sorted(paz.items()), sorted(result.items()))
paz = sp2.get_coordinates("BW.RJOB..EHZ", UTCDateTime("2010-01-01"))
self.assertEqual(sorted(paz.items()), sorted(result.items()))
def test_xseed2dataless(self):
with NamedTemporaryFile() as tf:
with CatchOutput() as out:
obspy_xseed2dataless(['--output', tf.name, self.xseed_file])
expected = '''Found 1 files.
Parsing file %s
''' % (self.xseed_file, )
self.assertEqual(expected, out.stdout)
with open(self.dataless_file, 'rb') as fh:
expected = fh.read()
with open(tf.name, 'rb') as fh:
actual = fh.read()
try:
compare_seed(expected, actual)
except Exception:
self.fail('compare_seed raised Exception unexpectedly!')
parser1 = Parser(expected)
parser2 = Parser(actual)
self.assertEqual(parser1.get_seed(), parser2.get_seed())
def dataless2xseed(filename, options):
files = []
for item in filename:
files.extend(glob(item))
outdir = False
outfile = False
if options.output:
if os.path.isdir(options.output):
outdir = options.output
elif len(files) > 1:
msg = 'More than one filename is given.' + os.linesep
msg += '\t--output argument will not be used.\n'
sys.stdout.write(msg)
else:
outfile = options.output
if options.verbose:
msg = 'Found %s files.' % len(files) + os.linesep
sys.stdout.write(msg)
for file in files:
if not os.path.isfile(file):
continue
f = open(file, 'rb')
if f.read(7)[6:] != b'V':
if options.verbose:
msg = 'Skipping file %s' % file
msg += '\t-- not a Dataless SEED file' + os.linesep
sys.stdout.write(msg)
f.close()
continue
f.close()
if outdir:
output = os.path.join(outdir,
os.path.basename(file) + os.extsep + 'xml')
elif outfile:
output = outfile
else:
output = os.path.basename(file) + os.extsep + 'xml'
if options.verbose:
msg = 'Parsing file %s' % file + os.linesep
sys.stdout.write(msg)
try:
parser = Parser(file, debug=options.debug)
parser.write_xseed(output,
version=str(options.version),
split_stations=options.split_stations)
except Exception as e:
if options.debug:
raise
msg = '\tError parsing file %s' % file + os.linesep
msg += '\t' + str(e) + os.linesep
sys.stderr.write(msg)
def test_splitStationsDataless2XSEED(self):
"""
Test case for writing dataless to XSEED with multiple entries.
"""
filename = os.path.join(self.path, 'dataless.seed.BW_DHFO')
parser = Parser()
parser.read(filename)
with NamedTemporaryFile() as fh:
tempfile = fh.name
# this will create two files due to two entries in dataless
parser.write_XSEED(tempfile, split_stations=True)
# the second file name is appended with the timestamp of start
# period
os.remove(tempfile + '.1301529600.0.xml')
def parser_sensor_resp(dir, sName, type):
par = Parser(dir + '.resp')
par.write_xseed(dir + '.xml')
par.write_seed(dir + '.dataless')
channel = par.blockettes[52][0].channel_identifier
paz = par.get_paz(channel)
if (len(paz['zeros']) <= len(paz['poles'])):
plot_Freq_Amp_Phase(dir + '.freq_amp_phase.png', paz, sName, type)
(Ymax, Ymin, Tmax, Tmin, Tzero) = plot_Seep_Response(dir + '.impulse.png', paz, sName, type)
return (paz, Ymax, Ymin, Tmax, Tmin, Tzero)
else:
print(
"sName Error! , zeros number is larger than poles, Can't Calculate Response and Bode Diagram, Check it!!!")
return (paz, 0, 0, 0, 0, 0)
def test_readFullSEED(self):
"""
Test the reading of a full-SEED file. The data portion will be omitted.
"""
filename = os.path.join(self.path, 'arclink_full.seed')
sp = Parser(filename)
# Just checks whether certain blockettes are written.
self.assertEqual(len(sp.stations), 1)
self.assertEqual([_i.id for _i in sp.volume], [10])
self.assertEqual(
[_i.id for _i in sp.abbreviations],
[30, 33, 33, 34, 34, 34, 34, 41, 43, 44, 47, 47, 48, 48, 48])
self.assertEqual([_i.id for _i in sp.stations[0]], [50, 52, 60, 58])
self.assertEqual(sp.stations[0][0].network_code, 'GR')
self.assertEqual(sp.stations[0][0].station_call_letters, 'FUR')
def test_get_inventory(self):
"""
Tests the parser's get_inventory() method.
"""
filename = os.path.join(self.path, 'dataless.seed.BW_FURT')
p = Parser(filename)
self.assertEqual(
p.get_inventory(), {
'networks': [{
'network_code': 'BW',
'network_name': 'BayernNetz'
}],
'stations': [{
'station_name': 'Furstenfeldbruck, Bavaria, BW-Net',
'station_id': 'BW.FURT'
}],
'channels': [{
'channel_id': 'BW.FURT..EHZ',
'start_date': UTCDateTime(2001, 1, 1, 0, 0),
'instrument': 'Lennartz LE-3D/1 seismometer',
'elevation_in_m': 565.0,
'latitude': 48.162899,
'local_depth_in_m': 0.0,
'longitude': 11.2752,
'end_date': '',
'sampling_rate': 200.0
}, {
'channel_id': 'BW.FURT..EHN',
'start_date': UTCDateTime(2001, 1, 1, 0, 0),
'instrument': 'Lennartz LE-3D/1 seismometer',
'elevation_in_m': 565.0,
'latitude': 48.162899,
'local_depth_in_m': 0.0,
'longitude': 11.2752,
'end_date': '',
'sampling_rate': 200.0
}, {
'channel_id': 'BW.FURT..EHE',
'start_date': UTCDateTime(2001, 1, 1, 0, 0),
'instrument': 'Lennartz LE-3D/1 seismometer',
'elevation_in_m': 565.0,
'latitude': 48.162899,
'local_depth_in_m': 0.0,
'longitude': 11.2752,
'end_date': '',
'sampling_rate': 200.0
}]
})
def test_rotationToZNE(self):
"""
Weak test for rotation of arbitrarily rotated components to ZNE.
"""
st = read(
os.path.join(self.path, "II_COCO_three_channel_borehole.mseed"))
# Read the SEED file and rotate the Traces with the information stored
# in the SEED file.
p = Parser(os.path.join(self.path, "dataless.seed.II_COCO"))
st_r = p.rotate_to_ZNE(st)
# Still three channels left.
self.assertEqual(len(st_r), 3)
# Extract the components for easier assertions. This also asserts that
# the channel renaming worked.
tr_z = st.select(channel="BHZ")[0]
tr_1 = st.select(channel="BH1")[0]
tr_2 = st.select(channel="BH2")[0]
tr_r_z = st_r.select(channel="BHZ")[0]
tr_r_n = st_r.select(channel="BHN")[0]
tr_r_e = st_r.select(channel="BHE")[0]
# Convert all components to float for easier assertions.
tr_z.data = np.require(tr_z.data, dtype=np.float64)
tr_1.data = np.require(tr_1.data, dtype=np.float64)
tr_2.data = np.require(tr_2.data, dtype=np.float64)
# The total energy should not be different.
energy_before = np.sum((tr_z.data**2) + (tr_1.data**2) +
(tr_2.data**2))
energy_after = np.sum((tr_r_z.data**2) + (tr_r_n.data**2) +
(tr_r_e.data**2))
self.assertTrue(np.allclose(energy_before, energy_after))
# The vertical channel should not have changed at all.
np.testing.assert_array_equal(tr_z.data, tr_r_z.data)
# The other two are only rotated by 2 degree so should also not have
# changed much but at least a little bit. And the components should be
# renamed.
self.assertTrue(np.allclose(tr_1, tr_r_n, rtol=10E-3))
# The east channel carries very little energy for this particular
# example. Thus it changes quite a lot even for this very subtle
# rotation. The energy comparison should still ensure a sensible
# result.
self.assertTrue(np.allclose(tr_2, tr_r_e, atol=tr_r_e.max() / 4.0))
