Logo

User Documentation

  • Introduction
    • Why use PRISM?
    • When (not) to use PRISM?
  • Getting started
    • Installation
    • Running tests
    • Example usage
  • The PRISM pipeline
    • MPI implementation
  • ModelLink: A crash course
    • Writing a ModelLink subclass
    • Data identifiers (data_idx)
    • Wrapping a model (call_model)
      • Input arguments
      • Multi-calling
      • Backing up progress
    • Model discrepancy variance (md_var)
      • Theory
      • Implementation
  • Using PRISM
    • Minimal example
    • Projections
      • Properties
      • Options
      • Crystal (GUI)
    • Dual nature (normal/worker mode)
    • Hybrid sampling
      • Algorithm
      • Usage
      • Application
    • General usage rules
    • External data files
      • PRISM parameters file
      • Model parameters file
      • Model data file
  • Descriptions
    • Terminology
    • PRISM parameters
    • HDF5
  • FAQ
    • How do I contribute?
    • How do I report a bug/problem?
    • What does the term … mean?
    • Where can I get PRISM’s colormaps?
    • Which OSs are supported?
  • Community guidelines
    • License
    • Citation
    • Additions

API Reference

  • Pipeline
  • Emulator
    • Classes
      • Emulator
  • ModelLink
    • Classes
      • GaussianLink
      • ModelLink
      • PolyLink
      • SineWaveLink
    • Utilities
  • Utilities
  • Projection GUI
    • Classes
      • MainViewerWindow
      • OverviewDockWidget
      • ViewingAreaDockWidget
    • Widgets
      • GUI Base Layout Classes
      • GUI Base Widget Classes
      • GUI Widgets Core
      • GUI Widget Helpers
      • GUI Preferences
        • GUI Options
        • GUI Kwargs Dicts Options
        • GUI Custom Option Boxes
    • Functions
  • Internal
PRISM
  • Docs »
  • ModelLink »
  • PolyLink
  • Edit on GitHub
Next Previous

PolyLink¶

class prism.modellink.PolyLink(order=2, *args, **kwargs)[source]¶

ModelLink class wrapper for a simple polynomial model, used for testing the functionality of the PRISM pipeline.

Formatting data_idx

x : float
The value that needs to be used for \(x\) in the function \(\sum_i C_ix^i\) to obtain the data value.
__init__(order=2, *args, **kwargs)[source]¶

Initialize an instance of the PolyLink class.

Other Parameters:
 order (int. Default: 2) – The polynomial order to use for the polynomial model in this instance. The resulting number of model parameters n_par will be \(1+\mathrm{order}\).
order¶

Polynomial order used in this PolyLink instance.

Type:int
Next Previous

© Copyright 2019-2020, Ellert van der Velden Revision 1a876089.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions
latest
v1.3.1
v1.3.0
v1.2.3
v1.2.2
v1.2.1
v1.2.0.1
v1.2.0
v1.1.3
v1.1.2
v1.1.1
v1.0.x
v1.0.0
dev
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.