mt-metadata 0.3.8__py2.py3-none-any.whl → 0.4.0__py2.py3-none-any.whl

mt_metadata/features/standards/base_feature.json

@@ -0,0 +1,46 @@
+{
+    "name": {
+        "type": "string",
+        "required": true,
+        "style": "free form",
+        "units": null,
+        "description": "Name of the feature.",
+        "options": [],
+        "alias": [],
+        "example": "simple coherence",
+		"default": null
+    },
+    "description": {
+        "type": "string",
+        "required": true,
+        "style": "free form",
+        "units": null,
+        "description": "A full description of what the feature estimates.",
+        "options": [],
+        "alias": [],
+        "example": "Simple coherence measures the coherence between measured electric and magnetic fields.",
+		"default": null
+    },
+    "domain": {
+        "type": "string",
+        "required": true,
+        "style": "controlled vocabulary",
+        "units": null,
+        "description": "Temporal domain the feature is estimated in [ 'frequency' | 'time' ]",
+        "options": ["time", "frequency", "fc", "ts", "fourier"],
+        "alias": [],
+        "example": "frequency",
+		"default": "frequency"
+    },
+    "comments": {
+        "type": "string",
+        "required": false,
+        "style": "free form",
+        "units": null,
+        "description": "Any comments about the feature",
+        "options": [],
+        "alias": [],
+        "example": "estimated using hilburt transform.",
+		"default": null
+    }
+}

mt_metadata/features/standards/coherence.json

@@ -0,0 +1,57 @@
+{
+    "ch1": {
+        "type": "string",
+        "required": true,
+        "style": "free form",
+        "units": null,
+        "description": "The first channel of two channels in the coherence calculation.",
+        "options": [],
+        "alias": [],
+        "example": "ex",
+        "default": null
+    },
+    "ch2": {
+        "type": "string",
+        "required": true,
+        "style": "free form",
+        "units": null,
+        "description": "The second channel of two channels in the coherence calculation.",
+        "options": [],
+        "alias": [],
+        "example": "hy",
+        "default": null
+    },
+    "detrend": {
+        "type": "string",
+        "required": true,
+        "style": "controlled vocabulary",
+        "units": null,
+        "description": "How to detrend the data segments before fft.",
+        "options": ["linear", "constant"],
+        "alias": [],
+        "example": "constant",
+        "default": "linear"
+    },
+    "station1": {
+        "type": "string",
+        "required": true,
+        "style": "free form",
+        "units": null,
+        "description": "The station associated with the first channel in the coherence calculation.",
+        "options": [],
+        "alias": [],
+        "example": "PKD",
+        "default": ""
+    },
+    "station2": {
+        "type": "string",
+        "required": true,
+        "style": "free form",
+        "units": null,
+        "description": "The station associated with the second channel in the coherence calculation.",
+        "options": [],
+        "alias": [],
+        "example": "SAO",
+        "default": ""
+    }
+}

mt_metadata/features/standards/fc_coherence.json

@@ -0,0 +1,57 @@
+{
+    "channel_1": {
+        "type": "string",
+        "required": true,
+        "style": "free form",
+        "units": null,
+        "description": "The first channel of two channels in the coherence calculation.",
+        "options": [],
+        "alias": [],
+        "example": "ex",
+        "default": null
+    },
+    "channel_2": {
+        "type": "string",
+        "required": true,
+        "style": "free form",
+        "units": null,
+        "description": "The second channel of two channels in the coherence calculation.",
+        "options": [],
+        "alias": [],
+        "example": "hy",
+        "default": null
+    },
+    "minimum_fcs": {
+        "type": "integer",
+        "required": true,
+        "style": "number",
+        "units": null,
+        "description": "The minimum number of Fourier coefficients needed to compute the feature.",
+        "options": [],
+        "alias": [],
+        "example": "2",
+        "default": "3"
+    },
+    "band_definition_type": {
+        "type": "string",
+        "required": true,
+        "style": "controlled vocabulary",
+        "units": null,
+        "description": "How the feature frequency bands are defined.",
+        "options": ["Q", "fractional bandwidth", "user defined"],
+        "alias": [],
+        "example": "user defined",
+        "default": "Q"
+    },
+    "q_radius": {
+        "type": "string",
+        "required": true,
+        "style": "controlled vocabulary",
+        "units": null,
+        "description": "How the feature frequency bands are defined.",
+        "options": ["constant Q", "user defined"],
+        "alias": [],
+        "example": "user defined",
+        "default": "constant Q"
+    }
+}

mt_metadata/features/standards/feature_decimation_channel.json

