Catálogo e Publicação de metadados de coleções

Este documento demonstra como preparar as coleções de metadados em documentos JSON.

Metadados

O repositório metadata consiste em uma base de dados revisados pelos responsáveis de modo a publicar os dados no catálogo oficial da BIG/BDC. Basicamente, esses metadados são documentos em JSON que seguem algumas diretrizes de campos de modo a serem integrados com o modelo de dados do bdc-catalog.

Para incluir uma nova coleção neste repositório, recomenda-se criar um fork para sua conta no GitHub. Em seguida, clone o repositorio::

git clone https://github.com/<UserName>/metadata

Tip: Se você tiver dúvidas de como funciona um fork, por favor, acesse o documento oficial do GitHub how to fork a repo

A estrutura deste documento deve seguir os seguintes campos:

• id: Identificador Unico da coleção (Deve-se manter como null). Este valor deve ser alterado posteriormente uma vez que tenha um identificador referente no banco de dados do catálogo.

• name: (OBRIGATORIO) Nome curto para representar a coleção. Uma boa prática é manter os nomes com os caracteres em minúsculo. landsat, mod13q1, etc. Caso opte por usar algum separador de preferência ao uso de hífen (-).

• version: (OBRIGATORIO) Versão desta coleção e será considerado como chave unica com o campo collection-version.. Aceita-se numeros, letras etc. landsat-2 (Coleção Landsat Versão 2), mod13q1-6.1 (Coleção MOD13Q1 Versão 6.1), etc.

• title: (OBRIGATORIO) Título representativo da coleção. Utilize um titulo descritivo e curto pois será destacado no catálogo STAC. Landsat Collection 2 - Level-2 etc. Caso opte por usar algum separador de preferência ao uso de hífen (-).

• description: (OBRIGATORIO) Descrição do dado.

• grid_ref_sys: (OPCIONAL) Grade de referência da coleção, caso não exista manter como null.

• collection_type: (OBRIGATORIO) Enumeração do tipo do documento. Os valores disponíveis são: collection - coleções de dados; cube - cudos de dados; mosaic - mosaico de imagens; classification - mapa temático do produto classificado.

• metadata: (OBRIGATORIO) Metadados gerais a serem agregados na coleção. Nos objetos STAC Collection, incorpora novos campos dentro de properties.

  • providers: (OBRIGATORIO) Lista de entidades provedores dos dados. Cada entidade provedor segue a especificação STAC Provider Object e deve possuir os seguintes campos:

    • name: Nome real da entidade provedora dos dados.
    • roles: Enumeração que represente o papel do provedor de dados. Os valores disponíveis são: licensor, producer, processor e host.
    • url: Pagina inicial que o provedor utiliza para descrever o seu papel e a definição dos dados para contato.
    • description (OPCIONAL): Detalhes adicionais para descrever a entidade provedora.

• keywords: Palavras chaves associadas para descrever a coleção. Uma boa prática é manter os nomes com os caracteres em minúsculo. Algumas palavras chaves a serem adotadas podem referir-se à àrea do dado (brazil, biome, amazon, cerrado, paraiba state), nome do programa espacial (cbers, landsat), nome do satélite que carrega o instrumento (cbers-4, landsat-8, cbers-4a, sentinel-2), sensor (oli, msi, wfi), tipo do dado (mosaic), formato do dado (cog, cloud optimized geotiff) dentre outros (visible imagery, earth observation, visible wavelengths, ultraviolet wavelengths, yanomami, indigenous).

• is_public: Campo booleano que define se a coleção está disponível publicamente no STAC. Por padrão true. Quando configurado como false, só poderá acessa-la através de role definida no INPE IAM.

• is_available: Campo booleano que define se a coleção se encontra disponível. Este campo é usado quando uma coleção deixa de existir (devido a existência de uma nova) ou mesmo quando planeja-se alguma parada momentânea. Quando configurado como false, nem mesmo usuários com permissão de acesso (com exceção de administradores) podem acessa-lá caso tenham o privilégio configurado no INPE IAM. Por padrão, é configurado como false.

• category: (OBRIGATORIO) Campo interno do bdc-catalog para identificação da categoria de dados que se enquadra a coleção: eo, sar, lidar, unknown.

• quicklook: Propriedade que representa as bandas utilizadas na geração do asset thumbnail.

• version_predecessor: (OPCIONAL) Identificador INTEIRO da coleção que representa a versão anterior.

