Module sscws.mapping

Module defining classes to represent the mapping classes from https://sscweb.gsfc.nasa.gov/WebServices/REST/SSC.xsd.

Copyright © 2013-2020 United States Government as represented by the National Aeronautics and Space Administration. No copyright is claimed in the United States under Title 17, U.S.Code. All Other Rights Reserved.

#!/usr/bin/env python3

#
# NOSA HEADER START
#
# The contents of this file are subject to the terms of the NASA Open
# Source Agreement (NOSA), Version 1.3 only (the "Agreement").  You may
# not use this file except in compliance with the Agreement.
#
# You can obtain a copy of the agreement at
#   docs/NASA_Open_Source_Agreement_1.3.txt
# or
#   https://sscweb.gsfc.nasa.gov/WebServices/NASA_Open_Source_Agreement_1.3.txt.
#
# See the Agreement for the specific language governing permissions
# and limitations under the Agreement.
#
# When distributing Covered Code, include this NOSA HEADER in each
# file and include the Agreement file at
# docs/NASA_Open_Source_Agreement_1.3.txt.  If applicable, add the
# following below this NOSA HEADER, with the fields enclosed by
# brackets "[]" replaced with your own identifying information:
# Portions Copyright [yyyy] [name of copyright owner]
#
# NOSA HEADER END
#
# Copyright (c) 2013-2020 United States Government as represented by
# the National Aeronautics and Space Administration. No copyright is
# claimed in the United States under Title 17, U.S.Code. All Other
# Rights Reserved.
#

"""
Module defining classes to represent the mapping classes from
<https://sscweb.gsfc.nasa.gov/WebServices/REST/SSC.xsd>.<br>

Copyright &copy; 2013-2020 United States Government as represented by the
National Aeronautics and Space Administration. No copyright is claimed in
the United States under Title 17, U.S.Code. All Other Rights Reserved.
"""

from enum import Enum


class MapProjection(Enum):
    """
    Enumerations representing the MapProjection defined
    in <https://sscweb.gsfc.nasa.gov/WebServices/REST/SSC.xsd>.
    """
    AZIMUTHAL = 'Azimuthal'
    CYLINDRICAL = 'Cylindrical'
    MERCATOR = 'Mercator'
    MOLLEWEIDE = 'Molleweide'
    ORTHOGRAPHIC = 'Othographic'
    STEREOGRAPHIC = 'Stereographic'


class MapProjectionTrace(Enum):
    """
    Enumerations representing the MapProjectionTrace defined
    in <https://sscweb.gsfc.nasa.gov/WebServices/REST/SSC.xsd>.
    """
    B_FIELD_NORTH = 'BFieldNorth'
    B_FIELD_SOUTH = 'BFieldSouth'
    RADIAL = 'Radial'


class MapRegion(Enum):
    """
    Enumerations representing the MapRegion defined
    in <https://sscweb.gsfc.nasa.gov/WebServices/REST/SSC.xsd>.
    """
    NORTH_CUSP = 'NorthCusp'
    SOUTH_CUSP = 'SouthCusp'
    NORTH_CLEFT = 'NorthCleft'
    SOUTH_CLEFT = 'SouthCleft'
    NORTH_AURORAL_OVAL = 'NorthAuroralOval'
    SOUTH_AURORAL_OVAL = 'SouthOuroralOval'
    NORTH_POLAR_CAP = 'NorthPolarCap'
    SOUTH_POLAR_CAP = 'SouthPolarCap'
    NORTH_MID_LATITUDE = 'NorthMidLatitude'
    SOUTH_MID_LATITUDE = 'SouthMidLatitude'
    LOW_LATITUDE = 'LowLatitude'
    NONE = 'None'


class PolarMapOrientation(Enum):
    """
    Enumerations representing the PolarMapOrientation defined
    in <https://sscweb.gsfc.nasa.gov/WebServices/REST/SSC.xsd>.
    """
    EQUATORIAL = 'Equatorial'
    NORTH_POLE = 'NorthPole'
    SOUTH_POLE = 'SouthPole'

Classes

