rail.yaw_rail.stage_config module

This file implements the stage parameters and some automation tools to directly derive them, including their default values and documentation, from yet_another_wizz.

rail.yaw_rail.stage_config.cache = {'overwrite': Parameter(overwrite the path if it is an existing cache directory, type: <class 'bool'>, default: None [optional]), 'path': Parameter(path to cache directory, must not exist, type: <class 'str'>, default: None [required])}

Stage parameters to specify the cache directory.

rail.yaw_rail.stage_config.yaw_columns = {'dec_name': Parameter(column name of declination (in degrees), type: <class 'str'>, default: dec [optional]), 'degrees': Parameter(Whether the input coordinates are in degrees or radian., type: <class 'bool'>, default: True [optional]), 'ra_name': Parameter(column name of right ascension (in degrees), type: <class 'str'>, default: ra [optional]), 'redshift_name': Parameter(column name of redshift, type: <class 'str'>, default: None [optional]), 'weight_name': Parameter(column name of weight, type: <class 'str'>, default: None [optional])}

Stage parameters to specify column names in the input data.

rail.yaw_rail.stage_config.yaw_max_workers = Parameter(configure a custom maximum number of parallel workers to use, type: <class 'int'>, default: None [optional])

Stage parameter controlling the maximum number of parallel workers.

rail.yaw_rail.stage_config.yaw_patches = {'patch_file': Parameter(path to ASCII file that lists patch centers (one per line) as pair of R.A./Dec. in radian, separated by a single space or tab, type: <class 'str'>, default: None [optional]), 'patch_name': Parameter(column name of patch index (starting from 0), type: <class 'str'>, default: None [optional]), 'patch_num': Parameter(number of spatial patches to create using knn on coordinates of randoms, type: <class 'int'>, default: None [optional]), 'probe_size': Parameter(The approximate number of objects to sample from the input file when generating patch centers., type: <class 'int'>, default: -1 [optional])}

Optional stage parameters to specify the patch creation stragegy.

rail.yaw_rail.stage_config.yaw_scales = {'resolution': Parameter(Number of radial logarithmic bin used to approximate the weighting by separation., type: <class 'int'>, default: None [optional]), 'rmax': Parameter(Single or sequence of upper scale limits in given 'unit'., type: <class 'float'>, default: None [required]), 'rmin': Parameter(Single or sequence of lower scale limits in given 'unit'., type: <class 'float'>, default: None [required]), 'rweight': Parameter(Power-law exponent used to weight pairs by their separation., type: <class 'float'>, default: None [optional]), 'unit': Parameter(The unit of the lower and upper scale limits., type: <class 'str'>, default: kpc [optional])}

Stage parameters to configure the correlation measurements.