MivotViewer¶
- class pyvo.mivot.viewer.MivotViewer(votable_path, tableref=None, resolve_ref=False)[source]¶
- Bases: - object- MivotViewer is a PyVO table wrapper aiming at providing a model view on VOTable data read with usual tools. - Constructor of the MivotViewer class. - Parameters:
- votable_pathstr, parsed VOTable or DALResults instance
- VOTable that will be parsed with the parser of Astropy, which extracts the annotation block. 
- tablerefstr, optional
- Used to identify the table to process. If not specified, the first table is taken by default. 
- Parameters
- ———-
- resolve_refbool, optional
- If True, replace the REFERENCE elements with a copy of the objects they refer to. e.g. copy the space coordinates system, usually located in the GLOBALS block, in the position objects Default is False. 
 
 - Attributes Summary - Return an API to search various components in the XML mapping block. - getter for the identifier the astropy.table instance the viewer is connected to - getter for the identifier the table the viewer is connected to - Return an API to search various components in the VOTabel resource. - getter for the current astropy.table.array row - returns the Astropy parsed votable - returns - Methods Summary - close()- with statement implementation - get_first_instance_dmtype([tableref])- Return the dmtype of the head INSTANCE (first TEMPLATES child). - Get collection types in GLOBALS. - Get a dictionary of models and their URLs. - Return a list of the table located just below self._resource. - Get dmtypes (except ivoa:..) of all INSTANCE/COLLECTION of all TEMPLATES. - jump to the next table row and update the MivotInstance instance - Iterate once on the table row - rewind()- Rewind the table iterator on the table the veizer is connected with. - Attributes Documentation - annotation_seeker¶
- Return an API to search various components in the XML mapping block. 
 - connected_table¶
- getter for the identifier the astropy.table instance the viewer is connected to 
 - connected_table_ref¶
- getter for the identifier the table the viewer is connected to 
 - dm_instance¶
- Returns:
- A Python object (MivotInstance) built from the XML view of
- the mapped model with attribute values set from the last values
- of the last read data rows
 
 
 - resource_seeker¶
- Return an API to search various components in the VOTabel resource. 
 - table_row¶
- getter for the current astropy.table.array row 
 - votable¶
- returns the Astropy parsed votable 
 - xml_view¶
- Returns:
- The XML view on the current data row
 
 
 - xml_viewer¶
- returns
- XMLViewer tuned to browse the TEMPLATES content 
 
 - Methods Documentation - get_first_instance_dmtype(tableref=None)[source]¶
- Return the dmtype of the head INSTANCE (first TEMPLATES child). If no INSTANCE is found, take the first COLLECTION. - Parameters:
- tablerefstr or None, optional
- Identifier of the table. 
- Returns
- ——-
- ~`xml.etree.ElementTree.Element`
- The first child of TEMPLATES. 
 
 
 - get_globals_models()[source]¶
- Get collection types in GLOBALS. Collection types are GLOBALS/COLLECTION/INSTANCE@dmtype: used for collections of static objects. - Returns:
- dict
- A dictionary containing the dmtypes of all the top-level INSTANCE/COLLECTION of GLOBALS. The structure of the dictionary is {‘COLLECTION’: [dmtypes], ‘INSTANCE’: [dmtypes]}. 
 
 
 - get_models()[source]¶
- Get a dictionary of models and their URLs. - Returns:
- dict: Model names and a lists of their URLs.
- The format is {‘model’: [url], …}. 
 
 
 - get_templates_models()[source]¶
- Get dmtypes (except ivoa:..) of all INSTANCE/COLLECTION of all TEMPLATES. Note: COLLECTION not implemented yet. - Returns:
- dict: A dictionary containing dmtypes of all INSTANCE/COLLECTION of all TEMPLATES.
- The format is {‘tableref’: {‘COLLECTIONS’: [dmtypes], ‘INSTANCE’: [dmtypes]}, …}. 
 
 
 - next_row_view()[source]¶
- jump to the next table row and update the MivotInstance instance - Returns:
- MivotInstance: the updated instance or None
- it he able end has been reached