stereo.io.read_stereo_h5ad#

stereo.io.read_stereo_h5ad(file_path, use_raw=True, use_result=True, bin_type=None, bin_size=None)[source]#

Read the H5ad file, and generate the StereoExpData object.

Parameters:

  • file_path (str) – the path to input H5ad file.

  • use_raw (bool) – whether to read data of self.raw.

  • use_result (bool) – whether to read result and res_key.

  • bin_type (Optional[str]) – the bin type includes 'bins' or 'cell_bins'.

  • bin_size (Optional[int]) – the size of bin to merge, when bin_type is set to 'bins'.

Return type:

An object of StereoExpData.