Skip to content

gportal.product

Product

Wrapper of a product GeoJSON in search results.

You can access the properties or properties.gpp values by [] operator like a dictionary.

Source code in gportal/product.py 
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
class Product:
    """Wrapper of a product GeoJSON in search results.

    You can access the `properties` or `properties.gpp` values by `[]` operator like a dictionary.
    """

    VALUE_CONVERSION_MAP = {
        "": None,
        "true": True,
        "false": False,
    }

    def __init__(self, geojson: dict[str, Any], convert_types: bool = False):
        if convert_types and "properties" in geojson:
            geojson = {**geojson, "properties": self._convert_type(geojson["properties"])}

        self._geojson = geojson

    @classmethod
    def _convert_type(cls, val: Any) -> Any:
        if isinstance(val, str):
            if val in cls.VALUE_CONVERSION_MAP:
                return cls.VALUE_CONVERSION_MAP[val]
            try:
                return int(val)
            except ValueError:
                pass
            try:
                return float(val)
            except ValueError:
                pass
        elif isinstance(val, dict):
            return {key: cls._convert_type(val) for key, val in val.items()}

        return val

    def __repr__(self) -> str:
        if self.id is None:
            return super().__repr__()
        else:
            return f"<gportal.Product id={self.id}>"

    @property
    def __geo_interface__(self) -> dict[str, Any]:
        return self._geojson

    @property
    def geometry(self) -> dict[str, Any]:
        """GeoJSON geometry."""
        return self._geojson.get("geometry", {})

    @property
    def properties(self) -> dict[str, Any]:
        """GeoJSON properties."""
        return self._geojson.get("properties", {})

    def __getitem__(self, key: str) -> Any:
        if key in self.properties:
            return self.properties[key]

        if key in self.properties.get("gpp", {}):
            return self.properties["gpp"][key]

        raise KeyError(key)

    def get(self, key: str, default: Any = None) -> Any:
        try:
            return self[key]
        except KeyError:
            return default

    @property
    def id(self) -> Optional[str]:
        """Granule ID."""
        return self.get("identifier")

    @property
    def data_url(self) -> Optional[str]:
        """URL of the product file."""
        return self.get("product", {}).get("fileName")

    @property
    def data_path(self) -> Optional[str]:
        """Path to the product file on the SFTP server."""
        if self.data_url is None:
            return None

        return self.data_url.replace("https://gportal.jaxa.jp/download/", "", 1)

    @property
    def quicklook_url(self) -> Optional[str]:
        """Quicklook image URL."""
        for item in self.get("browse", []):
            if item.get("type", "").lower() == "quicklook":
                return item.get("fileName")

        return None

    def get_as_datetime(self, key: str) -> Optional[datetime]:
        """Gets a value as a datetime object."""
        val = self.get(key)
        if val is None:
            return None

        if sys.version_info < (3, 11):
            val = val.replace("Z", "+00:00")

        return datetime.fromisoformat(val)

    def flatten_properties(self) -> dict[str, Any]:
        """Flattens the nested properties.

        This method processes nested properties from the following keys:

        - `product`: Each key is prefixed with `product` (e.g. `product.fileName` => `productFileName`).
        - `browse`: Keys are the `type` fields (e.g. quicklook, thumbnail), and their values are `fileName` fields.
        - `gpp`: Keys and values are directly merged.

        Returns:
            The flattened properties.
        """
        properties = self.properties.copy()

        if "product" in properties and isinstance(properties["product"], dict):
            for key, value in properties["product"].items():
                properties[f"product{key[0].upper()}{key[1:]}"] = value

            del properties["product"]

        if "browse" in properties and isinstance(properties["browse"], list):
            for i, browse in enumerate(properties["browse"]):
                if "type" in browse and "fileName" in browse:
                    type = browse["type"].lower()
                    if type in properties:
                        properties[f"{type}{i}"] = browse["fileName"]
                    else:
                        properties[type] = browse["fileName"]

            del properties["browse"]

        if "gpp" in properties and isinstance(properties["gpp"], dict):
            properties.update(properties["gpp"])
            del properties["gpp"]

        return properties

    def to_dict(self, flatten_properties: bool = False) -> dict[str, Any]:
        """Converts to a dictionary of GeoJSON Feature.

        Args:
            flatten_properties: If True, the properties are flattened using
                [`flatten_properties`][gportal.product.Product.flatten_properties].

        Returns:
            This product as a dictionary.
        """
        if flatten_properties:
            return {
                **self._geojson,
                "properties": self.flatten_properties(),
            }
        else:
            return self._geojson

geometry: dict[str, Any] property

GeoJSON geometry.

properties: dict[str, Any] property

GeoJSON properties.

id: Optional[str] property

Granule ID.

data_url: Optional[str] property

URL of the product file.

data_path: Optional[str] property

Path to the product file on the SFTP server.

quicklook_url: Optional[str] property

Quicklook image URL.

get_as_datetime(key)

Gets a value as a datetime object.

Source code in gportal/product.py 
104
105
106
107
108
109
110
111
112
113
def get_as_datetime(self, key: str) -> Optional[datetime]:
    """Gets a value as a datetime object."""
    val = self.get(key)
    if val is None:
        return None

    if sys.version_info < (3, 11):
        val = val.replace("Z", "+00:00")

    return datetime.fromisoformat(val)

flatten_properties()

Flattens the nested properties.

This method processes nested properties from the following keys:

  • product: Each key is prefixed with product (e.g. product.fileName => productFileName).
  • browse: Keys are the type fields (e.g. quicklook, thumbnail), and their values are fileName fields.
  • gpp: Keys and values are directly merged.

Returns:

Type Description
dict[str, Any]

The flattened properties.
Source code in gportal/product.py 
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
def flatten_properties(self) -> dict[str, Any]:
    """Flattens the nested properties.

    This method processes nested properties from the following keys:

    - `product`: Each key is prefixed with `product` (e.g. `product.fileName` => `productFileName`).
    - `browse`: Keys are the `type` fields (e.g. quicklook, thumbnail), and their values are `fileName` fields.
    - `gpp`: Keys and values are directly merged.

    Returns:
        The flattened properties.
    """
    properties = self.properties.copy()

    if "product" in properties and isinstance(properties["product"], dict):
        for key, value in properties["product"].items():
            properties[f"product{key[0].upper()}{key[1:]}"] = value

        del properties["product"]

    if "browse" in properties and isinstance(properties["browse"], list):
        for i, browse in enumerate(properties["browse"]):
            if "type" in browse and "fileName" in browse:
                type = browse["type"].lower()
                if type in properties:
                    properties[f"{type}{i}"] = browse["fileName"]
                else:
                    properties[type] = browse["fileName"]

        del properties["browse"]

    if "gpp" in properties and isinstance(properties["gpp"], dict):
        properties.update(properties["gpp"])
        del properties["gpp"]

    return properties

to_dict(flatten_properties=False)

Converts to a dictionary of GeoJSON Feature.

Parameters:

Name Type Description Default
flatten_properties bool

If True, the properties are flattened using flatten_properties.

 False

Returns:

Type Description
dict[str, Any]

This product as a dictionary.
Source code in gportal/product.py 
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
def to_dict(self, flatten_properties: bool = False) -> dict[str, Any]:
    """Converts to a dictionary of GeoJSON Feature.

    Args:
        flatten_properties: If True, the properties are flattened using
            [`flatten_properties`][gportal.product.Product.flatten_properties].

    Returns:
        This product as a dictionary.
    """
    if flatten_properties:
        return {
            **self._geojson,
            "properties": self.flatten_properties(),
        }
    else:
        return self._geojson