merquaco.z_plane_detection.compute_z_ratio

merquaco.z_plane_detection.compute_z_ratio(transcripts: DataFrame, num_planes: int = None, high_plane: int = 6, low_plane: int = 0) → float

Returns ratio of transcript counts between highest and lowest planes

Parameters:

  • transcripts (pd.DataFrame) – Transcripts table

  • num_planes (int, optional) – Number of z-planes to count transcripts in. Default is None.

  • high_plane (int, optional) – Highest z-plane; numerator in z-ratio division. Default is 6.

  • low_plane (int, optional) – Lowest z-plane; denominator in z-ratio division. Default is 0.

Returns:

z_plane_ratio – Ratio of transcript counts in high/low z-planes

Return type:

float

Raises:

ValueError – If high_plane is outside of z-plane range for experiment