{
  "__type": "IngestedDoc",
  "__tag": 4010,
  "_content": {
    "Notes": {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "The probability density function for "
            },
            {
              "__type": "InlineRole",
              "__tag": 4003,
              "value": "rel_breitwigner",
              "domain": null,
              "role": null,
              "inventory": null
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " is"
            }
          ]
        },
        {
          "__type": "Math",
          "__tag": 4058,
          "value": "f(x, \\rho) = \\frac{k}{(x^2 - \\rho^2)^2 + \\rho^2}"
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "where"
            }
          ]
        },
        {
          "__type": "Math",
          "__tag": 4058,
          "value": "k = \\frac{2\\sqrt{2}\\rho^2\\sqrt{\\rho^2 + 1}}\n    {\\pi\\sqrt{\\rho^2 + \\rho\\sqrt{\\rho^2 + 1}}}"
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "The relativistic Breit-Wigner distribution is used in high energy physics to model resonances "
            },
            {
              "__type": "FootnoteReference",
              "__tag": 4066,
              "label": "1"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": ". It gives the uncertainty in the invariant mass, "
            },
            {
              "__type": "InlineMath",
              "__tag": 4057,
              "value": "M"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " "
            },
            {
              "__type": "FootnoteReference",
              "__tag": 4066,
              "label": "2"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": ", of a resonance with characteristic mass "
            },
            {
              "__type": "InlineMath",
              "__tag": 4057,
              "value": "M_0"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " and decay-width "
            },
            {
              "__type": "InlineMath",
              "__tag": 4057,
              "value": "\\Gamma"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": ", where "
            },
            {
              "__type": "InlineMath",
              "__tag": 4057,
              "value": "M"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": ", "
            },
            {
              "__type": "InlineMath",
              "__tag": 4057,
              "value": "M_0"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " and "
            },
            {
              "__type": "InlineMath",
              "__tag": 4057,
              "value": "\\Gamma"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " are expressed in natural units. In SciPy's parametrization, the shape parameter "
            },
            {
              "__type": "InlineMath",
              "__tag": 4057,
              "value": "\\rho"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " is equal to "
            },
            {
              "__type": "InlineMath",
              "__tag": 4057,
              "value": "M_0/\\Gamma"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " and takes values in "
            },
            {
              "__type": "InlineMath",
              "__tag": 4057,
              "value": "(0, \\infty)"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "."
            }
          ]
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "Equivalently, the relativistic Breit-Wigner distribution is said to give the uncertainty in the center-of-mass energy "
            },
            {
              "__type": "InlineMath",
              "__tag": 4057,
              "value": "E_{\\text{cm}}"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": ". In natural units, the speed of light "
            },
            {
              "__type": "InlineMath",
              "__tag": 4057,
              "value": "c"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " is equal to 1 and the invariant mass "
            },
            {
              "__type": "InlineMath",
              "__tag": 4057,
              "value": "M"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " is equal to the rest energy "
            },
            {
              "__type": "InlineMath",
              "__tag": 4057,
              "value": "Mc^2"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": ". In the center-of-mass frame, the rest energy is equal to the total energy "
            },
            {
              "__type": "FootnoteReference",
              "__tag": 4066,
              "label": "3"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "."
            }
          ]
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "%(after_notes)s"
            }
          ]
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "InlineMath",
              "__tag": 4057,
              "value": "\\rho = M/\\Gamma"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " and "
            },
            {
              "__type": "InlineMath",
              "__tag": 4057,
              "value": "\\Gamma"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " is the scale parameter. For example, if one seeks to model the "
            },
            {
              "__type": "InlineMath",
              "__tag": 4057,
              "value": "Z^0"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " boson with "
            },
            {
              "__type": "InlineMath",
              "__tag": 4057,
              "value": "M_0 \\approx 91.1876 \\text{ GeV}"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " and "
            },
            {
              "__type": "InlineMath",
              "__tag": 4057,
              "value": "\\Gamma \\approx 2.4952\\text{ GeV}"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " "
            },
            {
              "__type": "FootnoteReference",
              "__tag": 4066,
              "label": "4"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " one can set "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "rho=91.1876/2.4952"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " and "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "scale=2.4952"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "."
            }
          ]
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "To ensure a physically meaningful result when using the "
            },
            {
              "__type": "InlineRole",
              "__tag": 4003,
              "value": "fit",
              "domain": null,
              "role": null,
              "inventory": null
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " method, one should set "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "floc=0"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " to fix the location parameter to 0."
            }
          ]
        }
      ],
      "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": "A relativistic Breit-Wigner random variable."
            }
          ]
        }
      ],
      "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": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Extended Summary": {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "%(before_notes)s"
            }
          ]
        }
      ],
      "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/stats/_continuous_distns.py",
  "item_line": 12388,
  "item_type": "class",
  "aliases": [
    "scipy.stats._continuous_distns.rel_breitwigner_gen"
  ],
  "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": "cauchy",
        "reference": {
          "__type": "RefInfo",
          "__tag": 4000,
          "module": "current-module",
          "version": "current-version",
          "kind": "to-resolve",
          "path": "cauchy"
        },
        "kind": "module"
      },
      "descriptions": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "Cauchy distribution, also known as the Breit-Wigner distribution."
            }
          ]
        }
      ],
      "type": null
    }
  ],
  "signature": {
    "__type": "SignatureNode",
    "__tag": 4029,
    "kind": "function",
    "parameters": [
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "momtype",
        "annotation": {
          "__type": "Empty",
          "__tag": 4031
        },
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": "1"
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "a",
        "annotation": {
          "__type": "Empty",
          "__tag": 4031
        },
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": "None"
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "b",
        "annotation": {
          "__type": "Empty",
          "__tag": 4031
        },
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": "None"
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "xtol",
        "annotation": {
          "__type": "Empty",
          "__tag": 4031
        },
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": "1e-14"
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "badvalue",
        "annotation": {
          "__type": "Empty",
          "__tag": 4031
        },
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": "None"
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "name",
        "annotation": {
          "__type": "Empty",
          "__tag": 4031
        },
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": "None"
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "longname",
        "annotation": {
          "__type": "Empty",
          "__tag": 4031
        },
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": "None"
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "shapes",
        "annotation": {
          "__type": "Empty",
          "__tag": 4031
        },
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": "None"
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "seed",
        "annotation": {
          "__type": "Empty",
          "__tag": 4031
        },
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": "None"
      }
    ],
    "return_annotation": {
      "__type": "Empty",
      "__tag": 4031
    },
    "target_name": "rel_breitwigner_gen"
  },
  "references": [
    ".. [1] Relativistic Breit-Wigner distribution, Wikipedia,",
    "       https://en.wikipedia.org/wiki/Relativistic_Breit-Wigner_distribution",
    ".. [2] Invariant mass, Wikipedia,",
    "       https://en.wikipedia.org/wiki/Invariant_mass",
    ".. [3] Center-of-momentum frame, Wikipedia,",
    "       https://en.wikipedia.org/wiki/Center-of-momentum_frame",
    ".. [4] M. Tanabashi et al. (Particle Data Group) Phys. Rev. D 98, 030001 -",
    "       Published 17 August 2018",
    "",
    "%(example)s"
  ],
  "qa": "scipy.stats._continuous_distns:rel_breitwigner_gen",
  "arbitrary": [],
  "local_refs": []
}