objectNormalize: Object Intensity Normalization

View source: R/objectNormalize.R

objectNormalizeR Documentation

Object Intensity Normalization

Description

Normalizes a matrix to [0,1].

Usage

objectNormalize(
  mat,
  input_range = c(0, 4095),
  full_range = FALSE,
  force_range = FALSE,
  gamma = 1
)

Arguments

mat

a finite numeric matrix.

input_range

a finite numeric vector of 2 values, sets the range of the input intensity values. Values outside this range are clipped. Default is [0,4095].

full_range

if 'full_range' is TRUE, then 'input_range' will be set to [0,4095] and 'gamma' forced to 1. Default is FALSE.

force_range

if 'force_range' is TRUE, then 'input_range' will be adjusted to 'mat' range in [-4095,+inf] and 'gamma' forced to 1. Default is FALSE.
Note that this parameter takes the precedence over input_range' and full_range'.

gamma

'gamma' correction. Default is 1, for no correction.

Details

Note that negative values are used internally for removal of unmasked objects.

Value

a [0,1] normalized matrix


IFC documentation built on Sept. 14, 2023, 1:08 a.m.