visisipy.types

Types for use throughout visisipy.

This module contains type definitions and utility classes for use throughout the visisipy package.

Classes

SampleSize

Sample size.

Module Contents

class visisipy.types.SampleSize(sample_size: int | str | SampleSize)

Sample size.

This class represents a sample size used for various analyses. How the sample size is used depends on the backend. Sample sizes can be specified as integers or strings in the format “NxN”, where N is an integer. Only symmetric sample sizes are supported.

Attributes:

samplingint

The sample size.

Examples

>>> sample_size = SampleSize(512)
>>> print(int(sample_size))
512
>>> sample_size = SampleSize("512x512")
>>> print(sample_size)
512x512

property sampling: int

Get the sample size.