Kvector

class sonic.Kvector

Last Revised: 5/1/2024 Last author: Sebastien Henry

Constructor Summary
Kvector(cat, min_angle, max_angle, max_mag, bin_width_cos_angle, et, r_obs_AU)

Instantiate the Kvector table no preallocation but fast append in MATLAB

Inputs:
  • hip_cat (sonic.StarCatalog): Star Catalog, or subset thereof that we wish to create a k-ver

  • min_angle (1x1 double): the minimum interstar angle that will be stored in the k-vector (radians)

  • max_angle (1x1 double): the maximum interstar angle that will be stored in the k-vector (radians)

  • max_Vmag (1x1 double): maximum visual magnitude

  • bin_width_cos_angle (1x1): OPTIONAL the width of a bin of the histogram reprentation of the k-vector. Default to 0, which means there will be as many bins as interstar angle pairs.

  • et (1x1 double): OPTIONAL Epoch at which to evaluate the catalog, in TDB (consistent with SPICE ephemeris time)

  • r_obs_AU (3x1 double): OPTIONAL The position of the observer in ICRF, in astronomical units (AU).

Outputs:
  • obj (sonic.Kvector): Kvector object

Last revised: 4/7/24 Last author: Sebastien Henry

Property Summary
Is

1xn, always smaller than Js

Js

1xn

bin_width

constant bin width in cos(angle)

cos_interstar_angle

1xn

et
k

the “k” vector

m

slope

n

number of pairs

n_bins

number of bins in histogram

q

intercept

r_obs_AU
ymax

max cos interstar angle

ymin

min cos interstar angle

Method Summary
query(min_angle, max_angle)

Query the Kvector table and return the indices that define the limits for the interstar angles

Inputs:
  • obj (1x1 sonic.Kvector): Kvector object

  • min_angle (1x1 double): the minimum interstar angle (radians)

  • max_angle (1x1 double): the maximum interstar angle (radians)

Outputs:
  • min_idx (1x1, double): the approximate index corresponding to min_angle

  • max_idx (1x1, double): the approximate index corresponding to max_angle

Last revised: 4/12/24 Last author: Sebastien Henry