porescene.color.palette package

Submodules

• porescene.color.palette.fefa module
  • FeFaPalette

Module contents

class porescene.color.palette.Colormap(*values)

Bases: Enum

All colormaps bundled with porescene.

Each member’s value is the file name (without extension) of the corresponding colormap in porescene/data/colormap and can be passed to Palette.load(). The collection comprises

• Fabio Crameri’s scientific colour maps,

• cmocean,

• colorcet,

• ColorBrewer, and

• a selection of matplotlib colormaps.

See porescene/data/colormap/README.txt for the per-collection provenance and licenses.

ACCENT = 'Accent'

ACTON = 'acton'

ACTONS = 'actonS'

ALGAE = 'algae'

AMP = 'amp'

BALANCE = 'balance'

BAM = 'bam'

BAMAKO = 'bamako'

BAMAKOS = 'bamakoS'

BAMO = 'bamO'

BATLOW = 'batlow'

BATLOWK = 'batlowK'

BATLOWKS = 'batlowKS'

BATLOWS = 'batlowS'

BATLOWW = 'batlowW'

BATLOWWS = 'batlowWS'

BERLIN = 'berlin'

BGY = 'bgy'

BGYW = 'bgyw'

BILBAO = 'bilbao'

BILBAOS = 'bilbaoS'

BJY = 'bjy'

BKR = 'bkr'

BKY = 'bky'

BLUES = 'Blues'

BMW = 'bmw'

BMY = 'bmy'

BRBG = 'BrBG'

BROC = 'broc'

BROCO = 'brocO'

BUDA = 'buda'

BUDAS = 'budaS'

BUGN = 'BuGn'

BUKAVU = 'bukavu'

BUPU = 'BuPu'

BWY = 'bwy'

CIVIDIS = 'cividis'

COLORWHEEL = 'colorwheel'

COOLWARM = 'coolwarm'

CORK = 'cork'

CORKO = 'corkO'

CUBEHELIX = 'cubehelix'

CURL = 'curl'

CWR = 'cwr'

DARK2 = 'Dark2'

DAVOS = 'davos'

DAVOSS = 'davosS'

DEEP = 'deep'

DELTA = 'delta'

DENSE = 'dense'

DEVON = 'devon'

DEVONS = 'devonS'

DIFF = 'diff'

DIMGRAY = 'dimgray'

EMBER = 'ember'

FES = 'fes'

FIRE = 'fire'

GLASGOW = 'glasgow'

GLASGOWS = 'glasgowS'

GNBU = 'GnBu'

GOULDIAN = 'gouldian'

GRAY = 'gray'

GRAYC = 'grayC'

GRAYCS = 'grayCS'

GREENS = 'Greens'

GREYS = 'Greys'

GWV = 'gwv'

HALINE = 'haline'

HAWAII = 'hawaii'

HAWAIIS = 'hawaiiS'

ICE = 'ice'

IMOLA = 'imola'

IMOLAS = 'imolaS'

INFERNO = 'inferno'

ISOLUM = 'isolum'

KB = 'kb'

KBC = 'kbc'

KBGYW = 'kbgyw'

KG = 'kg'

KGY = 'kgy'

KR = 'kr'

LAJOLLA = 'lajolla'

LAJOLLAS = 'lajollaS'

LAPAZ = 'lapaz'

LAPAZS = 'lapazS'

LIPARI = 'lipari'

LIPARIS = 'lipariS'

LISBON = 'lisbon'

MAGMA = 'magma'

MANAGUA = 'managua'

MATTER = 'matter'

NAVIA = 'navia'

NAVIAS = 'naviaS'

NUUK = 'nuuk'

NUUKS = 'nuukS'

OLERON = 'oleron'

ORANGES = 'Oranges'

ORRD = 'OrRd'

OSLO = 'oslo'

OSLOS = 'osloS'

OXY = 'oxy'

PAIRED = 'Paired'

PASTEL1 = 'Pastel1'

PASTEL2 = 'Pastel2'

PHASE = 'phase'

PIYG = 'PiYG'

PLASMA = 'plasma'

PRGN = 'PRGn'

PUBU = 'PuBu'

PUBUGN = 'PuBuGn'

PUOR = 'PuOr'

PURD = 'PuRd'

PURPLES = 'Purples'

RAIN = 'rain'

RAINBOW = 'rainbow'

RAINBOW4 = 'rainbow4'

RDBU = 'RdBu'

RDGY = 'RdGy'

RDPU = 'RdPu'

RDYLBU = 'RdYlBu'

RDYLGN = 'RdYlGn'

REDS = 'Reds'

ROMA = 'roma'

ROMAO = 'romaO'

SET1 = 'Set1'

SET2 = 'Set2'

SET3 = 'Set3'

SOLAR = 'solar'

SPECTRAL = 'Spectral'

SPEED = 'speed'

TAB10 = 'tab10'

TARN = 'tarn'

TEMPO = 'tempo'

THERMAL = 'thermal'

TOFINO = 'tofino'

TOKYO = 'tokyo'

TOKYOS = 'tokyoS'

TOPO = 'topo'

TURBID = 'turbid'

TURBO = 'turbo'

TURKU = 'turku'

TURKUS = 'turkuS'

TWILIGHT = 'twilight'

VANIMO = 'vanimo'

VIK = 'vik'

VIKO = 'vikO'

VIRIDIS = 'viridis'

YLGN = 'YlGn'

YLGNBU = 'YlGnBu'

YLORBR = 'YlOrBr'

YLORRD = 'YlOrRd'

class porescene.color.palette.Palette(colors)

Bases: object

A basic wrapper for a collection of selected colors.

classmethod load(name)

Creates a Palette instance by loading colormap data from file.

porescene includes a large set of scientific colormaps, including:

• Fabio Crameri’s collection

• matplotlib colormaps

Parameters:

name (str | Colormap) – Colormap to be loaded from file, either as a Colormap member or the corresponding colormap name.

Return type:

Self

all()

Returns the full color palette.

Return type:

list[Color]

first()

Returns the first color of the palette.

Return type:

Color

last()

Returns the last color of the palette.

Return type:

Color

random(n=1)

Returns randomly selected colors from the palette.

Parameters:

n (int) – Number of colors to return, by default 1

Return type:

list[Color]

reversed()

Returns the colors from the palette in reversed order.

Return type:

list[Color]

subset(n=5)

Returns a subset of n equidistant sampled colors from the palette.

Parameters:

n (int) – Number of colors in the subset, by default 5

Return type:

list[Color]