Coverage for C: \ Users \ peaco \ OneDrive \ Documents \ GitHub \ mt_metadata \ mt_metadata \ features \ __init__.py: 100%

1# -*- coding: utf-8 -*- 

2""" 

3====================== 

4Features Metadata 

5====================== 

6 

7The Features module provides metadata containers for defining and calculating 

8features from magnetotelluric data in both time domain and frequency domain. 

9 

10Features are computed quantities that characterize data quality, signal properties, 

11or specific aspects of the electromagnetic response. This module supports various 

12feature types including coherence metrics, spectral characteristics, and custom 

13user-defined features. 

14 

15MetadataBase Objects 

16-------------------- 

17* Feature - Base class for all feature metadata, defining feature type, parameters, 

18 and computation methods 

19* FeatureTSRun - Time series run features for time domain calculations (e.g., 

20 signal statistics, anomaly detection) 

21* FeatureFCRun - Fourier coefficient run features for frequency domain calculations 

22 (e.g., spectral quality metrics, transfer function properties) 

23* FeatureDecimationChannel - Channel-specific features at different decimation 

24 levels for multi-resolution analysis 

25* StridingWindowCoherence - Coherence calculated over striding windows to assess 

26 signal consistency and quality over time 

27* SUPPORTED_FEATURE_DICT - Registry of all available feature types and their 

28 configurations 

29 

30Usage 

31----- 

32Features metadata objects define: 

33- Feature type and calculation method 

34- Input parameters and thresholds 

35- Output specifications 

36- Applicable frequency bands or time windows 

37- Quality control criteria 

38 

39These metadata containers ensure reproducible feature calculations and facilitate 

40sharing of feature extraction pipelines across different processing workflows. 

41 

42""" 

43 

44from .feature_ts_run import FeatureTSRun 

45from .feature_fc_run import FeatureFCRun 

46from .feature_decimation_channel import FeatureDecimationChannel 

47from .feature import Feature 

48from .striding_window_coherence import StridingWindowCoherence 

49 

50 

51__all__ = [ 

52 "FeatureTSRun", 

53 "FeatureFCRun", 

54 "Feature", 

55 "FeatureDecimationChannel", 

56 "StridingWindowCoherence", 

57 "SUPPORTED_FEATURE_DICT", 

58] 

59 

60# Import the supported feature dictionary from the registry to avoid circular imports 

61from mt_metadata.features.registry import SUPPORTED_FEATURE_DICT