Skip to content

Improve documentation of read.image #39

Description

@lambdamoses

Specifically the documentation of the subset argument, which isn't very clear. I need to look into the source code to figure out what to put for subset when reading in only a subset of the image. Basically, according to the source code, subset should be a named list whose names are among "x", "y", "c", "z", and "t", corresponding to the dimensions of x, y, channel, z, and time. Each element of the list is integer indices of pixels to read in the dimension of interest just like when subsetting matrices, and if it's NULL then all in that dimension is read.

subset = sapply(names(xyczt), function(d) {
if ( is.null(subset[[d]]) )
seq_len(xyczt[d])
else {
sub = as.integer(subset[[d]])
sub[ sub >= 1L & sub <= xyczt[d] ]
}
}, simplify = FALSE)

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions