gunshotmatch_pipeline.unknowns
Metadata and pipeline for unknown samples.
Classes:
|
Settings for an unknown propellant or OGSR sample. |
Functions:
|
Filter peaks by minimum peak area, then identify compounds. |
|
Process an “unknown” sample. |
-
class
UnknownSettings
(name, datafile, method, config, output_directory, data_directory='')[source] Bases:
libgunshotmatch.method.MethodBase
,gunshotmatch_pipeline.projects.LoaderMixin
Settings for an unknown propellant or OGSR sample.
- Parameters
name (
str
) – The unknown sample’s name or identifier.datafile (
str
) – The input datafilemethod (
str
) – Relative or absolute filename to the method TOML file. The table name is “method”.config (
str
) – Relative or absolute filename to the configuration TOML file. The table name is “config”.output_directory (
str
) – Relative or absolute path to the directory the output files should be placed in.data_directory (
str
) – Relative or absolute path to the directory containing the data files. Default''
.
Attributes:
Relative or absolute filename to the configuration TOML file.
Relative or absolute path to the directory containing the data files.
The input datafile
The absolute path to the datafile.
Relative or absolute filename to the method TOML file.
The unknown sample’s name or identifier.
Relative or absolute path to the directory the output files should be placed in.
Methods:
from_json
(json_string)Parse an
UnknownSettings
from a JSON string.from_toml
(toml_string)Parse an
UnknownSettings
from a TOML string.to_toml
()Convert an
UnknownSettings
to a TOML string.-
config
Type:
str
Relative or absolute filename to the configuration TOML file. The table name is “config”.
-
classmethod
from_json
(json_string)[source] Parse an
UnknownSettings
from a JSON string.- Parameters
json_string (
str
)- Return type
-
classmethod
from_toml
(toml_string)[source] Parse an
UnknownSettings
from a TOML string.- Parameters
toml_string (
str
)- Return type
-
method
Type:
str
Relative or absolute filename to the method TOML file. The table name is “method”.
-
output_directory
Type:
str
Relative or absolute path to the directory the output files should be placed in.
-
to_toml
()[source] Convert an
UnknownSettings
to a TOML string.- Return type