fov

Field of View

Field of view definitions, along with tests for checks to see if objects are within the FOVs.

class kete.fov.ConeFOV(pointing, angle, observer)

Generic Cone field of view.

angle: The longitudinal width of the FOV.

jd: JD of the observer location.

observer: The observer State.

pointing: Direction that the observer is looking.

class kete.fov.FOVList(list)

static load(filename): Load the fov list from a file.

save(filename): Save the fov list into a file.

sort(): Sort the list of FOVs by their JD.

class kete.fov.NeosCmos(pointing, rotation, observer, side_id, stack_id, quad_id, loop_id, subloop_id, exposure_id, cmos_id, band)

Field of view of a NEOS CMOS chip.

band: Band Number

cmos_id: Chip ID number

corners: Corners of this FOV

exposure_id: Metadata about where this FOV is in the Survey.

jd: JD of the observer location.

loop_id: Metadata about where this FOV is in the Survey.

observer: The observer State.

pointing: Direction that the observer is looking.

quad_id: Metadata about where this FOV is in the Survey.

rotation: Rotation angle of the FOV in degrees.

side_id: Metadata about where this FOV is in the Survey.

stack_id: Metadata about where this FOV is in the Survey.

subloop_id: Metadata about where this FOV is in the Survey.

class kete.fov.NeosVisit(x_width, y_width, gap_angle, pointing, rotation, observer, side_id, stack_id, quad_id, loop_id, subloop_id, exposure_id, band)

Field of view of a NEOS Visit.

exposure_id: Metadata about where this FOV is in the Survey.

jd: JD of the observer location.

loop_id: Metadata about where this FOV is in the Survey.

observer: Observer State.

pointing: Direction that the observer is looking.

quad_id: Metadata about where this FOV is in the Survey.

rotation: Rotation angle of the FOV in degrees.

side_id: Metadata about where this FOV is in the Survey.

stack_id: Metadata about where this FOV is in the Survey.

subloop_id: Metadata about where this FOV is in the Survey.

class kete.fov.OmniDirectionalFOV(observer)

Omni Directional field of view.

jd: JD of the observer location.

observer: The observer State.

class kete.fov.RectangleFOV(pointing, rotation, observer, lon_width, lat_width)

Generic Rectangular Field of view.

corners: Corners of this FOV

static from_corners(corners, observer)

Construct a new Rectangle FOV from the corners. The corners must be provided in clockwise order.

Parameters:

corners – 4 Vectors which represent the corners of the FOV, these must be provided in clockwise order.
observer – Position of the observer as a State.

static from_wcs(wcs, obs)

Construct a RectangleFOV from an astropy WCS along with an observer state.

Parameters:

wcs – An astropy WCS, this must include the shape of the array.
obs (State) – The observer position

Return type:

RectangleFOV

jd: JD of the observer location.

lat_width: The Latitudinal width of the FOV.

lon_width: The longitudinal width of the FOV.

observer: The observer State.

pointing: Direction that the observer is looking.

class kete.fov.WiseCmos(corners, observer, frame_num, scan_id)

Field of view of a WISE CMOS chip. Since all WISE CMOS see the same patch of sky, there is no differentiation of the individual wavelength bands.

corners: Corners of this FOV

frame_num: WISE Frame number.

static from_pointing(pointing, rotation, observer, frame_num, scan_id)

jd: JD of the observer location.

observer: Position of the observer in this FOV.

pointing: Direction that the observer is looking.

rotation: Rotation angle of the FOV in degrees.

scan_id: WISE Scan ID.

class kete.fov.ZtfCcdQuad(corners, observer, field, filefracday, ccdid, filtercode, imgtypecode, qid, maglimit, fid)

Field of view of a Single ZTF chips/quad combination.

ccdid: Metadata about where this FOV is in the Survey.

corners: Corners of this FOV

fid: Metadata about where this FOV is in the Survey.

field: Metadata about where this FOV is in the Survey.

filefracday: Metadata about where this FOV is in the Survey.

filtercode: Metadata about where this FOV is in the Survey.

imgtypecode: Metadata about where this FOV is in the Survey.

jd: JD of the observer location.

maglimit: Magnitude limit of this exposure.

observer: State of the observer for this FOV.

pointing: Direction that the observer is looking.

qid: Metadata about where this FOV is in the Survey.

class kete.fov.ZtfField(ztf_ccd_fields)

Field of view of all 64 ZTF chips/quad combinations. This is a meta collection of individual ZTF CCD Quad FOVs.

ccd_quads: Return all of the individual CCD quads present in this field.

fid: Metadata about where this FOV is in the Survey.

field: Metadata about where this FOV is in the Survey.

filtercode: Metadata about where this FOV is in the Survey.

imgtypecode: Metadata about where this FOV is in the Survey.

jd: JD of the observer location.

observer: State of the observer for this FOV.

kete.fov.fov_spice_check(desigs, fovs)

Given a list of object names and field of views, return only the objects which are visible to the observer, adding a correction for optical light delay.

Objects are queried from the loaded SPK files. This does a best effort lookup and may silently not return states if an object is not loaded or doesn’t have data for the specified epochs.

Parameters:

desigs (list[str]) – Designations to lookup.
fov – A list of field of views from which to subselect objects which are visible.

Return type:

list[State]

kete.fov.fov_state_check(obj_state, fovs, dt_limit=3.0, include_asteroids=False)

Given states and field of view, return only the objects which are visible to the observer, adding a correction for optical light delay.

Objects are propagated using 2 body physics to the time of the FOV if time steps are less than the specified dt.

Parameters:

states (list[State]) – States which do not already have a specified FOV.
fov (FOVList) – A field of view from which to subselect objects which are visible.
dt (float) – Length of time in days where 2-body mechanics is a good approximation.
include_asteroids (bool) – Include the 5 largest asteroids during the computation.

kete.fov.fov_static_check(pos, fovs)

Check if a list of static sky positions are present in the given Field of View list.

This returns a list of tuples, where the first entry in the tuple is the vector of all of the points in the provided FOV, and the second entry is the original FOV.

Parameters:

pos – Collection of Vectors defining sky positions from the point of view of the observer. These vectors are automatically converted to the Ecliptic frame, results will be returned in that frame as well.
fovs – Collection of Field of Views to check.