{ "__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": "load", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "astropy.io.fits.hdu.table:BinTableHDU.load" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " method is to allow the input of ASCII data that was edited in a standard text editor of the table data and parameters. The " }, { "__type": "CrossRef", "__tag": 4002, "value": "dump", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "astropy.io.fits.hdu.table:BinTableHDU.dump" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " method can be used to create the initial 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": "Create a table from the input ASCII files. The input is from up to three separate files, one containing column definitions, one containing header parameters, and one containing column 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": "datafile", "annotation": "path-like or file-like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Input data file containing the table data in ASCII format." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "cdfile", "annotation": "path-like or file-like, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Input column definition file containing the names, formats, display formats, physical units, multidimensional array dimensions, undefined values, scale factors, and offsets associated with the columns in the table. If " }, { "__type": "InlineRole", "__tag": 4003, "value": "None", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", the column definitions are taken from the current values in this object." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "hfile", "annotation": "path-like or file-like, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Input parameter definition file containing the header parameter definitions to be associated with the table. If " }, { "__type": "InlineRole", "__tag": 4003, "value": "None", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", the header parameter definitions are taken from the current values in this objects header." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "replace", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "When " }, { "__type": "InlineRole", "__tag": 4003, "value": "True", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", indicates that the entire header should be replaced with the contents of the ASCII file instead of just updating the current header." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "header", "annotation": "`~astropy.io.fits.Header`, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "When the cdfile and hfile are missing, use this Header object in the creation of the new table and HDU. Otherwise this Header supersedes the keywords from hfile, which is only used to update values not present in this Header, unless " }, { "__type": "InlineCode", "__tag": 4051, "value": "replace=True" }, { "__type": "Text", "__tag": 4046, "value": " in which this Header's values are completely replaced with the values from hfile." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The column definition and header parameters files are not required. When absent the column definitions and/or header parameters are taken from the header object given in the header argument; otherwise sensible defaults are inferred (though this mode is not recommended)." } ] } ], "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/hdu/table.py", "item_line": 1136, "item_type": "classmethod", "aliases": [ "astropy.io.fits.BinTableHDU.load" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "see_also": [], "signature": null, "references": null, "qa": "astropy.io.fits.hdu.table:BinTableHDU.load", "arbitrary": [], "local_refs": [ "cdfile", "datafile", "header", "hfile", "replace" ] }