Function getproj

src/wrf/projection.py:1115–1159

Return a :class:`wrf.WrfProj` subclass. This functions serves as a factory function for returning a :class:`wrf.WrfProj` subclass from the specified map projection parameters. Args: **proj_params: Map projection optional keyword arguments, that have the same names

(**proj_params)

def getproj(**proj_params):
    """Return a :class:`wrf.WrfProj` subclass.

    This functions serves as a factory function for returning a
    :class:`wrf.WrfProj` subclass from the specified map projection parameters.

    Args:

        **proj_params:  Map projection optional keyword arguments, that
            have the same names as found in WRF output NetCDF global
            attributes:

            - 'MAP_PROJ': The map projection type as an integer.
            - 'TRUELAT1': True latitude 1.
            - 'TRUELAT2': True latitude 2.
            - 'MOAD_CEN_LAT': Mother of all domains center latitude.
            - 'STAND_LON': Standard longitude.
            - 'POLE_LAT': Pole latitude.
            - 'POLE_LON': Pole longitude.

    Returns:

        :class:`wrf.WrfProj`: A :class:`wrf.WrfProj` subclass for the
        specified map projection parameters.

    """
    up_proj_params = dict_keys_to_upper(proj_params)

    proj_type = up_proj_params.get("MAP_PROJ", 0)
    if proj_type == ProjectionTypes.LAMBERT_CONFORMAL:
        return LambertConformal(**proj_params)
    elif proj_type == ProjectionTypes.POLAR_STEREOGRAPHIC:
        return PolarStereographic(**proj_params)
    elif proj_type == ProjectionTypes.MERCATOR:
        return Mercator(**proj_params)
    elif (proj_type == ProjectionTypes.ZERO or
          proj_type == ProjectionTypes.LAT_LON):
        if (up_proj_params.get("POLE_LAT", None) == 90.
                and up_proj_params.get("POLE_LON", None) == 0.):
            return LatLon(**proj_params)
        else:
            return RotatedLatLon(**proj_params)
    else:
        # Unknown projection
        return WrfProj(**proj_params)