8000 [MNT] - Reorganize 'measures' by TomDonoghue · Pull Request #396 · fooof-tools/fooof · GitHub
[go: up one dir, main page]

Skip to content
File renamed without changes.
4 changes: 2 additions & 2 deletions specparam/algorithms/spectral_fit.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@
from specparam.utils.select import groupby
from specparam.data.periodic import sort_peaks
from specparam.reports.strings import gen_width_warning_str
from specparam.measures.estimates import estimate_fwhm
from specparam.measures.params import compute_gauss_std
from specparam.params.periodic import compute_gauss_std
from specparam.algorithms.algorithm import AlgorithmCF
from specparam.algorithms.estimates import estimate_fwhm
from specparam.algorithms.settings import SettingsDefinition

###################################################################################################
Expand Down
1 change: 0 additions & 1 deletion specparam/convert/__init__.py

This file was deleted.

3 changes: 3 additions & 0 deletions specparam/demo/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
"""Demo sub-module."""

from .download import load_example_data
File renamed without changes.
1 change: 0 additions & 1 deletion specparam/measures/__init__.py

This file was deleted.

File renamed without changes.
4 changes: 2 additions & 2 deletions specparam/models/model.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
from specparam.data.conversions import model_to_dataframe
from specparam.results.results import Results

from specparam.convert.convert import convert_aperiodic_params, convert_periodic_params
from specparam.convert.definitions import update_converters, DEFAULT_CONVERTERS
from specparam.params.convert import convert_aperiodic_params, convert_periodic_params
from specparam.params.definitions import update_converters, DEFAULT_CONVERTERS

from specparam.algorithms.spectral_fit import SPECTRAL_FIT_SETTINGS_DEF
from specparam.algorithms.definitions import ALGORITHMS, check_algorithm_definition
Expand Down
2 changes: 1 addition & 1 deletion specparam/modes/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""Functionality related to definining fit modes."""

from .mode import Mode
from .params import ParamDefinition
from .check import check_modes
from .paramdef import ParamDefinition
2 changes: 1 addition & 1 deletion specparam/modes/definitions.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
from collections import OrderedDict

from specparam.modes.mode import Mode
from specparam.modes.params import ParamDefinition
from specparam.modes.paramdef import ParamDefinition
from specparam.modes.funcs import (powerlaw_function, lorentzian_function, double_expo_function,
gaussian_function, skewed_gaussian_function,
cauchy_function, gamma_function, triangle_function)
Expand Down
2 changes: 1 addition & 1 deletion specparam/modes/mode.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""Mode object."""

from specparam.modes.params import ParamDefinition
from specparam.modes.paramdef import ParamDefinition
from specparam.reports.strings import gen_mode_str
from specparam.utils.checks import check_input_options

Expand Down
File renamed without changes.
File renamed without changes.
1 change: 1 addition & 0 deletions specparam/params/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
"""Sub-module for functionality related to parameters and parameter conversions."""
36 changes: 1 addition & 35 deletions specparam/measures/params.py → specparam/params/aperiodic.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Utilities for working with parameters."""
"""Functions and converters for aperiodic parameters."""

import numpy as np

Expand Down Expand Up @@ -68,37 +68,3 @@ def compute_time_constant(knee_freq):
"""

return 1. / (2 * np.pi * knee_freq)


def compute_fwhm(std):
"""Compute the full-width half-max, given the gaussian standard deviation.

Parameters
----------
std : float
Gaussian standard deviation.

Returns
-------
float
Calculated full-width half-max.
"""

return 2 * np.sqrt(2 * np.log(2)) * std


def compute_gauss_std(fwhm):
"""Compute the gaussian standard deviation, given the full-width half-max.

Parameters
----------
fwhm : float
Full-width half-max.

Returns
-------
float
Calculated standard deviation of a gaussian.
"""

return fwhm / (2 * np.sqrt(2 * np.log(2)))
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

import numpy as np

from specparam.convert.definitions import get_converter
from specparam.params.definitions import get_converter

###################################################################################################
###################################################################################################
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

from copy import deepcopy

from specparam.convert.converter import AperiodicParamConverter, PeriodicParamConverter
from specparam.convert.params import compute_peak_height
from specparam.params.converter import AperiodicParamConverter, PeriodicParamConverter
from specparam.params.periodic import compute_peak_height

###################################################################################################
## DEFINE DEFAULT CONVERTERS
Expand Down
37 changes: 36 additions & 1 deletion specparam/convert/params.py → specparam/params/periodic.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Conversion functions for specific parameters."""
"""Functions and converters for periodic parameters."""

import numpy as np

Expand All @@ -14,6 +14,41 @@
'divide' : np.divide,
}


def compute_fwhm(std):
"""Compute the full-width half-max, given the gaussian standard deviation.

Parameters
----------
std : float
Gaussian standard deviation.

Returns
-------
float
Calculated full-width half-max.
"""

return 2 * np.sqrt(2 * np.log(2)) * std


def compute_gauss_std(fwhm):
"""Compute the gaussian standard deviation, given the full-width half-max.

Parameters
----------
fwhm : float
Full-width half-max.

Returns
-------
float
Calculated standard deviation of a gaussian.
"""

return fwhm / (2 * np.sqrt(2 * np.log(2)))


def compute_peak_height(model, peak_ind, spacing, operation):
"""Compute peak heights, based on specified approach & spacing.

Expand Down
3 changes: 2 additions & 1 deletion specparam/plts/annotate.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@

