From 7a876112c8513bdc383b6d71a6a38c950708b638 Mon Sep 17 00:00:00 2001 From: jmbhughes Date: Mon, 1 Apr 2024 17:24:39 +0000 Subject: [PATCH] deploy: cd11489e6dabe2b552e4e8cea873357ec578cb8c --- _sources/development.rst.txt | 1 + development.html | 3 ++- searchindex.js | 2 +- 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/_sources/development.rst.txt b/_sources/development.rst.txt index 35ce64b..6ccb87f 100644 --- a/_sources/development.rst.txt +++ b/_sources/development.rst.txt @@ -1,6 +1,7 @@ Development ============ We encourage all contributions. Please see our `contribution guide first `_. +If you're contributing code, we recommend reading `our project-wide evelopment guide `_. We recommend working in a virtual environment. diff --git a/development.html b/development.html index 3ba1ac7..c12578c 100644 --- a/development.html +++ b/development.html @@ -428,7 +428,8 @@

Development#

-

We encourage all contributions. Please see our contribution guide first.

+

We encourage all contributions. Please see our contribution guide first. +If you’re contributing code, we recommend reading our project-wide evelopment guide.

We recommend working in a virtual environment. This can be created by running python -m venv venv. Then, activate the environment with source venv/bin/activate. You can then install the required packages with pip install -r requirements_dev.txt.

