Spec-Zone.ru › Matplotlib 3.4

matplotlib.scale

Масштабирования определяют распределение значений данных на оси, например, логарифмическое масштабирование.

Они прикреплены к Axis и содержат Transform, который отвечает за фактическое преобразование данных.

См. также axes.Axes.set_xscale и примеры масштабирования в документации.

class matplotlib.scale.FuncScale(axis, functions)[source]

Bases: matplotlib.scale.ScaleBase

Обеспечивает произвольный масштаб с заданной пользователем функцией для оси.

Параметры:
axisAxis

Ось для масштабирования.

functions(callable, callable)

Двойка вызываемых функций: прямая и обратная для масштабирования. Прямая функция должна быть монотонной.

Обе функции должны иметь подпись:

def forward(values: array-like) -> array-like
get_transform()[source]

Возвращает FuncTransform, связанное с этим масштабированием.

name = 'function'
set_default_locators_and_formatters(axis)[source]

Устанавливает локаторы и форматеры axis, подходящие для данного масштаба.

class matplotlib.scale.FuncScaleLog(axis, functions, base=10)[source]

Bases: matplotlib.scale.LogScale

Обеспечивает произвольный масштаб с заданной пользователем функцией для оси, а затем размещает ее на логарифмической оси.

Параметры:
axismatplotlib.axis.Axis

Ось для масштабирования.

functions(callable, callable)

Двойка вызываемых функций: прямая и обратная для масштабирования. Прямая функция должна быть монотонной.

Обе функции должны иметь подпись:

def forward(values: array-like) -> array-like
basefloat, default: 10

Логарифмическая основа масштабирования.

property base
get_transform()[source]

Возвращает Transform, связанное с этим масштабированием.

name = 'functionlog'
class matplotlib.scale.FuncTransform(forward, inverse)[source]

Bases: matplotlib.transforms.Transform

Простое преобразование, принимающее произвольную функцию для прямого и обратного преобразования.

Параметры:
forwardcallable

Прямая функция преобразования. Эта функция должна иметь обратную функцию и, для наилучшего поведения, быть монотонной. Она должна иметь подпись:

def forward(values: array-like) -> array-like
inversecallable

Обратная функция прямой функции. Подпись как forward.

has_inverse = True
input_dims = 1
inverted()[source]

Возвращает соответствующее обратное преобразование.

Содержит x == self.inverted().transform(self.transform(x)).

Результат этого метода следует рассматривать как временный. Обновление self не вызывает соответствующего обновления его обратной копии.

is_separable = True
output_dims = 1
transform_non_affine(values)[source]

Применяет только неаффинные части этого преобразования.

transform(values) всегда эквивалентно transform_affine(transform_non_affine(values)).

В неаффинных преобразованиях это, как правило, эквивалентно transform(values). В аффинных преобразованиях это всегда нетрудно.

Параметры:
valuesмассив

Входные значения как массив NumPy длины input_dims или формы (N x input_dims).

Возвращает:
массив

Значения вывода как массив NumPy длины input_dims или формы (N x output_dims), в зависимости от входных данных.

END_OF_DOCUMENT_MARKER
класс matplotlib.scale.InvertedLogTransform(base)[source]

Базы: matplotlib.transforms.Transform

Параметры:
shorthand_namestr

Строка, представляющая «имя» преобразования. Имя не имеет значения, кроме как для повышения удобочитаемости str(transform) при DEBUG=True.

has_inverse = True
input_dims = 1
inverted()[source]

Возвращает соответствующее обратное преобразование.

Содержит x == self.inverted().transform(self.transform(x)).

Значение, возвращаемое этим методом, следует рассматривать как временное. Обновление self не вызывает соответствующего обновления его инвертированной копии.

is_separable = True
output_dims = 1
transform_non_affine(a)[source]

Применяет только неаффинную часть этого преобразования.

transform(values) всегда эквивалентно transform_affine(transform_non_affine(values)).

В неаффинных преобразованиях это обычно эквивалентно transform(values). В аффинных преобразованиях это всегда ничто.

Параметры:
значениямассив

