Geometry module

check_parameters_set(parameters, required_parameters_set)[source]#

Check input parameters against a set of required parameters.

Parameters

parameters (dict) – input parameters to be checked.
required_parameters_set (list) –

Returns

valid (bool), missing_parameters (list), extra_parameters (list)

check_validity()[source]#

Check overall validity of Geometry object.

Checked when not abstract objects are created.

compute()[source]#: Compute this Geometry object data at ephemeris time et.

getCondition()[source]#

getData()[source]#

getDict()[source]#

Returns Geometry object.

Returns: Geometry object time_inputs_dict
Return type: dict

getGeoJSON()[source]#

getName()[source]#

get_csv_header()[source]#

get_csv_line()[source]#

get_parent_class()[source]#

get_time_step()[source]#

isSearchable()[source]#

is_valid()[source]#

search()[source]#

set_parameters(parameters)[source]#

Check that required input parameters are provided, and set input parameters.

Parameters: parameters (dict) – input parameters to be used for computation.

Condition#

class gfinder.geometry.Condition(condition)[source]#: Bases: object

GeometryFactory#

class gfinder.geometry.GeometryFactory[source]#

Bases: object

Class responsible for creating Geometry objects from input geometry definition.

Parameters

classes_index (dict) – index of all Geometry classes available.
excluded_class_names (List(str)) –
lowlevel_class_names (List(str)) –
highlevel_class_names (List(str)) –

Constructor method.

create(geometry_def, geoevt=None)[source]#

get_geometries(name_filter='', class_filter='', searchable=False)[source]#

Returns Geometry class names matching input query.

Parameters

searchable –
name_filter –
class_filter –

Returns:

get_geometry_info(class_name)[source]#

Return information about a Geometry class.

Parameters: class_name –
Returns: geometry_class_dict

get_geometry_required_parameters(class_name, set_index=0)[source]#: Return a Geometry class required parameters set dict.

Low-level Geometry classes#

Scalar#

class gfinder.geometry.Scalar(parameters, geoevt=None, silent=None)[source]#

Bases: gfinder.geometry.Geometry

Abstract Geometry class that holds scalar data.

Parameters: type (str) – scalar type: numerical (default) or boolean

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

getData()[source]#

search(condition, cnfine, step)[source]#

Search and return times when input geometric condition is met.

Parameters

condition – input condition that relates to the scalar quantity.
cnfine (SpiceCell) – SPICE window to which the search is restricted.
step (float) – Step size used for locating extrema and roots.

Returns

SPICE window containing result

Return type

SpiceCell

Vector#

class gfinder.geometry.Vector(parameters, geoevt=None, silent=None)[source]#

Bases: gfinder.geometry.Geometry

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

getData(prefix=None)[source]#

Returns Geometry data as a list or list element (given its prefix)

Parameters: prefix – Name of the prefix to get data element from.

Multidimentional#

class gfinder.geometry.Multidimentional(parameters, geoevt=None, silent=None)[source]#

Bases: gfinder.geometry.Geometry

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

High-level Geometry classes#

Direction#

class gfinder.geometry.Direction(parameters, geoevt=None, silent=None)[source]#

Direction abstract class

Any Direction children classes/objects can be used as input vector for the simulated SC attitude (when not pointing-dependent !!)
It can be used as input to the Directions_Separation_Angle class.
It can be represented in the “pointing”/”NOA” coordinates space (PointingViewer)

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

get_pointing_angles(et, observer, target, frame='NOA')[source]#: Computes the directions pointing angles in a two-dimensional coordinate system based on NOA (default) or NPO SPICE dynamic frames.

setDirection(frame, vectors)[source]#

toJ2000(et, reference_frame='', vectors=[])[source]#

Geolocation#

class gfinder.geometry.Geolocation(parameters, geoevt=None, silent=None)[source]#

Geolocation abstract class - MapViewer

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

angular_sep(geolocation)[source]#

Returns ground angular separation between two geolocations (surface points).

Parameters: geolocation –

Returns:

getGeoJSON(surface_only=False, split=False)[source]#

setGeolocation(points)[source]#

to_rectangular()[source]#: Returns the rectangular coordinates of the Geolocation points.

Geometry classes#

Angular_Separation#

