Skip to contents

H5ClusteredArray (Virtual Base Class)

Source: R/all_class.R
H5ClusteredArray-class.Rd

A **virtual** base class for representing clustered neuroimaging data stored in HDF5. It holds the common elements shared across different representations (e.g., full voxel data, summary data). This class is not intended to be instantiated directly.

Slots

obj

An H5File object representing the open HDF5 file.

mask

A LogicalNeuroVol defining the brain mask (shared across runs).

clusters

A ClusteredNeuroVol containing cluster assignments (shared across runs).

n_voxels

An integer caching the number of voxels in the mask (sum(mask)).

See also

Other H5Cluster: $,H5ClusterExperiment-method, H5ClusterExperiment, H5ClusterExperiment-class, H5ClusterRun-class, H5ClusterRunSummary-class, [,H5ClusterRun,ANY,ANY,ANY-method, [,H5ClusterRun,ANY,missing,ANY-method, as.data.frame(), as.matrix(), close(), cluster_metadata,H5ClusterExperiment-method, clusters(), dim(), h5file,H5ClusteredArray-method, linear_access-methods, make_run_full(), make_run_summary(), mask(), matrix_concat(), n_scans,H5ClusterExperiment-method, scan_metadata,H5ClusterExperiment-method, scan_names,H5ClusterExperiment-method, series(), series_concat(), show,H5ClusterRun-method

Examples

# H5ClusteredArray is a virtual class and cannot be directly instantiated.
# See its subclasses H5ClusterRun and H5ClusterRunSummary for examples.

# You can check if an object inherits from it:
# run_object <- H5ClusterRun(...) # Assuming run_object is created
# inherits(run_object, "H5ClusteredArray") # Should return TRUE