Learn R Programming

IFC (version 0.1.1)

objectDisplay: Object Display

Description

This function is intended to display object extracted by objectExtract.

Usage

objectDisplay(
  image,
  input_range = c(0, 4095),
  full_range = FALSE,
  force_range = FALSE,
  gamma = 1,
  color = "Green",
  dpi = 300
)

Arguments

image

An object extracted by objectExtract of class `IFC_img` or `IFC_msk`. Note that a matrix with finite values can also be used.

input_range

a finite numeric vector of 2 values, sets the range of the input intensity values. Values exceeding this range are clipped. Default is 'c(0, 4095)'.

full_range

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

force_range

if 'force_range' is TRUE, then 'input_range' will be adjusted to object 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.

color

a color. Default is "Green".

dpi

display resolution. Default is 300.

Value

it invisibly returns NULL

Details

If input 'image' is of class `IFC_img` or `IFC_msk`, then if 'input_range', 'full_range', 'force_range', 'gamma' and / or 'color' parameters is/are missing, it/they will be extracted from 'image' attributes. If input 'image' is not of one of class `IFC_img` or `IFC_msk`, then force_range will be forced to TRUE. An error will be thrown if input image contains non finite values.