rail.creation.noisifier module

Abstract base class defining a noisifier.

The key feature here is the run adds noise to the catalog. Intended subclasses are noisifier that adds LSST noise / other telescope noise

class rail.creation.noisifier.Noisifier

Bases: RailStage

Base class Noisifier, which adds noise to the input catalog

Noisifier take “input” data in the form of pandas dataframes in Parquet files and provide as “output” another pandas dataframes written to Parquet files.

Parameters:

  • output_mode ([str] default=default) – What to do with the outputs. The options are ‘default’, where outputs will be written to files and some returned, and ‘return’, where outputs will only be returned and not written.

  • seed ([type not specified] default=None) – Set to an int to force reproducible results.

  • input (PqHandle (INPUT))

  • output (PqHandle (OUTPUT))

entrypoint_function: str | None = '__call__'
inputs = [('input', <class 'rail.core.data.PqHandle'>)]
name = 'Noisifier'
outputs = [('output', <class 'rail.core.data.PqHandle'>)]
run()

Run the stage and return the execution status.

Subclasses must implemented this method.

Return type:

None