class MapProjection (value, names=None, *, module=None, qualname=None, type=None, start=1)

Enumerations representing the MapProjection defined in https://sscweb.gsfc.nasa.gov/WebServices/REST/SSC.xsd.

Expand source code

class MapProjection(Enum):
    """
    Enumerations representing the MapProjection defined
    in <https://sscweb.gsfc.nasa.gov/WebServices/REST/SSC.xsd>.
    """
    AZIMUTHAL = 'Azimuthal'
    CYLINDRICAL = 'Cylindrical'
    MERCATOR = 'Mercator'
    MOLLEWEIDE = 'Molleweide'
    ORTHOGRAPHIC = 'Othographic'
    STEREOGRAPHIC = 'Stereographic'

Ancestors

• enum.Enum

Class variables

var AZIMUTHAL

var CYLINDRICAL

var MERCATOR

var MOLLEWEIDE

var ORTHOGRAPHIC

var STEREOGRAPHIC

class MapProjectionTrace (value, names=None, *, module=None, qualname=None, type=None, start=1)

Enumerations representing the MapProjectionTrace defined in https://sscweb.gsfc.nasa.gov/WebServices/REST/SSC.xsd.

Expand source code

class MapProjectionTrace(Enum):
    """
    Enumerations representing the MapProjectionTrace defined
    in <https://sscweb.gsfc.nasa.gov/WebServices/REST/SSC.xsd>.
    """
    B_FIELD_NORTH = 'BFieldNorth'
    B_FIELD_SOUTH = 'BFieldSouth'
    RADIAL = 'Radial'

Ancestors

• enum.Enum

Class variables

var B_FIELD_NORTH

var B_FIELD_SOUTH

var RADIAL

class MapRegion (value, names=None, *, module=None, qualname=None, type=None, start=1)

Enumerations representing the MapRegion defined in https://sscweb.gsfc.nasa.gov/WebServices/REST/SSC.xsd.

Expand source code

class MapRegion(Enum):
    """
    Enumerations representing the MapRegion defined
    in <https://sscweb.gsfc.nasa.gov/WebServices/REST/SSC.xsd>.
    """
    NORTH_CUSP = 'NorthCusp'
    SOUTH_CUSP = 'SouthCusp'
    NORTH_CLEFT = 'NorthCleft'
    SOUTH_CLEFT = 'SouthCleft'
    NORTH_AURORAL_OVAL = 'NorthAuroralOval'
    SOUTH_AURORAL_OVAL = 'SouthOuroralOval'
    NORTH_POLAR_CAP = 'NorthPolarCap'
    SOUTH_POLAR_CAP = 'SouthPolarCap'
    NORTH_MID_LATITUDE = 'NorthMidLatitude'
    SOUTH_MID_LATITUDE = 'SouthMidLatitude'
    LOW_LATITUDE = 'LowLatitude'
    NONE = 'None'

Ancestors

• enum.Enum

Class variables

var LOW_LATITUDE

var NONE

var NORTH_AURORAL_OVAL

var NORTH_CLEFT

var NORTH_CUSP

var NORTH_MID_LATITUDE

var NORTH_POLAR_CAP

var SOUTH_AURORAL_OVAL

var SOUTH_CLEFT

var SOUTH_CUSP

var SOUTH_MID_LATITUDE

var SOUTH_POLAR_CAP

class PolarMapOrientation (value, names=None, *, module=None, qualname=None, type=None, start=1)

Enumerations representing the PolarMapOrientation defined in https://sscweb.gsfc.nasa.gov/WebServices/REST/SSC.xsd.

Expand source code

class PolarMapOrientation(Enum):
    """
    Enumerations representing the PolarMapOrientation defined
    in <https://sscweb.gsfc.nasa.gov/WebServices/REST/SSC.xsd>.
    """
    EQUATORIAL = 'Equatorial'
    NORTH_POLE = 'NorthPole'
    SOUTH_POLE = 'SouthPole'

Ancestors

• enum.Enum

Class variables

var EQUATORIAL

var NORTH_POLE

var SOUTH_POLE