class gfinder.geometry.Angular_Separation(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Boresight_Target_Angle#

class gfinder.geometry.Boresight_Target_Angle(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Detector_Backward_Boresight#

class gfinder.geometry.Detector_Backward_Boresight(parameters, geoevt=None, silent=None)[source]#

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Detector_Boresight#

class gfinder.geometry.Detector_Boresight(parameters, geoevt=None, silent=None)[source]#

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Detector_Boresight_Altitude#

class gfinder.geometry.Detector_Boresight_Altitude(parameters, geoevt=None, silent=None)[source]#

Altitude of the detector boresight tangent point above the target surface.

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Detector_Boresight_Ground_Drift#

class gfinder.geometry.Detector_Boresight_Ground_Drift(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Detector_Boresight_Target_Point#

class gfinder.geometry.Detector_Boresight_Target_Point(parameters, geoevt=None, silent=None)[source]#

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Detector_FOV#

class gfinder.geometry.Detector_FOV(parameters, geoevt=None, silent=None)[source]#

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Detector_FOV_Footprint#

class gfinder.geometry.Detector_FOV_Footprint(parameters, geoevt=None, silent=None)[source]#

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Detector_Forward_Boresight#

class gfinder.geometry.Detector_Forward_Boresight(parameters, geoevt=None, silent=None)[source]#

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Directions_Angular_Separation#

class gfinder.geometry.Directions_Angular_Separation(parameters, geoevt=None, silent=None)[source]#

Compute separation angle between two direction vectors.

Example of usage in ODF file:

"name": "Directions_Angular_Separation",
"parameters": {
    "direction1": {
        "name": "SC_Vector",
        "parameters": {
            "vector": [0.0, 1.0, 0.0]
        }
    },
    "direction2": {
        "name": "Observer_Target_Velocity",
        "parameters": {
            "target": "JUPITER"
        }
    },
}

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Distance_To_Target#

class gfinder.geometry.Distance_To_Target(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Dwell_Time#

class gfinder.geometry.Dwell_Time(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Equatorial_Coverage#

class gfinder.geometry.Equatorial_Coverage(parameters, geoevt=None, silent=None)[source]#

Geometry class representing the maximum MAJIS scanner latitudinal coverage on a given target, as seen from its equatorial plane.

Initially implemented to enable the definition of MAJIS Jupiter Disk Nadir Scan observation opportunity.

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Ground_Speed#

class gfinder.geometry.Ground_Speed(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Ground_Track_Across_Direction#

class gfinder.geometry.Ground_Track_Across_Direction(parameters, geoevt=None, silent=None)[source]#

NOT AVAILABLE (WIP). Ground_Track_Across_Direction.

Parameters

required_parameters_sets (list) – [‘target’]
data (list) –

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Limb#

class gfinder.geometry.Limb(parameters, geoevt=None, silent=None)[source]#

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Limb_Directions#

class gfinder.geometry.Limb_Directions(parameters, geoevt=None, silent=None)[source]#

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Limb_Distance#

class gfinder.geometry.Limb_Distance(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Limb_Latitudes#

class gfinder.geometry.Limb_Latitudes(parameters, geoevt=None, silent=None)[source]#

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Limb_Max_Latitude#

class gfinder.geometry.Limb_Max_Latitude(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Limb_Min_Latitude#

class gfinder.geometry.Limb_Min_Latitude(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Limb_Point_Direction#

class gfinder.geometry.Limb_Point_Direction(parameters, geoevt=None, silent=None)[source]#

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Limb_Point_Tangent_Direction#

class gfinder.geometry.Limb_Point_Tangent_Direction(parameters, geoevt=None, silent=None)[source]#

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

MAJIS_Scan_Angle#

class gfinder.geometry.MAJIS_Scan_Angle(parameters, geoevt=None, silent=None, scan_duration=None)[source]#

MAJIS_Scan_Angle.

Parameters

required_parameters_sets (list) – [‘start_angle’,’start_scan_rate’, ‘stop_scan_rate’, ‘method’]
data (list) –

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

get_scanner_angle(time)[source]#

Returns scanner angle corresponding to a given time since scan start.

Parameters: time –

get_valid_scanner_angle(angle)[source]#

Returns valid scanner angle corresponding to an input angle.

Parameters: angle – input (mechanical) scanner angle, in degrees.

is_valid_scanner_angle(angle)[source]#

Returns whether or not an input angle is valid.

Parameters: angle – input (mechanical) scanner angle, in degrees.

Returns:

position_to_angle(position)[source]#

Returns scanner angle corresponding to a given scanner position.

Parameters: position –

set_scan_parameters()[source]#

Set scan parameters from input commanding parameters.

start_angle: stop_angle: n_steps: positions: times: t_scan: t_scan_yl:

Motion_Compensation#

class gfinder.geometry.Motion_Compensation(parameters, geoevt=None, silent=None)[source]#

Geometry class that computes the detector boresight rotation angle required for two consecutive detector FOV (slit) footprints to be contiguous (avoiding overlapping or drifting). Motion compensation is required when dwell time is greater or lower than the repetition time between two detector acquisitions.

It holds the coordinates of the rotated (compensated) forward- and backward-boresights surface intersect points in the target body-fixed frame. These coordinates are used to derive the required rotation angle of the next detector acquisition, and scan mirror position.

In our computation approach, we currently make the following hypothesis:

Boresight points in the “nadir” direction (vector from spacecraft to sub-spacecraft point or target center)

Slit (detector FOV) is perpendicular to orbital plane (velocity vector)

Spacecraft is in forward motion (velocity vector co-aligned with +Ysc axis)

Note for later: Direction-class-based method, by which only the SC pointing would be simulated (disabling the MAJIS Scan frame simulator). This would allow to determine the scanner motion required by any SC pointings (off-track pointing for example).

simulator.turn_off(frame=’JUICE_MAJIS_SCAN’) detector_bsight = Direction() detector_bsight.setDirection(self.detector.frame, self.detector.get_forward_bsight()) #detector_bsight.toJ2000(et) Q: why would I transform to J2000 ? forward_bsight_pvec = detector_bsight.data simulator.turn_on(frame=’JUICE_MAJIS_SCAN’)

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Motion_Compensation_Angle#

class gfinder.geometry.Motion_Compensation_Angle(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

No_Compensation_Required#

class gfinder.geometry.No_Compensation_Required(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

North_Pole_Direction#

class gfinder.geometry.North_Pole_Direction(parameters, geoevt=None, silent=None)[source]#

North_Pole_Direction.

Parameters

required_parameters_sets (list) – [‘target’]
data (list) –

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Obs_Limb_Latitudinal_Range#

class gfinder.geometry.Obs_Limb_Latitudinal_Range(parameters, geoevt=None, silent=None)[source]#

Observable limb latitudinal range during an observation opportunity.

Constructor.

Parameters

parameters –
geoevt –
silent –

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Obs_Max_Phase_Angle#

class gfinder.geometry.Obs_Max_Phase_Angle(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Obs_Max_SC_Altitude#

class gfinder.geometry.Obs_Max_SC_Altitude(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Obs_Max_Spatial_Resolution#

class gfinder.geometry.Obs_Max_Spatial_Resolution(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Obs_Min_Phase_Angle#

class gfinder.geometry.Obs_Min_Phase_Angle(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Obs_Min_SC_Altitude#

class gfinder.geometry.Obs_Min_SC_Altitude(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Obs_Min_Spatial_Resolution#

class gfinder.geometry.Obs_Min_Spatial_Resolution(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Obs_Ref_SubSC_Position#

class gfinder.geometry.Obs_Ref_SubSC_Position(parameters, geoevt=None, silent=None)[source]#

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Obs_SC_Slew_Parameters#

class gfinder.geometry.Obs_SC_Slew_Parameters(parameters, geoevt=None, silent=None)[source]#

Obs_SC_Slew_Parameters.

Requires Target_Angular_Size data.

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Obs_Scanner_Motion_Parameters#

class gfinder.geometry.Obs_Scanner_Motion_Parameters(parameters, geoevt=None, silent=None)[source]#

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Observed_Ring_Point#

class gfinder.geometry.Observed_Ring_Point(parameters, geoevt=None, silent=None)[source]#

Vector-type data container for detector’s boresight observed Jovian ring’s point coordinates and associated properties.

Geometry classes that users Observed_Ring_Point:

gfinder.geometry.Observed_Ring_Point_Radius
gfinder.geometry.Observed_Ring_Point_Azimuth
gfinder.geometry.Observed_Ring_Point_Spatial_Resolution
gfinder.geometry.Observed_Ring_Point_Phase
gfinder.geometry.Observed_Ring_Point_Incidence
gfinder.geometry.Observed_Ring_Point_Emergence

Parameters

required_parameters_sets (list) – [‘detector’]
data (list) – [radius, azimuth, slant, phase, incdnc, emissn]

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Observed_Ring_Point_Azimuth#

class gfinder.geometry.Observed_Ring_Point_Azimuth(parameters, geoevt=None, silent=None)[source]#

Detector boresight observed Jovian ring point azimuth (deg).

Parameters: required_parameters_sets (list) – [‘detector’]

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Observed_Ring_Point_Emergence#

class gfinder.geometry.Observed_Ring_Point_Emergence(parameters, geoevt=None, silent=None)[source]#

Detector boresight observed Jovian ring point emergence angle (deg).

Parameters: required_parameters_sets (list) – [‘detector’]

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Observed_Ring_Point_Incidence#

class gfinder.geometry.Observed_Ring_Point_Incidence(parameters, geoevt=None, silent=None)[source]#

Detector boresight observed Jovian ring point incidence angle (deg).

Parameters: required_parameters_sets (list) – [‘detector’]

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Observed_Ring_Point_Phase#

class gfinder.geometry.Observed_Ring_Point_Phase(parameters, geoevt=None, silent=None)[source]#

Detector boresight observed Jovian ring point phase angle (deg).

Parameters: required_parameters_sets (list) – [‘detector’]

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Observed_Ring_Point_Radius#

class gfinder.geometry.Observed_Ring_Point_Radius(parameters, geoevt=None, silent=None)[source]#

Detector boresight observed Jovian ring point radius (RJ).

Parameters: required_parameters_sets (list) – [‘detector’]

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Observed_Ring_Point_Spatial_Resolution#

class gfinder.geometry.Observed_Ring_Point_Spatial_Resolution(parameters, geoevt=None, silent=None)[source]#

Detector boresight observed Jovian ring point spatial resolution (km).

Parameters: required_parameters_sets (list) – [‘detector’]

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Observed_Target_Points#

class gfinder.geometry.Observed_Target_Points(parameters, geoevt=None, silent=None)[source]#

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Phase_Angle#

class gfinder.geometry.Phase_Angle(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

ROI_Boresight_Angle#

class gfinder.geometry.ROI_Boresight_Angle(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

ROI_In_FOV#

class gfinder.geometry.ROI_In_FOV(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

ROI_X_Depointing_Angle#

class gfinder.geometry.ROI_X_Depointing_Angle(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

ROI_Y_Depointing_Angle#

class gfinder.geometry.ROI_Y_Depointing_Angle(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Ring_Ansae#

class gfinder.geometry.Ring_Ansae(parameters, geoevt=None, silent=None)[source]#

Multidimensional-type data container for pointing-independent Jovian ring’s ansae properties.

Geometry classes that users Ring_Ansae:

gfinder.geometry.Ring_Illumination_Angle
gfinder.geometry.Ring_Horizontal_Angular_Size
gfinder.geometry.Ring_Vertical_Angular_Size
gfinder.geometry.Ring_West_Ansa_Phase_Angle
gfinder.geometry.Ring_East_Ansa_Phase_Angle
gfinder.geometry.Ring_West_Ansa_Best_Resolution
gfinder.geometry.Ring_East_Ansa_Best_Resolution
gfinder.geometry.Ring_Ansae_Phase_Angle_In_Range

Parameters

required_parameters_sets (list) – [‘radius’]
data (list) – [[[sun_elev, h_ang_size, v_ang_size]],[[west_phase, west_resol]],[[east_phase, east_resol]]]

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Ring_Ansae_Directions#

class gfinder.geometry.Ring_Ansae_Directions(parameters, geoevt=None, silent=None)[source]#

Direction vector(s) in J2000 from the observer to a given Jovian ring point or set of points.

TODO: Rename Ring_Ansae_Directions into Ring_Directions and create a new Ring_Point_Direction class.

Parameters

required_parameters_sets (list) – [[‘radius’, ‘azimuth’], [‘radius’, ‘n_points’]]
data (list) –

Example of ODF definition:

{
  "name": "Ring_Ansae_Directions",
  "parameters": {
    "radius": "@ring_radius",
    "n_points": 100
  }
}

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Ring_Ansae_Phase_Angle_In_Range#

class gfinder.geometry.Ring_Ansae_Phase_Angle_In_Range(parameters, geoevt=None, silent=None)[source]#

Whether or not at least one Jovian ring ansa phase angle is within a given range.

Parameters: required_parameters_sets (list) – [‘radius’, ‘min_phase_angle’, ‘max_phase_angle’]

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Ring_East_Ansa_Best_Resolution#

class gfinder.geometry.Ring_East_Ansa_Best_Resolution(parameters, geoevt=None, silent=None)[source]#

Jovian ring East ansa best resolution (km).

Parameters: required_parameters_sets (list) – [‘radius’]

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Ring_East_Ansa_Phase_Angle#

class gfinder.geometry.Ring_East_Ansa_Phase_Angle(parameters, geoevt=None, silent=None)[source]#

Jovian ring East ansa phase angle (deg).

Parameters: required_parameters_sets (list) – [‘radius’]

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Ring_Horizontal_Angular_Size#

class gfinder.geometry.Ring_Horizontal_Angular_Size(parameters, geoevt=None, silent=None)[source]#

Jovian ring horizontal angular size (deg).

Parameters: required_parameters_sets (list) – [‘radius’]

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Ring_Illumination_Angle#

class gfinder.geometry.Ring_Illumination_Angle(parameters, geoevt=None, silent=None)[source]#

Jovian ring solar illumination angle (deg).

Parameters: required_parameters_sets (list) – [‘radius’]

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Ring_Vertical_Angular_Size#

class gfinder.geometry.Ring_Vertical_Angular_Size(parameters, geoevt=None, silent=None)[source]#

Jovian ring vertical angular size (deg).

Parameters: required_parameters_sets (list) – [‘radius’]

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Ring_West_Ansa_Best_Resolution#

class gfinder.geometry.Ring_West_Ansa_Best_Resolution(parameters, geoevt=None, silent=None)[source]#

Jovian ring West ansa best resolution (km).

Parameters: required_parameters_sets (list) – [‘radius’]

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Ring_West_Ansa_Phase_Angle#

class gfinder.geometry.Ring_West_Ansa_Phase_Angle(parameters, geoevt=None, silent=None)[source]#

Jovian ring West ansa phase angle (deg).

Parameters: required_parameters_sets (list) – [‘radius’]

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

SC_Altitude#

class gfinder.geometry.SC_Altitude(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

SC_Elevation#

class gfinder.geometry.SC_Elevation(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

SC_In_Equatorial_Plane#

class gfinder.geometry.SC_In_Equatorial_Plane(parameters, geoevt=None, silent=None)[source]#

SC_In_Equatorial_Plane.

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

SC_Pointing_Offsets#

class gfinder.geometry.SC_Pointing_Offsets(parameters, geoevt=None, silent=None)[source]#

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

SC_Position#

class gfinder.geometry.SC_Position(parameters, geoevt=None, silent=None)[source]#

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

SC_Slew_Angles#

class gfinder.geometry.SC_Slew_Angles(parameters, geoevt=None, silent=None, et_start=None, et_stop=None)[source]#

SC_Slew_Angles.

required_parameters_sets#

[[‘x_start’,’x_stop’, ‘y_start’, ‘y_stop’], [‘x_start’, ‘x_rate’, ‘y_start’, ‘y_rate’]]

Type: list

data#

Type: list

Constructs SC_Slew_Angles object.

Parameters

parameters –
geoevt –
silent –
et_start (float, optional) – start ephemeris time.
et_stop –

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

SC_Solar_Array_Sun_Angle#

class gfinder.geometry.SC_Solar_Array_Sun_Angle(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

SC_Vector#

class gfinder.geometry.SC_Vector(parameters, geoevt=None, silent=None)[source]#

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

SC_Velocity#

class gfinder.geometry.SC_Velocity(parameters, geoevt=None, silent=None)[source]#

Target geometric velocity vector with respect to target, expressed in J2000 frame.

Parameters

required_parameters_sets (list) – [‘target’]
data (list) – [x, y, z]

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

SC_X_Axis_Sun_Angle#

class gfinder.geometry.SC_X_Axis_Sun_Angle(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

SC_Y_Axis_Velocity_Angle#

class gfinder.geometry.SC_Y_Axis_Velocity_Angle(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

SC_Z_Axis_Sun_Angle#

class gfinder.geometry.SC_Z_Axis_Sun_Angle(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

SC_Z_Axis_Target_Angle#

class gfinder.geometry.SC_Z_Axis_Target_Angle(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Simulated_SC_Frame#

class gfinder.geometry.Simulated_SC_Frame(parameters, geoevt=None, silent=None)[source]#

Simulated_SC_Frame.

Parameters

required_parameters_sets (list) – [‘target’]
data (list) – [[],[],[]]

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

apply_offset_rotations(simsc_j2000_rotmat, offset_rot_def)[source]#: Returns the SC basic pointing frame rotated around X and Y by angles derived from input “offset_rotation” geometry definition (eg: ‘SC_Slew_Angles’, which must be pre-computed.)

axis_str(axis_def)[source]#

Parse input axis definition string and returns axis parameters.

Definition string schema: [+|-][<frame_key>_][X|Y|Z]axis, where <frame_key> can be ‘SC’ (default) or ‘MAJIS’.

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Simulated_Scan_Frame#

class gfinder.geometry.Simulated_Scan_Frame(parameters, geoevt=None, silent=None)[source]#

Simulated_Scan_Frame.

Defined wrt to JUICE_MAJIS_BASE frame.

scan_zero (list): list of Euler rotation angles defining the orientation of the JUICE_MAJIS_SCAN wrt the JUICE_MAJIS_BASE when the scanner is in “zero” position (scanner rotation axis).

scan_rotation_angle:

Parameters

required_parameters_sets (list) – [‘scan_zero’, ‘scan_rotation_angle’]
data (list) – [[],[],[]]

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Spatial_Resolution#

class gfinder.geometry.Spatial_Resolution(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

SubSC_Point#

class gfinder.geometry.SubSC_Point(parameters, geoevt=None, silent=None)[source]#

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

SubSC_Point_Direction#

class gfinder.geometry.SubSC_Point_Direction(parameters, geoevt=None, silent=None)[source]#

SubSC_Point_Direction.

Parameters

required_parameters_sets (list) – [‘target’]
data (list) –

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Surface_Point_Direction#

class gfinder.geometry.Surface_Point_Direction(parameters, geoevt=None, silent=None)[source]#

Direction vector from SC to a given target surface point in J2000 frame.

Parameters

required_parameters_sets (list) – [‘target’, ‘longitude’, ‘latitude’]
data (list) –

Example of ODF definition:

{
  "name": "Surface_Point_Direction",
  "parameters": {
    "target": "JUPITER",
    "longitude": 0.0,
    "latitude": 0.0
  }
}

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Target_Angular_Size#

class gfinder.geometry.Target_Angular_Size(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Target_Point#

class gfinder.geometry.Target_Point(parameters, geoevt=None, silent=None)[source]#

Detector boresight target point coordinates and its associated illumination and viewing angles.

TODO: Shall become deprecated and replaced by Detector_Boresight_Target_Point.

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Target_Point_Altitude#

class gfinder.geometry.Target_Point_Altitude(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Target_Point_Emission#

class gfinder.geometry.Target_Point_Emission(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Target_Point_Incidence#

class gfinder.geometry.Target_Point_Incidence(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Target_Point_Latitude#

class gfinder.geometry.Target_Point_Latitude(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Target_Point_Longitude#

class gfinder.geometry.Target_Point_Longitude(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Target_Point_Phase#

class gfinder.geometry.Target_Point_Phase(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Target_Point_Slant#

class gfinder.geometry.Target_Point_Slant(parameters, geoevt=None, silent=None)[source]#

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Target_Position#

class gfinder.geometry.Target_Position(parameters, geoevt=None, silent=None)[source]#

Target center geometric position vector with respect to spacecraft, expressed in J2000.

Parameters

required_parameters_sets (list) – [‘target’]
data (list) –

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Target_Solar_Eclipse#

class gfinder.geometry.Target_Solar_Eclipse(parameters, geoevt=None, silent=None)[source]#

https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/occult_c.html

Target_Solar_Eclipse.

Scalar constructor class.

Returns: Scalar object
Return type: Scalar

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Terminator#

class gfinder.geometry.Terminator(parameters, geoevt=None, silent=None)[source]#

Constructor class.

Parameters

parameters (dict) – parameters to be used for computation
geoevt (GeometryEvent) – associated GeometryEvent object (None by default)

Returns

Geometry object

Return type

compute(et)[source]#: Compute this Geometry object data at ephemeris time et.

Vertical_Resolution#

class gfinder.geometry.Vertical_Resolution(parameters, geoevt=None, silent=None)[source]#