parse_channels

mapsims.parse_channels(filter='all', instrument_parameters=None)

Create a list of Channel objects from a HDF5 and an optional filter

Reads a HDF5 file which contains the instruments parameters and parses it into a list of Channel objects, by default all channels are included.

Parameters:

instrument_parametersstr or Path

See the instrument_parameters argument of MapSim

filterstr or None

See the channels argument of MapSim

Returns:

channel_objects_listlist of Channel objects or list of tuples of Channel objects

List of the selected Channel objects, in case of tubes, we return a list where each element is the tuple of the Channel objects in a tube. This is useful to simulate correlated noise.