vispy.visuals package

Subpackages

• vispy.visuals.collections package
  • Submodules
    • vispy.visuals.collections.agg_fast_path_collection module
      • AggFastPathCollection
    • vispy.visuals.collections.agg_path_collection module
      • AggPathCollection
    • vispy.visuals.collections.agg_point_collection module
      • AggPointCollection
    • vispy.visuals.collections.agg_segment_collection module
      • AggSegmentCollection
    • vispy.visuals.collections.array_list module
      • Example
      • Example
      • ArrayList
    • vispy.visuals.collections.base_collection module
      • BaseCollection
      • Item
      • next_power_of_2()
    • vispy.visuals.collections.collection module
      • Collection
      • CollectionView
    • vispy.visuals.collections.path_collection module
      • PathCollection()
    • vispy.visuals.collections.point_collection module
      • PointCollection()
    • vispy.visuals.collections.polygon_collection module
      • PolygonCollection()
    • vispy.visuals.collections.raw_path_collection module
      • RawPathCollection
    • vispy.visuals.collections.raw_point_collection module
      • RawPointCollection
    • vispy.visuals.collections.raw_polygon_collection module
      • RawPolygonCollection
    • vispy.visuals.collections.raw_segment_collection module
      • RawSegmentCollection
    • vispy.visuals.collections.raw_triangle_collection module
      • RawTriangleCollection
    • vispy.visuals.collections.segment_collection module
      • SegmentCollection()
    • vispy.visuals.collections.triangle_collection module
      • TriangleCollection()
    • vispy.visuals.collections.util module
      • dtype_reduce()
      • fetchcode()
  • Module contents
• vispy.visuals.filters package
  • Subpackages
    • vispy.visuals.filters.tests package
      • Submodules
      • Module contents
  • Submodules
    • vispy.visuals.filters.base_filter module
      • BaseFilter
      • Filter
    • vispy.visuals.filters.clipper module
      • Clipper
    • vispy.visuals.filters.clipping_planes module
      • PlanesClipper
    • vispy.visuals.filters.color module
      • Alpha
      • ColorFilter
      • IsolineFilter
      • ZColormapFilter
    • vispy.visuals.filters.mesh module
      • InstancedShadingFilter
      • ShadingFilter
      • TextureFilter
      • WireframeFilter
    • vispy.visuals.filters.picking module
      • PickingFilter
  • Module contents
• vispy.visuals.glsl package
  • Submodules
    • vispy.visuals.glsl.antialiasing module
      • ANTIALIAS_OUTLINE
      • ANTIALIAS_STROKE
    • vispy.visuals.glsl.color module
  • Module contents
• vispy.visuals.graphs package
  • Subpackages
    • vispy.visuals.graphs.layouts package
      • Submodules
      • Module contents
    • vispy.visuals.graphs.tests package
      • Submodules
      • Module contents
  • Submodules
    • vispy.visuals.graphs.graph module
      • Graph Visual
      • GraphVisual
    • vispy.visuals.graphs.util module
      • Graph utilities
  • Module contents
• vispy.visuals.line package
  • Submodules
    • vispy.visuals.line.arrow module
      • ArrowVisual
    • vispy.visuals.line.dash_atlas module
      • DashAtlas
    • vispy.visuals.line.line module
      • LineVisual
  • Module contents