@@ -0,0 +1,68 @@
+{
+    "name": {
+        "type": "string",
+        "required": true,
+        "style": "free form",
+        "units": null,
+        "description": "Name of channel",
+        "options": [],
+        "alias": [],
+        "example": "ex",
+		"default": null
+    },
+    "frequency_max": {
+        "type": "float",
+        "required": true,
+        "style": "number",
+        "units": "samples per second",
+        "description": "Highest frequency present in the sprectrogam data.",
+        "options": [],
+        "alias": [],
+        "example": 77.0,
+		"default": 0.0
+    },
+    "frequency_min": {
+        "type": "float",
+        "required": true,
+        "style": "number",
+        "units": "samples per second",
+        "description": "Lowest frequency present in the sprectrogam data.",
+        "options": [],
+        "alias": [],
+        "example": 99.0,
+		"default": 0.0
+    },
+	"sample_rate_decimation_level": {
+        "type": "float",
+        "required": true,
+        "style": "number",
+        "units": "samples per second",
+        "description": "Sample rate of the time series that was Fourier transformed to generate the FC decimation level.",
+        "options": [],
+        "alias": [],
+        "example": 60,
+		"default": 1
+    },
+	"sample_rate_window_step": {
+        "type": "float",
+        "required": true,
+        "style": "number",
+        "units": "samples per second",
+        "description": "Sample rate of the windows.",
+        "options": [],
+        "alias": [],
+        "example": 4,
+		"default": 1
+    },
+	"units": {
+        "type": "string",
+        "required": true,
+        "style": "free form",
+        "units": null,
+        "description": "Units of the channel",
+        "options": [],
+        "alias": [],
+        "example": "millivolts",
+		"default": "counts"
+    }
+}

mt_metadata/features/standards/feature_fc_run.json

@@ -0,0 +1,35 @@
+{
+	"id": {
+        "type": "string",
+        "required": true,
+        "style": "alpha numeric",
+        "units": null,
+        "description": "Suggested Run ID should be sample rate followed by a number or character.  Characters should only be used if the run number is small, if the run number is high consider using digits with zeros.  For example if you have 100 runs the run ID could be 001 or sr{sample_rate}_001. Should be the same as the time series run ID.",
+        "options": [],
+        "alias": [],
+        "example": "001",
+		"default": null
+    },
+    "sample_rate": {
+        "type": "float",
+        "required": true,
+        "style": "number",
+        "units": "samples per second",
+        "description": "Digital sample rate for the run",
+        "options": [],
+        "alias": [],
+        "example": "100",
+		"default": 0.0
+    },
+    "comments": {
+        "type": "string",
+        "required": false,
+        "style": "free form",
+        "units": null,
+        "description": "Any comments about the feature",
+        "options": [],
+        "alias": [],
+        "example": "estimated using hilburt transform.",
+		"default": null
+    }
+}

mt_metadata/features/standards/feature_ts_run.json

@@ -0,0 +1,35 @@
+{
+	"id": {
+        "type": "string",
+        "required": true,
+        "style": "alpha numeric",
+        "units": null,
+        "description": "Suggested Run ID should be sample rate followed by a number or character.  Characters should only be used if the run number is small, if the run number is high consider using digits with zeros.  For example if you have 100 runs the run ID could be 001 or sr{sample_rate}_001. Should be the same as the time series run ID.",
+        "options": [],
+        "alias": [],
+        "example": "001",
+		"default": null
+    },
+    "sample_rate": {
+        "type": "float",
+        "required": true,
+        "style": "number",
+        "units": "samples per second",
+        "description": "Digital sample rate for the run",
+        "options": [],
+        "alias": [],
+        "example": "100",
+		"default": 0.0
+    },
+    "comments": {
+        "type": "string",
+        "required": false,
+        "style": "free form",
+        "units": null,
+        "description": "Any comments about the feature",
+        "options": [],
+        "alias": [],
+        "example": "estimated using hilburt transform.",
+		"default": null
+    }
+}

mt_metadata/features/standards/feature_weighting_window.json

