Commit c3dbfd46 authored by Jesse Mapel's avatar Jesse Mapel
Browse files

Added a quick start guide to the docs & restructured Pythong docs (#378) 

* Added loads docs

* Added other base driver mix-ins

* Simple quick start guide

* minor clean up

* Added quick start and cleaned up

* Combined mix-in files

* Fixed label data name

* Restructured Python docs

* Added Python rotation docs

* PR review updates

* Updated label_data description
parent a2c93cf1

ale/base/data_naif.py

+28 −0
Original line number Diff line number Diff line
@@ -9,6 +9,10 @@ from ale.rotation import TimeDependentRotation 
from ale import util



class NaifSpice():

    """

    Mix-in for reading data from NAIF SPICE Kernels.

    """



    def __enter__(self):

        """

        Called when the context is created. This is used
@@ -29,6 +33,30 @@ class NaifSpice(): 


    @property

    def kernels(self):

        """

        Get the NAIF SPICE Kernels to furnish



        There are two ways to specify which kernels a driver will use:



        1. Passing the 'kernels' property into load(s) or at instantiation.

           This can be either a straight iterable or a dictionary that specifies

           the kernels in ISIS style ('TargetPosition', 'InstrumentPosition', etc).

        2. Set the ALESPICEROOT environment variable. This variable should be

           the path to a directory that contains directories whose naming

           convention matches the PDS Kernel Archives format,

           `shortMissionName-versionInfo`. The directory corresponding to the

           driver's mission will be searched for the approriate meta kernel to

           load.



        See Also

        --------

        ale.util.get_kernels_from_isis_pvl : Function used to parse ISIS style dict

        ale.util.get_metakernels : Function that searches ALESPICEROOT for meta kernels

        ale.util.generate_kernels_from_cube : Helper function to get an ISIS style dict

                                              from an ISIS cube that has been through

                                              spiceinit



        """

        if not hasattr(self, '_kernels'):

            if 'kernels' in self._props.keys():

                try:

ale/base/label_isis.py

+3 −0
Original line number Diff line number Diff line 
import pvl



class IsisLabel():

    """

    Mix-in for parsing ISIS Cube labels.

    """



    @property

    def label(self):

ale/base/label_pds3.py

+3 −0
Original line number Diff line number Diff line 
import pvl



class Pds3Label():

    """

    Mix-in for parsing PDS3 PVL labels.

    """



    @property

    def label(self):

ale/base/type_distortion.py

+10 −2
Original line number Diff line number Diff line 
class RadialDistortion():

    """

    Mix-in for sensors that use a radial distortion model.

    """



    @property

    def usgscsm_distortion_model(self):

        """
@@ -18,6 +22,10 @@ class RadialDistortion(): 




class NoDistortion():

    """

    Mix-in for sensors and data sets that do not have a distortion model.

    """



    @property

    def usgscsm_distortion_model(self):

        """

ale/base/type_sensor.py

+13 −2
Original line number Diff line number Diff line 
import numpy as np



class LineScanner():

    """

    Mix-in for line scan sensors.

    """



    @property

    def name_model(self):
@@ -70,6 +73,10 @@ class LineScanner(): 
        return self.ephemeris_start_time + (self.image_lines * self.exposure_duration)



class Framer():

    """

    Mix-in for framing sensors.

    """



    @property

    def name_model(self):

        """
@@ -114,6 +121,10 @@ class Framer(): 
        return self.ephemeris_start_time + self.exposure_duration



class Radar():

    """

    Mix-in for synthetic aperture radar sensors.

    """



    @property

    def name_model(self):

        """