stereo.core.StPipeline.filter_coordinates#

StPipeline.filter_coordinates(min_x=None, max_x=None, min_y=None, max_y=None, filter_raw=True, inplace=True)[source]#

Filter cells based on coordinate information.

Parameters:

  • min_x (Optional[int]) – minimum of coordinate x for a cell to pass filtering.

  • max_x (Optional[int]) – maximum of coordinate x for a cell to pass filtering.

  • min_y (Optional[int]) – minimum of coordinate y for a cell to pass filtering.

  • max_y (Optional[int]) – maximum of coordinate y for a cell to pass filtering.

  • filter_raw (bool) – whether to filter raw data meanwhile.

  • inplace (bool) – whether to inplace the previous data or return a new data.

Returns:

  • An object of StereoExpData.

  • Depending on inplace, if True, the data will be replaced by those filtered.