@@ -0,0 +1,46 @@
+{
+    "threshold": {
+        "type": "string",
+        "required": true,
+        "style": "controlled vocabulary",
+        "units": null,
+        "description": "Specify which side of a threshold should downweighted.",
+        "options": ["low cut", "high cut"],
+        "alias": [],
+        "example": "low cut",
+		"default": null
+    },
+    "half_window_style": {
+        "type": "string",
+        "required": true,
+        "style": "controlled vocabulary",
+        "units": null,
+        "description": "What taper to use between the 0 (rejected) and 1 (accepted) values.",
+        "options": ["hamming", "hann", "rectangle"],
+        "alias": [],
+        "example": "hann",
+		"default": null
+    },
+    "transition_lower_bound": {
+        "type": "float",
+        "required": true,
+        "style": "number",
+        "units": null,
+        "description": "a refernece point for where the function begins to change from 0 to 1 or from 1 to zero",
+        "options": [],
+        "alias": [],
+        "example": "0.3",
+		"default": "-inf"
+    },
+    "transition_upper_bound": {
+        "type": "float",
+        "required": true,
+        "style": "number",
+        "units": null,
+        "description": "a refernece point for where the function finishes changing from 0 to 1 or from 1 to zero",
+        "options": [],
+        "alias": [],
+        "example": "0.999",
+		"default": "+inf"
+    }
+}

mt_metadata/features/standards/weight_kernel.json

@@ -0,0 +1,46 @@
+{
+    "threshold": {
+        "type": "string",
+        "required": true,
+        "style": "controlled vocabulary",
+        "units": null,
+        "description": "Specify which side of a threshold should downweighted.",
+        "options": ["low cut", "high cut"],
+        "alias": [],
+        "example": "low cut",
+		"default": null
+    },
+    "half_window_style": {
+        "type": "string",
+        "required": true,
+        "style": "controlled vocabulary",
+        "units": null,
+        "description": "What taper to use between the 0 (rejected) and 1 (accepted) values.",
+        "options": ["hamming", "hann", "rectangle"],
+        "alias": [],
+        "example": "hann",
+		"default": null
+    },
+    "transition_lower_bound": {
+        "type": "float",
+        "required": true,
+        "style": "number",
+        "units": null,
+        "description": "a refernece point for where the function begins to change from 0 to 1 or from 1 to zero",
+        "options": [],
+        "alias": [],
+        "example": "0.3",
+		"default": "-inf"
+    },
+    "transition_upper_bound": {
+        "type": "float",
+        "required": true,
+        "style": "number",
+        "units": null,
+        "description": "a refernece point for where the function finishes changing from 0 to 1 or from 1 to zero",
+        "options": [],
+        "alias": [],
+        "example": "0.999",
+		"default": "+inf"
+    }
+}

mt_metadata/features/standards/weights.json

@@ -0,0 +1,101 @@
+{
+    "output_channel": {
+        "type": "string",
+        "required": true,
+        "style": "free form",
+        "units": null,
+        "description": "The output hannel if the transfer function equation being solved, usually ex, ey, hz.",
+        "options": [],
+        "alias": [],
+        "example": "ex",
+        "default": null
+    },
+    "combination_style": {
+        "type": "string",
+        "required": true,
+        "style": "controlled vocabulary",
+        "units": null,
+        "description": "A keyword describing how the various features will be combined to generate data weightings.",
+        "options": [],
+        "alias": [],
+        "example": "multiplication",
+        "default": "multiplication"
+    }
+}                    "weights": {
+                        "ex": {
+                          "combination_style": "multiplication",
+                          "features":[
+                            {
+                            "feature_name": "coherence",
+                            "feature_params": {
+                            "ch1": "ex",
+                            "ch2": "hy",
+                            "detrend": true
+                            },
+                            "low_cut_weight_function": {
+                            "half_window_style": "hamming",
+                            "transition_lower_bound": 0.3,
+                            "transition_upper_bound": 0.8
+                            },
+                            "high_cut_weight_function": {
+                            "half_window_style": "hamming",
+                            "transition_lower_bound": 0.8,
+                            "transition_upper_bound": 1.3
+                            }
+                            },
+                          {
+                            "feature_name": "multiple_coherence",
+                            "feature_params": {
+                              "output_channel": "ex"
+                            },
+                            "window_style": "threshold",
+                            "window_params": {
+                                "style": "rectange",
+                                "transition_lower_bound": 0.9,
+                                "transition_upper_bound": 0.9
+                            },
+                                     "style": "rectange",
+                                "transition_lower_bound": 0.9,
+                                "transition_upper_bound": 0.11
+                              "min": 0.9,
+                              "max": 1.1
+                            }
+                          }
+                        ]
+                        },
+
+{
+    "channel_1": {
+        "type": "string",
+        "required": true,
+        "style": "free form",
+        "units": null,
+        "description": "The first channel of two channels in the coherence calculation.",
+        "options": [],
+        "alias": [],
+        "example": "ex",
+        "default": null
+    },
+    "channel_2": {
+        "type": "string",
+        "required": true,
+        "style": "free form",
+        "units": null,
+        "description": "The second channel of two channels in the coherence calculation.",
+        "options": [],
+        "alias": [],
+        "example": "hy",
+        "default": null
+    },
+    "detrend": {
+        "type": "string",
+        "required": true,
+        "style": "controlled vocabulary",
+        "units": null,
+        "description": "How to detrend the data segments before fft.",
+        "options": ["linear", "constant"],
+        "alias": [],
+        "example": "constant",
+        "default": "linear"
+    }
+}

