Spec-Zone.ru › Matplotlib 3.3

matplotlib.scale

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

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

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

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

Базы: matplotlib.scale.ScaleBase

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

Параметры:
axisAxis

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

functions(callable, callable)

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

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

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

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

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

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

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

Базы: matplotlib.scale.LogScale

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

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

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

functions(callable, callable)

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

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

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

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

property base
get_transform(self) [source]

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

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

Базы: matplotlib.transforms.Transform

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

Параметры:
forwardcallable

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

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

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

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

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

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

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

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

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

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

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

Параметры:
valuesarray

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

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

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

END_OF_DOCUMENT_MARKER
class matplotlib.scale.InvertedLogTransform(base) [source]

Основы: matplotlib.transforms.Transform

Параметры:
shorthand_namestr

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

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

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

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

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

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

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

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

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

Параметры:
valuesarray

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

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

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

class matplotlib.scale.InvertedSymmetricalLogTransform(base, linthresh, linscale) [source]

Основы: matplotlib.transforms.Transform

Параметры:
shorthand_namestr

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

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

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

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

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

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

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

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

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

Параметры:
valuesarray

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

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

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

class matplotlib.scale.LinearScale(axis, **kwargs) [source]

Основы: matplotlib.scale.ScaleBase

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

get_transform(self) [source]

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

name = 'linear'
set_default_locators_and_formatters(self, axis) [source]

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

class matplotlib.scale.LogScale(axis, **kwargs) [source]

Bases: matplotlib.scale.ScaleBase

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

Параметры:
axisAxis

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

basefloat, default: 10

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

nonpositive{'clip', 'mask'}, default: 'clip'

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

subssequence of int, default: None

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

property InvertedLogTransform
property LogTransform
property base
get_transform(self) [source]

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

limit_range_for_scale(self, vmin, vmax, minpos) [source]

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

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

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

class matplotlib.scale.LogTransform(**kwargs) [source]

Bases: matplotlib.transforms.Transform

Параметры:
shorthand_namestr

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

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

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

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

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

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

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

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

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

Параметры:
valuesarray

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

Возвращает:
array

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

class matplotlib.scale.LogisticTransform(**kwargs) [source]

Bases: matplotlib.transforms.Transform

Параметры:
shorthand_namestr

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

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

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

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

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

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

логарифмическое преобразование (по основанию 10)

class matplotlib.scale.LogitScale(**kwargs) [source]

Bases: matplotlib.scale.ScaleBase

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

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

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

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

nonpositive{'mask', 'clip'}

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

use_overlinebool, default: False

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

one_halfstr, default: r"frac{1}{2}"

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

get_transform(self) [source]

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

limit_range_for_scale(self, vmin, vmax, minpos) [source]

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

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

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

END_OF_DOCUMENT_MARKER
class matplotlib.scale.LogitTransform(**kwargs) [source]

Базы: matplotlib.transforms.Transform

Параметры:
shorthand_namestr

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

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

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

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

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

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

Логическое преобразование (основание 10), с маской или ограничением

class matplotlib.scale.ScaleBase(axis, **kwargs) [source]

Базы: object

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

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

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

  • name
  • get_transform()
  • set_default_locators_and_formatters()

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

  • limit_range_for_scale()

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

Примечания

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

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

get_transform(self) [source]

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

limit_range_for_scale(self, vmin, vmax, minpos) [source]

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

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

set_default_locators_and_formatters(self, axis) [source]

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

class matplotlib.scale.SymmetricalLogScale(axis, **kwargs) [source]

Базы: matplotlib.scale.ScaleBase

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

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

Параметры:
basefloat, default: 10

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

linthreshfloat, default: 2

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

subssequence of int

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

linscalefloat, optional

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

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

Примечания

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

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

property InvertedSymmetricalLogTransform
property SymmetricalLogTransform
property base
get_transform(self) [source]

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

property linscale
property linthresh
name = 'symlog'
set_default_locators_and_formatters(self, axis) [source]

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

END_OF_DOCUMENT_MARKER
class matplotlib.scale.SymmetricalLogTransform(base, linthresh, linscale) [source]

Bases: matplotlib.transforms.Transform

Параметры:
shorthand_namestr

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

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

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

Сохраняется x == self.inverted().transform(self.transform(x)).

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

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

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

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

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

Параметры:
valuesarray

Входные значения в виде массива 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_classsubclass of ScaleBase

Регистрируемая шкала.

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

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

Параметры:
scale{'function', 'functionlog', 'linear', 'log', 'logit', 'symlog'}
axismatplotlib.axis.Axis

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

Spec-Zone.ru

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