cortex.dataset.Volume.random

classmethod Volume.random(subject: str, xfmname: str, random_type: Literal['low_frequency', 'uniform'] = 'low_frequency', falloff_exponent: float = -1.25, **kwargs) → Self

Create a random-valued VolumeData for the given subject and xfmname. Random values are from gaussian distribution with mean 0, s.d. 1. Often useful for testing purposes.

Parameters:

subjectstr

Subject identifier. Must exist in the pycortex database.

xfmnamestr

Transform name. Must exist in the pycortex database.

random_typestr, optional

type of random data to use. Default: low_frequency. One of (‘low_frequency’, ‘uniform’) ‘low_frequency’ yields blobby, brain-like data ‘uniform’ yields uniform random noise.

falloff_exponentfloat, optional

Only used when random_type is ‘low_frequency’. Factor by which Fourier power falls off. Higher magnitude emphasizes low frequencies more strongly.

**kwargs

Other keyword arguments are passed to the init function for this class.

Returns:

VolumeData subclass

A VolumeData subclass object whose data is random.