mt_metadata/features/test_helpers/channel_weight_specs_example.json

@@ -0,0 +1,156 @@
+{
+    "channel_weight_specs": [
+            {
+                "channel_weight_spec": {
+                    "output_channels": [
+                        "ex"
+                    ],
+                    "combination_style": "multiplication",
+                    "feature_weight_specs": [
+                        {
+                            "feature_weight_spec": {
+                                "feature": {
+                                    "name": "striding_window_coherence",
+                                    "ch1": "ex",
+                                    "ch2": "hy"
+                                },
+                                "weight_kernels": [
+                                    {
+                                        "weight_kernel": {
+                                            "half_window_style": "hann",
+                                            "transition_lower_bound": 0.6,
+                                            "transition_upper_bound": 0.9,
+                                            "threshold": "low cut"
+                                        }
+                                    },
+                                    {
+                                        "weight_kernel": {
+                                            "half_window_style": "hann",
+                                            "transition_lower_bound": 0.9995,
+                                            "transition_upper_bound": 1.01,
+                                            "threshold": "high cut"
+                                        }
+                                    }
+                                ]
+                            }
+                        },
+                        {
+                            "feature_weight_spec": {
+                                "feature": {
+                                    "name": "multiple_coherence",
+                                    "output_channel": "ex"
+                                },
+                                "weight_kernels": [
+                                    {
+                                        "weight_kernel": {
+                                            "activation_style": "sigmoid",
+                                            "transition_lower_bound": 0.8,
+                                            "transition_upper_bound": 1.2,
+                                            "threshold": "low cut"
+                                        }
+                                    }
+                                ]
+                            }
+                        }
+                    ]
+                }
+            },
+            {
+                "channel_weight_spec": {
+                    "output_channels": [
+                        "ey"
+                    ],
+                    "combination_style": "multiplication",
+                    "feature_weight_specs": [
+                        {
+                            "feature_weight_spec": {
+                                "feature": {
+                                    "name": "striding_window_coherence",
+                                    "ch1": "ey",
+                                    "ch2": "hx"
+                                },
+                                "weight_kernels": [
+                                    {
+                                        "weight_kernel": {
+                                            "half_window_style": "hann",
+                                            "transition_lower_bound": 0.4,
+                                            "transition_upper_bound": 0.77,
+                                            "threshold": "low cut"
+                                        }
+                                    }
+                                ]
+                            }
+                        },
+                        {
+                            "feature_weight_spec": {
+                                "feature": {
+                                    "name": "multiple_coherence",
+                                    "output_channel": "ey"
+                                },
+                                "weight_kernels": [
+                                    {
+                                        "weight_kernel": {
+                                            "half_window_style": "hann",
+                                            "transition_lower_bound": 0.4,
+                                            "transition_upper_bound": 0.8,
+                                            "threshold": "low cut"
+                                        }
+                                    }
+                                ]
+                            }
+                        }
+                    ]
+                }
+            },
+            {
+                "channel_weight_spec": {
+                    "output_channels": [
+                        "hz"
+                    ],
+                    "combination_style": "multiplication",
+                    "feature_weight_specs": [
+                        {
+                            "feature_weight_spec": {
+                                "feature": {
+                                    "name": "striding_window_coherence",
+                                    "ch1": "hx",
+                                    "ch2": "rx"
+                                },
+                                "weight_kernels": [
+                                    {
+                                        "weight_kernel": {
+                                            "style": "taper",
+                                            "half_window_style": "hann",
+                                            "transition_lower_bound": 0.6,
+                                            "transition_upper_bound": 0.9,
+                                            "threshold": "low cut"
+                                        }
+                                    }
+                                ]
+                            }
+                        },
+                        {
+                            "feature_weight_spec": {
+                                "feature": {
+                                    "name": "striding_window_coherence",
+                                    "ch1": "hy",
+                                    "ch2": "ry"
+                                },
+                                "weight_kernels": [
+                                    {
+                                        "weight_kernel": {
+                                            "style": "taper",
+                                            "half_window_style": "hann",
+                                            "transition_lower_bound": 0.5,
+                                            "transition_upper_bound": 0.9,
+                                            "threshold": "low cut"
+                                        }
+                                    }
+                                ]
+                            }
+                        }
+                    ]
+                }
+            }
+        ]
+}