wouter/Artemis
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
b3f7f1cb9908d6e5e791e065b5ce4690b715f506
Artemis/basic_operations/index.html
Marco Dalla Tiezza b3f7f1cb99 Deployed 707cc00 with MkDocs version: 1.6.0
2024-06-04 21:58:05 +02:00

1453 lines
35 KiB
HTML
Executable File
Raw Blame History

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="prev" href="../build_package/">
<link rel="next" href="../database/db_overview/">
<link rel="icon" href="../assets/artemis_icon.ico">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.25">
<title>Basic Operations - ARTEMIS</title>
<link rel="stylesheet" href="../assets/stylesheets/main.6543a935.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<link rel="stylesheet" href="https://unpkg.com/katex@0/dist/katex.min.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="black" data-md-color-accent="indigo">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#_1" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="ARTEMIS" class="md-header__button md-logo" aria-label="ARTEMIS" data-md-component="logo">
<img src="../assets/logo_small_white.svg" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
ARTEMIS
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Basic Operations
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="black" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2a7 7 0 0 0-7 7c0 2.38 1.19 4.47 3 5.74V17a1 1 0 0 0 1 1h6a1 1 0 0 0 1-1v-2.26c1.81-1.27 3-3.36 3-5.74a7 7 0 0 0-7-7M9 21a1 1 0 0 0 1 1h4a1 1 0 0 0 1-1v-1H9v1Z"/></svg>
</label>
<input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="black" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2a7 7 0 0 1 7 7c0 2.38-1.19 4.47-3 5.74V17a1 1 0 0 1-1 1H9a1 1 0 0 1-1-1v-2.26C6.19 13.47 5 11.38 5 9a7 7 0 0 1 7-7M9 21v-1h6v1a1 1 0 0 1-1 1h-4a1 1 0 0 1-1-1m3-17a5 5 0 0 0-5 5c0 2.05 1.23 3.81 3 4.58V16h4v-2.42c1.77-.77 3-2.53 3-4.58a5 5 0 0 0-5-5Z"/></svg>
</label>
</form>
<script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/AresValley/Artemis" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
GitHub
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="ARTEMIS" class="md-nav__button md-logo" aria-label="ARTEMIS" data-md-component="logo">
<img src="../assets/logo_small_white.svg" alt="logo">
</a>
ARTEMIS
</label>
<div class="md-nav__source">
<a href="https://github.com/AresValley/Artemis" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
GitHub
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<span class="md-ellipsis">
Welcome
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
Getting Started
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<span class="md-ellipsis">
Installation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../run_from_source/" class="md-nav__link">
<span class="md-ellipsis">
Run from source
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build_package/" class="md-nav__link">
<span class="md-ellipsis">
Build Package
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Basic Operations
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Basic Operations
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#1-main-menu" class="md-nav__link">
<span class="md-ellipsis">
1. Main Menu
</span>
</a>
<nav class="md-nav" aria-label="1. Main Menu">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#file" class="md-nav__link">
<span class="md-ellipsis">
File
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#signal" class="md-nav__link">
<span class="md-ellipsis">
Signal
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#space-weather" class="md-nav__link">
<span class="md-ellipsis">
Space Weather
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#2-signal-list" class="md-nav__link">
<span class="md-ellipsis">
2. Signal List
</span>
</a>
<nav class="md-nav" aria-label="2. Signal List">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#filter-by-namedescription" class="md-nav__link">
<span class="md-ellipsis">
Filter by Name/Description
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#3-signal-menu" class="md-nav__link">
<span class="md-ellipsis">
3. Signal Menu
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#4-tags" class="md-nav__link">
<span class="md-ellipsis">
4. Tags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#5-add-parameter" class="md-nav__link">
<span class="md-ellipsis">
5. Add Parameter
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#6-edit-parameter" class="md-nav__link">
<span class="md-ellipsis">
6. Edit Parameter
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#7-description" class="md-nav__link">
<span class="md-ellipsis">
7. Description
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#8-audio-sample" class="md-nav__link">
<span class="md-ellipsis">
8. Audio Sample
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#9-image-sample" class="md-nav__link">
<span class="md-ellipsis">
9. Image Sample
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#10-extra" class="md-nav__link">
<span class="md-ellipsis">
10. Extra
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis">
Database
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Database
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../database/db_overview/" class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_2" >
<label class="md-nav__link" for="__nav_4_2" id="__nav_4_2_label" tabindex="0">
<span class="md-ellipsis">
Structure
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_2">
<span class="md-nav__icon md-icon"></span>
Structure
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../database/db_info/" class="md-nav__link">
<span class="md-ellipsis">
Info
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../database/db_signals/" class="md-nav__link">
<span class="md-ellipsis">
Signals
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../database/db_frequency/" class="md-nav__link">
<span class="md-ellipsis">
Frequency
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../database/db_bandwidth/" class="md-nav__link">
<span class="md-ellipsis">
Bandwidth
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../database/db_modulation/" class="md-nav__link">
<span class="md-ellipsis">
Modulation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../database/db_mode/" class="md-nav__link">
<span class="md-ellipsis">
Mode
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../database/db_location/" class="md-nav__link">
<span class="md-ellipsis">
Location
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../database/db_category/" class="md-nav__link">
<span class="md-ellipsis">
Category
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../database/db_cat_label/" class="md-nav__link">
<span class="md-ellipsis">
Category Label
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../database/db_acf/" class="md-nav__link">
<span class="md-ellipsis">
ACF
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../database/sigid/" class="md-nav__link">
<span class="md-ellipsis">
SigID
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
Space Weather
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Space Weather
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../space_weather/current/" class="md-nav__link">
<span class="md-ellipsis">
Current
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../space_weather/forecasts/" class="md-nav__link">
<span class="md-ellipsis">
Forecasts
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../space_weather/drap/" class="md-nav__link">
<span class="md-ellipsis">
DRAP
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../space_weather/aurora/" class="md-nav__link">
<span class="md-ellipsis">
Aurora
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<span class="md-ellipsis">
Example
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Example
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../acf_analysis/" class="md-nav__link">
<span class="md-ellipsis">
ACF Analysis
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../contribute/" class="md-nav__link">
<span class="md-ellipsis">
Contribute
</span>
</a>
</li>
<li class="md-nav__item">
<a href="https://github.com/AresValley/Artemis/blob/master/CHANGELOG.md" class="md-nav__link">
<span class="md-ellipsis">
Changelog
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../credits/" class="md-nav__link">
<span class="md-ellipsis">
License & Credits
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#1-main-menu" class="md-nav__link">
<span class="md-ellipsis">
1. Main Menu
</span>
</a>
<nav class="md-nav" aria-label="1. Main Menu">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#file" class="md-nav__link">
<span class="md-ellipsis">
File
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#signal" class="md-nav__link">
<span class="md-ellipsis">
Signal
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#space-weather" class="md-nav__link">
<span class="md-ellipsis">
Space Weather
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#2-signal-list" class="md-nav__link">
<span class="md-ellipsis">
2. Signal List
</span>
</a>
<nav class="md-nav" aria-label="2. Signal List">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#filter-by-namedescription" class="md-nav__link">
<span class="md-ellipsis">
Filter by Name/Description
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#3-signal-menu" class="md-nav__link">
<span class="md-ellipsis">
3. Signal Menu
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#4-tags" class="md-nav__link">
<span class="md-ellipsis">
4. Tags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#5-add-parameter" class="md-nav__link">
<span class="md-ellipsis">
5. Add Parameter
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#6-edit-parameter" class="md-nav__link">
<span class="md-ellipsis">
6. Edit Parameter
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#7-description" class="md-nav__link">
<span class="md-ellipsis">
7. Description
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#8-audio-sample" class="md-nav__link">
<span class="md-ellipsis">
8. Audio Sample
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#9-image-sample" class="md-nav__link">
<span class="md-ellipsis">
9. Image Sample
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#10-extra" class="md-nav__link">
<span class="md-ellipsis">
10. Extra
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="_1"></h1>
<p><img alt="sw_current" src="../assets/main_window.webp" /></p>
<h2 id="1-main-menu">1. Main Menu</h2>
<h3 id="file">File</h3>
<ul>
<li><strong>New Database:</strong> Create a new database.</li>
<li><strong>Load Database:</strong> Open the Database Manager windows in order to open, rename, or delete a database.</li>
<li><strong>Import Database:</strong> Import an Artemis database with a standard .tar format.</li>
<li><strong>Export Database:</strong> Export the loaded database with a standard .tar format.</li>
<li><strong>Edit Tags:</strong> Open the tags editor window. From here, you can add, rename, or delete tags. The tags can be added to a signal from the <a href="#4-tags">tags menu</a></li>
<li><strong>Open Database Folder:</strong> Shows the folder of the currently loaded database in the explorer.</li>
<li><strong>Preferences:</strong> Open the program settings window.</li>
<li><strong>Exit:</strong> This will simply close the application.</li>
</ul>
<h3 id="signal">Signal</h3>
<ul>
<li><strong>New:</strong> Add a new signal to the database.</li>
<li><strong>Edit:</strong> Edit the current/selected signal from the loaded database.</li>
</ul>
<h3 id="space-weather">Space Weather</h3>
<ul>
<li><strong>Check Report:</strong> Open the main <a href="../space_weather/current/">Space Weather window</a> and retrieve all the live data from Poseidon Crawler.</li>
</ul>
<h2 id="2-signal-list">2. Signal List</h2>
<p>This is the signal list where all the database entries are shown. When a signal is selected, it will load on the right panel.</p>
<h3 id="filter-by-namedescription">Filter by Name/Description</h3>
<p>On top of the list, there is a field for filtering signals by name or any keyword inside the description of the signal: this filter has the highest priority among all the filters.</p>
<h2 id="3-signal-menu">3. Signal Menu</h2>
<p>Here you can swithc between the main <strong>signal</strong> window and the <strong>filter</strong> page.</p>
<h2 id="4-tags">4. Tags</h2>
<ul>
<li><strong>Associate Tag:</strong> Custom tags can be associated to the selected signal with the <span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16"><path d="M8 0a8 8 0 1 1 0 16A8 8 0 0 1 8 0ZM1.5 8a6.5 6.5 0 1 0 13 0 6.5 6.5 0 0 0-13 0Zm7.25-3.25v2.5h2.5a.75.75 0 0 1 0 1.5h-2.5v2.5a.75.75 0 0 1-1.5 0v-2.5h-2.5a.75.75 0 0 1 0-1.5h2.5v-2.5a.75.75 0 0 1 1.5 0Z"/></svg></span> icon</li>
<li><strong>Remove Tag:</strong> In order to remove a tag, just click on its badge. </li>
<li><strong>Add/Rename Tag:</strong> To add a new tag open the <a href="#1-main-menu">Tags Editor</a> in the main menu.</li>
</ul>
<h2 id="5-add-parameter">5. Add Parameter</h2>
<p>Click on the labels to add the corresponding parameter to the signal (e.g. click on <strong>Frequency</strong> to add a new frequency).</p>
<h2 id="6-edit-parameter">6. Edit Parameter</h2>
<p>Click on the parameter badge to open the Signal Editor windows. From here, you can edit or delete the corresponding parameter.</p>
<div class="admonition tip">
<p class="admonition-title">Parameter Description</p>
<p>All the parameters have a description field: if some text is added, it will appear when the corresponding parameter badge is hovered with the mouse pointer.</p>
</div>
<h2 id="7-description">7. Description <span class="twemoji" title="Markdown Supported"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M22.27 19.385H1.73A1.73 1.73 0 0 1 0 17.655V6.345a1.73 1.73 0 0 1 1.73-1.73h20.54A1.73 1.73 0 0 1 24 6.345v11.308a1.73 1.73 0 0 1-1.73 1.731zM5.769 15.923v-4.5l2.308 2.885 2.307-2.885v4.5h2.308V8.078h-2.308l-2.307 2.885-2.308-2.885H3.46v7.847zM21.232 12h-2.309V8.077h-2.307V12h-2.308l3.461 4.039z"/></svg></span></h2>
<p>This is the description of the signal and can be edited from the <a href="#1-main-menu">Main Menu</a> (<code>Signal/Edit...</code>)</p>
<div class="admonition tip">
<p class="admonition-title">Markdown Supported</p>
<p>The Description field can render <strong>Markdown</strong>, a simple markup language for creating rich text using plain text. Headers, emphasis, lists, links, code blocks, and many more features for advanced text formatting. <a href="https://www.markdownguide.org/basic-syntax/">Markdown Basic Syntax <span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M22.27 19.385H1.73A1.73 1.73 0 0 1 0 17.655V6.345a1.73 1.73 0 0 1 1.73-1.73h20.54A1.73 1.73 0 0 1 24 6.345v11.308a1.73 1.73 0 0 1-1.73 1.731zM5.769 15.923v-4.5l2.308 2.885 2.307-2.885v4.5h2.308V8.078h-2.308l-2.307 2.885-2.308-2.885H3.46v7.847zM21.232 12h-2.309V8.077h-2.307V12h-2.308l3.461 4.039z"/></svg></span></a></p>
</div>
<h2 id="8-audio-sample">8. Audio Sample</h2>
<p>This is a player where an audio sample of the signal can be played. To associate an audio file to be shown as the <strong>main</strong> audio sample, check in the <a href="#10-extra">extra menu</a> below the signal spectrum.</p>
<h2 id="9-image-sample">9. Image Sample</h2>
<p>This is an image box that commonly contains the signal spectrum/waterfall. To associate an image file to be shown as the <strong>main</strong> image sample, check in the <a href="#10-extra">extra menu</a> below the signal spectrum.</p>
<h2 id="10-extra">10. Extra</h2>
<p><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17.9 17.39c-.26-.8-1.01-1.39-1.9-1.39h-1v-3a1 1 0 0 0-1-1H8v-2h2a1 1 0 0 0 1-1V7h2a2 2 0 0 0 2-2v-.41a7.984 7.984 0 0 1 2.9 12.8M11 19.93c-3.95-.49-7-3.85-7-7.93 0-.62.08-1.22.21-1.79L9 15v1a2 2 0 0 0 2 2m1-16A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2Z"/></svg></span> This button is only available for the standard SigID wiki database and connects the local signal to its counterpart on the <a href="https://www.sigidwiki.com/">sigidwiki website</a>.</p>
<p><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 4v18h16v2H4c-1.1 0-2-.9-2-2V4h2m11 3h5.5L15 1.5V7M8 0h8l6 6v12c0 1.11-.89 2-2 2H8a2 2 0 0 1-2-2V2c0-1.11.89-2 2-2m9 16v-2H8v2h9m3-4v-2H8v2h12Z"/></svg></span> This will open the <strong>Documents Manager</strong>. From here you can add any file (audio, image, pdf, etc.) to the signal entry. It is also possible to mark only one image and one audio to be shown on the main signal window.</p>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "..", "features": "content.code.copy content.tooltips", "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script src="../assets/javascripts/bundle.081f42fc.min.js"></script>
<script src="../javascripts/katex.js"></script>
<script src="https://unpkg.com/katex@0/dist/katex.min.js"></script>
<script src="https://unpkg.com/katex@0/dist/contrib/auto-render.min.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink