obspy.io.gcf.core._read_gcf

_read_gcf(file, headonly=False, network='', station='', location='', channel_prefix='HH', blockmerge=True, cleanoverlap=True, errorret=False, **kwargs)[source]

Reads a GCF file and returns a Stream

Only GCF data records are supported. Function supports format as described by GCF Reference SWA-RFC-GCFR Issue F, December 2021

Warning

This function should NOT be called directly, it registers via the ObsPy read() function, call this instead.

Parameters:

  • file (str or Path or file-like object( e.g. ByesIO)) – path to GCF file to read

  • headonly (bool, optional) – if True only read block headers

  • network (str, optional) – network code to use

  • station (str, optional) – station code to use, if not specified unitID in gcf header will be used (first 4 characters in stream_id)

  • location (str, optional) – location code to use

  • channel_prefix (str, optional) – 2-character channel prefix to use (e.g. "HH" for a high-gain seismometer sampled at 200 Hz)

  • blockmerge (bool, optional) – if True merge blocks if aligned

  • cleanoverlap (bool, optional) – ignored if blockmerge is False, if True, remove overlapping identical data prior to merging blocks, if False overlapping blocks will not be merged even if data in overlap is identical

  • errorret (bool, optional) – if True block and header issues will be set in trace.stats.gcf.stat for each Trace object in returned Stream object, else function will raise raise an IOError with an appropriate error message

Return type:

Stream

Returns:

Stream object