{
  "__type": "IngestedDoc",
  "__tag": 4010,
  "_content": {
    "Notes": {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "The primary use for the "
            },
            {
              "__type": "CrossRef",
              "__tag": 4002,
              "value": "printdiff",
              "reference": {
                "__type": "LocalRef",
                "__tag": 4022,
                "kind": "module",
                "path": "astropy.io.fits.convenience:printdiff"
              },
              "kind": "module"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " function is to allow quick print out of a FITS difference report and will write to "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "sys.stdout"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": ". To save the diff report to a file please use "
            },
            {
              "__type": "CrossRef",
              "__tag": 4002,
              "value": "FITSDiff",
              "reference": {
                "__type": "RefInfo",
                "__tag": 4000,
                "module": "astropy",
                "version": "*",
                "kind": "api",
                "path": "astropy.io.fits.diff:FITSDiff"
              },
              "kind": "module"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " directly."
            }
          ]
        }
      ],
      "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": "Compare two parts of a FITS file, including entire FITS files, FITS "
            },
            {
              "__type": "CrossRef",
              "__tag": 4002,
              "value": "HDUList",
              "reference": {
                "__type": "LocalRef",
                "__tag": 4022,
                "kind": "module",
                "path": "astropy.io.fits.hdu.hdulist:HDUList"
              },
              "kind": "module"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " objects and FITS "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "HDU"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " objects."
            }
          ]
        }
      ],
      "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": "inputa",
              "annotation": "str, `HDUList` object, or ``HDU`` object",
              "desc": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "The filename of a FITS file, "
                    },
                    {
                      "__type": "CrossRef",
                      "__tag": 4002,
                      "value": "HDUList",
                      "reference": {
                        "__type": "LocalRef",
                        "__tag": 4022,
                        "kind": "module",
                        "path": "astropy.io.fits.hdu.hdulist:HDUList"
                      },
                      "kind": "module"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": ", or "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "HDU"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " object to compare to "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "inputb"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "."
                    }
                  ]
                }
              ]
            },
            {
              "__type": "DocParam",
              "__tag": 4016,
              "name": "inputb",
              "annotation": "str, `HDUList` object, or ``HDU`` object",
              "desc": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "The filename of a FITS file, "
                    },
                    {
                      "__type": "CrossRef",
                      "__tag": 4002,
                      "value": "HDUList",
                      "reference": {
                        "__type": "LocalRef",
                        "__tag": 4022,
                        "kind": "module",
                        "path": "astropy.io.fits.hdu.hdulist:HDUList"
                      },
                      "kind": "module"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": ", or "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "HDU"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " object to compare to "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "inputa"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "."
                    }
                  ]
                }
              ]
            },
            {
              "__type": "DocParam",
              "__tag": 4016,
              "name": "ext, extname, extver",
              "annotation": "",
              "desc": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "Additional positional arguments are for HDU specification if your inputs are string filenames (will not work if "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "inputa"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " and "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "inputb"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " are "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "HDU"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " objects or "
                    },
                    {
                      "__type": "CrossRef",
                      "__tag": 4002,
                      "value": "HDUList",
                      "reference": {
                        "__type": "LocalRef",
                        "__tag": 4022,
                        "kind": "module",
                        "path": "astropy.io.fits.hdu.hdulist:HDUList"
                      },
                      "kind": "module"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " objects). They are flexible and are best illustrated by examples.  In addition to using these arguments positionally you can directly call the keyword parameters "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "ext"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": ", "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "extname"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "."
                    }
                  ]
                },
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "By HDU number      "
                    }
                  ]
                },
                {
                  "__type": "Code",
                  "__tag": 4050,
                  "value": "printdiff('inA.fits', 'inB.fits', 0)      # the primary HDU\nprintdiff('inA.fits', 'inB.fits', 2)      # the second extension HDU\nprintdiff('inA.fits', 'inB.fits', ext=2)  # the second extension HDU",
                  "execution_status": null,
                  "out": ""
                },
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "By name, i.e., "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "EXTNAME"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " value (if unique). "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "EXTNAME"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " values are not case sensitive:"
                    }
                  ]
                },
                {
                  "__type": "Blockquote",
                  "__tag": 4059,
                  "children": [
                    {
                      "__type": "Paragraph",
                      "__tag": 4045,
                      "children": [
                        {
                          "__type": "Text",
                          "__tag": 4046,
                          "value": "printdiff('inA.fits', 'inB.fits', 'sci')     printdiff('inA.fits', 'inB.fits', extname='sci')  # equivalent"
                        }
                      ]
                    }
                  ]
                },
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "By combination of "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "EXTNAME"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " and "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "EXTVER"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " as separate arguments or as a tuple      "
                    }
                  ]
                },
                {
                  "__type": "Code",
                  "__tag": 4050,
                  "value": "printdiff('inA.fits', 'inB.fits', 'sci', 2)    # EXTNAME='SCI'\n                                               # & EXTVER=2\nprintdiff('inA.fits', 'inB.fits', extname='sci', extver=2)\n                                               # equivalent\nprintdiff('inA.fits', 'inB.fits', ('sci', 2))  # equivalent",
                  "execution_status": null,
                  "out": ""
                },
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "Ambiguous or conflicting specifications will raise an exception      "
                    }
                  ]
                },
                {
                  "__type": "Code",
                  "__tag": 4050,
                  "value": "printdiff('inA.fits', 'inB.fits',\n          ext=('sci', 1), extname='err', extver=2)",
                  "execution_status": null,
                  "out": ""
                }
              ]
            },
            {
              "__type": "DocParam",
              "__tag": 4016,
              "name": "**kwargs",
              "annotation": "",
              "desc": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "Any additional keyword arguments to be passed to "
                    },
                    {
                      "__type": "CrossRef",
                      "__tag": 4002,
                      "value": "FITSDiff",
                      "reference": {
                        "__type": "RefInfo",
                        "__tag": 4000,
                        "module": "astropy",
                        "version": "*",
                        "kind": "api",
                        "path": "astropy.io.fits.diff:FITSDiff"
                      },
                      "kind": "module"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "."
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "title": [],
      "level": 0,
      "target": null
    },
    "Extended Summary": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "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": "/astropy/io/fits/convenience.py",
  "item_line": 840,
  "item_type": "function",
  "aliases": [
    "astropy.io.fits.printdiff"
  ],
  "example_section_data": {
    "__type": "Section",
    "__tag": 4015,
    "children": [],
    "title": [],
    "level": 0,
    "target": null
  },
  "see_also": [],
  "signature": {
    "__type": "SignatureNode",
    "__tag": 4029,
    "kind": "function",
    "parameters": [
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "inputa",
        "annotation": {
          "__type": "Empty",
          "__tag": 4031
        },
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": {
          "__type": "Empty",
          "__tag": 4031
        }
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "inputb",
        "annotation": {
          "__type": "Empty",
          "__tag": 4031
        },
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": {
          "__type": "Empty",
          "__tag": 4031
        }
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "args",
        "annotation": {
          "__type": "Empty",
          "__tag": 4031
        },
        "kind": "VAR_POSITIONAL",
        "default": {
          "__type": "Empty",
          "__tag": 4031
        }
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "kwargs",
        "annotation": {
          "__type": "Empty",
          "__tag": 4031
        },
        "kind": "VAR_KEYWORD",
        "default": {
          "__type": "Empty",
          "__tag": 4031
        }
      }
    ],
    "return_annotation": {
      "__type": "Empty",
      "__tag": 4031
    },
    "target_name": "printdiff"
  },
  "references": null,
  "qa": "astropy.io.fits.convenience:printdiff",
  "arbitrary": [],
  "local_refs": [
    "**kwargs",
    "ext",
    "extname",
    "extver",
    "inputa",
    "inputb"
  ]
}