Module: search#

class kbmod.search.StampType#

Bases: pybind11_object

Members:

STAMP_SUM

STAMP_MEAN

STAMP_MEDIAN

Attributes:

name: name(self: handle) -> str
value

STAMP_MEAN = <StampType.STAMP_MEAN: 1>#

STAMP_MEDIAN = <StampType.STAMP_MEDIAN: 2>#

STAMP_SUM = <StampType.STAMP_SUM: 0>#

property name#

property value#

kbmod.search.ave_trajectory_dist(arg0: List[kbmod.search.pixel_pos], arg1: List[kbmod.search.pixel_pos]) → float#

class kbmod.search.baryCorrection#

Bases: pybind11_object

Attributes:

dx
dxdx
dxdy
dy
dydx
dydy

property dx#

property dxdx#

property dxdy#

property dy#

property dydx#

property dydy#

kbmod.search.calculate_likelihood_psi_phi(arg0: List[float], arg1: List[float]) → float#

kbmod.search.compute_traj_pos(arg0: kbmod.search.trajectory, arg1: float) → kbmod.search.pixel_pos#

kbmod.search.compute_traj_pos_bc(arg0: kbmod.search.trajectory, arg1: float, arg2: kbmod.search.baryCorrection) → kbmod.search.pixel_pos#

kbmod.search.create_mean_image(arg0: List[kbmod.search.raw_image]) → kbmod.search.raw_image#

kbmod.search.create_median_image(arg0: List[kbmod.search.raw_image]) → kbmod.search.raw_image#

kbmod.search.create_summed_image(arg0: List[kbmod.search.raw_image]) → kbmod.search.raw_image#

class kbmod.search.image_moments#

Bases: pybind11_object

Attributes:

m00
m01
m02
m10
m11
m20

property m00#

property m01#

property m02#

property m10#

property m11#

property m20#

class kbmod.search.image_stack#

Bases: pybind11_object

Methods

`apply_global_mask`(self, arg0, arg1)
`apply_mask_flags`(self, arg0, arg1)
`apply_mask_threshold`(self, arg0)
`convolve_psf`(self)
`get_global_mask`(self)
`get_height`(self)
`get_images`(self)
`get_masks`(self)
`get_ppi`(self)
`get_sciences`(self)
`get_single_image`(self, arg0)
`get_times`(self)
`get_variances`(self)
`get_width`(self)
`grow_mask`(self, arg0, arg1)
`img_count`(self)
`save_global_mask`(self, arg0)
`save_images`(self, arg0)
`set_single_image`(self, arg0, arg1)
`set_times`(self, arg0)
`simple_difference`(self)
`simple_shift_and_stack`(self, arg0, arg1, arg2)

masks
master_mask
sciences
variances

apply_global_mask(self: kbmod.search.image_stack, arg0: int, arg1: int) → None#

apply_mask_flags(self: kbmod.search.image_stack, arg0: int, arg1: List[int]) → None#

apply_mask_threshold(self: kbmod.search.image_stack, arg0: float) → None#

convolve_psf(self: kbmod.search.image_stack) → None#

get_global_mask(self: kbmod.search.image_stack) → kbmod.search.raw_image#

get_height(self: kbmod.search.image_stack) → int#

get_images(self: kbmod.search.image_stack) → List[kbmod.search.layered_image]#

get_masks(self: kbmod.search.image_stack) → List[kbmod.search.raw_image]#

get_ppi(self: kbmod.search.image_stack) → int#

get_sciences(self: kbmod.search.image_stack) → List[kbmod.search.raw_image]#

get_single_image(self: kbmod.search.image_stack, arg0: int) → kbmod.search.layered_image#

get_times(self: kbmod.search.image_stack) → List[float]#

get_variances(self: kbmod.search.image_stack) → List[kbmod.search.raw_image]#

get_width(self: kbmod.search.image_stack) → int#

grow_mask(self: kbmod.search.image_stack, arg0: int, arg1: bool) → None#

img_count(self: kbmod.search.image_stack) → int#

masks(copy_data=False)#

master_mask(copy_data=False)#

save_global_mask(self: kbmod.search.image_stack, arg0: str) → None#

save_images(self: kbmod.search.image_stack, arg0: str) → None#

sciences(copy_data=False)#

set_single_image(self: kbmod.search.image_stack, arg0: int, arg1: kbmod.search.layered_image) → None#

set_times(self: kbmod.search.image_stack, arg0: List[float]) → None#

simple_difference(self: kbmod.search.image_stack) → None#

simple_shift_and_stack(self: kbmod.search.image_stack, arg0: float, arg1: float, arg2: bool) → kbmod.search.raw_image#

