molProbMap: molProbMap Class Constructor

View source: R/S3classes.R

molProbMapR Documentation

molProbMap Class Constructor

Description

This is an S3 class to represent the calculated molecular probability maps. This class is only used with objects returned by 'porbMap' function and should not be called explicitly by the user.

Usage

molProbMap(
  bw,
  sppMoi,
  csrMoi,
  rhoMoi,
  rhoCsr,
  hotspotpp,
  hotspotIm,
  hotspotMask,
  coldspotpp,
  coldspotIm,
  coldspotMask
)

Arguments

bw

A numeric, the calculated Gaussian bandwidth

sppMoi

A 'analytePointPattern' object representing a given analyte (metabolite-of-interest).

csrMoi

A 'analytePointPattern' object representing the corresponding CSR model.

rhoMoi

An 'im' object storing the density image of 'sppMoi' after applying KDE.

rhoCsr

An 'im' object storing the density image of 'csrMoi' after applying KDE.

hotspotpp

A 'analytePointPattern' object holding only the points that are located within the hotspot.

hotspotIm

An 'im' object storing the corresponding pixellated image of the 'hotspotpp' slot.

hotspotMask

An 'owin' object storing the corresponding window of the 'hotspotpp' slot.

coldspotpp

A 'analytePointPattern' object holding only the points that are located within the coldspot.

coldspotIm

An 'im' object storing the corresponding pixellated image of the 'coldspotpp' slot.

coldspotMask

An 'owin' object storing the corresponding window of the 'coldspotpp' slot.

Value

An S3 object of type 'molProbMap'.


CeMOS-Mannheim/moleculaR documentation built on April 14, 2025, 8:27 a.m.