get_img

MPPData.get_img(data='mpp', channel_ids=None, **kwargs)[source]

Calculate data image of entire MPPData.

Parameters

  • data (str) – Key in MPPData.data() that should be plotted on the image.

  • channel_ids (Optional[Iterable[str]]) – Only if key == ‘mpp’. Channels that the image should have. If None, all channels are returned.

  • img_size – Size of returned image. If None, images have minimal required size to fit all information. If None, offset information is returned by this function.

  • pad – Amount of padding added to returned image (only used when img_size is None).

Return type

Union[ndarray, Tuple[ndarray, Tuple[int, int]]]

Returns

  • If img_size is None, returns (image, (offset_x, offset_y).) – Offset is that value that needs to be subtracted from MPPData.x and MPPData.y before being able to use them to index the returned image.

  • Otherwise returns (image)