variances(copy_data=False)#

class kbmod.search.layered_image#

Bases: pybind11_object

Methods

`add_object`(self, arg0, arg1, arg2)
`apply_mask_flags`(self, arg0, arg1)
`apply_mask_threshold`(self, arg0)
`convolve_psf`(self)
`generate_phi_image`(self)
`generate_psi_image`(self)
`get_height`(self)
`get_mask`(self)
`get_name`(self)
`get_ppi`(self)
`get_psf`(self)
`get_psfsq`(self)
`get_science`(self)
`get_time`(self)
`get_variance`(self)
`get_width`(self)
`grow_mask`(self, arg0, arg1)
`mask_object`(self, arg0, arg1)
`save_layers`(self, arg0)
`save_mask`(self, arg0)
`save_sci`(self, arg0)
`save_var`(self, arg0)
`set_mask`(self, arg0)
`set_psf`(self, arg0)
`set_science`(self, arg0)
`set_time`(self, arg0)
`set_variance`(self, arg0)
`sub_template`(self, arg0)

mask
science
variance

add_object(self: kbmod.search.layered_image, arg0: float, arg1: float, arg2: float) → None#

apply_mask_flags(self: kbmod.search.layered_image, arg0: int, arg1: List[int]) → None#

apply_mask_threshold(self: kbmod.search.layered_image, arg0: float) → None#

convolve_psf(self: kbmod.search.layered_image) → None#

generate_phi_image(self: kbmod.search.layered_image) → kbmod.search.raw_image#

generate_psi_image(self: kbmod.search.layered_image) → kbmod.search.raw_image#

get_height(self: kbmod.search.layered_image) → int#

get_mask(self: kbmod.search.layered_image) → kbmod.search.raw_image#

get_name(self: kbmod.search.layered_image) → str#

get_ppi(self: kbmod.search.layered_image) → int#

get_psf(self: kbmod.search.layered_image) → kbmod.search.psf#

get_psfsq(self: kbmod.search.layered_image) → kbmod.search.psf#

get_science(self: kbmod.search.layered_image) → kbmod.search.raw_image#

get_time(self: kbmod.search.layered_image) → float#

get_variance(self: kbmod.search.layered_image) → kbmod.search.raw_image#

get_width(self: kbmod.search.layered_image) → int#

grow_mask(self: kbmod.search.layered_image, arg0: int, arg1: bool) → None#

mask(copy_data=False)#

mask_object(self: kbmod.search.layered_image, arg0: float, arg1: float) → None#

save_layers(self: kbmod.search.layered_image, arg0: str) → None#

save_mask(self: kbmod.search.layered_image, arg0: str) → None#

save_sci(self: kbmod.search.layered_image, arg0: str) → None#

save_var(self: kbmod.search.layered_image, arg0: str) → None#

science(copy_data=False)#

set_mask(self: kbmod.search.layered_image, arg0: kbmod.search.raw_image) → None#

set_psf(self: kbmod.search.layered_image, arg0: kbmod.search.psf) → None#

set_science(self: kbmod.search.layered_image, arg0: kbmod.search.raw_image) → None#

set_time(self: kbmod.search.layered_image, arg0: float) → None#

set_variance(self: kbmod.search.layered_image, arg0: kbmod.search.raw_image) → None#

sub_template(self: kbmod.search.layered_image, arg0: kbmod.search.raw_image) → None#

variance(copy_data=False)#

class kbmod.search.pixel_pos#

Bases: pybind11_object

Attributes:

x
y

property x#

property y#

class kbmod.search.psf#

Bases: pybind11_object

Point Spread Function.

Parameters:

argfloat, numpy.array or psf

Given value represents one of:

standard deviation of a Gaussian PSF (float)
kernel representing the PSF (array-like)
another psf object.

Notes

When instantiated with another psf object, returns its copy.

When instantiated with an array-like object, that array must be a square matrix and have an odd number of dimensions

Methods

`get_dim`(self)	Returns the PSF kernel dimensions.
`get_kernel`(self)	Returns the PSF kernel.
`get_radius`(self)	Returns the radius of the PSF
`get_size`(self)	Returns the number of elements in the PSFs kernel.
`get_stdev`(self)	Returns the PSF's standard deviation.
`get_sum`(self)	Returns the sum of PSFs kernel elements.
`print_psf`(self)	Pretty-prints the PSF.
`set_array`(self, arg0)	Sets the PSF kernel.
`square_psf`(self)	Squares, raises to the power of two, the elements of the PSF kernel.

get_dim(self: kbmod.search.psf) → int#: Returns the PSF kernel dimensions.

