mth5.groups.filter_groups package

Submodules

mth5.groups.filter_groups.coefficient_filter_group module

Created on Wed Jun 9 08:58:15 2021

copyright

Jared Peacock (jpeacock@usgs.gov)

license

MIT

class mth5.groups.filter_groups.coefficient_filter_group.CoefficientGroup(group, **kwargs)[source]

Bases: mth5.groups.base.BaseGroup

Container for Coefficient type filters

add_filter(name, coefficient_metadata)[source]

Add a coefficient Filter

Parameters
  • name (TYPE) – DESCRIPTION

  • coefficient_metadata (TYPE) – DESCRIPTION

Returns

DESCRIPTION

Return type

TYPE

property filter_dict

Dictionary of available coefficient filters

Returns

DESCRIPTION

Return type

TYPE

from_object(coefficient_object)[source]

make a filter from a mt_metadata.timeseries.filters.CoefficientFilter

Parameters

zpk_object (mt_metadata.timeseries.filters.CoefficientFilter) – MT metadata Coefficient Filter

get_filter(name)[source]

Get a filter from the name

Parameters

name (string) – name of the filter

Returns

HDF5 group of the ZPK filter

remove_filter()[source]
to_object(name)[source]

make a mt_metadata.timeseries.filters.CoefficientFilter object

Returns

DESCRIPTION

Return type

TYPE

mth5.groups.filter_groups.fap_filter_group module

Created on Wed Jun 9 08:55:16 2021

copyright

Jared Peacock (jpeacock@usgs.gov)

license

MIT

class mth5.groups.filter_groups.fap_filter_group.FAPGroup(group, **kwargs)[source]

Bases: mth5.groups.base.BaseGroup

Container for fap type filters

add_filter(name, frequency, amplitude, phase, fap_metadata)[source]

create an HDF5 group/dataset from information given.

Parameters
  • name (string) – Nane of the filter

  • poles (np.ndarray(dtype=complex)) – poles of the filter as complex numbers

  • zeros (np.ndarray(dtype=comples)) – zeros of the filter as complex numbers

  • fap_metadata – metadata dictionary see

mt_metadata.timeseries.filters.PoleZeroFilter for details on entries :type fap_metadata: dictionary

property filter_dict

Dictionary of available fap filters

Returns

DESCRIPTION

Return type

TYPE

from_object(fap_object)[source]

make a filter from a mt_metadata.timeseries.filters.PoleZeroFilter

Parameters

fap_object (mt_metadata.timeseries.filters.PoleZeroFilter) – MT metadata PoleZeroFilter

get_filter(name)[source]

Get a filter from the name

Parameters

name (string) – name of the filter

Returns

HDF5 group of the fap filter

remove_filter()[source]
to_object(name)[source]

make a mt_metadata.timeseries.filters.pole_zeros_filter object :return: DESCRIPTION :rtype: TYPE

mth5.groups.filter_groups.fir_filter_group module

Created on Wed Jun 9 08:55:16 2021

copyright

Jared Peacock (jpeacock@usgs.gov)

license

MIT

class mth5.groups.filter_groups.fir_filter_group.FIRGroup(group, **kwargs)[source]

Bases: mth5.groups.base.BaseGroup

Container for fir type filters

add_filter(name, coefficients, fir_metadata)[source]

create an HDF5 group/dataset from information given.

Parameters
  • name (string) – Nane of the filter

  • poles (np.ndarray(dtype=complex)) – poles of the filter as complex numbers

  • zeros (np.ndarray(dtype=comples)) – zeros of the filter as complex numbers

  • fir_metadata – metadata dictionary see

mt_metadata.timeseries.filters.PoleZeroFilter for details on entries :type fir_metadata: dictionary

property filter_dict

Dictionary of available fir filters

Returns

DESCRIPTION

Return type

TYPE

from_object(fir_object)[source]

make a filter from a mt_metadata.timeseries.filters.PoleZeroFilter

Parameters

fir_object (mt_metadata.timeseries.filters.PoleZeroFilter) – MT metadata PoleZeroFilter

get_filter(name)[source]

Get a filter from the name

Parameters

name (string) – name of the filter

Returns

HDF5 group of the fir filter

remove_filter()[source]
to_object(name)[source]

make a mt_metadata.timeseries.filters.pole_zeros_filter object :return: DESCRIPTION :rtype: TYPE

mth5.groups.filter_groups.time_delay_filter_group module

Created on Wed Jun 9 09:01:55 2021

copyright

Jared Peacock (jpeacock@usgs.gov)

license

MIT