from specparam.utils.select import nearest_ind
from specparam.data.periodic import get_band_peak, sort_peaks
from specparam.measures.params import compute_knee_frequency, compute_fwhm
from specparam.params.periodic import compute_fwhm
from specparam.params.aperiodic import compute_knee_frequency
from specparam.modutils.errors import NoModelError
from specparam.modutils.dependencies import safe_import, check_dependency
from specparam.plts.spectra import plot_spectra
Expand Down
2 changes: 1 addition & 1 deletion specparam/plts/event.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

from specparam.modutils.errors import NoModelError
from specparam.modutils.dependencies import safe_import, check_dependency
from specparam.measures.properties import compute_presence
from specparam.utils.properties import compute_presence
from specparam.plts.utils import savefig
from specparam.plts.templates import plot_param_over_time_yshade
from specparam.plts.settings import PARAM_COLORS
Expand Down
2 changes: 1 addition & 1 deletion specparam/plts/model.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
from specparam.modutils.dependencies import safe_import, check_dependency
from specparam.utils.select import nearest_ind
from specparam.utils.spectral import trim_spectrum
from specparam.measures.params import compute_fwhm
from specparam.params.periodic import compute_fwhm
from specparam.plts.spectra import plot_spectra
from specparam.plts.settings import PLT_FIGSIZES, PLT_COLORS
from specparam.plts.utils import check_ax, check_plot_kwargs, savefig
Expand Down
2 changes: 1 addition & 1 deletion specparam/plts/templates.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
import numpy as np

from specparam.modutils.dependencies import safe_import, check_dependency
from specparam.measures.properties import compute_average, compute_dispersion
from specparam.utils.properties import compute_average, compute_dispersion
from specparam.plts.utils import check_ax, set_alpha
from specparam.plts.settings import (ITERABLES, PLT_FIGSIZES, DEFAULT_COLORS, PLT_TEXT_FONT,
TITLE_FONTSIZE, LABEL_SIZE, TICK_LABELSIZE)
Expand Down
2 changes: 1 addition & 1 deletion specparam/reports/strings.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

from specparam.utils.select import list_insert
from specparam.utils.array import compute_arr_desc
from specparam.measures.properties import compute_presence
from specparam.utils.properties import compute_presence
from specparam.version import __version__ as MODULE_VERSION
from specparam.reports.settings import LCV, SCV, DIVIDER

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
"""Test functions for specparam.measures.estimates."""
"""Test functions for specparam.algorithms.estimates."""

from specparam.sim.gen import gen_freqs, gen_noise
from specparam.modes.funcs import gaussian_function
from specparam.measures.params import compute_fwhm
from specparam.params.periodic import compute_fwhm

from specparam.measures.estimates import *
from specparam.algorithms.estimates import *

###################################################################################################
###################################################################################################
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
"""Test functions for specparam.utils.download."""
"""Test functions for specparam.demo.download."""

import os
import shutil
from pathlib import Path

import numpy as np

from specparam.utils.download import *
from specparam.demo.download import *

###################################################################################################
###################################################################################################
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""Test functions for specparam.measures.pointwise."""
"""Test functions for specparam.metrics.pointwise."""

from specparam.measures.pointwise import *
from specparam.metrics.pointwise import *

###################################################################################################
###################################################################################################
Expand Down
2 changes: 1 addition & 1 deletion specparam/tests/modes/test_mode.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

from collections import OrderedDict

from specparam.modes.params import ParamDefinition
from specparam.modes.paramdef import ParamDefinition

from specparam.modes.mode import *

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
"""Tests for specparam.modes.params."""
"""Tests for specparam.modes.paramdef."""

from collections import OrderedDict

from specparam.modes.params import *
from specparam.modes.paramdef import *

###################################################################################################
###################################################################################################
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""Test functions for specparam.utils.debug"""
"""Test functions for specparam.modutils.debug"""

from specparam.utils.debug import *
from specparam.modutils.debug import *

###################################################################################################
###################################################################################################
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""Test functions for specparam.measures.params."""
"""Test functions for specparam.params.aperiodic."""

from specparam.measures.params import *
from specparam.params.aperiodic import *

###################################################################################################
###################################################################################################
Expand All @@ -12,11 +12,3 @@ def test_compute_knee_frequency():
def test_compute_time_constant():

assert compute_time_constant(10)

def test_compute_fwhm():

assert compute_fwhm(1.5)

def test_compute_gauss_std():

assert compute_gauss_std(1.0)
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""Test functions for specparam.convert.convert."""
"""Test functions for specparam.params.convert."""

from specparam.convert.convert import *
from specparam.params.convert import *

###################################################################################################
###################################################################################################
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""Test functions for specparam.convert.converter."""
"""Test functions for specparam.params.converter."""

from specparam.convert.converter import *
from specparam.params.converter import *

###################################################################################################
###################################################################################################
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
"""Test functions for specparam.convert.definitions."""
"""Test functions for specparam.params.definitions."""

from specparam.modes.mode import VALID_COMPONENTS
from specparam.convert.converter import BaseParamConverter
from specparam.params.converter import BaseParamConverter

from specparam.convert.definitions import *
from specparam.params.definitions import *

###################################################################################################
###################################################################################################
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
"""Test functions for specparam.convert.params."""
"""Test functions for specparam.params.periodic."""

from specparam.convert.params import *
from specparam.params.periodic import *

###################################################################################################
###################################################################################################

def test_compute_fwhm():

assert compute_fwhm(1.5)

def test_compute_gauss_std():

assert compute_gauss_std(1.0)

def test_compute_peak_height(tfm):

for spacing in ['log', 'linear']:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
"""Tests for specparam.measures.properties."""
"""Tests for specparam.utils.properties."""

import numpy as np

from specparam.measures.properties import *
from specparam.utils.properties import *

###################################################################################################
###################################################################################################
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Compute properties of data."""
"""Compute data properties."""

from inspect import isfunction

Expand Down
Loading
0