get_kernel(self: kbmod.search.psf) → List[float]#: Returns the PSF kernel.

get_radius(self: kbmod.search.psf) → int#: Returns the radius of the PSF

get_size(self: kbmod.search.psf) → int#: Returns the number of elements in the PSFs kernel.

get_stdev(self: kbmod.search.psf) → float#: Returns the PSF’s standard deviation.

get_sum(self: kbmod.search.psf) → float#: Returns the sum of PSFs kernel elements.

print_psf(self: kbmod.search.psf) → str#: Pretty-prints the PSF.

set_array(self: kbmod.search.psf, arg0: numpy.ndarray[numpy.float32]) → None#

Sets the PSF kernel.

Parameters:

arrnumpy.array: Numpy array representing the PSF.

square_psf(self: kbmod.search.psf) → None#: Squares, raises to the power of two, the elements of the PSF kernel.

class kbmod.search.raw_image#

Bases: pybind11_object

Methods

`add_pixel`(self, arg0, arg1, arg2)
`apply_mask`(self, arg0, arg1, arg2)
`compute_bounds`(self)
`convolve`(self, arg0)
`create_stamp`(self, arg0, arg1, arg2, arg3, arg4)
`find_central_moments`(self)
`find_peak`(self, arg0)
`get_height`(self)
`get_pixel`(self, arg0, arg1)
`get_pixel_interp`(self, arg0, arg1)
`get_ppi`(args, *kwargs)	Overloaded function.
`get_width`(self)
`grow_mask`(self, arg0, arg1)
`mask_object`(self, arg0, arg1, arg2)
`pixel_has_data`(self, arg0, arg1)
`save_fits`(self, arg0, arg1)
`set_all`(self, arg0)
`set_array`(self, arg0)
`set_pixel`(self, arg0, arg1, arg2)

add_pixel(self: kbmod.search.raw_image, arg0: float, arg1: float, arg2: float) → None#

apply_mask(self: kbmod.search.raw_image, arg0: int, arg1: List[int], arg2: kbmod.search.raw_image) → None#

compute_bounds(self: kbmod.search.raw_image) → List[float[2]]#

convolve(self: kbmod.search.raw_image, arg0: kbmod.search.psf) → None#

create_stamp(self: kbmod.search.raw_image, arg0: float, arg1: float, arg2: int, arg3: bool, arg4: bool) → kbmod.search.raw_image#

find_central_moments(self: kbmod.search.raw_image) → search::imageMoments#

find_peak(self: kbmod.search.raw_image, arg0: bool) → search::pixelPos#

get_height(self: kbmod.search.raw_image) → int#

get_pixel(self: kbmod.search.raw_image, arg0: int, arg1: int) → float#

get_pixel_interp(self: kbmod.search.raw_image, arg0: float, arg1: float) → float#

get_ppi(*args, **kwargs)#

Overloaded function.

get_ppi(self: kbmod.search.raw_image) -> int
get_ppi(self: kbmod.search.raw_image) -> int

get_width(self: kbmod.search.raw_image) → int#

grow_mask(self: kbmod.search.raw_image, arg0: int, arg1: bool) → None#

mask_object(self: kbmod.search.raw_image, arg0: float, arg1: float, arg2: kbmod.search.psf) → None#

pixel_has_data(self: kbmod.search.raw_image, arg0: int, arg1: int) → bool#

save_fits(self: kbmod.search.raw_image, arg0: str, arg1: bool) → None#

set_all(self: kbmod.search.raw_image, arg0: float) → None#

set_array(self: kbmod.search.raw_image, arg0: numpy.ndarray[numpy.float32]) → None#

set_pixel(self: kbmod.search.raw_image, arg0: int, arg1: int, arg2: float) → None#

kbmod.search.sigmag_filtered_indices(arg0: List[float], arg1: float, arg2: float, arg3: float, arg4: float) → List[int]#

class kbmod.search.stack_search#

Bases: pybind11_object

Methods

`enable_corr`(self, arg0)
`enable_gpu_encoding`(self, arg0, arg1)
`enable_gpu_sigmag_filter`(self, arg0, arg1, arg2)
`filter_min_obs`(self, arg0)
`get_image_stack`(self)
`get_mult_traj_pos`(self, arg0)
`get_num_images`(self)
`get_phi_images`(self)
`get_psi_images`(self)
`get_results`(self, arg0, arg1)
`get_traj_pos`(self, arg0, arg1)
`gpu_coadded_stamps`(self, arg0, arg1, arg2)
`mean_sci_stamp`(self, arg0, arg1, arg2)
`median_sci_stamp`(self, arg0, arg1, arg2)
`phi_curves`(self, arg0)
`phi_stamps`(self, arg0, arg1)	set3
`prepare_psi_phi`(self)
`psi_curves`(self, arg0)
`psi_stamps`(self, arg0, arg1)	set2
`save_psi_phi`(self, arg0)
`save_results`(self, arg0, arg1)
`science_viz_stamps`(self, arg0, arg1)
`search`(self, arg0, arg1, arg2, arg3, arg4, ...)
`set_debug`(self, arg0)
`set_results`(self, arg0)
`set_start_bounds_x`(self, arg0, arg1)
`set_start_bounds_y`(self, arg0, arg1)
`summed_sci_stamp`(self, arg0, arg1, arg2)