class mth5.groups.filter_groups.time_delay_filter_group.TimeDelayGroup(group, **kwargs)[source]

Bases: mth5.groups.base.BaseGroup

Container for time_delay type filters

add_filter(name, time_delay_metadata)[source]

create an HDF5 group/dataset from information given.

Parameters
  • name (string) – Nane of the filter

  • poles (np.ndarray(dtype=complex)) – poles of the filter as complex numbers

  • zeros (np.ndarray(dtype=comples)) – zeros of the filter as complex numbers

  • time_delay_metadata – metadata dictionary see

mt_metadata.timeseries.filters.PoleZeroFilter for details on entries :type time_delay_metadata: dictionary

property filter_dict

Dictionary of available time_delay filters

Returns

DESCRIPTION

Return type

TYPE

from_object(time_delay_object)[source]

make a filter from a mt_metadata.timeseries.filters.PoleZeroFilter

Parameters

time_delay_object (mt_metadata.timeseries.filters.PoleZeroFilter) – MT metadata PoleZeroFilter

get_filter(name)[source]

Get a filter from the name

Parameters

name (string) – name of the filter

Returns

HDF5 group of the time_delay filter

remove_filter()[source]
to_object(name)[source]

make a mt_metadata.timeseries.filters.pole_zeros_filter object :return: DESCRIPTION :rtype: TYPE

mth5.groups.filter_groups.zpk_filter_group module

Created on Wed Jun 9 08:55:16 2021

copyright

Jared Peacock (jpeacock@usgs.gov)

license

MIT

class mth5.groups.filter_groups.zpk_filter_group.ZPKGroup(group, **kwargs)[source]

Bases: mth5.groups.base.BaseGroup

Container for ZPK type filters

add_filter(name, poles, zeros, zpk_metadata)[source]

create an HDF5 group/dataset from information given.

Parameters
  • name (string) – Nane of the filter

  • poles (np.ndarray(dtype=complex)) – poles of the filter as complex numbers

  • zeros (np.ndarray(dtype=comples)) – zeros of the filter as complex numbers

  • zpk_metadata – metadata dictionary see

mt_metadata.timeseries.filters.PoleZeroFilter for details on entries :type zpk_metadata: dictionary

property filter_dict

Dictionary of available ZPK filters

Returns

DESCRIPTION

Return type

TYPE

from_object(zpk_object)[source]

make a filter from a mt_metadata.timeseries.filters.PoleZeroFilter

Parameters

zpk_object (mt_metadata.timeseries.filters.PoleZeroFilter) – MT metadata PoleZeroFilter

get_filter(name)[source]

Get a filter from the name

Parameters

name (string) – name of the filter

Returns

HDF5 group of the ZPK filter

remove_filter()[source]
to_object(name)[source]

make a mt_metadata.timeseries.filters.pole_zeros_filter object :return: DESCRIPTION :rtype: TYPE

Module contents

Import all Group objects

class mth5.groups.filter_groups.CoefficientGroup(group, **kwargs)[source]

Bases: mth5.groups.base.BaseGroup

Container for Coefficient type filters

add_filter(name, coefficient_metadata)[source]

Add a coefficient Filter

Parameters
  • name (TYPE) – DESCRIPTION

  • coefficient_metadata (TYPE) – DESCRIPTION

Returns

DESCRIPTION

Return type

TYPE

property filter_dict

Dictionary of available coefficient filters

Returns

DESCRIPTION

Return type

TYPE

from_object(coefficient_object)[source]

make a filter from a mt_metadata.timeseries.filters.CoefficientFilter

Parameters

zpk_object (mt_metadata.timeseries.filters.CoefficientFilter) – MT metadata Coefficient Filter

get_filter(name)[source]

Get a filter from the name

Parameters

name (string) – name of the filter

Returns

HDF5 group of the ZPK filter

remove_filter()[source]
to_object(name)[source]

make a mt_metadata.timeseries.filters.CoefficientFilter object

Returns

DESCRIPTION

Return type

TYPE

class mth5.groups.filter_groups.FAPGroup(group, **kwargs)[source]

Bases: mth5.groups.base.BaseGroup

Container for fap type filters

add_filter(name, frequency, amplitude, phase, fap_metadata)[source]

create an HDF5 group/dataset from information given.

Parameters
  • name (string) – Nane of the filter

  • poles (np.ndarray(dtype=complex)) – poles of the filter as complex numbers

  • zeros (np.ndarray(dtype=comples)) – zeros of the filter as complex numbers

  • fap_metadata – metadata dictionary see

mt_metadata.timeseries.filters.PoleZeroFilter for details on entries :type fap_metadata: dictionary

