mt_metadata.transfer_functions.io.jfiles.jfile

Classes

JFile

be able to read and write a j-file

Module Contents

class JFile.JFile(fn=None, **kwargs)

be able to read and write a j-file

header
property fn
z = None
z_err = None
t = None
t_err = None
frequency = None
property periods: None | numpy.typing.NDArray[numpy.float64]
read(fn=None, get_elevation=False)

Read data from a j file

Parameters:
  • fn (str | Path | None) – full path to j-file to read, defaults to None

  • get_elevation (bool, optional) – if True, will try to get elevation from the NM elevation service, defaults to False

Raises:
  • ValueError – If the file is not found or cannot be opened.

  • NameError – If the file is not a valid j-file.

Returns:

Reads the data into the instance variables.

Return type:

None

property station_metadata
property survey_metadata