• vispy.visuals.shaders package
  • Subpackages
    • vispy.visuals.shaders.tests package
      • Submodules
      • Module contents
  • Submodules
    • vispy.visuals.shaders.compiler module
      • Compiler
    • vispy.visuals.shaders.expression module
      • Expression
      • FunctionCall
      • TextExpression
    • vispy.visuals.shaders.function module
      • Details
      • Function
      • FunctionChain
      • MainFunction
      • StatementList
    • vispy.visuals.shaders.multiprogram module
      • MultiProgram
      • MultiShader
    • vispy.visuals.shaders.parsing module
      • find_functions()
      • find_program_variables()
      • find_prototypes()
      • find_template_variables()
      • parse_function_signature()
    • vispy.visuals.shaders.program module
      • ModularProgram
    • vispy.visuals.shaders.shader_object module
      • ShaderObject
    • vispy.visuals.shaders.variable module
      • InVar
      • Variable
      • Varying
  • Module contents
    • Compiler
      • Compiler.compile()
    • Function
      • Function.args
      • Function.code
      • Function.definition()
      • Function.expression()
      • Function.name
      • Function.replace()
      • Function.rtype
      • Function.signature
      • Function.static_names()
      • Function.template_vars
    • FunctionChain
      • FunctionChain.append()
      • FunctionChain.code
      • FunctionChain.definition()
      • FunctionChain.functions
      • FunctionChain.insert()
      • FunctionChain.remove()
      • FunctionChain.signature
      • FunctionChain.static_names()
      • FunctionChain.template_vars
    • MainFunction
      • MainFunction.add_callback()
      • MainFunction.add_chain()
      • MainFunction.definition()
      • MainFunction.remove_callback()
      • MainFunction.signature
      • MainFunction.static_names()
      • MainFunction.version_pragma
    • ModularProgram
      • ModularProgram.build_if_needed()
      • ModularProgram.draw()
      • ModularProgram.frag
      • ModularProgram.geom
      • ModularProgram.update_variables()
      • ModularProgram.vert
    • MultiProgram
      • MultiProgram.add_program()
      • MultiProgram.bind()
      • MultiProgram.frag
      • MultiProgram.geom
      • MultiProgram.vert
    • Variable
      • Variable.definition()
      • Variable.dtype
      • Variable.expression()
      • Variable.name
      • Variable.state_id
      • Variable.value
      • Variable.vtype
    • Varying
      • Varying.dtype
      • Varying.invar()
      • Varying.link()
      • Varying.value
