sparseIntensityMatrix: sparseIntensityMatrix Class Constructor

View source: R/S3classes.R

sparseIntensityMatrixR Documentation

sparseIntensityMatrix Class Constructor

Description

An S3 class to hold mass spectrometry imaging (MSI) intensity data in a sparse representation ('Matrix::dgCMatrix' class) with few additional slots. It is used to speed-up computation. This constructor is for internal use and normally should not be called by the user.

Usage

sparseIntensityMatrix(spmat, mzAxis, coordinates)

Arguments

spmat

A sparse matrix of type 'Matrix::dgCMatrix' holding MSI intensity data.

mzAxis

A numeric, the overall m/z axis for the experiment.

coordinates

A two-column data.frame, the coordinates of the spectra which are stored in rows of 'spmat'.

Value

An S3 object 'sparseIntensityMatrix' with the following entries

  • spmat: A sparse matrix of type 'Matrix::dgCMatrix' holding MSI intensity data.

  • mzAxis: A numeric, the overall m/z axis for the experiment.

  • coordinates: A two-column data.frame, the coordinates of the spectra which are stored in rows of 'spmat'.


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