Signal Processing¶
-
class
mrsimulator.signal_processing.
SignalProcessor
(*, processed_data: csdmpy.csdm.CSDM = None, operations: List[mrsimulator.signal_processing._base.AbstractOperation] = [])¶ Bases:
pydantic.main.BaseModel
Signal processing class to apply a series of operations to the dependent variables of the simulation dataset.
-
operations
¶ A list of operations.
- Type
List
Examples
>>> post_sim = SignalProcessor(operations=[o1, o2])
Method Documentation
-
classmethod
parse_dict_with_units
(py_dict)¶ Parse a list of operations dictionary to a SignalProcessor class object.
- Parameters
pt_dict – A python dict object.
-
json
()¶ Serialize the SignalProcessor object to a JSON compliant python dictionary object, where physical quantities are represented as string with a value and a unit.
- Returns
A Dict object.
-
apply_operations
(data, **kwargs)¶ Function to apply all the operation functions in the operations member of a SignalProcessor object. Operations applied sequentially over the data member.
- Returns
A copy of the data member with the operations applied to it.
- Return type
CSDM object
-