proc

Below is an auto-generated summary of the xftsim.proc submodule API.

Module to define classes for post-processing xft simulation data. Classes:

PostProcessor: Base class for defining post-processing operations on xft simulation data.

LimitMemory(PostProcessor): Class to limit the amount of memory used by the simulation by deleting old haplotype and/or phenotype data.

WriteToDisk(PostProcessor): Class to write simulation data to disk.

class xftsim.proc.LimitMemory(n_haplotype_generations=-1, n_phenotype_generations=-1)

Bases: PostProcessor

Class to limit the amount of memory used by the simulation by deleting old haplotype and/or phenotype data. Parameters: ———– n_haplotype_generations: int, optional

The number of haplotype generations to keep. If -1, keep all generations. Default is -1.

n_phenotype_generations: int, optional

The number of phenotype generations to keep. If -1, keep all generations. Default is -1.

Methods:

processor(sim: xft.sim.Simulation) -> None:

Deletes old haplotype and/or phenotype data from the simulation.

processor(sim)

Deletes old haplotype and/or phenotype data from the simulation.

Parameters:

sim: xft.sim.Simulation

The simulation to delete old data from.

Returns:

None

class xftsim.proc.PostProcessor(processor, name)

Bases: object

Base class for defining post-processing operations on XFT simulation data. Parameters: ———– processor: Callable

A callable object that takes a single argument of type xft.sim.Simulation and performs some post-processing operation on it.

name: str

A name for the post-processing operation being defined.

Methods:

process(sim: xft.sim.Simulation) -> None:

Applies the post-processing operation to the given simulation.

process(sim)

Applies the post-processing operation to the given simulation.

Parameters:

sim: xft.sim.Simulation

The simulation to apply the post-processing operation to.

Returns:

None

class xftsim.proc.WriteToDisk(arg)

Bases: PostProcessor

docstring for PostProcess