property filter_dict

Dictionary of available fap filters

Returns

DESCRIPTION

Return type

TYPE

from_object(fap_object)[source]

make a filter from a mt_metadata.timeseries.filters.PoleZeroFilter

Parameters

fap_object (mt_metadata.timeseries.filters.PoleZeroFilter) – MT metadata PoleZeroFilter

get_filter(name)[source]

Get a filter from the name

Parameters

name (string) – name of the filter

Returns

HDF5 group of the fap filter

remove_filter()[source]
to_object(name)[source]

make a mt_metadata.timeseries.filters.pole_zeros_filter object :return: DESCRIPTION :rtype: TYPE

class mth5.groups.filter_groups.FIRGroup(group, **kwargs)[source]

Bases: mth5.groups.base.BaseGroup

Container for fir type filters

add_filter(name, coefficients, fir_metadata)[source]

create an HDF5 group/dataset from information given.

Parameters
  • name (string) – Nane of the filter

  • poles (np.ndarray(dtype=complex)) – poles of the filter as complex numbers

  • zeros (np.ndarray(dtype=comples)) – zeros of the filter as complex numbers

  • fir_metadata – metadata dictionary see

mt_metadata.timeseries.filters.PoleZeroFilter for details on entries :type fir_metadata: dictionary

property filter_dict

Dictionary of available fir filters

Returns

DESCRIPTION

Return type

TYPE

from_object(fir_object)[source]

make a filter from a mt_metadata.timeseries.filters.PoleZeroFilter

Parameters

fir_object (mt_metadata.timeseries.filters.PoleZeroFilter) – MT metadata PoleZeroFilter

get_filter(name)[source]

Get a filter from the name

Parameters

name (string) – name of the filter

Returns

HDF5 group of the fir filter

remove_filter()[source]
to_object(name)[source]

make a mt_metadata.timeseries.filters.pole_zeros_filter object :return: DESCRIPTION :rtype: TYPE

class mth5.groups.filter_groups.TimeDelayGroup(group, **kwargs)[source]

Bases: mth5.groups.base.BaseGroup

Container for time_delay type filters

add_filter(name, time_delay_metadata)[source]

create an HDF5 group/dataset from information given.

Parameters
  • name (string) – Nane of the filter

  • poles (np.ndarray(dtype=complex)) – poles of the filter as complex numbers

  • zeros (np.ndarray(dtype=comples)) – zeros of the filter as complex numbers

  • time_delay_metadata – metadata dictionary see

mt_metadata.timeseries.filters.PoleZeroFilter for details on entries :type time_delay_metadata: dictionary

property filter_dict

Dictionary of available time_delay filters

Returns

DESCRIPTION

Return type

TYPE

from_object(time_delay_object)[source]

make a filter from a mt_metadata.timeseries.filters.PoleZeroFilter

Parameters

time_delay_object (mt_metadata.timeseries.filters.PoleZeroFilter) – MT metadata PoleZeroFilter

get_filter(name)[source]

Get a filter from the name

Parameters

name (string) – name of the filter

Returns

HDF5 group of the time_delay filter

remove_filter()[source]
to_object(name)[source]

make a mt_metadata.timeseries.filters.pole_zeros_filter object :return: DESCRIPTION :rtype: TYPE

class mth5.groups.filter_groups.ZPKGroup(group, **kwargs)[source]

Bases: mth5.groups.base.BaseGroup

Container for ZPK type filters

add_filter(name, poles, zeros, zpk_metadata)[source]

create an HDF5 group/dataset from information given.

Parameters
  • name (string) – Nane of the filter

  • poles (np.ndarray(dtype=complex)) – poles of the filter as complex numbers

  • zeros (np.ndarray(dtype=comples)) – zeros of the filter as complex numbers

  • zpk_metadata – metadata dictionary see

mt_metadata.timeseries.filters.PoleZeroFilter for details on entries :type zpk_metadata: dictionary

property filter_dict

Dictionary of available ZPK filters

Returns

DESCRIPTION

Return type

TYPE

from_object(zpk_object)[source]

make a filter from a mt_metadata.timeseries.filters.PoleZeroFilter

Parameters

zpk_object (mt_metadata.timeseries.filters.PoleZeroFilter) – MT metadata PoleZeroFilter

get_filter(name)[source]

Get a filter from the name

Parameters

name (string) – name of the filter

Returns

HDF5 group of the ZPK filter

remove_filter()[source]
to_object(name)[source]

make a mt_metadata.timeseries.filters.pole_zeros_filter object :return: DESCRIPTION :rtype: TYPE