{
  "__type": "IngestedDoc",
  "__tag": 4010,
  "_content": {
    "Notes": {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "It is required that "
            },
            {
              "__type": "ParamRef",
              "__tag": 4071,
              "name": "S"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " has "
            },
            {
              "__type": "InlineRole",
              "__tag": 4003,
              "value": "f_pts",
              "domain": null,
              "role": null,
              "inventory": null
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " entries along the "
            },
            {
              "__type": "ParamRef",
              "__tag": 4071,
              "name": "f_axis"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": ". For the "
            },
            {
              "__type": "ParamRef",
              "__tag": 4071,
              "name": "t_axis"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " it is assumed that the first entry corresponds to "
            },
            {
              "__type": "InlineRole",
              "__tag": 4003,
              "value": "p_min",
              "domain": null,
              "role": null,
              "inventory": null
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " * "
            },
            {
              "__type": "InlineRole",
              "__tag": 4003,
              "value": "delta_t",
              "domain": null,
              "role": null,
              "inventory": null
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " (being <= 0). The length of "
            },
            {
              "__type": "ParamRef",
              "__tag": 4071,
              "name": "t_axis"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " needs to be compatible with "
            },
            {
              "__type": "ParamRef",
              "__tag": 4071,
              "name": "k1"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": ". I.e., "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "S.shape[t_axis] >= self.p_max(k1)"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " must hold, if "
            },
            {
              "__type": "ParamRef",
              "__tag": 4071,
              "name": "k1"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " is not "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "None"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": ". Else "
            },
            {
              "__type": "ParamRef",
              "__tag": 4071,
              "name": "k1"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " is set to "
            },
            {
              "__type": "CrossRef",
              "__tag": 4002,
              "value": "k_max",
              "reference": {
                "__type": "LocalRef",
                "__tag": 4022,
                "kind": "module",
                "path": "scipy.signal._short_time_fft:ShortTimeFFT.k_max"
              },
              "kind": "module"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " with      "
            }
          ]
        },
        {
          "__type": "Code",
          "__tag": 4050,
          "value": "q_max = S.shape[t_range] + self.p_min\nk_max = (q_max - 1) * self.hop + self.m_num - self.m_num_mid",
          "execution_status": null
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "The "
            },
            {
              "__type": "InlineRole",
              "__tag": 4003,
              "value": "tutorial_stft",
              "domain": null,
              "role": "ref",
              "inventory": null
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " section of the "
            },
            {
              "__type": "InlineRole",
              "__tag": 4003,
              "value": "user_guide",
              "domain": null,
              "role": "ref",
              "inventory": null
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " discussed the slicing behavior by means of an example."
            }
          ]
        }
      ],
      "title": [],
      "level": 0,
      "target": null
    },
    "Warns": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Raises": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Yields": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Methods": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Returns": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Summary": {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "Inverse short-time Fourier transform."
            }
          ]
        }
      ],
      "title": [],
      "level": 0,
      "target": null
    },
    "Receives": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Warnings": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Attributes": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Parameters": {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Parameters",
          "__tag": 4026,
          "children": [
            {
              "__type": "DocParam",
              "__tag": 4016,
              "name": "S",
              "annotation": "",
              "desc": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "A complex valued array where "
                    },
                    {
                      "__type": "ParamRef",
                      "__tag": 4071,
                      "name": "f_axis"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " denotes the frequency values and the "
                    },
                    {
                      "__type": "InlineRole",
                      "__tag": 4003,
                      "value": "t-axis",
                      "domain": null,
                      "role": null,
                      "inventory": null
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " dimension the temporal values of the STFT values."
                    }
                  ]
                }
              ]
            },
            {
              "__type": "DocParam",
              "__tag": 4016,
              "name": "k0, k1",
              "annotation": "",
              "desc": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "The start and the end index of the reconstructed signal. The default ("
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "k0 = 0"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": ", "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "k1 = None"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": ") assumes that the maximum length signal should be reconstructed."
                    }
                  ]
                }
              ]
            },
            {
              "__type": "DocParam",
              "__tag": 4016,
              "name": "f_axis, t_axis",
              "annotation": "",
              "desc": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "The axes in "
                    },
                    {
                      "__type": "ParamRef",
                      "__tag": 4071,
                      "name": "S"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " denoting the frequency and the time dimension."
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "title": [],
      "level": 0,
      "target": null
    },
    "Extended Summary": {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "It returns an array of dimension "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "S.ndim - 1"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "  which is real if "
            },
            {
              "__type": "InlineRole",
              "__tag": 4003,
              "value": "onesided_fft",
              "domain": null,
              "role": null,
              "inventory": null
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " is set, else complex. If the STFT is not "
            },
            {
              "__type": "InlineRole",
              "__tag": 4003,
              "value": "invertible",
              "domain": null,
              "role": null,
              "inventory": null
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": ", or the parameters are out of bounds  a "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "ValueError"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " is raised."
            }
          ]
        }
      ],
      "title": [],
      "level": 0,
      "target": null
    },
    "Other Parameters": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    }
  },
  "_ordered_sections": [
    "Summary",
    "Extended Summary",
    "Parameters",
    "Attributes",
    "Methods",
    "Returns",
    "Yields",
    "Receives",
    "Other Parameters",
    "Raises",
    "Warns",
    "Warnings",
    "Notes"
  ],
  "item_file": "/scipy/signal/_short_time_fft.py",
  "item_line": 1452,
  "item_type": "function",
  "aliases": [
    "scipy.signal.ShortTimeFFT.istft"
  ],
  "example_section_data": {
    "__type": "Section",
    "__tag": 4015,
    "children": [],
    "title": [],
    "level": 0,
    "target": null
  },
  "see_also": [
    {
      "__type": "SeeAlsoItem",
      "__tag": 4028,
      "name": {
        "__type": "CrossRef",
        "__tag": 4002,
        "value": "invertible",
        "reference": {
          "__type": "RefInfo",
          "__tag": 4000,
          "module": "current-module",
          "version": "current-version",
          "kind": "to-resolve",
          "path": "invertible"
        },
        "kind": "module"
      },
      "descriptions": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "Check if STFT is invertible."
            }
          ]
        }
      ],
      "type": null
    },
    {
      "__type": "SeeAlsoItem",
      "__tag": 4028,
      "name": {
        "__type": "CrossRef",
        "__tag": 4002,
        "value": "scipy.signal.ShortTimeFFT",
        "reference": {
          "__type": "LocalRef",
          "__tag": 4022,
          "kind": "module",
          "path": "scipy.signal._short_time_fft:ShortTimeFFT"
        },
        "kind": "module"
      },
      "descriptions": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "Class this method belongs to."
            }
          ]
        }
      ],
      "type": "class"
    },
    {
      "__type": "SeeAlsoItem",
      "__tag": 4028,
      "name": {
        "__type": "CrossRef",
        "__tag": 4002,
        "value": "~ShortTimeFFT.stft",
        "reference": {
          "__type": "RefInfo",
          "__tag": 4000,
          "module": "current-module",
          "version": "current-version",
          "kind": "to-resolve",
          "path": "~ShortTimeFFT.stft"
        },
        "kind": "module"
      },
      "descriptions": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "Perform Short-time Fourier transform."
            }
          ]
        }
      ],
      "type": "meth"
    }
  ],
  "signature": {
    "__type": "SignatureNode",
    "__tag": 4029,
    "kind": "function",
    "parameters": [
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "self",
        "annotation": {
          "__type": "Empty",
          "__tag": 4031
        },
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": {
          "__type": "Empty",
          "__tag": 4031
        }
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "S",
        "annotation": "np.ndarray",
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": {
          "__type": "Empty",
          "__tag": 4031
        }
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "k0",
        "annotation": "int",
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": "0"
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "k1",
        "annotation": "int | None",
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": "None"
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "f_axis",
        "annotation": "int",
        "kind": "KEYWORD_ONLY",
        "default": "-2"
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "t_axis",
        "annotation": "int",
        "kind": "KEYWORD_ONLY",
        "default": "-1"
      }
    ],
    "return_annotation": "np.ndarray",
    "target_name": "istft"
  },
  "references": null,
  "qa": "scipy.signal._short_time_fft:ShortTimeFFT.istft",
  "arbitrary": [],
  "local_refs": [
    "S",
    "f_axis",
    "k0",
    "k1",
    "t_axis"
  ]
}