Module: run_search#

class kbmod.run_search.run_search(input_parameters)[source]#

Run the KBMoD grid search.

Parameters:

input_parametersdict: Input parameters. Merged with the defaults dictionary. Must contain im_filepath and res_filepath keys, paths to the image and results directory respectively. Should contain v_arr, and ang_arr, which are lists containing the lower and upper velocity and angle limits.

Attributes:

default_mask_bits_dictdict: Map between mask key and bit values.
default_flag_keyslist: Pixels marked with these flags will be ignored in the search. Default: ["BAD", "EDGE", "NO_DATA", "SUSPECT", "UNMASKEDNAN"]
default_repeated_flag_keyslist: Don’t know
configdict: Search parameters.

Methods

`do_gpu_search`(search, img_info, ...)	Performs search on the GPU.
`run_search`()	This function serves as the highest-level python interface for starting a KBMOD search.

do_gpu_search(search, img_info, suggested_angle, post_process)[source]#

Performs search on the GPU.

Parameters:

search~kbmod.search.Search: Search object.
img_infokbmod.search.ImageInfo: ImageInfo object.
suggested_anglefloat: Angle a 12 arcsecond segment parallel to the ecliptic is seen under from the image origin.
post_process: Don’t know

run_search()[source]#

This function serves as the highest-level python interface for starting a KBMOD search.

The config attribute requires the following key value pairs.

Parameters:

self.config.im_filepathstring: Path to the folder containing the images to be ingested into KBMOD and searched over.
self.config.res_filepathstring: Path to the folder that will contain the results from the search.
self.config.out_suffixstring: Suffix to append to the output files. Used to differentiate between different searches over the same stack of images.
self.config.time_filestring: Path to the file containing the image times (or None to use values from the FITS files).
self.config.psf_filestring: Path to the file containing the image PSFs (or None to use default).
self.config.lh_levelfloat: Minimum acceptable likelihood level for a trajectory. Trajectories with likelihoods below this value will be discarded.
self.config.psf_valfloat: The value of the variance of the default PSF to use.
self.config.mjd_limsnumpy array: Limits the search to images taken within the limits input by mjd_lims (or None for no filtering).
self.config.average_anglefloat: Overrides the ecliptic angle calculation and instead centers the average search around average_angle.