diff --git a/searchindex.js b/searchindex.js index 27e2017..2d0472a 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["autoapi/index", "autoapi/solpolpy/alpha/index", "autoapi/solpolpy/constants/index", "autoapi/solpolpy/core/index", "autoapi/solpolpy/errors/index", "autoapi/solpolpy/graph/index", "autoapi/solpolpy/index", "autoapi/solpolpy/instruments/index", "autoapi/solpolpy/plotting/index", "autoapi/solpolpy/polarizers/index", "cite", "development", "example", "help", "index", "quickstart"], "filenames": ["autoapi/index.rst", "autoapi/solpolpy/alpha/index.rst", "autoapi/solpolpy/constants/index.rst", "autoapi/solpolpy/core/index.rst", "autoapi/solpolpy/errors/index.rst", "autoapi/solpolpy/graph/index.rst", "autoapi/solpolpy/index.rst", "autoapi/solpolpy/instruments/index.rst", "autoapi/solpolpy/plotting/index.rst", "autoapi/solpolpy/polarizers/index.rst", "cite.rst", "development.rst", "example.ipynb", "help.rst", "index.rst", "quickstart.rst"], "titles": ["API Reference", "solpolpy.alpha", "solpolpy.constants", "solpolpy.core", "solpolpy.errors", "solpolpy.graph", "solpolpy", "solpolpy.instruments", "solpolpy.plotting", "solpolpy.polarizers", "Cite", "Development", "Examples", "Help", "Welcome to solpolpy\u2019s documentation!", "Quickstart"], "terms": {"thi": [0, 3, 7, 11, 12, 13, 15], "page": [0, 14, 15], "contain": [0, 12], "auto": 0, "gener": [0, 3], "document": [0, 3, 11, 12, 15], "1": [0, 3, 9, 14, 15], "solpolpi": [0, 15], "alpha": [0, 3, 6, 8, 9, 12], "constant": [0, 6], "core": [0, 6], "error": [0, 6], "graph": [0, 3, 6], "instrument": [0, 3, 6, 12], "plot": [0, 6, 12, 14], "polar": [0, 1, 3, 6, 14, 15], "creat": [0, 1, 11], "sphinx": [0, 11], "autoapi": 0, "relat": 1, "construct": [1, 5, 7], "an": [1, 3, 7, 8, 12, 13, 14], "arrai": [1, 3, 8, 12], "transform": [1, 3, 5, 12, 14, 15], "radial_north": 1, "shape": [1, 3, 7], "orient": 1, "west": [1, 9], "paramet": [1, 3, 7, 8, 12, 15], "tupl": [1, 3, 7, 8, 12], "int": [1, 3, 7, 8, 12], "how": [1, 12], "big": 1, "should": 1, "return": [1, 3, 7, 8, 12], "us": [1, 2, 3, 8, 10, 11, 12, 13, 14, 15], "calcul": [1, 3], "type": [1, 3, 7, 8, 12], "np": [1, 7, 8, 9, 12], "ndarrai": [1, 3, 7, 8, 12], "note": [1, 9, 11, 12], "assum": 1, "solar": [1, 3, 7, 12, 14, 15], "north": 1, "i": [1, 3, 7, 8, 9, 11, 12, 13, 14, 15], "up": [1, 13, 14], "0": [1, 3, 12, 14], "along": [1, 3, 12], "axi": 1, "radial": [1, 3, 7, 12], "map": [1, 8], "angl": [1, 3, 9, 12, 14, 15], "increas": [1, 3], "counterclockwis": 1, "direct": [1, 3, 12], "alpha_funct": 1, "code": [2, 7, 11, 13], "valid_kind": 2, "resolv": [3, 14], "input_data": [3, 12], "list": [3, 7, 8, 9, 12], "str": [3, 7, 8, 12], "ndcube": [3, 7, 8, 12], "ndcollect": [3, 7, 8, 12], "out_system": [3, 12, 15], "imax_effect": [3, 15], "bool": [3, 7, 8, 12], "fals": [3, 7, 8, 12], "appli": [3, 8, 12], "set": [3, 12, 14, 15], "input": [3, 8, 9, 14, 15], "datafram": 3, "either": [3, 12], "collect": [3, 8, 12, 15], "where": [3, 7, 12], "each": [3, 8, 12], "member": 3, "ha": [3, 12, 14, 15], "expect": [3, 12], "name": [3, 8, 12], "2": [3, 9, 14, 15], "path": [3, 7, 12, 15], "fit": [3, 7, 8, 12, 15], "file": [3, 7, 8, 12], "we": [3, 11, 12, 13, 15], "recommend": [3, 11, 15], "option": [3, 7, 8, 12, 15], "string": [3, 8, 12], "The": [3, 7, 9, 11, 12, 14, 15], "state": [3, 12], "you": [3, 10, 11, 12, 13, 15], "want": [3, 11, 12, 13], "convert": [3, 12, 14, 15], "your": [3, 13], "must": [3, 11], "one": [3, 15], "follow": [3, 11, 15], "mzp": [3, 12, 15], "triplet": [3, 14], "imag": [3, 7, 9, 12, 14, 15], "taken": [3, 12], "60": [3, 12, 14], "btbr": [3, 12], "pair": [3, 14], "tangenti": [3, 12], "respect": [3, 12, 14], "sun": [3, 12], "stoke": [3, 14], "total": [3, 12], "bright": [3, 14], "vertic": [3, 12], "horizont": [3, 12], "ax": [3, 8, 12], "q": [3, 12, 14], "45": [3, 12], "u": [3, 11, 12, 14], "bpb": [3, 12, 15], "excess": [3, 12], "bp3": [3, 12], "analog": [3, 12], "rotat": [3, 12], "around": [3, 12], "instead": [3, 12], "fix": [3, 12], "frame": [3, 12], "refer": [3, 12, 14], "bthp": [3, 12], "degre": [3, 9, 12], "fourpol": 3, "For": [3, 12], "observ": [3, 12, 15], "sequenc": 3, "four": 3, "e": [3, 9, 12], "90": 3, "135": 3, "npol": 3, "than": [3, 7, 13, 15], "three": [3, 9, 12], "other": [3, 7, 11, 13], "boolean": 3, "imax": [3, 14], "effect": [3, 14], "describ": [3, 15], "chang": [3, 12], "appar": [3, 15], "measur": 3, "result": [3, 9, 12, 14], "foreshorten": [3, 15], "becom": 3, "more": [3, 12, 15], "pronounc": 3, "wide": [3, 15], "field": [3, 15], "see": [3, 7, 11, 12], "patel": 3, "et": [3, 9, 12, 15], "al": [3, 9, 12, 15], "2024": 3, "prepar": 3, "If": [3, 7, 9, 11, 12, 13, 15], "true": [3, 7, 8, 12, 15], "part": [3, 14], "resolut": 3, "process": 3, "rais": 3, "assertionerror": 3, "get": [3, 7, 9, 11, 15], "data": [3, 7, 8, 14, 15], "cannot": 3, "due": 3, "discontinu": 3, "infin": 3, "ar": [3, 7, 8, 9, 11, 12, 15], "most": 3, "maintain": 3, "dimension": 3, "sourc": [3, 11, 14], "vector": 3, "some": [3, 8, 12], "emb": 3, "project": [3, 12], "decreas": 3, "addit": [3, 8, 12], "dimens": [3, 7, 12], "present": [3, 12, 15], "still": 3, "append": 3, "output": [3, 8, 12, 14, 15], "all": [3, 4, 11, 12, 13], "ani": [3, 7, 8, 9, 11, 12, 15], "case": [3, 12], "determine_input_kind": 3, "determin": [3, 12], "what": [3, 12], "kind": [3, 12], "wa": [3, 12], "evalu": 3, "valid": [3, 7, 15], "full": 3, "under": 3, "get_transform_path": 3, "input_kind": 3, "output_kind": 3, "given": 3, "system": [3, 14], "requir": [3, 11, 15], "from": [3, 7, 8, 10, 12, 13, 15], "start": [3, 13, 15], "point": 3, "end": [3, 12], "identifi": 3, "get_transform_equ": 3, "callabl": 3, "compos": 3, "equat": [3, 9, 15], "execut": [3, 11], "check_alpha_requir": 3, "through": [3, 15], "whether": [3, 8, 12], "generate_imax_matrix": 3, "arrayshap": 3, "numpi": [3, 7], "defin": [3, 7], "A": 3, "matrix": 3, "which": [3, 15], "camera": 3, "coord": 3, "x": [3, 7, 8, 12], "wc": [3, 7, 12], "between": [3, 7, 12, 14], "coordin": [3, 7, 12], "resolve_imax_effect": 3, "provid": [3, 8, 12, 15], "correct": [3, 15], "fov": [3, 15], "_determine_image_shap": 3, "input_collect": [3, 9, 15], "add_alpha": 3, "add": [3, 12], "dataset": [3, 12], "_compose2": 3, "f": 3, "g": [3, 12], "togeth": [3, 12], "outer": [3, 7], "inner": [3, 7], "ident": 3, "valu": [3, 8, 9, 12], "back": 3, "except": 4, "toofewfileserror": 4, "base": [4, 11, 12, 15], "common": [4, 7], "class": 4, "non": [4, 15], "exit": 4, "unsupportedinstrumenterror": 4, "unsupportedtransformationerror": 4, "transform_graph": 5, "specif": 7, "load_data": [7, 12, 15], "path_list": 7, "mask": [7, 9, 12], "none": [7, 8, 9, 12], "use_instrument_mask": [7, 12], "basic": 7, "load": [7, 12], "load_with_occulter_mask": 7, "param": [7, 8], "coupl": [7, 12], "overrid": 7, "comput": 7, "when": [7, 9, 11], "get_instrument_mask": 7, "object": [7, 12], "header": [7, 8, 12], "inform": [7, 12], "avail": 7, "kei": [7, 12], "label": [7, 8, 12], "angle_1": [7, 12], "angle_2": [7, 12], "angle_3": [7, 12], "construct_mask": 7, "inner_radiu": 7, "float": [7, 8, 12], "outer_radiu": 7, "center_x": 7, "center_i": 7, "indic": [7, 12], "pixel": 7, "invalid": 7, "distanc": 7, "everi": 7, "standard": 7, "coronograph": 7, "radiu": 7, "closer": 7, "center": 7, "farther": 7, "y": [7, 8, 12], "mark": [7, 8, 12], "those": [7, 11], "less": 7, "greater": 7, "astropi": [7, 8, 12], "io": [7, 8], "support": [7, 13, 15], "lasco": [7, 12, 14], "cosmo": 7, "k": 7, "secchi": 7, "question": 7, "out": [7, 12], "flag": 7, "plot_collect": [8, 12, 15], "figsiz": [8, 12], "8": [8, 12], "show_colorbar": [8, 12], "lat_tick": [8, 12], "lon_tick": [8, 12], "major_formatt": [8, 12], "dd": [8, 12], "xlabel": [8, 12], "hp": [8, 12], "longitud": [8, 12], "ylabel": [8, 12], "latitud": [8, 12], "vmin": [8, 12], "vmax": [8, 12], "cmap": [8, 12], "greys_r": [8, 12], "ignore_alpha": [8, 12], "fontsiz": [8, 12], "18": [8, 12], "visual": [8, 12], "figur": [8, 11, 12], "size": [8, 12], "accord": [8, 12], "matplotlib": [8, 12], "show": [8, 12, 14], "colorbar": [8, 12], "tick": [8, 12], "default": [8, 12], "otherwis": [8, 9, 12], "formatt": [8, 12], "major": [8, 12], "tickmark": [8, 12], "specifi": [8, 12], "minimum": [8, 12], "thei": [8, 12], "left": [8, 12], "right": [8, 12], "maximum": [8, 12], "colormap": [8, 12], "accept": [8, 12], "normal": [8, 12], "help": [8, 12, 14], "font": [8, 12], "aspect": [8, 12], "edit": [8, 12], "get_colormap_str": [8, 12], "meta": [8, 12], "retriev": 8, "color": 8, "appropri": [8, 12, 15], "found": [9, 12, 15], "deforest": [9, 12, 15], "c": 9, "seaton": 9, "d": 9, "b": [9, 12, 15], "m": [9, 11], "j": 9, "2022": [9, 12, 15], "treatment": 9, "linear": [9, 15], "coronagraph": 9, "heliospher": 9, "astrophys": 9, "journal": 9, "927": 9, "98": 9, "conv_polar_from_head": 9, "input_cub": 9, "npol_to_mzp": 9, "44": [9, 15], "mzp_to_bpb": 9, "7": [9, 12], "9": [9, 12], "bpb_to_mzp": 9, "4": [9, 12], "bpb_to_btbr": 9, "btbr_to_bpb": 9, "tabl": 9, "mzp_to_stok": 9, "12": [9, 12], "13": [9, 12], "stokes_to_mzp": 9, "11": [9, 12], "pi": 9, "mzp_to_bp3": 9, "10": [9, 12], "bp3_to_mzp": 9, "btbr_to_mzp": 9, "3": [9, 14], "bp3_to_bthp": 9, "15": [9, 12], "16": [9, 12], "btbr_to_npol": 9, "fourpol_to_stok": 9, "combine_mask": 9, "arg": 9, "combin": 9, "doe": [9, 11], "logic": 9, "To": [10, 11, 12, 15], "softwar": 10, "pleas": [10, 11, 12, 13], "citat": 10, "zenodo": 10, "version": [10, 12], "encourag": [11, 13], "contribut": 11, "our": [11, 12], "guid": 11, "first": [11, 12, 13, 15], "work": 11, "virtual": 11, "environ": 11, "can": [11, 12, 13, 15], "python": [11, 14], "venv": 11, "Then": 11, "activ": 11, "bin": 11, "instal": [11, 15], "packag": [11, 12, 13, 14, 15], "pip": [11, 15], "r": 11, "requirements_dev": 11, "txt": 11, "time": 11, "issu": [11, 13], "contact": 11, "guidelin": 11, "here": 11, "ll": [11, 12], "need": [11, 13], "check": 11, "style": 11, "consist": 11, "It": [11, 12, 14, 15], "do": [11, 12], "them": [11, 12], "now": [11, 12], "everytim": 11, "built": 11, "navig": 11, "directori": 11, "make": [11, 13], "html": 11, "rerun": 11, "exampl": [11, 14, 15], "jupyt": 11, "notebook": 11, "manual": [11, 12], "updat": 11, "pytest": 11, "repositori": 11, "variou": 12, "format": 12, "nativ": 12, "tripl": 12, "also": 12, "known": 12, "convent": 12, "pb": 12, "etc": 12, "basi": [12, 14], "c2": [12, 14], "shown": [12, 14], "below": [12, 14], "top": [12, 14], "panel": [12, 14], "bm": [12, 14], "bz": [12, 14], "bp": [12, 14], "bottom": [12, 14], "initi": [12, 14], "invok": 12, "simpl": 12, "interfac": 12, "sp": 12, "sunpi": 12, "desir": [12, 15], "util": 12, "function": [12, 15], "call": 12, "There": 12, "minu": 12, "zero": 12, "plu": 12, "unpolar": 12, "orthogon": 12, "\u03b1": 12, "unlik": 12, "later": 12, "theta": 12, "phi": 12, "polarz": 12, "2010": 12, "04": 12, "03": 12, "ut": 12, "These": 12, "substitut": 12, "have": 12, "glob": 12, "pyplot": 12, "plt": 12, "rcparam": 12, "famili": 12, "serif": 12, "stereo_path": 12, "ft": 12, "altern": 12, "pass": 12, "filenam": 12, "method": [12, 15], "showcas": 12, "howev": 12, "control": 12, "In": [12, 15], "becaus": 12, "stereo_collect": 12, "warn": 12, "fitsfixedwarn": 12, "crota": 12, "7105675": 12, "keyword": [12, 15], "look": 12, "veri": 12, "much": 12, "like": [12, 13], "crotan": 12, "isn": 12, "39": 12, "t": 12, "datfix": 12, "made": 12, "mjd": 12, "ob": 12, "55289": 12, "423090": 12, "date": 12, "avg": 12, "423218": 12, "423345": 12, "7106929": 12, "422743": 12, "422870": 12, "422998": 12, "7109408": 12, "422396": 12, "422523": 12, "422651": 12, "re": [12, 13, 15], "familiar": 12, "http": 12, "doc": [12, 14], "org": 12, "essenti": 12, "multipl": 12, "world": 12, "uncertainti": 12, "metadata": 12, "dict_kei": 12, "number": 12, "know": 12, "cube": [12, 15], "lt": 12, "0x10765a110": 12, "gt": 12, "2048": 12, "pix": 12, "physic": [12, 14, 15], "custom": 12, "po": 12, "helioproject": 12, "lon": 12, "lat": 12, "unit": 12, "uint16": 12, "": [12, 13], "particularli": 12, "That": 12, "track": 12, "240": 12, "5": 12, "inspect": 12, "entir": 12, "6": 12, "put": 12, "just": [12, 15], "so": [12, 13], "line": 12, "long": 12, "written": 12, "idl": 12, "mon": 12, "apr": 12, "17": 12, "bitpix": 12, "naxi": 12, "naxis1": 12, "naxis2": 12, "extend": 12, "03t10": 12, "09": 12, "006": 12, "fileorig": 12, "a4030234": 12, "411": 12, "seb_prog": 12, "sync": 12, "two": [12, 15], "mani": [12, 15], "argument": 12, "suggest": 12, "modul": [12, 14], "20": 12, "10_000": 12, "directli": 12, "scienc": 12, "differ": [12, 14, 15], "avoid": 12, "output_bpb": 12, "As": 12, "earlier": 12, "well": 12, "produc": 12, "access": [12, 15], "4118": 12, "66666667": 12, "4117": 12, "33333333": 12, "4116": 12, "4122": 12, "4121": 12, "4120": 12, "4125": 12, "4113": 12, "4114": 12, "4124": 12, "forget": 12, "deal": 12, "same": 12, "wai": [12, 15], "14": 12, "20000": 12, "200": 12, "could": 12, "output_stok": 12, "onc": 12, "again": 12, "bi": 12, "bq": 12, "bu": 12, "500": 12, "ask": 12, "run": [12, 14], "command": 12, "origin": 12, "convers": 12, "behind": 12, "scene": 12, "ever": 12, "imposs": 12, "let": 12, "thank": 13, "notic": 13, "bug": 13, "open": [13, 14], "github": 13, "discuss": 13, "rather": 13, "email": 13, "benefit": 13, "inquiri": 13, "too": 13, "user": 13, "friendli": 13, "possibl": 13, "encount": 13, "someon": 13, "els": 13, "everyon": 13, "speak": 13, "heliophys": 14, "been": 14, "develop": 14, "punch": [14, 15], "mission": 14, "quickstart": 14, "handl": 14, "import": [14, 15], "view": [14, 15], "stereo": 14, "take": [14, 15], "shortcut": 14, "cite": 14, "pre": 14, "commit": 14, "build": 14, "test": 14, "api": 14, "index": 14, "search": 14, "unfamiliar": 15, "comprehens": 15, "allow": 15, "relev": 15, "find": 15, "detail": 15, "descript": 15, "easiest": 15, "interact": 15, "path_to_image0": 15, "path_to_image1": 15, "path_to_image2": 15, "output_collect": 15, "print": 15, "anoth": 15, "wfi": 15, "suffer": 15, "across": 15, "deviat": 15, "ideal": 15, "spatial": 15, "locat": 15, "draw": 15, "parallel": 15, "3d": 15, "screen": 15, "about": 15, "soon": 15, "publish": 15, "research": 15, "articl": 15, "configur": 15}, "objects": {"": [[6, 0, 0, "-", "solpolpy"]], "solpolpy": [[1, 0, 0, "-", "alpha"], [2, 0, 0, "-", "constants"], [3, 0, 0, "-", "core"], [4, 0, 0, "-", "errors"], [5, 0, 0, "-", "graph"], [7, 0, 0, "-", "instruments"], [8, 0, 0, "-", "plotting"], [9, 0, 0, "-", "polarizers"]], "solpolpy.alpha": [[1, 1, 1, "", "ALPHA_FUNCTIONS"], [1, 2, 1, "", "radial_north"]], "solpolpy.constants": [[2, 1, 1, "", "VALID_KINDS"]], "solpolpy.core": [[3, 2, 1, "", "_compose2"], [3, 2, 1, "", "_determine_image_shape"], [3, 2, 1, "", "add_alpha"], [3, 2, 1, "", "check_alpha_requirement"], [3, 2, 1, "", "determine_input_kind"], [3, 2, 1, "", "generate_imax_matrix"], [3, 2, 1, "", "get_transform_equation"], [3, 2, 1, "", "get_transform_path"], [3, 2, 1, "", "identity"], [3, 2, 1, "", "resolve"], [3, 2, 1, "", "resolve_imax_effect"]], "solpolpy.errors": [[4, 3, 1, "", "TooFewFilesError"], [4, 3, 1, "", "UnsupportedInstrumentError"], [4, 3, 1, "", "UnsupportedTransformationError"]], "solpolpy.graph": [[5, 1, 1, "", "transform_graph"]], "solpolpy.instruments": [[7, 2, 1, "", "construct_mask"], [7, 2, 1, "", "get_instrument_mask"], [7, 2, 1, "", "load_data"]], "solpolpy.plotting": [[8, 2, 1, "", "get_colormap_str"], [8, 2, 1, "", "plot_collection"]], "solpolpy.polarizers": [[9, 2, 1, "", "bp3_to_bthp"], [9, 2, 1, "", "bp3_to_mzp"], [9, 2, 1, "", "bpb_to_btbr"], [9, 2, 1, "", "bpb_to_mzp"], [9, 2, 1, "", "btbr_to_bpb"], [9, 2, 1, "", "btbr_to_mzp"], [9, 2, 1, "", "btbr_to_npol"], [9, 2, 1, "", "combine_masks"], [9, 2, 1, "", "conv_polar_from_head"], [9, 2, 1, "", "fourpol_to_stokes"], [9, 2, 1, "", "mzp_to_bp3"], [9, 2, 1, "", "mzp_to_bpb"], [9, 2, 1, "", "mzp_to_stokes"], [9, 2, 1, "", "npol_to_mzp"], [9, 2, 1, "", "stokes_to_mzp"]]}, "objtypes": {"0": "py:module", "1": "py:data", "2": "py:function", "3": "py:exception"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "data", "Python data"], "2": ["py", "function", "Python function"], "3": ["py", "exception", "Python exception"]}, "titleterms": {"api": 0, "refer": 0, "solpolpi": [1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 14], "alpha": 1, "modul": [1, 2, 3, 4, 5, 7, 8, 9], "content": [1, 2, 3, 4, 5, 7, 8, 9, 14], "function": [1, 3, 7, 8, 9], "attribut": 1, "constant": 2, "core": 3, "error": 4, "graph": 5, "submodul": 6, "instrument": 7, "plot": [8, 15], "polar": [9, 12], "cite": 10, "develop": 11, "set": 11, "up": 11, "pre": 11, "commit": 11, "build": 11, "doc": 11, "run": 11, "test": 11, "exampl": 12, "system": [12, 15], "handl": 12, "import": 12, "data": 12, "view": 12, "stereo": 12, "triplet": 12, "input": 12, "1": 12, "resolv": [12, 15], "bright": 12, "pair": 12, "2": 12, "stoke": 12, "3": 12, "take": 12, "shortcut": 12, "help": 13, "welcom": 14, "": 14, "document": 14, "indic": 14, "tabl": 14, "quickstart": 15, "between": 15, "imax": 15, "effect": 15, "result": 15}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "nbsphinx": 4, "sphinx": 60}, "alltitles": {"API Reference": [[0, "api-reference"]], "solpolpy.alpha": [[1, "module-solpolpy.alpha"]], "Module Contents": [[1, "module-contents"], [2, "module-contents"], [3, "module-contents"], [4, "module-contents"], [5, "module-contents"], [7, "module-contents"], [8, "module-contents"], [9, "module-contents"]], "Functions": [[1, "functions"], [3, "functions"], [7, "functions"], [8, "functions"], [9, "functions"]], "Attributes": [[1, "attributes"]], "solpolpy.constants": [[2, "module-solpolpy.constants"]], "solpolpy.core": [[3, "module-solpolpy.core"]], "solpolpy.errors": [[4, "module-solpolpy.errors"]], "solpolpy.graph": [[5, "module-solpolpy.graph"]], "solpolpy": [[6, "module-solpolpy"]], "Submodules": [[6, "submodules"]], "solpolpy.instruments": [[7, "module-solpolpy.instruments"]], "solpolpy.plotting": [[8, "module-solpolpy.plotting"]], "solpolpy.polarizers": [[9, "module-solpolpy.polarizers"]], "Cite": [[10, "cite"]], "Development": [[11, "development"]], "Setting up pre-commit": [[11, "setting-up-pre-commit"]], "Building the docs": [[11, "building-the-docs"]], "Running tests": [[11, "running-tests"]], "Examples": [[12, "Examples"]], "Polarization systems handled by solpolpy": [[12, "Polarization-systems-handled-by-solpolpy"]], "Import Data": [[12, "Import-Data"]], "View the STEREO triplet input data": [[12, "View-the-STEREO-triplet-input-data"]], "1. Resolve STEREO triplet into a Brightness and Polarized Brightness pair": [[12, "1.-Resolve-STEREO-triplet-into-a-Brightness-and-Polarized-Brightness-pair"]], "2. Resolve STEREO brightness and polarized brightness pair into a Stokes triplet": [[12, "2.-Resolve-STEREO-brightness-and-polarized-brightness-pair-into-a-Stokes-triplet"]], "3. Taking the shortcut": [[12, "3.-Taking-the-shortcut"]], "Help": [[13, "help"]], "Welcome to solpolpy\u2019s documentation!": [[14, "welcome-to-solpolpy-s-documentation"]], "Contents:": [[14, null]], "Indices and tables": [[14, "indices-and-tables"]], "Quickstart": [[15, "quickstart"]], "Resolve between systems": [[15, "resolve-between-systems"]], "IMAX Effect": [[15, "imax-effect"]], "Plotting results": [[15, "plotting-results"]]}, "indexentries": {"alpha_functions (in module solpolpy.alpha)": [[1, "solpolpy.alpha.ALPHA_FUNCTIONS"]], "module": [[1, "module-solpolpy.alpha"], [2, "module-solpolpy.constants"], [3, "module-solpolpy.core"], [4, "module-solpolpy.errors"], [5, "module-solpolpy.graph"], [6, "module-solpolpy"], [7, "module-solpolpy.instruments"], [8, "module-solpolpy.plotting"], [9, "module-solpolpy.polarizers"]], "radial_north() (in module solpolpy.alpha)": [[1, "solpolpy.alpha.radial_north"]], "solpolpy.alpha": [[1, "module-solpolpy.alpha"]], "valid_kinds (in module solpolpy.constants)": [[2, "solpolpy.constants.VALID_KINDS"]], "solpolpy.constants": [[2, "module-solpolpy.constants"]], "_compose2() (in module solpolpy.core)": [[3, "solpolpy.core._compose2"]], "_determine_image_shape() (in module solpolpy.core)": [[3, "solpolpy.core._determine_image_shape"]], "add_alpha() (in module solpolpy.core)": [[3, "solpolpy.core.add_alpha"]], "check_alpha_requirement() (in module solpolpy.core)": [[3, "solpolpy.core.check_alpha_requirement"]], "determine_input_kind() (in module solpolpy.core)": [[3, "solpolpy.core.determine_input_kind"]], "generate_imax_matrix() (in module solpolpy.core)": [[3, "solpolpy.core.generate_imax_matrix"]], "get_transform_equation() (in module solpolpy.core)": [[3, "solpolpy.core.get_transform_equation"]], "get_transform_path() (in module solpolpy.core)": [[3, "solpolpy.core.get_transform_path"]], "identity() (in module solpolpy.core)": [[3, "solpolpy.core.identity"]], "resolve() (in module solpolpy.core)": [[3, "solpolpy.core.resolve"]], "resolve_imax_effect() (in module solpolpy.core)": [[3, "solpolpy.core.resolve_imax_effect"]], "solpolpy.core": [[3, "module-solpolpy.core"]], "toofewfileserror": [[4, "solpolpy.errors.TooFewFilesError"]], "unsupportedinstrumenterror": [[4, "solpolpy.errors.UnsupportedInstrumentError"]], "unsupportedtransformationerror": [[4, "solpolpy.errors.UnsupportedTransformationError"]], "solpolpy.errors": [[4, "module-solpolpy.errors"]], "solpolpy.graph": [[5, "module-solpolpy.graph"]], "transform_graph (in module solpolpy.graph)": [[5, "solpolpy.graph.transform_graph"]], "solpolpy": [[6, "module-solpolpy"]], "construct_mask() (in module solpolpy.instruments)": [[7, "solpolpy.instruments.construct_mask"]], "get_instrument_mask() (in module solpolpy.instruments)": [[7, "solpolpy.instruments.get_instrument_mask"]], "load_data() (in module solpolpy.instruments)": [[7, "solpolpy.instruments.load_data"]], "solpolpy.instruments": [[7, "module-solpolpy.instruments"]], "get_colormap_str() (in module solpolpy.plotting)": [[8, "solpolpy.plotting.get_colormap_str"]], "plot_collection() (in module solpolpy.plotting)": [[8, "solpolpy.plotting.plot_collection"]], "solpolpy.plotting": [[8, "module-solpolpy.plotting"]], "bp3_to_bthp() (in module solpolpy.polarizers)": [[9, "solpolpy.polarizers.bp3_to_bthp"]], "bp3_to_mzp() (in module solpolpy.polarizers)": [[9, "solpolpy.polarizers.bp3_to_mzp"]], "bpb_to_btbr() (in module solpolpy.polarizers)": [[9, "solpolpy.polarizers.bpb_to_btbr"]], "bpb_to_mzp() (in module solpolpy.polarizers)": [[9, "solpolpy.polarizers.bpb_to_mzp"]], "btbr_to_bpb() (in module solpolpy.polarizers)": [[9, "solpolpy.polarizers.btbr_to_bpb"]], "btbr_to_mzp() (in module solpolpy.polarizers)": [[9, "solpolpy.polarizers.btbr_to_mzp"]], "btbr_to_npol() (in module solpolpy.polarizers)": [[9, "solpolpy.polarizers.btbr_to_npol"]], "combine_masks() (in module solpolpy.polarizers)": [[9, "solpolpy.polarizers.combine_masks"]], "conv_polar_from_head() (in module solpolpy.polarizers)": [[9, "solpolpy.polarizers.conv_polar_from_head"]], "fourpol_to_stokes() (in module solpolpy.polarizers)": [[9, "solpolpy.polarizers.fourpol_to_stokes"]], "mzp_to_bp3() (in module solpolpy.polarizers)": [[9, "solpolpy.polarizers.mzp_to_bp3"]], "mzp_to_bpb() (in module solpolpy.polarizers)": [[9, "solpolpy.polarizers.mzp_to_bpb"]], "mzp_to_stokes() (in module solpolpy.polarizers)": [[9, "solpolpy.polarizers.mzp_to_stokes"]], "npol_to_mzp() (in module solpolpy.polarizers)": [[9, "solpolpy.polarizers.npol_to_mzp"]], "solpolpy.polarizers": [[9, "module-solpolpy.polarizers"]], "stokes_to_mzp() (in module solpolpy.polarizers)": [[9, "solpolpy.polarizers.stokes_to_mzp"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["autoapi/index", "autoapi/solpolpy/alpha/index", "autoapi/solpolpy/constants/index", "autoapi/solpolpy/core/index", "autoapi/solpolpy/errors/index", "autoapi/solpolpy/graph/index", "autoapi/solpolpy/index", "autoapi/solpolpy/instruments/index", "autoapi/solpolpy/plotting/index", "autoapi/solpolpy/polarizers/index", "cite", "development", "example", "help", "index", "quickstart"], "filenames": ["autoapi/index.rst", "autoapi/solpolpy/alpha/index.rst", "autoapi/solpolpy/constants/index.rst", "autoapi/solpolpy/core/index.rst", "autoapi/solpolpy/errors/index.rst", "autoapi/solpolpy/graph/index.rst", "autoapi/solpolpy/index.rst", "autoapi/solpolpy/instruments/index.rst", "autoapi/solpolpy/plotting/index.rst", "autoapi/solpolpy/polarizers/index.rst", "cite.rst", "development.rst", "example.ipynb", "help.rst", "index.rst", "quickstart.rst"], "titles": ["API Reference", "solpolpy.alpha", "solpolpy.constants", "solpolpy.core", "solpolpy.errors", "solpolpy.graph", "solpolpy", "solpolpy.instruments", "solpolpy.plotting", "solpolpy.polarizers", "Cite", "Development", "Examples", "Help", "Welcome to solpolpy\u2019s documentation!", "Quickstart"], "terms": {"thi": [0, 3, 7, 11, 12, 13, 15], "page": [0, 14, 15], "contain": [0, 12], "auto": 0, "gener": [0, 3], "document": [0, 3, 11, 12, 15], "1": [0, 3, 9, 14, 15], "solpolpi": [0, 15], "alpha": [0, 3, 6, 8, 9, 12], "constant": [0, 6], "core": [0, 6], "error": [0, 6], "graph": [0, 3, 6], "instrument": [0, 3, 6, 12], "plot": [0, 6, 12, 14], "polar": [0, 1, 3, 6, 14, 15], "creat": [0, 1, 11], "sphinx": [0, 11], "autoapi": 0, "relat": 1, "construct": [1, 5, 7], "an": [1, 3, 7, 8, 12, 13, 14], "arrai": [1, 3, 8, 12], "transform": [1, 3, 5, 12, 14, 15], "radial_north": 1, "shape": [1, 3, 7], "orient": 1, "west": [1, 9], "paramet": [1, 3, 7, 8, 12, 15], "tupl": [1, 3, 7, 8, 12], "int": [1, 3, 7, 8, 12], "how": [1, 12], "big": 1, "should": 1, "return": [1, 3, 7, 8, 12], "us": [1, 2, 3, 8, 10, 11, 12, 13, 14, 15], "calcul": [1, 3], "type": [1, 3, 7, 8, 12], "np": [1, 7, 8, 9, 12], "ndarrai": [1, 3, 7, 8, 12], "note": [1, 9, 11, 12], "assum": 1, "solar": [1, 3, 7, 12, 14, 15], "north": 1, "i": [1, 3, 7, 8, 9, 11, 12, 13, 14, 15], "up": [1, 13, 14], "0": [1, 3, 12, 14], "along": [1, 3, 12], "axi": 1, "radial": [1, 3, 7, 12], "map": [1, 8], "angl": [1, 3, 9, 12, 14, 15], "increas": [1, 3], "counterclockwis": 1, "direct": [1, 3, 12], "alpha_funct": 1, "code": [2, 7, 11, 13], "valid_kind": 2, "resolv": [3, 14], "input_data": [3, 12], "list": [3, 7, 8, 9, 12], "str": [3, 7, 8, 12], "ndcube": [3, 7, 8, 12], "ndcollect": [3, 7, 8, 12], "out_system": [3, 12, 15], "imax_effect": [3, 15], "bool": [3, 7, 8, 12], "fals": [3, 7, 8, 12], "appli": [3, 8, 12], "set": [3, 12, 14, 15], "input": [3, 8, 9, 14, 15], "datafram": 3, "either": [3, 12], "collect": [3, 8, 12, 15], "where": [3, 7, 12], "each": [3, 8, 12], "member": 3, "ha": [3, 12, 14, 15], "expect": [3, 12], "name": [3, 8, 12], "2": [3, 9, 14, 15], "path": [3, 7, 12, 15], "fit": [3, 7, 8, 12, 15], "file": [3, 7, 8, 12], "we": [3, 11, 12, 13, 15], "recommend": [3, 11, 15], "option": [3, 7, 8, 12, 15], "string": [3, 8, 12], "The": [3, 7, 9, 11, 12, 14, 15], "state": [3, 12], "you": [3, 10, 11, 12, 13, 15], "want": [3, 11, 12, 13], "convert": [3, 12, 14, 15], "your": [3, 13], "must": [3, 11], "one": [3, 15], "follow": [3, 11, 15], "mzp": [3, 12, 15], "triplet": [3, 14], "imag": [3, 7, 9, 12, 14, 15], "taken": [3, 12], "60": [3, 12, 14], "btbr": [3, 12], "pair": [3, 14], "tangenti": [3, 12], "respect": [3, 12, 14], "sun": [3, 12], "stoke": [3, 14], "total": [3, 12], "bright": [3, 14], "vertic": [3, 12], "horizont": [3, 12], "ax": [3, 8, 12], "q": [3, 12, 14], "45": [3, 12], "u": [3, 11, 12, 14], "bpb": [3, 12, 15], "excess": [3, 12], "bp3": [3, 12], "analog": [3, 12], "rotat": [3, 12], "around": [3, 12], "instead": [3, 12], "fix": [3, 12], "frame": [3, 12], "refer": [3, 12, 14], "bthp": [3, 12], "degre": [3, 9, 12], "fourpol": 3, "For": [3, 12], "observ": [3, 12, 15], "sequenc": 3, "four": 3, "e": [3, 9, 12], "90": 3, "135": 3, "npol": 3, "than": [3, 7, 13, 15], "three": [3, 9, 12], "other": [3, 7, 11, 13], "boolean": 3, "imax": [3, 14], "effect": [3, 14], "describ": [3, 15], "chang": [3, 12], "appar": [3, 15], "measur": 3, "result": [3, 9, 12, 14], "foreshorten": [3, 15], "becom": 3, "more": [3, 12, 15], "pronounc": 3, "wide": [3, 11, 15], "field": [3, 15], "see": [3, 7, 11, 12], "patel": 3, "et": [3, 9, 12, 15], "al": [3, 9, 12, 15], "2024": 3, "prepar": 3, "If": [3, 7, 9, 11, 12, 13, 15], "true": [3, 7, 8, 12, 15], "part": [3, 14], "resolut": 3, "process": 3, "rais": 3, "assertionerror": 3, "get": [3, 7, 9, 11, 15], "data": [3, 7, 8, 14, 15], "cannot": 3, "due": 3, "discontinu": 3, "infin": 3, "ar": [3, 7, 8, 9, 11, 12, 15], "most": 3, "maintain": 3, "dimension": 3, "sourc": [3, 11, 14], "vector": 3, "some": [3, 8, 12], "emb": 3, "project": [3, 11, 12], "decreas": 3, "addit": [3, 8, 12], "dimens": [3, 7, 12], "present": [3, 12, 15], "still": 3, "append": 3, "output": [3, 8, 12, 14, 15], "all": [3, 4, 11, 12, 13], "ani": [3, 7, 8, 9, 11, 12, 15], "case": [3, 12], "determine_input_kind": 3, "determin": [3, 12], "what": [3, 12], "kind": [3, 12], "wa": [3, 12], "evalu": 3, "valid": [3, 7, 15], "full": 3, "under": 3, "get_transform_path": 3, "input_kind": 3, "output_kind": 3, "given": 3, "system": [3, 14], "requir": [3, 11, 15], "from": [3, 7, 8, 10, 12, 13, 15], "start": [3, 13, 15], "point": 3, "end": [3, 12], "identifi": 3, "get_transform_equ": 3, "callabl": 3, "compos": 3, "equat": [3, 9, 15], "execut": [3, 11], "check_alpha_requir": 3, "through": [3, 15], "whether": [3, 8, 12], "generate_imax_matrix": 3, "arrayshap": 3, "numpi": [3, 7], "defin": [3, 7], "A": 3, "matrix": 3, "which": [3, 15], "camera": 3, "coord": 3, "x": [3, 7, 8, 12], "wc": [3, 7, 12], "between": [3, 7, 12, 14], "coordin": [3, 7, 12], "resolve_imax_effect": 3, "provid": [3, 8, 12, 15], "correct": [3, 15], "fov": [3, 15], "_determine_image_shap": 3, "input_collect": [3, 9, 15], "add_alpha": 3, "add": [3, 12], "dataset": [3, 12], "_compose2": 3, "f": 3, "g": [3, 12], "togeth": [3, 12], "outer": [3, 7], "inner": [3, 7], "ident": 3, "valu": [3, 8, 9, 12], "back": 3, "except": 4, "toofewfileserror": 4, "base": [4, 11, 12, 15], "common": [4, 7], "class": 4, "non": [4, 15], "exit": 4, "unsupportedinstrumenterror": 4, "unsupportedtransformationerror": 4, "transform_graph": 5, "specif": 7, "load_data": [7, 12, 15], "path_list": 7, "mask": [7, 9, 12], "none": [7, 8, 9, 12], "use_instrument_mask": [7, 12], "basic": 7, "load": [7, 12], "load_with_occulter_mask": 7, "param": [7, 8], "coupl": [7, 12], "overrid": 7, "comput": 7, "when": [7, 9, 11], "get_instrument_mask": 7, "object": [7, 12], "header": [7, 8, 12], "inform": [7, 12], "avail": 7, "kei": [7, 12], "label": [7, 8, 12], "angle_1": [7, 12], "angle_2": [7, 12], "angle_3": [7, 12], "construct_mask": 7, "inner_radiu": 7, "float": [7, 8, 12], "outer_radiu": 7, "center_x": 7, "center_i": 7, "indic": [7, 12], "pixel": 7, "invalid": 7, "distanc": 7, "everi": 7, "standard": 7, "coronograph": 7, "radiu": 7, "closer": 7, "center": 7, "farther": 7, "y": [7, 8, 12], "mark": [7, 8, 12], "those": [7, 11], "less": 7, "greater": 7, "astropi": [7, 8, 12], "io": [7, 8], "support": [7, 13, 15], "lasco": [7, 12, 14], "cosmo": 7, "k": 7, "secchi": 7, "question": 7, "out": [7, 12], "flag": 7, "plot_collect": [8, 12, 15], "figsiz": [8, 12], "8": [8, 12], "show_colorbar": [8, 12], "lat_tick": [8, 12], "lon_tick": [8, 12], "major_formatt": [8, 12], "dd": [8, 12], "xlabel": [8, 12], "hp": [8, 12], "longitud": [8, 12], "ylabel": [8, 12], "latitud": [8, 12], "vmin": [8, 12], "vmax": [8, 12], "cmap": [8, 12], "greys_r": [8, 12], "ignore_alpha": [8, 12], "fontsiz": [8, 12], "18": [8, 12], "visual": [8, 12], "figur": [8, 11, 12], "size": [8, 12], "accord": [8, 12], "matplotlib": [8, 12], "show": [8, 12, 14], "colorbar": [8, 12], "tick": [8, 12], "default": [8, 12], "otherwis": [8, 9, 12], "formatt": [8, 12], "major": [8, 12], "tickmark": [8, 12], "specifi": [8, 12], "minimum": [8, 12], "thei": [8, 12], "left": [8, 12], "right": [8, 12], "maximum": [8, 12], "colormap": [8, 12], "accept": [8, 12], "normal": [8, 12], "help": [8, 12, 14], "font": [8, 12], "aspect": [8, 12], "edit": [8, 12], "get_colormap_str": [8, 12], "meta": [8, 12], "retriev": 8, "color": 8, "appropri": [8, 12, 15], "found": [9, 12, 15], "deforest": [9, 12, 15], "c": 9, "seaton": 9, "d": 9, "b": [9, 12, 15], "m": [9, 11], "j": 9, "2022": [9, 12, 15], "treatment": 9, "linear": [9, 15], "coronagraph": 9, "heliospher": 9, "astrophys": 9, "journal": 9, "927": 9, "98": 9, "conv_polar_from_head": 9, "input_cub": 9, "npol_to_mzp": 9, "44": [9, 15], "mzp_to_bpb": 9, "7": [9, 12], "9": [9, 12], "bpb_to_mzp": 9, "4": [9, 12], "bpb_to_btbr": 9, "btbr_to_bpb": 9, "tabl": 9, "mzp_to_stok": 9, "12": [9, 12], "13": [9, 12], "stokes_to_mzp": 9, "11": [9, 12], "pi": 9, "mzp_to_bp3": 9, "10": [9, 12], "bp3_to_mzp": 9, "btbr_to_mzp": 9, "3": [9, 14], "bp3_to_bthp": 9, "15": [9, 12], "16": [9, 12], "btbr_to_npol": 9, "fourpol_to_stok": 9, "combine_mask": 9, "arg": 9, "combin": 9, "doe": [9, 11], "logic": 9, "To": [10, 11, 12, 15], "softwar": 10, "pleas": [10, 11, 12, 13], "citat": 10, "zenodo": 10, "version": [10, 12], "encourag": [11, 13], "contribut": 11, "our": [11, 12], "guid": 11, "first": [11, 12, 13, 15], "re": [11, 12, 13, 15], "read": 11, "evelop": 11, "work": 11, "virtual": 11, "environ": 11, "can": [11, 12, 13, 15], "python": [11, 14], "venv": 11, "Then": 11, "activ": 11, "bin": 11, "instal": [11, 15], "packag": [11, 12, 13, 14, 15], "pip": [11, 15], "r": 11, "requirements_dev": 11, "txt": 11, "time": 11, "issu": [11, 13], "contact": 11, "guidelin": 11, "here": 11, "ll": [11, 12], "need": [11, 13], "check": 11, "style": 11, "consist": 11, "It": [11, 12, 14, 15], "do": [11, 12], "them": [11, 12], "now": [11, 12], "everytim": 11, "built": 11, "navig": 11, "directori": 11, "make": [11, 13], "html": 11, "rerun": 11, "exampl": [11, 14, 15], "jupyt": 11, "notebook": 11, "manual": [11, 12], "updat": 11, "pytest": 11, "repositori": 11, "variou": 12, "format": 12, "nativ": 12, "tripl": 12, "also": 12, "known": 12, "convent": 12, "pb": 12, "etc": 12, "basi": [12, 14], "c2": [12, 14], "shown": [12, 14], "below": [12, 14], "top": [12, 14], "panel": [12, 14], "bm": [12, 14], "bz": [12, 14], "bp": [12, 14], "bottom": [12, 14], "initi": [12, 14], "invok": 12, "simpl": 12, "interfac": 12, "sp": 12, "sunpi": 12, "desir": [12, 15], "util": 12, "function": [12, 15], "call": 12, "There": 12, "minu": 12, "zero": 12, "plu": 12, "unpolar": 12, "orthogon": 12, "\u03b1": 12, "unlik": 12, "later": 12, "theta": 12, "phi": 12, "polarz": 12, "2010": 12, "04": 12, "03": 12, "ut": 12, "These": 12, "substitut": 12, "have": 12, "glob": 12, "pyplot": 12, "plt": 12, "rcparam": 12, "famili": 12, "serif": 12, "stereo_path": 12, "ft": 12, "altern": 12, "pass": 12, "filenam": 12, "method": [12, 15], "showcas": 12, "howev": 12, "control": 12, "In": [12, 15], "becaus": 12, "stereo_collect": 12, "warn": 12, "fitsfixedwarn": 12, "crota": 12, "7105675": 12, "keyword": [12, 15], "look": 12, "veri": 12, "much": 12, "like": [12, 13], "crotan": 12, "isn": 12, "39": 12, "t": 12, "datfix": 12, "made": 12, "mjd": 12, "ob": 12, "55289": 12, "423090": 12, "date": 12, "avg": 12, "423218": 12, "423345": 12, "7106929": 12, "422743": 12, "422870": 12, "422998": 12, "7109408": 12, "422396": 12, "422523": 12, "422651": 12, "familiar": 12, "http": 12, "doc": [12, 14], "org": 12, "essenti": 12, "multipl": 12, "world": 12, "uncertainti": 12, "metadata": 12, "dict_kei": 12, "number": 12, "know": 12, "cube": [12, 15], "lt": 12, "0x10765a110": 12, "gt": 12, "2048": 12, "pix": 12, "physic": [12, 14, 15], "custom": 12, "po": 12, "helioproject": 12, "lon": 12, "lat": 12, "unit": 12, "uint16": 12, "": [12, 13], "particularli": 12, "That": 12, "track": 12, "240": 12, "5": 12, "inspect": 12, "entir": 12, "6": 12, "put": 12, "just": [12, 15], "so": [12, 13], "line": 12, "long": 12, "written": 12, "idl": 12, "mon": 12, "apr": 12, "17": 12, "bitpix": 12, "naxi": 12, "naxis1": 12, "naxis2": 12, "extend": 12, "03t10": 12, "09": 12, "006": 12, "fileorig": 12, "a4030234": 12, "411": 12, "seb_prog": 12, "sync": 12, "two": [12, 15], "mani": [12, 15], "argument": 12, "suggest": 12, "modul": [12, 14], "20": 12, "10_000": 12, "directli": 12, "scienc": 12, "differ": [12, 14, 15], "avoid": 12, "output_bpb": 12, "As": 12, "earlier": 12, "well": 12, "produc": 12, "access": [12, 15], "4118": 12, "66666667": 12, "4117": 12, "33333333": 12, "4116": 12, "4122": 12, "4121": 12, "4120": 12, "4125": 12, "4113": 12, "4114": 12, "4124": 12, "forget": 12, "deal": 12, "same": 12, "wai": [12, 15], "14": 12, "20000": 12, "200": 12, "could": 12, "output_stok": 12, "onc": 12, "again": 12, "bi": 12, "bq": 12, "bu": 12, "500": 12, "ask": 12, "run": [12, 14], "command": 12, "origin": 12, "convers": 12, "behind": 12, "scene": 12, "ever": 12, "imposs": 12, "let": 12, "thank": 13, "notic": 13, "bug": 13, "open": [13, 14], "github": 13, "discuss": 13, "rather": 13, "email": 13, "benefit": 13, "inquiri": 13, "too": 13, "user": 13, "friendli": 13, "possibl": 13, "encount": 13, "someon": 13, "els": 13, "everyon": 13, "speak": 13, "heliophys": 14, "been": 14, "develop": 14, "punch": [14, 15], "mission": 14, "quickstart": 14, "handl": 14, "import": [14, 15], "view": [14, 15], "stereo": 14, "take": [14, 15], "shortcut": 14, "cite": 14, "pre": 14, "commit": 14, "build": 14, "test": 14, "api": 14, "index": 14, "search": 14, "unfamiliar": 15, "comprehens": 15, "allow": 15, "relev": 15, "find": 15, "detail": 15, "descript": 15, "easiest": 15, "interact": 15, "path_to_image0": 15, "path_to_image1": 15, "path_to_image2": 15, "output_collect": 15, "print": 15, "anoth": 15, "wfi": 15, "suffer": 15, "across": 15, "deviat": 15, "ideal": 15, "spatial": 15, "locat": 15, "draw": 15, "parallel": 15, "3d": 15, "screen": 15, "about": 15, "soon": 15, "publish": 15, "research": 15, "articl": 15, "configur": 15}, "objects": {"": [[6, 0, 0, "-", "solpolpy"]], "solpolpy": [[1, 0, 0, "-", "alpha"], [2, 0, 0, "-", "constants"], [3, 0, 0, "-", "core"], [4, 0, 0, "-", "errors"], [5, 0, 0, "-", "graph"], [7, 0, 0, "-", "instruments"], [8, 0, 0, "-", "plotting"], [9, 0, 0, "-", "polarizers"]], "solpolpy.alpha": [[1, 1, 1, "", "ALPHA_FUNCTIONS"], [1, 2, 1, "", "radial_north"]], "solpolpy.constants": [[2, 1, 1, "", "VALID_KINDS"]], "solpolpy.core": [[3, 2, 1, "", "_compose2"], [3, 2, 1, "", "_determine_image_shape"], [3, 2, 1, "", "add_alpha"], [3, 2, 1, "", "check_alpha_requirement"], [3, 2, 1, "", "determine_input_kind"], [3, 2, 1, "", "generate_imax_matrix"], [3, 2, 1, "", "get_transform_equation"], [3, 2, 1, "", "get_transform_path"], [3, 2, 1, "", "identity"], [3, 2, 1, "", "resolve"], [3, 2, 1, "", "resolve_imax_effect"]], "solpolpy.errors": [[4, 3, 1, "", "TooFewFilesError"], [4, 3, 1, "", "UnsupportedInstrumentError"], [4, 3, 1, "", "UnsupportedTransformationError"]], "solpolpy.graph": [[5, 1, 1, "", "transform_graph"]], "solpolpy.instruments": [[7, 2, 1, "", "construct_mask"], [7, 2, 1, "", "get_instrument_mask"], [7, 2, 1, "", "load_data"]], "solpolpy.plotting": [[8, 2, 1, "", "get_colormap_str"], [8, 2, 1, "", "plot_collection"]], "solpolpy.polarizers": [[9, 2, 1, "", "bp3_to_bthp"], [9, 2, 1, "", "bp3_to_mzp"], [9, 2, 1, "", "bpb_to_btbr"], [9, 2, 1, "", "bpb_to_mzp"], [9, 2, 1, "", "btbr_to_bpb"], [9, 2, 1, "", "btbr_to_mzp"], [9, 2, 1, "", "btbr_to_npol"], [9, 2, 1, "", "combine_masks"], [9, 2, 1, "", "conv_polar_from_head"], [9, 2, 1, "", "fourpol_to_stokes"], [9, 2, 1, "", "mzp_to_bp3"], [9, 2, 1, "", "mzp_to_bpb"], [9, 2, 1, "", "mzp_to_stokes"], [9, 2, 1, "", "npol_to_mzp"], [9, 2, 1, "", "stokes_to_mzp"]]}, "objtypes": {"0": "py:module", "1": "py:data", "2": "py:function", "3": "py:exception"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "data", "Python data"], "2": ["py", "function", "Python function"], "3": ["py", "exception", "Python exception"]}, "titleterms": {"api": 0, "refer": 0, "solpolpi": [1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 14], "alpha": 1, "modul": [1, 2, 3, 4, 5, 7, 8, 9], "content": [1, 2, 3, 4, 5, 7, 8, 9, 14], "function": [1, 3, 7, 8, 9], "attribut": 1, "constant": 2, "core": 3, "error": 4, "graph": 5, "submodul": 6, "instrument": 7, "plot": [8, 15], "polar": [9, 12], "cite": 10, "develop": 11, "set": 11, "up": 11, "pre": 11, "commit": 11, "build": 11, "doc": 11, "run": 11, "test": 11, "exampl": 12, "system": [12, 15], "handl": 12, "import": 12, "data": 12, "view": 12, "stereo": 12, "triplet": 12, "input": 12, "1": 12, "resolv": [12, 15], "bright": 12, "pair": 12, "2": 12, "stoke": 12, "3": 12, "take": 12, "shortcut": 12, "help": 13, "welcom": 14, "": 14, "document": 14, "indic": 14, "tabl": 14, "quickstart": 15, "between": 15, "imax": 15, "effect": 15, "result": 15}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "nbsphinx": 4, "sphinx": 60}, "alltitles": {"API Reference": [[0, "api-reference"]], "solpolpy.alpha": [[1, "module-solpolpy.alpha"]], "Module Contents": [[1, "module-contents"], [2, "module-contents"], [3, "module-contents"], [4, "module-contents"], [5, "module-contents"], [7, "module-contents"], [8, "module-contents"], [9, "module-contents"]], "Functions": [[1, "functions"], [3, "functions"], [7, "functions"], [8, "functions"], [9, "functions"]], "Attributes": [[1, "attributes"]], "solpolpy.constants": [[2, "module-solpolpy.constants"]], "solpolpy.core": [[3, "module-solpolpy.core"]], "solpolpy.errors": [[4, "module-solpolpy.errors"]], "solpolpy.graph": [[5, "module-solpolpy.graph"]], "solpolpy": [[6, "module-solpolpy"]], "Submodules": [[6, "submodules"]], "solpolpy.instruments": [[7, "module-solpolpy.instruments"]], "solpolpy.plotting": [[8, "module-solpolpy.plotting"]], "solpolpy.polarizers": [[9, "module-solpolpy.polarizers"]], "Cite": [[10, "cite"]], "Development": [[11, "development"]], "Setting up pre-commit": [[11, "setting-up-pre-commit"]], "Building the docs": [[11, "building-the-docs"]], "Running tests": [[11, "running-tests"]], "Examples": [[12, "Examples"]], "Polarization systems handled by solpolpy": [[12, "Polarization-systems-handled-by-solpolpy"]], "Import Data": [[12, "Import-Data"]], "View the STEREO triplet input data": [[12, "View-the-STEREO-triplet-input-data"]], "1. Resolve STEREO triplet into a Brightness and Polarized Brightness pair": [[12, "1.-Resolve-STEREO-triplet-into-a-Brightness-and-Polarized-Brightness-pair"]], "2. Resolve STEREO brightness and polarized brightness pair into a Stokes triplet": [[12, "2.-Resolve-STEREO-brightness-and-polarized-brightness-pair-into-a-Stokes-triplet"]], "3. Taking the shortcut": [[12, "3.-Taking-the-shortcut"]], "Help": [[13, "help"]], "Welcome to solpolpy\u2019s documentation!": [[14, "welcome-to-solpolpy-s-documentation"]], "Contents:": [[14, null]], "Indices and tables": [[14, "indices-and-tables"]], "Quickstart": [[15, "quickstart"]], "Resolve between systems": [[15, "resolve-between-systems"]], "IMAX Effect": [[15, "imax-effect"]], "Plotting results": [[15, "plotting-results"]]}, "indexentries": {"alpha_functions (in module solpolpy.alpha)": [[1, "solpolpy.alpha.ALPHA_FUNCTIONS"]], "module": [[1, "module-solpolpy.alpha"], [2, "module-solpolpy.constants"], [3, "module-solpolpy.core"], [4, "module-solpolpy.errors"], [5, "module-solpolpy.graph"], [6, "module-solpolpy"], [7, "module-solpolpy.instruments"], [8, "module-solpolpy.plotting"], [9, "module-solpolpy.polarizers"]], "radial_north() (in module solpolpy.alpha)": [[1, "solpolpy.alpha.radial_north"]], "solpolpy.alpha": [[1, "module-solpolpy.alpha"]], "valid_kinds (in module solpolpy.constants)": [[2, "solpolpy.constants.VALID_KINDS"]], "solpolpy.constants": [[2, "module-solpolpy.constants"]], "_compose2() (in module solpolpy.core)": [[3, "solpolpy.core._compose2"]], "_determine_image_shape() (in module solpolpy.core)": [[3, "solpolpy.core._determine_image_shape"]], "add_alpha() (in module solpolpy.core)": [[3, "solpolpy.core.add_alpha"]], "check_alpha_requirement() (in module solpolpy.core)": [[3, "solpolpy.core.check_alpha_requirement"]], "determine_input_kind() (in module solpolpy.core)": [[3, "solpolpy.core.determine_input_kind"]], "generate_imax_matrix() (in module solpolpy.core)": [[3, "solpolpy.core.generate_imax_matrix"]], "get_transform_equation() (in module solpolpy.core)": [[3, "solpolpy.core.get_transform_equation"]], "get_transform_path() (in module solpolpy.core)": [[3, "solpolpy.core.get_transform_path"]], "identity() (in module solpolpy.core)": [[3, "solpolpy.core.identity"]], "resolve() (in module solpolpy.core)": [[3, "solpolpy.core.resolve"]], "resolve_imax_effect() (in module solpolpy.core)": [[3, "solpolpy.core.resolve_imax_effect"]], "solpolpy.core": [[3, "module-solpolpy.core"]], "toofewfileserror": [[4, "solpolpy.errors.TooFewFilesError"]], "unsupportedinstrumenterror": [[4, "solpolpy.errors.UnsupportedInstrumentError"]], "unsupportedtransformationerror": [[4, "solpolpy.errors.UnsupportedTransformationError"]], "solpolpy.errors": [[4, "module-solpolpy.errors"]], "solpolpy.graph": [[5, "module-solpolpy.graph"]], "transform_graph (in module solpolpy.graph)": [[5, "solpolpy.graph.transform_graph"]], "solpolpy": [[6, "module-solpolpy"]], "construct_mask() (in module solpolpy.instruments)": [[7, "solpolpy.instruments.construct_mask"]], "get_instrument_mask() (in module solpolpy.instruments)": [[7, "solpolpy.instruments.get_instrument_mask"]], "load_data() (in module solpolpy.instruments)": [[7, "solpolpy.instruments.load_data"]], "solpolpy.instruments": [[7, "module-solpolpy.instruments"]], "get_colormap_str() (in module solpolpy.plotting)": [[8, "solpolpy.plotting.get_colormap_str"]], "plot_collection() (in module solpolpy.plotting)": [[8, "solpolpy.plotting.plot_collection"]], "solpolpy.plotting": [[8, "module-solpolpy.plotting"]], "bp3_to_bthp() (in module solpolpy.polarizers)": [[9, "solpolpy.polarizers.bp3_to_bthp"]], "bp3_to_mzp() (in module solpolpy.polarizers)": [[9, "solpolpy.polarizers.bp3_to_mzp"]], "bpb_to_btbr() (in module solpolpy.polarizers)": [[9, "solpolpy.polarizers.bpb_to_btbr"]], "bpb_to_mzp() (in module solpolpy.polarizers)": [[9, "solpolpy.polarizers.bpb_to_mzp"]], "btbr_to_bpb() (in module solpolpy.polarizers)": [[9, "solpolpy.polarizers.btbr_to_bpb"]], "btbr_to_mzp() (in module solpolpy.polarizers)": [[9, "solpolpy.polarizers.btbr_to_mzp"]], "btbr_to_npol() (in module solpolpy.polarizers)": [[9, "solpolpy.polarizers.btbr_to_npol"]], "combine_masks() (in module solpolpy.polarizers)": [[9, "solpolpy.polarizers.combine_masks"]], "conv_polar_from_head() (in module solpolpy.polarizers)": [[9, "solpolpy.polarizers.conv_polar_from_head"]], "fourpol_to_stokes() (in module solpolpy.polarizers)": [[9, "solpolpy.polarizers.fourpol_to_stokes"]], "mzp_to_bp3() (in module solpolpy.polarizers)": [[9, "solpolpy.polarizers.mzp_to_bp3"]], "mzp_to_bpb() (in module solpolpy.polarizers)": [[9, "solpolpy.polarizers.mzp_to_bpb"]], "mzp_to_stokes() (in module solpolpy.polarizers)": [[9, "solpolpy.polarizers.mzp_to_stokes"]], "npol_to_mzp() (in module solpolpy.polarizers)": [[9, "solpolpy.polarizers.npol_to_mzp"]], "solpolpy.polarizers": [[9, "module-solpolpy.polarizers"]], "stokes_to_mzp() (in module solpolpy.polarizers)": [[9, "solpolpy.polarizers.stokes_to_mzp"]]}}) \ No newline at end of file