ImageStack#

class ImageStack(*args: Any, id: ID | None = None, **kwargs: Any)[源代码]#

基类: ImageBase

使用 StackColorMapper 将作为 3D 堆叠数组给出的图像渲染为 RGBA 图像，方法是将每个堆栈展平。

3D 数组的形状为 (ny, nx, nstack)，其中 nstack 是堆栈的数量。 color_mapper 通过组合 nstack 方向上的数组值，为 (ny, nx) 中的每个像素生成 RGBA 值。

JSON 原型
{
  "anchor": "bottom_left", 
  "color_mapper": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "decorations": [], 
  "dh": {
    "field": "dh", 
    "type": "field"
  }, 
  "dilate": false, 
  "dw": {
    "field": "dw", 
    "type": "field"
  }, 
  "global_alpha": {
    "type": "value", 
    "value": 1.0
  }, 
  "id": "p58247", 
  "image": {
    "field": "image", 
    "type": "field"
  }, 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "origin": "bottom_left", 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "x": {
    "field": "x", 
    "type": "field"
  }, 
  "y": {
    "field": "y", 
    "type": "field"
  }
}
anchor = 'bottom_left'#
类型:

Either(Enum(Anchor), Tuple(Either(Enum(Align), Enum(HAlign), Percent), Either(Enum(Align), Enum(VAlign), Percent)))

图像的位置应锚定在 x、y 坐标处。

color_mapper = Undefined#
类型:

Instance(StackColorMapper)

用于将 image 中的标量数据映射到用于显示的 RGBA 值的 ScalarColorMapper。

注意

颜色映射步骤在客户端执行。

decorations = []#
类型:

列表

一系列标记装饰，例如箭头。

使用 GlyphRenderer.add_decoration() 可为标记渲染器中的所有标记轻松设置装饰。当需要更精细的控制时，请使用此属性。

注意

装饰仅用于辅助标记的视觉外观，但它们不会参与命中测试等。

dh = Field(field='dh', transform=Unspecified, units=Unspecified)#
类型:

DistanceSpec

图像将在其中占据的绘图区域的高度。

注意

这不是图像的高度像素数。该数字由图像本身固定。

dh_units = 'data'#
类型:

NotSerialized(Enum(SpatialUnits))

用于关联属性的单位：屏幕或数据

dilate = False#
类型:

布尔值

是否始终以使图像变大的方式对小数像素位置进行四舍五入。

如果像素舍入错误导致图像之间出现间隙，而它们应该紧密相邻，则此设置可能有用。

dw = Field(field='dw', transform=Unspecified, units=Unspecified)#
类型:

DistanceSpec

图像将占据的绘图区域的宽度。

注意

这不是图像的像素宽度。该数量由图像本身固定。

dw_units = 'data'#
类型:

NotSerialized(Enum(SpatialUnits))

用于关联属性的单位：屏幕或数据

global_alpha = 1.0#
类型:

AlphaSpec

图像的全局 alpha 值。

image = Field(field='image', transform=Unspecified, units=Unspecified)#
类型:

NumberSpec

图像的数据的 3D 数组。

name = None#
类型:

Nullable(String)

此模型的任意用户提供的名称。

此名称在查询文档以检索特定 Bokeh 模型时可能很有用。

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

不保证任何提供的名称的唯一性或其他条件，Bokeh 也不会出于任何原因直接使用该名称。

origin = 'bottom_left'#
类型:

Enum(ImageOrigin)

定义图像的坐标空间。

syncable = True#
类型:

布尔值

指示此模型在 Web 浏览器中更新时是否应同步回 Bokeh 服务器。设置为 False 可能有助于在处理经常更新的对象时减少网络流量，这些对象的更新值我们不需要。

注意

将此属性设置为 False 将阻止对此对象的任何 on_change() 回调触发。但是，任何 JS 端回调仍然可以工作。

tags = []#
类型:

列表

一个可选的任意用户提供的值的列表，用于附加到此模型。

此数据在查询文档以检索特定 Bokeh 模型时可能很有用

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者只是将任何必要的元数据附加到模型的一种便捷方式，这些元数据可以通过 CustomJS 回调等访问。

注意

不保证任何提供的标签的唯一性或其他条件，Bokeh 也不会出于任何原因直接使用这些标签。

x = Field(field='x', transform=Unspecified, units=Unspecified)#
类型:

NumberSpec

定位图像锚点的 x 坐标。

y = Field(field='y', transform=Unspecified, units=Unspecified)#
类型:

NumberSpec

定位图像锚点的 y 坐标。

apply_theme(property_values: dict[str, Any]) → None#

应用一组主题值，这些值将用作默认值，但不会覆盖应用程序设置的值。

传递的字典可以保留原样，并与其他实例共享以节省内存（因此，调用者和 HasProps 实例都不应该修改它）。

参数:

property_values (dict) – 要用作默认值的主题值

返回:

None

classmethod clear_extensions() → None#

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论是否使用。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self#

复制 HasProps 对象。

这会创建原始模型的浅克隆，即任何可变容器或子模型都不会被复制。允许在克隆时覆盖特定属性。

classmethod dataspecs() → dict[str, DataSpec]#