Входные значения в виде массива NumPy длиной input_dims или формы (N x input_dims).

Возвращает:
массив

Выходные значения в виде массива NumPy длиной input_dims или формы (N x output_dims), в зависимости от входных данных.

класс matplotlib.scale.InvertedSymmetricalLogTransform(base, linthresh, linscale)[source]

Базы: matplotlib.transforms.Transform

Параметры:
shorthand_namestr

Строка, представляющая «имя» преобразования. Имя не имеет значения, кроме как для повышения удобочитаемости str(transform) при DEBUG=True.

has_inverse = True
input_dims = 1
inverted()[source]

Возвращает соответствующее обратное преобразование.

Содержит x == self.inverted().transform(self.transform(x)).

Значение, возвращаемое этим методом, следует рассматривать как временное. Обновление self не вызывает соответствующего обновления его инвертированной копии.

is_separable = True
output_dims = 1
transform_non_affine(a)[source]

Применяет только неаффинную часть этого преобразования.

transform(values) всегда эквивалентно transform_affine(transform_non_affine(values)).

В неаффинных преобразованиях это обычно эквивалентно transform(values). В аффинных преобразованиях это всегда ничто.

Параметры:
значениямассив

Входные значения в виде массива NumPy длиной input_dims или формы (N x input_dims).

Возвращает:
массив

Выходные значения в виде массива NumPy длиной input_dims или формы (N x output_dims), в зависимости от входных данных.

класс matplotlib.scale.LinearScale(axis)[source]

Базы: matplotlib.scale.ScaleBase

По умолчанию линейная шкала.

get_transform()[source]

Возвращает преобразование для линейного масштабирования, которое представляет собой просто IdentityTransform.

name = 'линейный'
set_default_locators_and_formatters(axis)[source]

Устанавливает локатороы и форматировщики axis в экземпляры, подходящие для этой шкалы.

класс matplotlib.scale.LogScale(axis, **kwargs)[source]

Bases: matplotlib.scale.ScaleBase

Стандартная логарифмическая шкала. Учитываются только положительные значения.

Параметры:
axisAxis

Ось для шкалы.

basefloat, по умолчанию: 10

Основание логарифма.

nonpositive{'clip', 'mask'}, по умолчанию: 'clip'

Определяет поведение для неположительных значений. Они могут быть либо замаскированы как недопустимые, либо обрезаны до очень малого положительного числа.

subsпоследовательность int, по умолчанию: None

Где разместить подделения между каждым основным делением. Например, в логарифмической шкале по основанию 10, [2, 3, 4, 5, 6, 7, 8, 9] разместит 8 логарифмически распределённых подделений между каждым основным делением.

свойство InvertedLogTransform
свойство LogTransform
свойство base
get_transform()[source]

Возвращает LogTransform, связанный с этой шкалой.

limit_range_for_scale(vmin, vmax, minpos)[source]

Ограничивает область положительными значениями.

name = 'log'
set_default_locators_and_formatters(axis)[source]

Устанавливает локторы и форматировщики axis на значения, подходящие для этой шкалы.

класс matplotlib.scale.LogTransform(base, nonpositive='clip')[source]

Bases: matplotlib.transforms.Transform

Параметры:
shorthand_namestr

Строка, представляющая "имя" преобразования. Имя не имеет значения, кроме как для повышения удобочитаемости str(transform) при DEBUG=True.

has_inverse = True
input_dims = 1
inverted()[source]

Возвращает соответствующее обратное преобразование.

Выполняется x == self.inverted().transform(self.transform(x)).

Результат этого метода должен рассматриваться как временный. Обновление self не вызывает соответствующего обновления его обратного копии.

is_separable = True
output_dims = 1
transform_non_affine(a)[source]

Применяет только часть преобразования, не зависящую от аффинных преобразований.

transform(values) всегда эквивалентно transform_affine(transform_non_affine(values)).

В преобразованиях, не зависящих от аффинных преобразований, это, как правило, эквивалентно transform(values). В аффинных преобразованиях это всегда бесполезно.

Параметры:
valuesмассив

Входные значения как массив NumPy длины input_dims или формы (N x input_dims).

