rail.evaluation.metrics.tomography module

class rail.evaluation.metrics.tomography.KDEBinOverlap

Bases: RailStage

Stage KDEBinOverlap

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.

  • hdf5_groupname ([str] default=photometry) – name of hdf5 group for data, if None, then set to ‘’

  • redshift_col ([str] default=redshift) – name of redshift column

  • bin_name ([str] default=class_id) – Groupname for the tomographic bin index in the hdf5 handle

  • truth (TableHandle (INPUT))

  • bin_index (Hdf5Handle (INPUT))

  • output (Hdf5Handle (OUTPUT))

entrypoint_function: str | None = 'evaluate'
evaluate(bin_index, truth, **kwargs)

Evaluate function for KDEBinOverlap

Parameters:

  • bin_index (TableLike) – bin_index

  • truth (TableLike) – truth

Returns:

Output data

Return type:

Hdf5Handle

inputs = [('truth', <class 'rail.core.data.TableHandle'>), ('bin_index', <class 'rail.core.data.Hdf5Handle'>)]
interactive_function: str | None = 'kde_bin_overlap'
name = 'KDEBinOverlap'
outputs = [('output', <class 'rail.core.data.Hdf5Handle'>)]
run()

Run the stage and return the execution status.

Subclasses must implemented this method.

Return type:

None