stereo.core.StPipeline.scale#

StPipeline.scale(zero_center=True, max_value=None, inplace=True, res_key='scale')[source]#

Scale express matrix to unit variance and zero mean.

Parameters:

  • zero_center (bool) – if False, ignore zero variables, which allows to deal with sparse input efficently.

  • max_value (Optional[float]) – truncate to this value after scaling, if None, do not truncate.

  • inplace (bool) – whether to inplace the previous data or get a new express matrix after scaling.

  • res_key (str) – the key to get targeted result from self.result.

Returns:

  • An object of StereoExpData.

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