Возвращает:
массив

Выходные значения как массив NumPy длины input_dims или формы (N x output_dims), в зависимости от входных данных.

класс matplotlib.scale.LogisticTransform(nonpositive='mask')[source]

Bases: matplotlib.transforms.Transform

Параметры:
shorthand_namestr

Строка, представляющая "имя" преобразования. Имя не имеет значения, кроме как для повышения удобочитаемости str(transform) при DEBUG=True.

has_inverse = True
input_dims = 1
inverted()[source]

Возвращает соответствующее обратное преобразование.

Выполняется x == self.inverted().transform(self.transform(x)).

Результат этого метода должен рассматриваться как временный. Обновление self не вызывает соответствующего обновления его обратного копии.

is_separable = True
output_dims = 1
transform_non_affine(a)[source]

Логистическое преобразование (основание 10).

класс matplotlib.scale.LogitScale(axis, nonpositive='mask', *, one_half='\x0crac{1}{2}', use_overline=False)[source]

Базы: matplotlib.scale.ScaleBase

Шкала логарифма для данных между нулём и единицей, обе исключены.

Эта шкала похожа на логарифмическую шкалу около нуля и единицы и почти линейна около 0,5. Она отображает интервал ]0, 1[ на ]-infty, +infty[.

Параметры:
axismatplotlib.axis.Axis

В настоящее время не используется.

nonpositive{'mask', 'clip'}

Определяет поведение для значений за пределами открытого интервала ]0, 1[. Они могут быть замаскированы как недействительные или ограничены числом, очень близким к 0 или 1.

use_overlinebool, по умолчанию: False

Указывает на использование обозначения выживаемости (overline{x}) вместо стандартного обозначения (1-x) для вероятности, близкой к единице.

one_halfstr, по умолчанию: r"frac{1}{2}"

Строка, используемая для форматирования меток для представления 1/2.

get_transform()[source]

Возвращает LogitTransform, связанный с этой шкалой.

limit_range_for_scale(vmin, vmax, minpos)[source]

Ограничивает область значениями между 0 и 1 (исключая).

name = 'logit'
set_default_locators_and_formatters(axis)[source]

Устанавливает локатороы и форматировщики axis на экземпляры, подходящие для этой шкалы.

класс matplotlib.scale.LogitTransform(nonpositive='mask')[source]

Базы: matplotlib.transforms.Transform

Параметры:
shorthand_namestr

Строка, представляющая "имя" преобразования. Имя не имеет значения, кроме улучшения читабельности str(transform) при DEBUG=True.

has_inverse = True
input_dims = 1
inverted()[source]

Возвращает соответствующее обратное преобразование.

Это соответствует x == self.inverted().transform(self.transform(x)).

Результат выполнения этого метода следует рассматривать как временный. Обновление self не вызывает соответствующего обновления его инвертированной копии.

is_separable = True
output_dims = 1
transform_non_affine(a)[source]

Преобразование логарифма (основание 10), замаскированное или ограниченное.

класс matplotlib.scale.ScaleBase(axis)[source]

Базы: object

Базовый класс для всех шкал.

Шкалы являются разделяемыми преобразованиями, работающими над одной осью.

Любые подклассы должны переопределить:

  • name
  • get_transform()
  • set_default_locators_and_formatters()

И, необязательно:

  • limit_range_for_scale()

Создаёт новую шкалу.

Примечания

Следующее примечание предназначено для разработчиков шкал.

По причинам обратной совместимости, шкалы принимают объект Axis в качестве первого аргумента. Однако этот аргумент не должен использоваться: один объект шкалы должен быть пригоден для использования несколькими объектами Axis одновременно.

get_transform()[source]

Возвращает объект Transform, связанный с этой шкалой.

limit_range_for_scale(vmin, vmax, minpos)[source]

Возвращает диапазон vmin, vmax, ограниченный областью, поддерживаемой этой шкалой (при необходимости).

minpos должно быть минимальным положительным значением в данных. Это используется логарифмическими шкалами для определения минимального значения.

set_default_locators_and_formatters(axis)[source]

Устанавливает локатороы и форматировщики axis на экземпляры, подходящие для этой шкалы.

END_OF_DOCUMENT_MARKER
класс matplotlib.scale.SymmetricalLogScale(axis, **kwargs)[source]

Базы: matplotlib.scale.ScaleBase

Симметричный логарифмический масштаб — логарифмический как в положительном, так и в отрицательном направлениях от начала координат.

Поскольку значения, близкие к нулю, стремятся к бесконечности, требуется диапазон значений около нуля, который является линейным. Параметр linthresh позволяет пользователю указать размер этого диапазона (-linthresh, linthresh).

Параметры:
basefloat, по умолчанию: 10

Основание логарифма.

linthreshfloat, по умолчанию: 2

Определяет диапазон (-x, x), в пределах которого график является линейным. Это предотвращает стремление графика к бесконечности около нуля.

subsпоследовательность int

Местоположение дополнительных делений между основными делениями. Например, в логарифмическом масштабе по основанию 10: [2, 3, 4, 5, 6, 7, 8, 9] разместит 8 логарифмически распределенных дополнительных делений между каждым основным делением.

linscalefloat, необязательно

Это позволяет растянуть линейный диапазон (-linthresh, linthresh) относительно логарифмического диапазона. Его значение — количество десятичных разрядов, используемых для каждой половины линейного диапазона. Например, когда linscale == 1.0 (по умолчанию), пространство, используемое для положительной и отрицательной половин линейного диапазона, будет равно одному десятичному разряду в логарифмическом диапазоне.

Создать новый масштаб.

Примечания

Следующее примечание предназначено для разработчиков масштабов.

По соображениям обратной совместимости масштабы принимают объект Axis в качестве первого аргумента. Однако этот аргумент не следует использовать: один объект масштаба должен быть пригоден для нескольких объектов Axis одновременно.

свойство InvertedSymmetricalLogTransform
свойство SymmetricalLogTransform
свойство base
get_transform()[source]

Возвращает SymmetricalLogTransform, связанный с этим масштабом.

свойство linscale
свойство linthresh
name = 'symlog'
set_default_locators_and_formatters(axis)[source]

Устанавливает локаторы и форматеры объекта axis, подходящие для данного масштаба.

класс matplotlib.scale.SymmetricalLogTransform(base, linthresh, linscale)[source]

Базы: matplotlib.transforms.Transform

Параметры:
shorthand_namestr

Строка, представляющая «имя» преобразования. Имя не имеет никакого значения, кроме улучшения удобочитаемости str(transform) при DEBUG=True.

has_inverse = True
input_dims = 1
inverted()[source]

Возвращает соответствующее обратное преобразование.

Удовлетворяет x == self.inverted().transform(self.transform(x)).

Результат этого метода следует рассматривать как временный. Обновление self не вызывает соответствующего обновления его обратной копии.

is_separable = True
output_dims = 1
transform_non_affine(a)[source]

Применяет только неаффинную часть этого преобразования.

transform(values) всегда эквивалентно transform_affine(transform_non_affine(values)).

В неаффинных преобразованиях это обычно эквивалентно transform(values). В аффинных преобразованиях это всегда пустая операция.

Параметры:
valuesмассив

Вводные значения в виде массива NumPy длиной input_dims или формы (N x input_dims).

Возвращает:
массив

Выходные значения в виде массива NumPy длиной input_dims или формы (N x output_dims), в зависимости от входных данных.

matplotlib.scale.get_scale_names()[source]

Возвращает имена доступных масштабов.

matplotlib.scale.register_scale(scale_class)[source]

Регистрирует новый тип масштаба.

Параметры:
scale_classподкласс ScaleBase

Регистрируемый масштаб.

END_OF_DOCUMENT_MARKER
matplotlib.scale.scale_factory(scale, axis, **kwargs)[source]

Возвращает класс шкалы по имени.

Параметры:
scale{'функция', 'функцияlog', 'линейная', 'log', 'logit', 'symlog'}
axismatplotlib.axis.Axis

© 2012–2021 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.4.3/api/scale_api.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API