The Base Stage Class

All TXPipe stages inherit from this base class.

class txpipe.base_stage.PipelineStage(*args: Any, **kwargs: Any)

Bases: PipelineStage

The parent class for all TXPipe stages

This stage should not be used directly (hence the name)

memory_report(tag=None)

Print a report about memory currently available on the node the process is running on.

Parameters:

tag (str) – Additional info to print in the output line. Default is empty.

open_output(tag, wrapper=False, **kwargs)

Find and open an output file with the given tag, in write mode.

For general files this will simply return a standard python file object.

For specialized file types like FITS or HDF5 it will return a more specific object - see the types.py file for more info.

This is an extended version of the parent class method which also saves configuration information. Putting this here right now for testing.