seriesCount: Number of Image Series

In aoles/RBioFormats: R interface to Bio-Formats

Number of Image Series

Description

Get the number of image series contained in an object.

Usage

seriesCount(x)

## S4 method for signature 'ANY'
seriesCount(x)

## S4 method for signature 'matrix'
seriesCount(x)

## S4 method for signature 'array'
seriesCount(x)

## S4 method for signature 'ImageMetadata'
seriesCount(x)

## S4 method for signature 'AnnotatedImageList'
seriesCount(x)

## S4 method for signature 'ImageMetadataList'
seriesCount(x)

Arguments

x	an images object.

Details

Image series are encoded by AnnotatedImageList or ImageMetadataList objects. Therefore, only these objects can possibly yield image series count higher than 1 while for all the rest of image objects this number is expected to be 1.

Value

The number of image series the object contains, see Details.

Author(s)

Andrzej Oleś <[e-mail]>, 2014-2023

Examples

f = mockFile(sizeX = 256, sizeY = 256, series = 2)
img = read.image(f)
seriesCount(img)

meta <- metadata(img)
seriesCount(meta)

aoles/RBioFormats documentation built on May 3, 2024, 7:46 a.m.