sam/pyFTS
1
0
Fork 0
Code Issues 3 Pull Requests Actions Packages Projects Releases Wiki Activity
02f6022a53
pyFTS/docs/build/html/pyFTS.models.seasonal.html
Petrônio Cândido 471d7b2f48 Documentation update
2023-05-24 20:05:50 -03:00

530 lines
54 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<title>pyFTS.models.seasonal package &#8212; pyFTS 1.7 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/bizstyle.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/bizstyle.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="pyFTS.partitioners package" href="pyFTS.partitioners.html" />
<link rel="prev" title="pyFTS.models.nonstationary package" href="pyFTS.models.nonstationary.html" />
<meta name="viewport" content="width=device-width,initial-scale=1.0" />
<!--[if lt IE 9]>
<script src="_static/css3-mediaqueries.js"></script>
<![endif]-->
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="pyFTS.partitioners.html" title="pyFTS.partitioners package"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="pyFTS.models.nonstationary.html" title="pyFTS.models.nonstationary package"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">pyFTS 1.7 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="modules.html" >pyFTS</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="pyFTS.html" >pyFTS package</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="pyFTS.models.html" accesskey="U">pyFTS.models package</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">pyFTS.models.seasonal package</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="pyfts-models-seasonal-package">
<h1>pyFTS.models.seasonal package<a class="headerlink" href="#pyfts-models-seasonal-package" title="Permalink to this headline"></a></h1>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</section>
<section id="module-pyFTS.models.seasonal.SeasonalIndexer">
<span id="pyfts-models-seasonal-seasonalindexer-module"></span><h2>pyFTS.models.seasonal.SeasonalIndexer module<a class="headerlink" href="#module-pyFTS.models.seasonal.SeasonalIndexer" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyFTS.models.seasonal.SeasonalIndexer.</span></span><span class="sig-name descname"><span class="pre">DataFrameSeasonalIndexer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index_fields</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">index_seasons</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_field</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#DataFrameSeasonalIndexer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer" title="pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer</span></code></a></p>
<p>Use the Pandas.DataFrame index position to index the seasonality</p>
<dl class="py method">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.get_data">
<span class="sig-name descname"><span class="pre">get_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#DataFrameSeasonalIndexer.get_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.get_data" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.get_data_by_season">
<span class="sig-name descname"><span class="pre">get_data_by_season</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indexes</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#DataFrameSeasonalIndexer.get_data_by_season"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.get_data_by_season" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.get_index_by_season">
<span class="sig-name descname"><span class="pre">get_index_by_season</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">indexes</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#DataFrameSeasonalIndexer.get_index_by_season"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.get_index_by_season" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.get_season_by_index">
<span class="sig-name descname"><span class="pre">get_season_by_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#DataFrameSeasonalIndexer.get_season_by_index"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.get_season_by_index" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.get_season_of_data">
<span class="sig-name descname"><span class="pre">get_season_of_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#DataFrameSeasonalIndexer.get_season_of_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.get_season_of_data" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.set_data">
<span class="sig-name descname"><span class="pre">set_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#DataFrameSeasonalIndexer.set_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.set_data" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyFTS.models.seasonal.SeasonalIndexer.</span></span><span class="sig-name descname"><span class="pre">DateTimeSeasonalIndexer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">date_field</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">index_fields</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">index_seasons</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_field</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#DateTimeSeasonalIndexer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer" title="pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer</span></code></a></p>
<p>Use a Pandas.DataFrame date field to index the seasonality</p>
<dl class="py method">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_data">
<span class="sig-name descname"><span class="pre">get_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#DateTimeSeasonalIndexer.get_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_data" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_data_by_season">
<span class="sig-name descname"><span class="pre">get_data_by_season</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indexes</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#DateTimeSeasonalIndexer.get_data_by_season"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_data_by_season" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_index">
<span class="sig-name descname"><span class="pre">get_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#DateTimeSeasonalIndexer.get_index"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_index" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_index_by_season">
<span class="sig-name descname"><span class="pre">get_index_by_season</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">indexes</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#DateTimeSeasonalIndexer.get_index_by_season"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_index_by_season" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_season_by_index">
<span class="sig-name descname"><span class="pre">get_season_by_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#DateTimeSeasonalIndexer.get_season_by_index"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_season_by_index" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_season_of_data">
<span class="sig-name descname"><span class="pre">get_season_of_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#DateTimeSeasonalIndexer.get_season_of_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_season_of_data" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.set_data">
<span class="sig-name descname"><span class="pre">set_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#DateTimeSeasonalIndexer.set_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.set_data" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.LinearSeasonalIndexer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyFTS.models.seasonal.SeasonalIndexer.</span></span><span class="sig-name descname"><span class="pre">LinearSeasonalIndexer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">seasons</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">units</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignore</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#LinearSeasonalIndexer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.LinearSeasonalIndexer" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer" title="pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer</span></code></a></p>
<p>Use the data array/list position to index the seasonality</p>
<dl class="py method">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.LinearSeasonalIndexer.get_data">
<span class="sig-name descname"><span class="pre">get_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#LinearSeasonalIndexer.get_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.LinearSeasonalIndexer.get_data" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.LinearSeasonalIndexer.get_index_by_season">
<span class="sig-name descname"><span class="pre">get_index_by_season</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">indexes</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#LinearSeasonalIndexer.get_index_by_season"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.LinearSeasonalIndexer.get_index_by_season" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.LinearSeasonalIndexer.get_season_by_index">
<span class="sig-name descname"><span class="pre">get_season_by_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#LinearSeasonalIndexer.get_season_by_index"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.LinearSeasonalIndexer.get_season_by_index" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.LinearSeasonalIndexer.get_season_of_data">
<span class="sig-name descname"><span class="pre">get_season_of_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#LinearSeasonalIndexer.get_season_of_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.LinearSeasonalIndexer.get_season_of_data" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyFTS.models.seasonal.SeasonalIndexer.</span></span><span class="sig-name descname"><span class="pre">SeasonalIndexer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_seasons</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#SeasonalIndexer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Seasonal Indexer. Responsible to find the seasonal index of a data point inside its data set</p>
<dl class="py method">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_data">
<span class="sig-name descname"><span class="pre">get_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#SeasonalIndexer.get_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_data" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_data_by_season">
<span class="sig-name descname"><span class="pre">get_data_by_season</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indexes</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#SeasonalIndexer.get_data_by_season"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_data_by_season" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_index">
<span class="sig-name descname"><span class="pre">get_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#SeasonalIndexer.get_index"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_index" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_index_by_season">
<span class="sig-name descname"><span class="pre">get_index_by_season</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">indexes</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#SeasonalIndexer.get_index_by_season"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_index_by_season" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_season_by_index">
<span class="sig-name descname"><span class="pre">get_season_by_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">inde</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#SeasonalIndexer.get_season_by_index"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_season_by_index" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_season_of_data">
<span class="sig-name descname"><span class="pre">get_season_of_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#SeasonalIndexer.get_season_of_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_season_of_data" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<section id="pyfts-models-seasonal-cmsfts-module">
<h2>pyFTS.models.seasonal.cmsfts module<a class="headerlink" href="#pyfts-models-seasonal-cmsfts-module" title="Permalink to this headline"></a></h2>
</section>
<section id="module-pyFTS.models.seasonal.common">
<span id="pyfts-models-seasonal-common-module"></span><h2>pyFTS.models.seasonal.common module<a class="headerlink" href="#module-pyFTS.models.seasonal.common" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyFTS.models.seasonal.common.</span></span><span class="sig-name descname"><span class="pre">DateTime</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/common.html#DateTime"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/enum.html#enum.Enum" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></a></p>
<p>Data and Time granularity for time granularity and seasonality identification</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.day_of_month">
<span class="sig-name descname"><span class="pre">day_of_month</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">30</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.day_of_month" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.day_of_week">
<span class="sig-name descname"><span class="pre">day_of_week</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">7</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.day_of_week" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.day_of_year">
<span class="sig-name descname"><span class="pre">day_of_year</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">364</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.day_of_year" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.half">
<span class="sig-name descname"><span class="pre">half</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.half" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.hour">
<span class="sig-name descname"><span class="pre">hour</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">24</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.hour" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.hour_of_day">
<span class="sig-name descname"><span class="pre">hour_of_day</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">24</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.hour_of_day" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.hour_of_month">
<span class="sig-name descname"><span class="pre">hour_of_month</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">744</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.hour_of_month" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.hour_of_week">
<span class="sig-name descname"><span class="pre">hour_of_week</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">168</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.hour_of_week" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.hour_of_year">
<span class="sig-name descname"><span class="pre">hour_of_year</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">8736</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.hour_of_year" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.minute">
<span class="sig-name descname"><span class="pre">minute</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">60</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.minute" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.minute_of_day">
<span class="sig-name descname"><span class="pre">minute_of_day</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1440</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.minute_of_day" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.minute_of_hour">
<span class="sig-name descname"><span class="pre">minute_of_hour</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">60</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.minute_of_hour" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.minute_of_month">
<span class="sig-name descname"><span class="pre">minute_of_month</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">44640</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.minute_of_month" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.minute_of_week">
<span class="sig-name descname"><span class="pre">minute_of_week</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">10080</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.minute_of_week" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.minute_of_year">
<span class="sig-name descname"><span class="pre">minute_of_year</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">524160</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.minute_of_year" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.month">
<span class="sig-name descname"><span class="pre">month</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">12</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.month" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.quarter">
<span class="sig-name descname"><span class="pre">quarter</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">4</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.quarter" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.second">
<span class="sig-name descname"><span class="pre">second</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">60</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.second" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.second_of_day">
<span class="sig-name descname"><span class="pre">second_of_day</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">86400</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.second_of_day" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.second_of_hour">
<span class="sig-name descname"><span class="pre">second_of_hour</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3600</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.second_of_hour" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.second_of_minute">
<span class="sig-name descname"><span class="pre">second_of_minute</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">60.00001</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.second_of_minute" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.sixth">
<span class="sig-name descname"><span class="pre">sixth</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">6</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.sixth" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.third">
<span class="sig-name descname"><span class="pre">third</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.third" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.year">
<span class="sig-name descname"><span class="pre">year</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.year" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.FuzzySet">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyFTS.models.seasonal.common.</span></span><span class="sig-name descname"><span class="pre">FuzzySet</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">datepart</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mf</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">centroid</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alpha</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/common.html#FuzzySet"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.common.FuzzySet" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyFTS.common.html#pyFTS.common.FuzzySet.FuzzySet" title="pyFTS.common.FuzzySet.FuzzySet"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyFTS.common.FuzzySet.FuzzySet</span></code></a></p>
<p>Temporal/Seasonal Fuzzy Set</p>
<dl class="py method">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.FuzzySet.transform">
<span class="sig-name descname"><span class="pre">transform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/common.html#FuzzySet.transform"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.common.FuzzySet.transform" title="Permalink to this definition"></a></dt>
<dd><p>Preprocess the data point for non native types</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>x</strong> – </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>return a native type value for the structured type</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.strip_datepart">
<span class="sig-prename descclassname"><span class="pre">pyFTS.models.seasonal.common.</span></span><span class="sig-name descname"><span class="pre">strip_datepart</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">date</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">date_part</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mask</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/common.html#strip_datepart"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.common.strip_datepart" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</section>
<section id="pyfts-models-seasonal-msfts-module">
<h2>pyFTS.models.seasonal.msfts module<a class="headerlink" href="#pyfts-models-seasonal-msfts-module" title="Permalink to this headline"></a></h2>
</section>
<section id="module-pyFTS.models.seasonal.partitioner">
<span id="pyfts-models-seasonal-partitioner-module"></span><h2>pyFTS.models.seasonal.partitioner module<a class="headerlink" href="#module-pyFTS.models.seasonal.partitioner" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.partitioner.TimeGridPartitioner">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyFTS.models.seasonal.partitioner.</span></span><span class="sig-name descname"><span class="pre">TimeGridPartitioner</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/partitioner.html#TimeGridPartitioner"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.partitioner.TimeGridPartitioner" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyFTS.partitioners.html#pyFTS.partitioners.partitioner.Partitioner" title="pyFTS.partitioners.partitioner.Partitioner"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyFTS.partitioners.partitioner.Partitioner</span></code></a></p>
<p>Even Length DateTime Grid Partitioner</p>
<dl class="py method">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.partitioner.TimeGridPartitioner.build">
<span class="sig-name descname"><span class="pre">build</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/partitioner.html#TimeGridPartitioner.build"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.partitioner.TimeGridPartitioner.build" title="Permalink to this definition"></a></dt>
<dd><p>Perform the partitioning of the Universe of Discourse</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>data</strong> – training data</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.partitioner.TimeGridPartitioner.build_index">
<span class="sig-name descname"><span class="pre">build_index</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/partitioner.html#TimeGridPartitioner.build_index"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.partitioner.TimeGridPartitioner.build_index" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.partitioner.TimeGridPartitioner.extractor">
<span class="sig-name descname"><span class="pre">extractor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/partitioner.html#TimeGridPartitioner.extractor"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.partitioner.TimeGridPartitioner.extractor" title="Permalink to this definition"></a></dt>
<dd><p>Extract a single primitive type from an structured instance</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.partitioner.TimeGridPartitioner.mask">
<span class="sig-name descname"><span class="pre">mask</span></span><a class="headerlink" href="#pyFTS.models.seasonal.partitioner.TimeGridPartitioner.mask" title="Permalink to this definition"></a></dt>
<dd><p>A string with datetime formating mask</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.partitioner.TimeGridPartitioner.plot">
<span class="sig-name descname"><span class="pre">plot</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ax</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/partitioner.html#TimeGridPartitioner.plot"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.partitioner.TimeGridPartitioner.plot" title="Permalink to this definition"></a></dt>
<dd><p>Plot the
:param ax:
:return:</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.partitioner.TimeGridPartitioner.search">
<span class="sig-name descname"><span class="pre">search</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/partitioner.html#TimeGridPartitioner.search"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.partitioner.TimeGridPartitioner.search" title="Permalink to this definition"></a></dt>
<dd><p>Perform a search for the nearest fuzzy sets of the point ‘data’. This function were designed to work with several
overlapped fuzzy sets.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – the value to search for the nearest fuzzy sets</p></li>
<li><p><strong>type</strong> – the return type: ‘index’ for the fuzzy set indexes or ‘name’ for fuzzy set names.</p></li>
<li><p><strong>results</strong> – the number of nearest fuzzy sets to return</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>a list with the nearest fuzzy sets</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.partitioner.TimeGridPartitioner.season">
<span class="sig-name descname"><span class="pre">season</span></span><a class="headerlink" href="#pyFTS.models.seasonal.partitioner.TimeGridPartitioner.season" title="Permalink to this definition"></a></dt>
<dd><p>Seasonality, a pyFTS.models.seasonal.common.DateTime object</p>
</dd></dl>
</dd></dl>
</section>
<section id="pyfts-models-seasonal-sfts-module">
<h2>pyFTS.models.seasonal.sfts module<a class="headerlink" href="#pyfts-models-seasonal-sfts-module" title="Permalink to this headline"></a></h2>
</section>
<section id="module-pyFTS.models.seasonal">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyFTS.models.seasonal" title="Permalink to this headline"></a></h2>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/logo_heading2.png" alt="Logo"/>
</a></p>
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">pyFTS.models.seasonal package</a><ul>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#module-pyFTS.models.seasonal.SeasonalIndexer">pyFTS.models.seasonal.SeasonalIndexer module</a></li>
<li><a class="reference internal" href="#pyfts-models-seasonal-cmsfts-module">pyFTS.models.seasonal.cmsfts module</a></li>
<li><a class="reference internal" href="#module-pyFTS.models.seasonal.common">pyFTS.models.seasonal.common module</a></li>
<li><a class="reference internal" href="#pyfts-models-seasonal-msfts-module">pyFTS.models.seasonal.msfts module</a></li>
<li><a class="reference internal" href="#module-pyFTS.models.seasonal.partitioner">pyFTS.models.seasonal.partitioner module</a></li>
<li><a class="reference internal" href="#pyfts-models-seasonal-sfts-module">pyFTS.models.seasonal.sfts module</a></li>
<li><a class="reference internal" href="#module-pyFTS.models.seasonal">Module contents</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="pyFTS.models.nonstationary.html"
title="previous chapter">pyFTS.models.nonstationary package</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="pyFTS.partitioners.html"
title="next chapter">pyFTS.partitioners package</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/pyFTS.models.seasonal.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="pyFTS.partitioners.html" title="pyFTS.partitioners package"
>next</a> |</li>
<li class="right" >
<a href="pyFTS.models.nonstationary.html" title="pyFTS.models.nonstationary package"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">pyFTS 1.7 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="modules.html" >pyFTS</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="pyFTS.html" >pyFTS package</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="pyFTS.models.html" >pyFTS.models package</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">pyFTS.models.seasonal package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2022, Machine Intelligence and Data Science Laboratory - UFMG - Brazil.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink