CrossMatch

class macauff.CrossMatch(crossmatch_params_file_path, cat_a_params_file_path, cat_b_params_file_path, resume_file_path=None, use_mpi=True, walltime=None, end_within='00:10:00', polling_rate=1)

Bases: object

A class to cross-match two photometric catalogues with one another, producing a composite catalogue of merged sources.

Parameters:

crossmatch_params_file_pathstring

A path to the location of the joint-match parameter file.

cat_a_params_file_pathstring

A path to the location of the file containing the left-hand catalogue parameters.

cat_b_params_file_pathstring

A path to the location of the input parameter file containing the relevant information for the right-hand catalogue “b”.

resume_file_pathstring, optional

A path to the location of the file containing resume information for the cross match.

use_mpiboolean, optional

Enable/disable the use of MPI parallelisation (enabled by default).

walltimestring, optional

Maximum runtime of the cross-match job in format ‘HH:MM:SS’ (hours, minutes and seconds). Controls checkpointing.

end_withinstring, optional

End time in ‘HH:MM:SS’ format (hours, minutes and seconds). Default is ‘00:10:00’, i.e. end within 10 minutes of the given walltime.

polling_rateinteger, optional

Rate in seconds at which manager process checks for new work requests and monitors walltime. Default is 1 second.

Initialisation function for cross-match class.

Methods Summary

__call__()	Call function for CrossMatch, performs cross-matching two photometric catalogues.
load_psf_auf_params()	Load PSF AUF parameters from package data to class attributes.
make_shared_data()	Function to initialise the shared variables used in the cross-match process.

Methods Documentation

__call__()

Call function for CrossMatch, performs cross-matching two photometric catalogues.

load_psf_auf_params()

Load PSF AUF parameters from package data to class attributes.

make_shared_data()

Function to initialise the shared variables used in the cross-match process.