{ "__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": "tabledump", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "astropy.io.fits.convenience:tabledump" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " function is to allow editing in a standard text editor of the table data and parameters. The " }, { "__type": "CrossRef", "__tag": 4002, "value": "tableload", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "astropy.io.fits.convenience:tableload" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " function can be used to reassemble the table from the three ASCII files." } ] }, { "__type": "Blockquote", "__tag": 4059, "children": [ { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Strong", "__tag": 4048, "children": [ { "__type": "Text", "__tag": 4046, "value": "datafile:" } ] }, { "__type": "Text", "__tag": 4046, "value": " Each line of the data file represents one row of table data. The data is output one column at a time in column order. If a column contains an array, each element of the column array in the current row is output before moving on to the next column. Each row ends with a new line." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Integer data is output right-justified in a 21-character field followed by a blank. Floating point data is output right justified using 'g' format in a 21-character field with 15 digits of precision, followed by a blank. String data that does not contain whitespace is output left-justified in a field whose width matches the width specified in the " }, { "__type": "InlineCode", "__tag": 4051, "value": "TFORM" }, { "__type": "Text", "__tag": 4046, "value": " header parameter for the column, followed by a blank. When the string data contains whitespace characters, the string is enclosed in quotation marks (" }, { "__type": "InlineCode", "__tag": 4051, "value": "\"\"" }, { "__type": "Text", "__tag": 4046, "value": "). For the last data element in a row, the trailing blank in the field is replaced by a new line character." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "For column data containing variable length arrays ('P' format), the array data is preceded by the string " }, { "__type": "InlineCode", "__tag": 4051, "value": "'VLA_Length= '" }, { "__type": "Text", "__tag": 4046, "value": " and the integer length of the array for that row, left-justified in a 21-character field, followed by a blank." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "note", "base_type": "note", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "note " } ] }, { "__type": "DefList", "__tag": 4033, "children": [ { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This format does " }, { "__type": "Emphasis", "__tag": 4047, "children": [ { "__type": "Text", "__tag": 4046, "value": "not" } ] }, { "__type": "Text", "__tag": 4046, "value": " support variable length arrays using the" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "('Q' format) due to difficult to overcome ambiguities. What this means is that this file format cannot support VLA columns in tables stored in files that are over 2 GB in size." } ] } ] } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "For column data representing a bit field ('X' format), each bit value in the field is output right-justified in a 21-character field as 1 (for true) or 0 (for false)." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Strong", "__tag": 4048, "children": [ { "__type": "Text", "__tag": 4046, "value": "cdfile:" } ] }, { "__type": "Text", "__tag": 4046, "value": " Each line of the column definitions file provides the definitions for one column in the table. The line is broken up into 8, sixteen-character fields. The first field provides the column name (" }, { "__type": "InlineCode", "__tag": 4051, "value": "TTYPEn" }, { "__type": "Text", "__tag": 4046, "value": "). The second field provides the column format (" }, { "__type": "InlineCode", "__tag": 4051, "value": "TFORMn" }, { "__type": "Text", "__tag": 4046, "value": "). The third field provides the display format (" }, { "__type": "InlineCode", "__tag": 4051, "value": "TDISPn" }, { "__type": "Text", "__tag": 4046, "value": "). The fourth field provides the physical units (" }, { "__type": "InlineCode", "__tag": 4051, "value": "TUNITn" }, { "__type": "Text", "__tag": 4046, "value": "). The fifth field provides the dimensions for a multidimensional array (" }, { "__type": "InlineCode", "__tag": 4051, "value": "TDIMn" }, { "__type": "Text", "__tag": 4046, "value": "). The sixth field provides the value that signifies an undefined value (" }, { "__type": "InlineCode", "__tag": 4051, "value": "TNULLn" }, { "__type": "Text", "__tag": 4046, "value": "). The seventh field provides the scale factor (" }, { "__type": "InlineCode", "__tag": 4051, "value": "TSCALn" }, { "__type": "Text", "__tag": 4046, "value": "). The eighth field provides the offset value (" }, { "__type": "InlineCode", "__tag": 4051, "value": "TZEROn" }, { "__type": "Text", "__tag": 4046, "value": "). A field value of " }, { "__type": "InlineCode", "__tag": 4051, "value": "\"\"" }, { "__type": "Text", "__tag": 4046, "value": " is used to represent the case where no value is provided." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Strong", "__tag": 4048, "children": [ { "__type": "Text", "__tag": 4046, "value": "hfile:" } ] }, { "__type": "Text", "__tag": 4046, "value": " Each line of the header parameters file provides the definition of a single HDU header card as represented by the card image." } ] } ] } ] } ] } ], "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": "Dump a table HDU to a file in ASCII format. The table may be dumped in three separate files, one containing column definitions, one containing header parameters, and one for table data." } ] } ], "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": "filename", "annotation": "path-like or file-like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Input fits file." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "datafile", "annotation": "path-like or file-like, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Output data file. The default is the root name of the input fits file appended with an underscore, followed by the extension number (ext), followed by the extension " }, { "__type": "InlineCode", "__tag": 4051, "value": ".txt" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "cdfile", "annotation": "path-like or file-like, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Output column definitions file. The default is " }, { "__type": "InlineRole", "__tag": 4003, "value": "None", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", no column definitions output is produced." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "hfile", "annotation": "path-like or file-like, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Output header parameters file. The default is " }, { "__type": "InlineRole", "__tag": 4003, "value": "None", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", no header parameters output is produced." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "ext", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The number of the extension containing the table HDU to be dumped." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "overwrite", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "InlineCode", "__tag": 4051, "value": "True" }, { "__type": "Text", "__tag": 4046, "value": ", overwrite the output file if it exists. Raises an " }, { "__type": "InlineCode", "__tag": 4051, "value": "OSError" }, { "__type": "Text", "__tag": 4046, "value": " if " }, { "__type": "InlineCode", "__tag": 4051, "value": "False" }, { "__type": "Text", "__tag": 4046, "value": " and the output file exists. Default is " }, { "__type": "InlineCode", "__tag": 4051, "value": "False" }, { "__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": 949, "item_type": "function", "aliases": [ "astropy.io.fits.tabledump" ], "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": "filename", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "datafile", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "cdfile", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "hfile", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "ext", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "1" }, { "__type": "SigParam", "__tag": 4030, "name": "overwrite", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "tabledump" }, "references": null, "qa": "astropy.io.fits.convenience:tabledump", "arbitrary": [], "local_refs": [ "cdfile", "datafile", "ext", "filename", "hfile", "overwrite" ] }