Glue Logo
rtd
  • Installing and running glue
  • Getting started
  • Advanced User Interface Guide
  • Using the IPython terminal in Glue
  • Working with Data objects
  • Starting Glue from Python
  • Visualizing Astronomical Dendrograms
  • Introduction to customizing/extending glue
  • List of available plugins
  • Configuring Glue via a startup file
  • Customizing your Glue environment
  • Distributing your own plugin package
  • Customizing the coordinate system of a data object
  • Programmatically configuring viewers
  • Writing a simple custom data viewer
  • Watching data for changes
  • Custom fitting plugins
  • Writing a custom viewer for glue
  • Writing a custom viewer for glue with Qt
  • Writing a custom viewer for glue with Qt and Matplotlib
  • Custom tools for viewers and custom toolbars
  • Defining your own data objects
  • Demo Videos
  • Frequently Asked Questions
  • Getting Help with Glue
  • Known issues and solutions
  • The selection/subset framework
  • The communication framework
  • The linking framework
  • Developer Guide
  • API
    • Core Data
      • glue.core.component Module
      • glue.core.component_id Module
      • glue.core.component_link Module
      • glue.core.coordinates Module
      • glue.core.data Module
      • glue.core.data_collection Module
      • glue.core.hub Module
      • glue.core.subset Module
      • glue.core.subset_group Module
      • glue.core.roi Module
      • glue.core.link_helpers Module
        • Classes
      • glue.core.data_factories Package
      • glue.core.fitters Module
      • glue.core.state_objects Module
      • glue.core.exceptions Module
      • glue.core.session Module
    • User Interface
    • Utilities
    • Bundled third-party packages
Glue
  • Docs »
  • API »
  • MultiLink
  • Edit on GitHub

MultiLink¶

class glue.core.link_helpers.MultiLink(cids1=None, cids2=None, forwards=None, backwards=None, labels1=None, labels2=None, **kwargs)[source]¶

Bases: glue.core.link_helpers.BaseMultiLink

A link collection that is generated on-the-fly based on forward and backward transformation functions and lists of input/output component IDs.

This is similar to BaseMultiLink() except that the forwards and backwards functions are specified in the initializer rather than being methods of the class.

Parameters
forwardsfunction

Function that maps cids1 to cids2. This should have the signature cids2 = forwards(*cids1), and is assumed to return a tuple. If not specified, no forward links are calculated.

backwardsfunction

The inverse function to forwards. If not specified, no forward links are calculated.

labels1list of str

The human-readable names of the inputs to the forwards function. If not specified, this is set to the argument names of forwards.

labels2list of str

The human-readable names of the inputs to the backwards function. If not specified, this is set to the argument names of backwards.

kwargs :

Additional arguments are passed

Next Previous

© Copyright 2012-2019, Chris Beaumont, Thomas Robitaille, Michelle Borkin Revision cfc88f18.

Built with Sphinx using a theme provided by Read the Docs.