• vispy.visuals.tests package
  • Submodules
    • vispy.visuals.tests.test_arrows module
      • test_arrow_attributes()
      • test_arrow_draw()
      • test_arrow_reactive()
      • test_arrow_transform_draw()
    • vispy.visuals.tests.test_axis module
      • test_axis()
      • test_axis_zero_domain()
      • test_rotation_angle()
      • test_text_position()
      • test_tick_position()
    • vispy.visuals.tests.test_collections module
      • test_init()
    • vispy.visuals.tests.test_colorbar module
      • create_colorbar()
      • test_attributes()
      • test_colorbar_draw()
      • test_colorbar_label_as_textvisual()
      • test_colorbar_label_change()
      • test_reactive_draw()
    • vispy.visuals.tests.test_colormap module
      • test_colormap()
      • test_colormap_CubeHelix()
      • test_colormap_coolwarm()
      • test_colormap_discrete()
      • test_colormap_discrete_nu()
      • test_colormap_single_hue()
    • vispy.visuals.tests.test_ellipse module
      • test_arc_draw1()
      • test_circle_draw()
      • test_ellipse_draw()
      • test_reactive_draw()
    • vispy.visuals.tests.test_histogram module
      • test_histogram()
    • vispy.visuals.tests.test_image module
      • test_bad_init_gamma()
      • test_change_clim_float()
      • test_image()
      • test_image_clims_and_gamma()
      • test_image_equal_clims()
      • test_image_interpolation()
      • test_image_nan_rgb()
      • test_image_nan_single_band()
      • test_image_set_data_different_dtype()
      • test_image_vertex_updates()
    • vispy.visuals.tests.test_image_complex module
      • test_image_complex()
    • vispy.visuals.tests.test_infinite_line module
      • test_set_data()
    • vispy.visuals.tests.test_instanced_mesh module
      • setup_module()
      • teardown_module()
      • test_mesh_with_vertex_values()
    • vispy.visuals.tests.test_isosurface module
      • test_isosurface()
    • vispy.visuals.tests.test_linear_region module
      • test_linear_region_color()
      • test_linear_region_gradient()
      • test_linear_region_vertical_horizontal()
    • vispy.visuals.tests.test_markers module
      • test_empty_markers_symbol()
      • test_markers()
      • test_markers_edge_width()
    • vispy.visuals.tests.test_mesh module
      • test_intensity_or_color_as_rgba()
      • test_mesh_bounds()
      • test_mesh_color()
      • test_mesh_shading_change_from_none()
      • test_mesh_shading_filter()
      • test_mesh_shading_filter_colors()
      • test_mesh_shading_filter_enabled()
      • test_mesh_wireframe_filter()
      • test_mesh_with_vertex_values()
    • vispy.visuals.tests.test_mesh_normals module
      • test_mesh_normals()
      • test_mesh_normals_empty()
      • test_mesh_normals_length_array()
      • test_mesh_normals_length_method()
      • test_mesh_normals_length_scalar()
      • test_mesh_normals_length_scale()
    • vispy.visuals.tests.test_polygon module
      • test_reactive_draw()
      • test_rectangle_draw()
      • test_square_draw()
    • vispy.visuals.tests.test_rectangle module
      • test_attributes()
      • test_reactive_draw()
      • test_rectangle_draw()
      • test_rectpolygon_draw()
    • vispy.visuals.tests.test_regular_polygon module
      • test_reactive_draw()
      • test_regular_polygon_draw1()
      • test_regular_polygon_draw2()
    • vispy.visuals.tests.test_scalable_textures module
      • CPUScaledStub
      • GPUScaledStub
      • Stub
      • test_clim_handling_cpu()
      • test_clim_handling_gpu()
      • test_default_clim()
      • test_default_clim_non_finite()
    • vispy.visuals.tests.test_sdf module
      • test_sdf()
    • vispy.visuals.tests.test_spectrogram module
      • test_spectrogram()
    • vispy.visuals.tests.test_text module
      • test_face_bold_italic()
      • test_text()
      • test_text_depth_test()
      • test_text_rotation_update()
    • vispy.visuals.tests.test_volume module
      • test_all_render_methods()
      • test_changing_cmap()
      • test_equal_clims()
      • test_minip_cutoff()
      • test_mip_cutoff()
      • test_plane_depth()
      • test_set_data_changes_shape()
      • test_set_data_does_not_change_input()
      • test_volume()
      • test_volume_bounds()
      • test_volume_clims_and_gamma()
      • test_volume_depth()
      • test_volume_draw()
      • test_volume_set_data_different_dtype()
    • vispy.visuals.tests.test_windbarb module
      • test_windbarb_draw()
  • Module contents
• vispy.visuals.text package
  • Submodules
    • vispy.visuals.text.text module
      • FontManager
      • SDFRendererCPU
      • TextVisual
      • TextureFont
  • Module contents