get_phi
get_psi

enable_corr(self: kbmod.search.stack_search, arg0: List[float]) → None#

enable_gpu_encoding(self: kbmod.search.stack_search, arg0: int, arg1: int) → None#

enable_gpu_sigmag_filter(self: kbmod.search.stack_search, arg0: List[float], arg1: float, arg2: float) → None#

filter_min_obs(self: kbmod.search.stack_search, arg0: int) → None#

get_image_stack(self: kbmod.search.stack_search) → kbmod.search.image_stack#

get_mult_traj_pos(self: kbmod.search.stack_search, arg0: search::trajectory) → List[search::pixelPos]#

get_num_images(self: kbmod.search.stack_search) → int#

get_phi(copy_data=False)#

get_phi_images(self: kbmod.search.stack_search) → List[kbmod.search.raw_image]#

get_psi(copy_data=False)#

get_psi_images(self: kbmod.search.stack_search) → List[kbmod.search.raw_image]#

get_results(self: kbmod.search.stack_search, arg0: int, arg1: int) → List[search::trajectory]#

get_traj_pos(self: kbmod.search.stack_search, arg0: search::trajectory, arg1: int) → search::pixelPos#

gpu_coadded_stamps(self: kbmod.search.stack_search, arg0: List[search::trajectory], arg1: List[List[bool]], arg2: search::stampParameters) → List[kbmod.search.raw_image]#

mean_sci_stamp(self: kbmod.search.stack_search, arg0: search::trajectory, arg1: int, arg2: List[bool]) → kbmod.search.raw_image#

median_sci_stamp(self: kbmod.search.stack_search, arg0: search::trajectory, arg1: int, arg2: List[bool]) → kbmod.search.raw_image#

phi_curves(self: kbmod.search.stack_search, arg0: search::trajectory) → List[float]#

phi_stamps(self: kbmod.search.stack_search, arg0: search::trajectory, arg1: int) → List[kbmod.search.raw_image]#: set3

prepare_psi_phi(self: kbmod.search.stack_search) → None#

psi_curves(self: kbmod.search.stack_search, arg0: search::trajectory) → List[float]#

psi_stamps(self: kbmod.search.stack_search, arg0: search::trajectory, arg1: int) → List[kbmod.search.raw_image]#: set2

save_psi_phi(self: kbmod.search.stack_search, arg0: str) → None#

save_results(self: kbmod.search.stack_search, arg0: str, arg1: float) → None#

science_viz_stamps(self: kbmod.search.stack_search, arg0: search::trajectory, arg1: int) → List[kbmod.search.raw_image]#

search(self: kbmod.search.stack_search, arg0: int, arg1: int, arg2: float, arg3: float, arg4: float, arg5: float, arg6: int) → None#

set_debug(self: kbmod.search.stack_search, arg0: bool) → None#

set_results(self: kbmod.search.stack_search, arg0: List[search::trajectory]) → None#

set_start_bounds_x(self: kbmod.search.stack_search, arg0: int, arg1: int) → None#

set_start_bounds_y(self: kbmod.search.stack_search, arg0: int, arg1: int) → None#

summed_sci_stamp(self: kbmod.search.stack_search, arg0: search::trajectory, arg1: int, arg2: List[bool]) → kbmod.search.raw_image#

class kbmod.search.stamp_parameters#

Bases: pybind11_object

Attributes:

center_thresh
do_filtering
m01
m02
m10
m11
m20
peak_offset_x
peak_offset_y
radius
stamp_type

property center_thresh#

property do_filtering#

property m01#

property m02#

property m10#

property m11#

property m20#

property peak_offset_x#

property peak_offset_y#

property radius#

property stamp_type#

class kbmod.search.trajectory#

Bases: pybind11_object

A trajectory structure holding basic information about potential results.

Attributes:

flux
lh
obs_count
x
x_v
y
y_v

property flux#

property lh#

property obs_count#

property x#

property x_v#

property y#

property y_v#