documentation changes

Author: vinay0000

docs/miscellaneous.rst

@@ -40,6 +40,8 @@ The axis of the Nadir-pointing reference frame are defined as follows:
 
 * :math:`\bf Z_{np}` axis: Aligned to Nadir vector (i.e. the negative of the position vector of satellite in EARTH_FIXED frame)
 
+(Note that this results in roll axis as `Y_{np}` and not `X_{np}`.)
+
 .. figure:: nadirframe.png
     :scale: 100 %
     :align: center

instrupy/passive_optical_scanner_model.py

@@ -86,10 +86,10 @@ class PassiveOpticalScannerModel(Entity):
        :ivar scanTechnique: Scan technique.
        :vartype scanTechnique: :class:`instrupy.passive_optical_scanner_model.ScanTech`
         
-       :ivar numberDetectorRows: Number of detector rows (along the Y-axis of the SENOR_BODY_FIXED frame). If the SENSOR_BODY_FIXED frame is aligned to the NADIR_POINTING frame, this direction corresponds to the along-track direction.
+       :ivar numberDetectorRows: Number of detector rows (along the Y-axis of the SENSOR_BODY_FIXED frame). If the SENSOR_BODY_FIXED frame is aligned to the NADIR_POINTING frame, this direction corresponds to the along-track direction.
        :vartype numberDetectorRows: int
 
-       :ivar numberDetectorCols: Number of detector columns (along the X-axis of the SENOR_BODY_FIXED frame). If the SENSOR_BODY_FIXED frame is aligned to the NADIR_POINTING frame, this direction corresponds to the cross-track direction.
+       :ivar numberDetectorCols: Number of detector columns (along the X-axis of the SENSOR_BODY_FIXED frame). If the SENSOR_BODY_FIXED frame is aligned to the NADIR_POINTING frame, this direction corresponds to the cross-track direction.
        :vartype numberDetectorCols: int
 
        :ivar Fnum: F-number/ F# of lens.
@@ -108,10 +108,10 @@ class PassiveOpticalScannerModel(Entity):
     
        :vartype bandwidth: float
 
-       :ivar quantumEff: Quantum efficiency of the detector element (:math:`0 < qe < 1`)
+       :ivar quantumEff: Quantum efficiency of the detector element (:math:`0 < qe <= 1`)
        :vartype quantumEff: float
 
-       :ivar opticsSysEff: Optical systems efficiency (:math:`0 < \\tau_0 < 1`)
+       :ivar opticsSysEff: Optical systems efficiency (:math:`0 < \\tau_0 <= 1`)
        :vartype opticsSysEff: float
 
        :ivar numOfReadOutE: Number of read out electrons of the detector.
@@ -129,7 +129,7 @@ class PassiveOpticalScannerModel(Entity):
        :ivar apertureDia: Telescope aperture diameter in meters.
        :vartype apertureDia: float
 
-       :ivar maxDetectorExposureTime: Maximum exposure time of detector in seconds.
+       :ivar maxDetectorExposureTime: (Optional) Maximum exposure time of detector in seconds.
        :vartype maxDetectorExposureTime: float
        
        :ivar atmosLossModel: The atmospheric loss model. 'LOWTRAN7' model is supported. If ``None`` the atmospheric losses are not be considered.

instrupy/synthetic_aperture_radar_model.py

@@ -633,7 +633,7 @@ def calc_data_metrics_impl1(self, alt_km, sc_speed_kmps, sc_gnd_speed_kmps, inc_
                 * :code:`NESZ [dB]` (:class:`float`)  The backscatter coefficient :math:`\\sigma_0` of a target for which the signal power level in final image is equal to the noise power level (units: decibels). **Numerically lesser is better instrument performance.**
                 * :code:`ground pixel along-track resolution [m]` (:class:`float`) Along-track resolution (meters) of a ground-pixel centered about observation point.
                 * :code:`ground pixel cross-track resolution [m]` (:class:`float`) Cross-track resolution (meters) of a ground-pixel centered about observation point.
-                * :code:`swath-width [m]` (:class:`float`) Swath-width (meters) of the strip of which the imaged pixel is part off.
+                * :code:`swath-width [km]` (:class:`float`) Swath-width (meters) of the strip of which the imaged pixel is part off.
                 * :code:`incidence angle [deg]` (:class:`float`) Observation incidence angle (degrees) at the ground-pixel.
                 * :code:`PRF [Hz]` (:class:`float`)  Highest Pulse Repetition Frequency (Hz) (within the specified PRF range) at which the observation is possible.
         

instrupy/util.py

@@ -1274,7 +1274,6 @@ def get_roll_only_mv_proxy_sen_specs(roll_min, roll_max):
                                ViewGeometry(    Orientation.from_sideLookAngle(ref_frame="NADIR_POINTING", side_look_angle=w2), 
                                                 SphericalGeometry.from_dict({"shape":'RECTANGULAR', "angleHeight":x2, "angleWidth":y2})
                                )]
-
 
         return field_of_regard
 
@@ -1284,15 +1283,18 @@ class Antenna(Entity):
         .. todo:: The operating frequency is not made as an instance parameter. Change behavior in the future?
 
         :ivar shape: Antenna shape.
-        :vartype shape: :class:`instrupy.util.Antenna.AntennaApertureShape`
+        :vartype shape: :class:`instrupy.util.Antenna.Shape`
 
         :ivar apertureExcitationProfile: Antenna aperture profile.
         :vartype apertureExcitationProfile: :class:`instrupy.util.Antenna.AntennaApertureExcitationProfile`
 
-        :ivar height: [meters] Antenna height (along the along-track direction when *SENSOR_BODY_FIXED* is aligned to *NADIR_POINTING* frame).
+        :ivar diameter: [meters] Antenna diameter (applicable when the antenna shape is Circular).
+        :vartype diameter: float
+
+        :ivar height: [meters] Antenna height (along the along-track direction when *SENSOR_BODY_FIXED* is aligned to *NADIR_POINTING* frame). (Applicable when the antenna shape is Rectangular.)
         :vartype height: float
 
-        :ivar width: [meters] Antenna width (along the cross-track direction when *SENSOR_BODY_FIXED* is aligned to *NADIR_POINTING* frame).
+        :ivar width: [meters] Antenna width (along the cross-track direction when *SENSOR_BODY_FIXED* is aligned to *NADIR_POINTING* frame). (Applicable when the antenna shape is Rectangular.)
         :vartype antennaWidth: float
 
         :ivar apertureEfficiency: Aperture efficiency of antenna (:math:`0 < \\eta_{ap} < 1`).
@@ -1633,7 +1635,7 @@ def geo2eci(gcoord, JDtime):
 
         .. seealso:: 
             * :mod:`JD2GMST`
-            * `IDL Astronomy Users Library <https://idlastro.gsfc.nasa.gov/ftp/pro/astro/geo2eci.pro>`_
+            * `IDL Astronomy Users Library <https://github.com/wlandsman/IDLAstro/blob/master/pro/geo2eci.pro>`_
         
         EXAMPLES: