Python PDS4 Tools
This document describes the current status and usage of Python tools developed at PDS-SBN to read and visualize PDS4 data in Python. Please note that a more feature-complete PDS4 reader and visualizer for IDL is also available.
We also have a Github repository which holds our Python tools, including development versions.
Reading PDS4 Images
This section describes an example Python module that can read and display an image from a BOPPS/BIRC PDS4 data product. The code will read the data based on the label keywords, but does not otherwise validate the label. If the user wants to display the image, the code will consider the label's Display_Settings, and provide a copy of the image in the correct orientation for drawing with the origin in the lower left corner (which can then be displayed with Matplotlib).
The code below is specifically designed for reading BOPPS/BIRC images, but can be used as an example for other limited problems. A more general solution may use a different approach, and will be developed by SBN in the future.
Contact Mike Kelley with questions or comments regarding this code or its description.
Goal and Method
The goal is to read in an image from a BOPPS/BIRC data product into a Numpy array, providing the correct orientation for display. We will provide a function with the name of the label, the function will then
- Open the label.
- Find the data product file name.
- Determine the Array_2D_Image data type and shape.
- Read in the data array.
- Return the array and meta data in a single object.
The object will have two attributes that allow access to the data
- the data with the axis order and orientation as provided in the file, and
- the data with the axis order and orientation reconfigured according to the label's Display_Settings class, so that it will have the correct orientation if drawn with the origin in the lower left corner.
For this basic example, we designed the reader as a function in a module named birc_example_reader. The user calls a single function, read_image(), passing the name of the label as the first argument. The function will load the label using the ElementTree module and find the first Array_2D_Image element to read in. A second function, read_pds4_array(), determines the correct data type and shape, then reads the data from the file. A class specifically designed for PDS4 Array_2D_Image objects, aptly named PDS4_Array_2D_Image, is initialized with the data, the label describing the data, and the local_identifier of the array. The local_identifier is not normally required in PDS4 array objects, but it must be present when the image display orientation is provided via Display_Settings. Since these are present in the BIRC labels, our class assumes local_identifier is included. The class then determines the image orientation. The image is stored as a class attribute data. The class attribute display_data is also provided, which can be used for displaying with Matplotlib.
Minimal Working Example
Below we provide a minimal working example with the same basic functionality. The example is a flat script with extensive comments, which may more clearly illustrate some of the methods for working with PDS4 image labels.
Reading PDS4 Tables
This section describes a Python package that can read and display PDS4 table data. Currently only Table_Character and Table_Binary objects are supported. In the future this tool is expected to support all PDS4 objects. The package expects labels that pass PDS4 Schema and Schematron validation, it will perform additional validation for both PDS4 Standards as well as optionally some PDS-SBN standards. A PDS4 data viewer is also available for supported objects.
Contact Lev Nagdimunov with questions or comments regarding this code or its description.
This tool assumes the user is running Python 2.6 or 2.7. There are no additional requirements to read PDS4 data, although a recent NumPy package can be used if installed. To visualize data Tkinter is required; it is part of the standard Python distribution for most platforms.
import sys sys.path.extend(['/path/to/your/extraction/directory']) # Or # On a windows machine remember to escape your backslashes import sys sys.path.extend(['C:\\path\\to\\your\\extraction\\directory'])
Download the ZIP file File:PDS4 tools-0.1.zip. You can use "pip install PDS4_tools-0.1.zip" or "easy_install PDS4_tools-0.1.zip". You can also extract the ZIP file and use "python /path/to/extracted/setup.py install". Note that there is no uninstall script provided (although "pip uninstall pds4_tools" should work), and that this tool currently has many missing features and will be updated in the future.
You may call pds4_read from command line or from your own script. Typing the shell command python pds4_read.py -h prints out the help text:
usage: pds4_read.py [-h] [--quiet] [--use_numpy] [--object_num OBJECT_NUM] [--object_name OBJECT_NAME] [--object_lid OBJECT_LID] filename positional arguments: filename Filename, including full path, of the label optional arguments: -h, --help show this help message and exit --quiet Suppresses all info/warnings --use_numpy Returned data will be a numpy array and use numpy data types --object_num OBJECT_NUM Only reads the data object specified by zero-based order (integer) --object_name OBJECT_NAME Only reads the data object specified by name --object_lid OBJECT_LID Only reads the data object specified by local identifier
If called from another module or a script, all of the above optional arguments would be available as optional named parameters of the function pds4_read(). Basic example usage is as follows:
""" Basic pds4_read example """ from pds4_tools import pds4_read data = pds4_read('/path/to/label.xml') # Dictionary-like access column = data['table_name']['field_name'] row_1_to_100 = column[0:100] # List-like access column = data row_1_to_100 = column[0:100] # Meta-data access column_meta = data['table_name'].meta_data('field_name') column_meta = data.meta_data(0) print column_meta.description print column_meta.unit
To display the objects in a label you may call pds4_viewer from the command line:
usage: pds4_viewer.py [-h] [--quiet] [--object_num OBJECT_NUM] [--object_name OBJECT_NAME] [--object_lid OBJECT_LID] [filename] positional arguments: filename Filename, including full path, of the label optional arguments: -h, --help show this help message and exit --quiet Suppresses all info/warnings --object_num OBJECT_NUM Only reads the data object specified by zero-based order (integer) --object_name OBJECT_NAME Only reads the data object specified by name --object_lid OBJECT_LID Only reads the data object specified by local identifier
It is not necessary to include the filename parameter for pds4_viewer, you may simplify call it without any options or arguments and a GUI will open from which you can open labels.
You may also call pds4_viewer from another module or script. All the above optional arguments are available as optional named parameters. A basic example usage is as follows:
""" Basic pds4_viewer example """ from pds4_tools import pds4_read, pds4_viewer pds4_viewer() # or pds4_viewer('label.xml') # or data = pds4_read('label.xml') pds4_viewer('label.xml', from_existing_data=data) # Won't re-read the data