• vispy.visuals.transforms package
  • Subpackages
    • vispy.visuals.transforms.tests package
      • Submodules
      • Module contents
  • Submodules
    • vispy.visuals.transforms.base_transform module
      • BaseTransform
      • InverseTransform
    • vispy.visuals.transforms.chain module
      • ChainTransform
      • SimplifiedChainTransform
    • vispy.visuals.transforms.interactive module
      • PanZoomTransform
    • vispy.visuals.transforms.linear module
      • MatrixTransform
      • NullTransform
      • STTransform
    • vispy.visuals.transforms.nonlinear module
      • LogTransform
      • Magnify1DTransform
      • MagnifyTransform
      • PolarTransform
    • vispy.visuals.transforms.transform_system module
      • TransformSystem
  • Module contents
    • ChainTransform
      • ChainTransform.Isometric
      • ChainTransform.Linear
      • ChainTransform.NonScaling
      • ChainTransform.Orthogonal
      • ChainTransform.append()
      • ChainTransform.glsl_imap
      • ChainTransform.glsl_map
      • ChainTransform.imap()
      • ChainTransform.map()
      • ChainTransform.prepend()
      • ChainTransform.shader_imap()
      • ChainTransform.shader_map()
      • ChainTransform.simplified
      • ChainTransform.transforms
    • LogTransform
      • LogTransform.Isometric
      • LogTransform.Linear
      • LogTransform.NonScaling
      • LogTransform.Orthogonal
      • LogTransform.base
      • LogTransform.glsl_imap
      • LogTransform.glsl_map
      • LogTransform.imap()
      • LogTransform.map()
      • LogTransform.shader_imap()
      • LogTransform.shader_map()
    • MatrixTransform
      • MatrixTransform.Isometric
      • MatrixTransform.Linear
      • MatrixTransform.NonScaling
      • MatrixTransform.Orthogonal
      • MatrixTransform.glsl_imap
      • MatrixTransform.glsl_map
      • MatrixTransform.imap()
      • MatrixTransform.inv_matrix
      • MatrixTransform.map()
      • MatrixTransform.matrix
      • MatrixTransform.reset()
      • MatrixTransform.rotate()
      • MatrixTransform.scale()
      • MatrixTransform.set_frustum()
      • MatrixTransform.set_mapping()
      • MatrixTransform.set_ortho()
      • MatrixTransform.set_perspective()
      • MatrixTransform.shader_imap()
      • MatrixTransform.shader_map()
      • MatrixTransform.translate()
    • NullTransform
      • NullTransform.Isometric
      • NullTransform.Linear
      • NullTransform.NonScaling
      • NullTransform.Orthogonal
      • NullTransform.glsl_imap
      • NullTransform.glsl_map
      • NullTransform.imap()
      • NullTransform.map()
    • PanZoomTransform
      • PanZoomTransform.attach()
      • PanZoomTransform.canvas_tr
      • PanZoomTransform.on_mouse_move()
      • PanZoomTransform.on_mouse_wheel()
      • PanZoomTransform.on_resize()
    • PolarTransform
      • PolarTransform.Isometric
      • PolarTransform.Linear
      • PolarTransform.NonScaling
      • PolarTransform.Orthogonal
      • PolarTransform.glsl_imap
      • PolarTransform.glsl_map
      • PolarTransform.imap()
      • PolarTransform.map()
    • STTransform
      • STTransform.Isometric
      • STTransform.Linear
      • STTransform.NonScaling
      • STTransform.Orthogonal
      • STTransform.as_matrix()
      • STTransform.from_mapping()
      • STTransform.glsl_imap
      • STTransform.glsl_map
      • STTransform.imap()
      • STTransform.map()
      • STTransform.move()
      • STTransform.scale
      • STTransform.set_mapping()
      • STTransform.shader_imap()
      • STTransform.shader_map()
      • STTransform.translate
      • STTransform.zoom()
    • TransformSystem
      • TransformSystem.canvas
      • TransformSystem.canvas_transform
      • TransformSystem.configure()
      • TransformSystem.document_transform
      • TransformSystem.dpi
      • TransformSystem.framebuffer_transform
      • TransformSystem.get_transform()
      • TransformSystem.pixel_scale
      • TransformSystem.scene_transform
      • TransformSystem.visual_transform

Submodules

• vispy.visuals.axis module
  • AxisVisual
    • AxisVisual.axis_color
    • AxisVisual.axis_font_size
    • AxisVisual.axis_label
    • AxisVisual.axis_label_margin
    • AxisVisual.axis_width
    • AxisVisual.domain
    • AxisVisual.major_tick_length
    • AxisVisual.minor_tick_length
    • AxisVisual.pos
    • AxisVisual.text_color
    • AxisVisual.tick_color
    • AxisVisual.tick_direction
    • AxisVisual.tick_font_size
    • AxisVisual.tick_label_margin
    • AxisVisual.tick_width
  • MaxNLocator
    • MaxNLocator.bin_boundaries()
    • MaxNLocator.tick_values()
    • MaxNLocator.view_limits()
  • Ticker
    • Ticker.get_update()
  • scale_range()
• vispy.visuals.border module
• vispy.visuals.box module
  • BoxVisual
    • BoxVisual.border
    • BoxVisual.mesh
