libpyvinyl.Parameters.Collections.InstrumentParameters
libpyvinyl.Parameters.Collections.InstrumentParameters¶
- class libpyvinyl.Parameters.Collections.InstrumentParameters¶
Object intended for use as instrument parameters
This object holds Parameters objects for a number of calculators and can have master parameters which control parameters for a number of calculators at once.
- __init__()¶
Create an empty ParametersCollection instance
Methods
__init__()Create an empty ParametersCollection instance
add(key, parameters)Here key could be a calculator object or a reference to such an object, like its name
add_master_parameter(name, links, **kwargs)link: dict with keys and parameters for which this parameter should override
from_dict(instrument_dict)Initialize an instance from a dict.
from_json(fname)Initialize an instance from a json file.
to_dict()to_json(fname)Save this parameters class to a human readable json file.
- add(key, parameters)¶
Here key could be a calculator object or a reference to such an object, like its name
- add_master_parameter(name, links, **kwargs)¶
link: dict with keys and parameters for which this parameter should override
- classmethod from_dict(instrument_dict: dict)¶
Initialize an instance from a dict.
- Parameters
fname (str) – The filename (path) of the json file.
- classmethod from_json(fname: str)¶
Initialize an instance from a json file.
- Parameters
fname (str) – The filename (path) of the json file.
- to_json(fname: str)¶
Save this parameters class to a human readable json file.
- Parameters
fname (str) – Write to this file.