Skip to content

Colormap

Colormap

Colormap(colormap: str = None)

Colormap transform allows to map a scalar to a color

Colormap transform allows to map a scalar to a color

Example
from gsp.transform import Colormap
colormap = Colormap("viridis")
1
2
3
4
5
6
7
8
1. COMMAND
     - METHOD: "transform.Colormap" (str)
     - COMMAND_ID: 1 (int)
     - TIMESTAMP: 2024-08-21T12:52:33.753046 (datetime)
   PARAMETERS
     - OBJECT_ID: 1 (int)
     - COLORMAP: viridis (str)

{
  "jsonrpc": "2.0",
  "commands": [
    {
      "method": "transform.Colormap",
      "id": 1,
      "timestamp": 1724237553.753046,
      "parameters": {
        "id": 1,
        "colormap": "viridis"
      }
    }
  ]
}

Parameters:

Name Type Description Default
colormap str

Name of the colormap

None

set_colormap

set_colormap(colormap: str)

Set the colormap

Example
1
2
3
from gsp.transform import Colormap
colormap = Colormap("viridis")
colormap.set_colormap("inferno")
1. COMMAND
     - METHOD: "transform.Colormap" (str)
     - COMMAND_ID: 1 (int)
     - TIMESTAMP: 2024-08-21T12:52:33.820752 (datetime)
   PARAMETERS
     - OBJECT_ID: 1 (int)
     - COLORMAP: viridis (str)

2. COMMAND
     - METHOD: "Colormap/set_colormap" (str)
     - COMMAND_ID: 2 (int)
     - TIMESTAMP: 2024-08-21T12:52:33.820783 (datetime)
   PARAMETERS
     - OBJECT_ID: 1 (int)
     - COLORMAP: inferno (str)

{
  "jsonrpc": "2.0",
  "commands": [
    {
      "method": "transform.Colormap",
      "id": 1,
      "timestamp": 1724237553.820752,
      "parameters": {
        "id": 1,
        "colormap": "viridis"
      }
    },
    {
      "method": "Colormap/set_colormap",
      "id": 2,
      "timestamp": 1724237553.820783,
      "parameters": {
        "id": 1,
        "colormap": "inferno"
      }
    }
  ]
}

Parameters:

Name Type Description Default
colormap str

Name of the colormap

required