• vispy.visuals.colorbar module
  • ColorBarVisual
    • ColorBarVisual.border_color
    • ColorBarVisual.border_width
    • ColorBarVisual.clim
    • ColorBarVisual.cmap
    • ColorBarVisual.label
    • ColorBarVisual.orientation
    • ColorBarVisual.pos
    • ColorBarVisual.size
    • ColorBarVisual.text_padding_factor
    • ColorBarVisual.ticks
• vispy.visuals.cube module
  • CubeVisual
• vispy.visuals.ellipse module
  • EllipseVisual
    • EllipseVisual.center
    • EllipseVisual.num_segments
    • EllipseVisual.radius
    • EllipseVisual.span_angle
    • EllipseVisual.start_angle
• vispy.visuals.gridlines module
  • GridLinesVisual
    • GridLinesVisual.size
• vispy.visuals.gridmesh module
  • GridMeshVisual
    • GridMeshVisual.set_data()
• vispy.visuals.histogram module
  • HistogramVisual
• vispy.visuals.image module
  • ImageVisual
    • ImageVisual.clim
    • ImageVisual.cmap
    • ImageVisual.custom_kernel
    • ImageVisual.gamma
    • ImageVisual.interpolation
    • ImageVisual.interpolation_functions
    • ImageVisual.method
    • ImageVisual.set_data()
    • ImageVisual.size
    • ImageVisual.view()
• vispy.visuals.image_complex module
  • ComplexImageVisual
    • ComplexImageVisual.COMPLEX_MODES
    • ComplexImageVisual.clim
    • ComplexImageVisual.complex_mode
    • ComplexImageVisual.set_data()
• vispy.visuals.infinite_line module
  • InfiniteLineVisual
    • InfiniteLineVisual.antialias
    • InfiniteLineVisual.color
    • InfiniteLineVisual.is_vertical
    • InfiniteLineVisual.line_width
    • InfiniteLineVisual.pos
    • InfiniteLineVisual.set_data()
• vispy.visuals.instanced_mesh module
  • InstancedMeshVisual
    • InstancedMeshVisual.instance_colors
    • InstancedMeshVisual.instance_positions
    • InstancedMeshVisual.instance_transforms
• vispy.visuals.isocurve module
  • IsocurveVisual
    • IsocurveVisual.color
    • IsocurveVisual.levels
    • IsocurveVisual.set_data()
• vispy.visuals.isoline module
  • IsolineVisual
    • IsolineVisual.color
    • IsolineVisual.data
    • IsolineVisual.levels
    • IsolineVisual.set_color()
    • IsolineVisual.set_data()
  • iso_mesh_line()
• vispy.visuals.isosurface module
  • IsosurfaceVisual
    • IsosurfaceVisual.level
    • IsosurfaceVisual.set_data()
• vispy.visuals.line_plot module
  • LinePlotVisual
    • LinePlotVisual.set_data()
• vispy.visuals.linear_region module
  • LinearRegionVisual
    • LinearRegionVisual.color
    • LinearRegionVisual.is_vertical
    • LinearRegionVisual.pos
    • LinearRegionVisual.set_data()
• vispy.visuals.markers module
  • MarkersVisual
    • MarkersVisual.alpha
    • MarkersVisual.antialias
    • MarkersVisual.light_ambient
    • MarkersVisual.light_color
    • MarkersVisual.light_position
    • MarkersVisual.scaling
    • MarkersVisual.set_data()
    • MarkersVisual.spherical
    • MarkersVisual.symbol
    • MarkersVisual.symbols
• vispy.visuals.mesh module
  • MeshVisual
    • MeshVisual.clim
    • MeshVisual.cmap
    • MeshVisual.color
    • MeshVisual.mesh_data
    • MeshVisual.mesh_data_changed()
    • MeshVisual.mode
    • MeshVisual.set_data()
    • MeshVisual.shading
• vispy.visuals.mesh_normals module
  • MeshNormalsVisual
    • MeshNormalsVisual.set_data()
• vispy.visuals.plane module
  • PlaneVisual
• vispy.visuals.polygon module
  • PolygonVisual
    • PolygonVisual.border
    • PolygonVisual.border_color
    • PolygonVisual.color
    • PolygonVisual.mesh
    • PolygonVisual.pos
