{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [], "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": "Diff two table data arrays. It doesn't matter whether the data originally came from a binary or ASCII table--the data should be passed in as a recarray." } ] } ], "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": "CrossRef", "__tag": 4002, "value": "TableDataDiff", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "astropy.io.fits.diff:TableDataDiff" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " objects have the following diff attributes:" } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "diff_column_count" }, { "__type": "Text", "__tag": 4046, "value": ": If the tables being compared have different numbers of columns, this contains a 2-tuple of the column count in each table. Even if the tables have different column counts, an attempt is still made to compare any columns they have in common." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "diff_columns" }, { "__type": "Text", "__tag": 4046, "value": ": If either table contains columns unique to that table, either in name or format, this contains a 2-tuple of lists. The first element is a list of columns (these are full " }, { "__type": "CrossRef", "__tag": 4002, "value": "Column", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "astropy.io.fits.column:Column" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " objects) that appear only in table a. The second element is a list of tables that appear only in table b. This only lists columns with different column definitions, and has nothing to do with the data in those columns." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "diff_column_names" }, { "__type": "Text", "__tag": 4046, "value": ": This is like " }, { "__type": "InlineCode", "__tag": 4051, "value": "diff_columns" }, { "__type": "Text", "__tag": 4046, "value": ", but lists only the names of columns unique to either table, rather than the full " }, { "__type": "CrossRef", "__tag": 4002, "value": "Column", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "astropy.io.fits.column:Column" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " objects." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "diff_column_attributes" }, { "__type": "Text", "__tag": 4046, "value": ": Lists columns that are in both tables but have different secondary attributes, such as TUNIT or TDISP. The format is a list of 2-tuples: The first a tuple of the column name and the attribute, the second a tuple of the different values." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "diff_values" }, { "__type": "Text", "__tag": 4046, "value": ": " }, { "__type": "CrossRef", "__tag": 4002, "value": "TableDataDiff", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "astropy.io.fits.diff:TableDataDiff" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " compares the data in each table on a column-by-column basis. If any different data is found, it is added to this list. The format of this list is similar to the " }, { "__type": "InlineCode", "__tag": 4051, "value": "diff_pixels" }, { "__type": "Text", "__tag": 4046, "value": " attribute on " }, { "__type": "CrossRef", "__tag": 4002, "value": "ImageDataDiff", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "astropy.io.fits.diff:ImageDataDiff" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " objects, though the \"index\" consists of a (column_name, row) tuple. For example " } ] }, { "__type": "Code", "__tag": 4050, "value": "[('TARGET', 0), ('NGC1001', 'NGC1002')]", "execution_status": null, "out": "" }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "shows that the tables contain different values in the 0-th row of the 'TARGET' column." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "diff_total" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineCode", "__tag": 4051, "value": "diff_ratio" }, { "__type": "Text", "__tag": 4046, "value": ": Same as " }, { "__type": "CrossRef", "__tag": 4002, "value": "ImageDataDiff", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "astropy.io.fits.diff:ImageDataDiff" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "TableDataDiff", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "astropy.io.fits.diff:TableDataDiff" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " objects also have a " }, { "__type": "InlineCode", "__tag": 4051, "value": "common_columns" }, { "__type": "Text", "__tag": 4046, "value": " attribute that lists the " }, { "__type": "CrossRef", "__tag": 4002, "value": "Column", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "astropy.io.fits.column:Column" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " objects for columns that are identical in both tables, and a " }, { "__type": "InlineCode", "__tag": 4051, "value": "common_column_names" }, { "__type": "Text", "__tag": 4046, "value": " attribute which contains a set of the names of those columns." } ] } ], "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/diff.py", "item_line": 1234, "item_type": "class", "aliases": [ "astropy.io.fits.TableDataDiff" ], "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": "a", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "b", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "ignore_fields", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "[]" }, { "__type": "SigParam", "__tag": 4030, "name": "numdiffs", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "10" }, { "__type": "SigParam", "__tag": 4030, "name": "rtol", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "0.0" }, { "__type": "SigParam", "__tag": 4030, "name": "atol", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "0.0" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "TableDataDiff" }, "references": null, "qa": "astropy.io.fits.diff:TableDataDiff", "arbitrary": [], "local_refs": [] }