• version_successor: (OPCIONAL) Identificador INTEIRO da coleção que representa a versão seguinte.

• bands: (OBRIGATORIO) Lista de bandas da coleção. Cada banda deve seguir a seguinte assinatura:

  • name: (OBRIGATORIO) Nome real da banda disponível no sensor.
  • common_name: (OBRIGATORIO) Alias da banda (nome usual).
  • description: (OPCIONAL) Descrição curta para banda.
  • min_value: (OBRIGATORIO) Valor minimo considerado como válido.
  • max_value: (OBRIGATORIO) Valor máximo considerado como válido.
  • scale: (OBRIGATORIO) Escala multiplicadora do dado. Ex: muitos dados de reflectância de superfície são armazenados como inteiros variando entre 0 e 10000. Assim o scale desses dados é 0.0001 para transforma-los em escala 0 a 1.
  • scale_add: (OPCIONAL) Fator aditivo a ser considerado na banda. Em produtos Landsat-2 Collection 2 por exemplo, existe um fator aditivo de -0.2 a ser considerado após o scale multiplicativo. Por padrão, valor null.
  • data_type: (OBRIGATORIO) Representação do tipo de dado em computação para armazenamento dos dados. Os valores disponíveis seguem o bdc-catalog: uint8, int8, uint16, int16, uint32, int32, float32, float64.
  • mime_type: (OBRIGATORIO) Media type vinculado a banda gerada em disco. Os valores suportados atualmente são: image/png, image/tiff, image/tiff; application=geotiff, image/tiff; application=geotiff; profile=cloud-optimized, text/plain, text/html, application/json, application/xml, application/x-tar, application/zip, application/gzip, image/jp2; profile=cloud-optimized, image/jp2, application/x-netcdf, application/netcdf.
  • resolution_x: (OPCIONAL) Resolução espacial dos pixels em x.
  • resolution_y: (OPCIONAL) Resolução espacial dos pixels em y.
  • resolution_unit: (OPCIONAL) Unidade da Resolução espacial. Ex: Meter, Kilometer.
  • center_wavelength: (OPCIONAL) Comprimento central da onda, em micrometros (μm), quando houver.
  • full_width_half_max: (OPCIONAL) Largura à meia altura, parâmetro que descreve a largura de uma banda espectral em termos de resolução espectral.

• summaries: (OPCIONAL) Sumário dos valores dos campos que podem ser vinculados a nivel item na coleção:

  • instruments: (OBRIGATORIO) Lista de sensores presentes na coleção. Por exemplo no sentinel-2 ["msi"].
  • platform: (OBRIGATORIO) Lista de plataformas vinculadas na coleção. Por exemplo no sentinel-2 ["sentinel-2a", "sentinel-2b"].
  • constellation: (OPCIONAL) Constelações vinculadas a coleção. Por exemplo no sentinel-2 ["sentinel-2"].
  • gsd: (OPCIONAL) Ground Sampling Distance, parâmetro que define a resolução espacial de uma imagem capturada por um sensor.
  • view:off_nadir (OPCIONAL) Visada do sensor a Nadir.

• item_assets: (OBRIGATORIO) Mapa de assets presentes na coleção, de modo a oferecer uma visão alto nivel para que o usuário possa determinar quais assets esta interessado. O mapa deve representar Map[str, Asset] onde a chave é uma string representando o nome do asset e o Asset a seguinte assinatura:

  • title: (OBRIGATORIO) Titulo descritivo do asset.
  • type: (OBRIGATORIO) Media type do asset.
  • roles: (OBRIGATORIO) Caracteristica do asset: thumbnail, overview, data, metadata.
  • description (OPCIONAL) Descrição detalhada do asset e/ou como foi processado.

• properties: (OPCIONAL) Campos opcionais sem validação que podem ser incorporados no corpo do STAC.

Os campos a seguir referem-se ao collection_type cube ou mosaic:

• temporal_composition_schema: (OPCIONAL) composição temporal da coleção. Esse campo pode ser opcional se for uma coleção Identidade por exemplo.
• composition_function: (OPCIONAL) função de composição do cubo de dados. Os valores disponíveis atualmente são: Identity, Least CC First, Median.

Uma vez preparado o documento JSON, você pode fazer o commit no seu fork e em seguite abrir um pull-request* no repositorio oficial dos metadados.

⚠️ Warning: Revise os documentos antes de fazer o commit e abrir o pull-request. Garanta que o documento é um JSON válido, caso contrário não será aceito.