收集此类上所有 DataSpec 属性的名称。

此方法始终遍历类层次结构，并包括在任何父类中定义的属性。

返回:

DataSpec 属性的名称

返回类型:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]#

按定义顺序排列的属性描述符列表。

destroy() → None#

清理对文档和属性的引用

equals(other: HasProps) → bool#

模型的结构等效性。

参数:

other (HasProps) – 要比较的另一个实例

返回:

如果属性在结构上相等，则为 True，否则为 False

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一个简便方法，它简化了添加 CustomJS 回调以更新一个 Bokeh 模型属性，只要另一个属性更改值。

参数:

  • attr (str) – 此模型上 Bokeh 属性的名称

  • other (Model) – 要链接到 self.attr 的 Bokeh 模型

  • other_attr (str) – 要链接在一起的 other 上的属性

  • attr_selector (int | str) – 链接可索引 attr 中项目的索引

在版本 1.1 中添加

引发：

ValueError –

示例

这段使用 js_link 的代码

select.js_link('value', plot, 'sizing_mode')

等效于以下代码

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧附加到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)
js_on_change(event: str, *callbacks: JSChangeCallback) → None#

将 CustomJS 回调附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件具有 "change:property_name" 的形式。为了方便起见，如果传递给此方法的事件名称也是模型上的属性名称，则它会自动以 "change:" 为前缀

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

但是，除了属性更改事件之外，还有其他类型的事件可以用来响应。例如，要运行在数据流式传输到 ColumnDataSource 时触发的回调，请在源上使用 "stream" 事件

source.js_on_change('streaming', callback)
classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None#

在类上查找 Bokeh 属性的 PropertyDescriptor，给定属性名称。

参数:

  • name (str) – 要搜索的属性名称

  • raises (bool) – 如果缺少，是否要引发异常或返回 None

返回:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None#

在该对象上添加一个回调，以在 attr 更改时触发。

参数:

  • attr (str) – 该对象上的属性名称

  • *callbacks (callable) – 要注册的回调函数

返回:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None#

当此模型上发生指定的事件时，运行回调。

并非所有模型都支持所有事件。有关哪些模型能够触发哪些事件的详细信息，请参见 bokeh.events 中的特定事件。

classmethod parameters() → list[Parameter]#

生成适合从字形派生的函数的 Python Parameter 值。

返回:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]#

收集此类上的属性名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，该字典将属性名称映射到属性对象。为了使当前使用此方法的代码将来能够使用，请将返回值包装在 list 中。

返回:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]#

收集此类上所有具有引用属性的名称。

此方法始终遍历类层次结构，并包括在任何父类中定义的属性。

返回:

具有引用的属性名称

返回类型:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]#

收集一个字典，将属性名称映射到它们的值。

此方法始终遍历类层次结构，并包括在任何父类中定义的属性。

不可序列化的属性将被跳过，属性值将以“序列化”格式显示，这可能与您通常从属性中读取的值略有不同；此方法的目的是返回无损地重构对象实例所需的信息。

参数:

include_defaults (bool, optional) – 是否包含自对象创建以来未显式设置的属性。（默认值：True）

返回:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]#

使用谓词查询 HasProps 实例的属性值。

参数:

  • query (callable) – 一个可调用对象，它接受属性描述符并返回 True 或 False

  • include_defaults (bool, optional) – 是否包含用户未显式设置的属性（默认值：True）

返回:

匹配属性的属性名称和值的映射

返回类型:

dict

references() → set[Model]#

返回此对象引用的所有Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None#

从该对象中移除一个回调函数。

select(selector: SelectorType) → Iterable[Model]#

查询该对象及其所有引用，以查找与给定选择器匹配的对象。

参数:

selector (JSON-like)

返回:

seq[Model]

select_one(selector: SelectorType) → Model | None#

查询该对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则会引发错误。返回单个匹配对象，如果没有找到，则返回 None :param selector: :type selector: JSON-like

返回:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None#

从 JSON 中设置对象上的属性值。

参数:

  • name (str) – 要设置的属性的名称

  • value (JSON-value) – 要设置到属性的值

  • setter (ClientSession or ServerSession or None, optional) –

    这用于防止对 Bokeh 应用程序的“回旋镖”更新。

    在 Bokeh 服务器应用程序的上下文中，传入的属性更新将用进行更新的会话进行注释。该值会传播到更新触发的任何后续更改通知中。会话可以将事件设置程序与自身进行比较，并抑制来自自身的所有更新。

返回:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None#

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

  • selector (JSON-like)

  • updates (dict)

返回:

None

themed_values() → dict[str, Any] | None#

获取主题提供的任何覆盖。

结果将以从属性名称到值的字典形式返回，如果主题没有覆盖该实例的任何值，则返回 None。

返回:

字典或 None

to_serializable(serializer: Serializer) → ObjectRefRep#

将此对象转换为可序列化表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None#
unapply_theme() → None#

移除任何主题值并恢复默认值。

返回:

None

更新(**kwargs: Any) → None#

使用给定的关键字参数更新对象的属性。

返回:

None

示例

以下等效：

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)
属性 document: Document | None#

此模型附加到的 Document（可以是 None）