• vispy.visuals.rectangle module
  • RectangleVisual
    • RectangleVisual.center
    • RectangleVisual.height
    • RectangleVisual.radius
    • RectangleVisual.width
• vispy.visuals.regular_polygon module
  • RegularPolygonVisual
    • RegularPolygonVisual.sides
• vispy.visuals.scrolling_lines module
  • ScrollingLinesVisual
    • ScrollingLinesVisual.fragment_code
    • ScrollingLinesVisual.roll_data()
    • ScrollingLinesVisual.set_color()
    • ScrollingLinesVisual.set_data()
    • ScrollingLinesVisual.set_pos_offset()
    • ScrollingLinesVisual.vertex_code
• vispy.visuals.spectrogram module
  • SpectrogramVisual
    • SpectrogramVisual.color_scale
    • SpectrogramVisual.freqs
    • SpectrogramVisual.fs
    • SpectrogramVisual.n_fft
    • SpectrogramVisual.normalize
    • SpectrogramVisual.step
    • SpectrogramVisual.window
    • SpectrogramVisual.x
• vispy.visuals.sphere module
  • SphereVisual
    • SphereVisual.border
    • SphereVisual.mesh
• vispy.visuals.surface_plot module
  • SurfacePlotVisual
    • SurfacePlotVisual.set_data()
• vispy.visuals.tube module
  • TubeVisual
• vispy.visuals.visual module
  • Definitions
  • Class Structure
  • Making Visual Subclasses
  • Making CompoundVisual Subclasses
  • BaseVisual
    • BaseVisual.attach()
    • BaseVisual.bounds()
    • BaseVisual.detach()
    • BaseVisual.draw()
    • BaseVisual.get_transform()
    • BaseVisual.transform
    • BaseVisual.transforms
    • BaseVisual.update()
    • BaseVisual.view()
    • BaseVisual.visible
  • BaseVisualView
    • BaseVisualView.visual
  • CompoundVisual
    • CompoundVisual.add_subvisual()
    • CompoundVisual.attach()
    • CompoundVisual.detach()
    • CompoundVisual.draw()
    • CompoundVisual.remove_subvisual()
    • CompoundVisual.set_gl_state()
    • CompoundVisual.update_gl_state()
  • CompoundVisualView
  • Visual
    • Visual.attach()
    • Visual.detach()
    • Visual.draw()
    • Visual.set_gl_state()
    • Visual.shared_program
    • Visual.update_gl_state()
    • Visual.view_program
  • VisualShare
  • VisualView
  • updating_property
    • updating_property.setter()
• vispy.visuals.volume module
  • About this technique
  • VolumeVisual
    • VolumeVisual.attenuation
    • VolumeVisual.clim
    • VolumeVisual.clipping_planes
    • VolumeVisual.clipping_planes_coord_system
    • VolumeVisual.cmap
    • VolumeVisual.gamma
    • VolumeVisual.interpolation
    • VolumeVisual.interpolation_methods
    • VolumeVisual.method
    • VolumeVisual.minip_cutoff
    • VolumeVisual.mip_cutoff
    • VolumeVisual.plane_normal
    • VolumeVisual.plane_position
    • VolumeVisual.plane_thickness
    • VolumeVisual.raycasting_mode
    • VolumeVisual.raycasting_modes
    • VolumeVisual.relative_step_size
    • VolumeVisual.rendering_methods
    • VolumeVisual.set_data()
    • VolumeVisual.threshold
• vispy.visuals.windbarb module
  • WindbarbVisual
    • WindbarbVisual.set_data()
• vispy.visuals.xyz_axis module
  • XYZAxisVisual

Module contents

This module provides a library of Visual classes, which are drawable objects intended to encapsulate simple graphic objects such as lines, meshes, points, 2D shapes, images, text, etc.

These classes define only the OpenGL machinery and connot be used directly in a scenegraph. For scenegraph use, see the complementary Visual+Node classes defined in vispy.scene.