oif

A package to efficiently tell whether a set of objects are in field


Keywords
astronomy, interferometry, data, processing, reduction, model, fitting, optical
License
BSD-3-Clause
Install
pip install oif==0.0.0

Documentation

objectsInField

=========================================================================
Copyright (c) 2018, California Institute of Technology ("Caltech"). U.S. Government sponsorship acknowledged.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  • Neither the name of Caltech nor its operating division, the Jet Propulsion Laboratory, nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

=========================================================================

This module generates a list of candidate detections for an input population of moving objects in a specified list of field pointings.

Requirements:

  • python 3
  • spiceypy python library
  • pyoorb python library
  • other standard python libraries like numpy, pandas, etc.
  • NAIF SPICE Utilities

Setup:

  • Make sure you can import spiceypy, pyoorb, and other libraries in python.

  • Make sure you can run the NAIF SPICE Utility executables from your command line.

  • Download the package and run the DownloadKernels.sh script in the kernels/ folder.

  • Copy the binary de430.dat file required by pyoorb into the data/ folder.

Usage:

From the main/ folder run python main.py input.config. Refer to the documentation under the doc/ folder for more details.

Note:

Regularly update and run DownloadKernels.sh file to download the latest SPICE kernels.