nav.dataset

class DataSet(*, config: Config | None = None)

Bases: ABC, NavBase

abstractmethod static add_selection_arguments(cmdparser: ArgumentParser, group: _ArgumentGroup | None = None) → None

Adds dataset-specific command-line arguments for image selection.

Parameters:

• cmdparser – The argument parser to add arguments to.

• group – Optional argument group to add arguments to. If None, creates a new group.

pds4_bundle_name() → str

Returns bundle name for PDS4 bundle generation.

Checks config section pds4.{dataset_name}.bundle_name first, then allows override.

Returns:

Bundle name (e.g., “cassini_iss_saturn_backplanes_rsfrench2027”).

static pds4_bundle_path_for_image(image_name: str) → str

Maps image name to bundle directory path.

Parameters:

image_name – The image name to map.

Returns:

Bundle directory path relative to bundle root (e.g., “1234xxxxxx/123456xxxx”).

pds4_bundle_template_dir() → str

Returns absolute path to template directory for PDS4 bundle generation.

Checks config section pds4.{dataset_name}.template_dir first, then allows override. If just a name is given, it is relative to the pds4/templates directory. If a full path is given, it will be left as absolute.

Returns:

Absolute path to template directory (e.g., “/path/to/pds4/templates/cassini_iss_saturn_1.0”).

pds4_image_name_to_browse_lid(image_name: str) → str

Returns the browse LID for the given image name.

Parameters:

image_name – The image name to convert to a browse LID.

Returns:

The browse LID.

pds4_image_name_to_browse_lidvid(image_name: str) → str

Returns the browse LIDVID for the given image name.

Parameters:

image_name – The image name to convert to a browse LID.

Returns:

The browse LID.

pds4_image_name_to_data_lid(image_name: str) → str

Returns the data LID for the given image name.

Parameters:

image_name – The image name to convert to a data LID.

Returns:

The data LID.

pds4_image_name_to_data_lidvid(image_name: str) → str

Returns the data LIDVID for the given image name.

Parameters:

image_name – The image name to convert to a data LID.

Returns:

The data LID.

pds4_path_stub(image_file: ImageFile) → str

Returns PDS4 path stub for bundle directory structure.

Parameters:

image_file – The image file to generate path stub for.

Returns:

Path stub relative to bundle root (e.g., “1234xxxxxx/123456xxxx/1234567890w”).

pds4_template_variables(*, image_file: ImageFile, nav_metadata: dict[str, Any], backplane_metadata: dict[str, Any]) → dict[str, Any]

Returns template variables for PDS4 label generation.

Parameters:

• image_file – The image file being processed.

• nav_metadata – Navigation metadata dictionary (as read from offset_metadata JSON file).

• backplane_metadata – Backplane metadata dictionary (created from backplane FITS file).

Returns:

Dictionary mapping variable names to values for template substitution.

abstractmethod static supported_grouping() → list[str]

Returns the list of supported grouping types.

Returns:

The list of supported grouping types.

abstractmethod yield_image_files_from_arguments(arguments: Namespace) → Iterator[ImageFiles]

Yields image filenames based on provided command-line arguments.

Parameters:

arguments – The parsed arguments structure.

Yields:

Information about the selected files in groups as ImageFiles objects.

abstractmethod yield_image_files_index(**kwargs: Any) → Iterator[ImageFiles]

Yields image filenames based on index information.

Parameters:

**kwargs – Arbitrary keyword arguments, usually used to restrict the search.

Yields:

Information about the selected files in groups as ImageFiles objects.

class ImageFile(image_file_url: FCPath, label_file_url: FCPath, results_path_stub: str, index_file_row: dict[str, ~typing.Any]=<factory>, extra_params: dict[str, ~typing.Any]=<factory>, _image_file_path: Path | None = None, _label_file_path: Path | None = None)

Bases: object

Represents a single image file with its metadata and lazy-loaded paths.

image_file_url

Remote URL for the image file.

Type:

filecache.file_cache_path.FCPath

label_file_url

Remote URL for the label file.

Type:

filecache.file_cache_path.FCPath

results_path_stub

Local path stub for storing results.

Type:

str

index_file_row

Optional metadata from index files.

Type:

dict[str, Any]

extra_params

Optional extra parameters that will be passed to the observation class’s from_file method when the file is read.

Type:

dict[str, Any]

extra_params: dict[str, Any]

property image_file_name: str

property image_file_path: Path

image_file_url: FCPath

index_file_row: dict[str, Any]

property label_file_name: str

property label_file_path: Path

label_file_url: FCPath

results_path_stub: str

retrieve_image_file() → Path

retrieve_label_file() → Path

class ImageFiles(image_files: list[ImageFile])

Bases: object

A collection of ImageFile objects that behaves like a sequence.

Supports iteration, indexing, and length operations on the wrapped image files.

image_files: list[ImageFile]

class DataSetPDS3(pds3_holdings_root: str | Path | FCPath | None = None, *, index_filecache: FileCache | None = None, pds3_holdings_filecache: FileCache | None = None, config: Config | None = None)

Bases: DataSet

Parent class for PDS3 datasets.

This class provides functionality common to all PDS3 datasets.

static add_selection_arguments(cmdparser: ArgumentParser, group: _ArgumentGroup | None = None) → None

Adds PDS3-specific command-line arguments for image selection.

Parameters:

• cmdparser – The argument parser to add arguments to.

• group – Optional argument group to add arguments to. If None, creates a new group.

property pds3_holdings_root: FCPath

The PDS3 holdings directory; may be a URL.

static supported_grouping() → list[str]

Returns the list of supported grouping types.

Returns:

The list of supported grouping types.

yield_image_files_from_arguments(arguments: Namespace) → Iterator[ImageFiles]

Given parsed arguments, yield all selected filenames.

Parameters:

arguments – The parsed arguments structure.

Yields:

ImageFiles objects containing information about groups of selected image files.

yield_image_files_index(**kwargs: Any) → Iterator[ImageFiles]

Yield filenames given search criteria using index files. Overridden by subclasses.

Parameters:

**kwargs – Arbitrary keyword arguments, usually used to restrict the search.

Yields:

ImageFiles objects containing information about groups of selected image files.

class DataSetPDS4(*, config: Config | None = None)

Bases: DataSet, ABC

Parent class for PDS4 datasets.

This class provides functionality common to all PDS4 datasets.

static add_selection_arguments(cmdparser: ArgumentParser, group: _ArgumentGroup | None = None) → None

Adds dataset-specific command-line arguments for image selection.

Parameters:

• cmdparser – The argument parser to add arguments to.

• group – Optional argument group to add arguments to. If None, creates a new group.

static supported_grouping() → list[str]

Returns the list of supported grouping types.

Returns:

The list of supported grouping types.

yield_image_files_from_arguments(arguments: Namespace) → Iterator[ImageFiles]

Yields image filenames based on provided command-line arguments.

Parameters:

arguments – The parsed arguments structure.

Yields:

Information about the selected files in groups as ImageFiles objects.

yield_image_files_index(**kwargs: Any) → Iterator[ImageFiles]

Yields image filenames based on index information.

Parameters:

**kwargs – Arbitrary keyword arguments, usually used to restrict the search.

Yields:

Information about the selected files in groups as ImageFiles objects.

class DataSetPDS3CassiniISS(pds3_holdings_root: str | Path | FCPath | None = None, *, index_filecache: FileCache | None = None, pds3_holdings_filecache: FileCache | None = None, config: Config | None = None)

Bases: DataSetPDS3

Implements dataset access for PDS3 Cassini ISS (Imaging Science Subsystem) data.

This class provides specialized functionality for accessing and parsing Cassini ISS image data stored in PDS3 format. Includes all volumes (1001-1009 and 2001-2116).

static add_selection_arguments(cmdparser: ArgumentParser, group: _ArgumentGroup | None = None) → None

Adds Cassini ISS-specific command-line arguments for image selection.

Parameters:

• cmdparser – The argument parser to add arguments to.

• group – Optional argument group to add arguments to. If None, creates a new group.

pds4_bundle_name() → str

Returns bundle name for PDS4 bundle generation.

Returns:

Bundle name.

static pds4_bundle_path_for_image(image_name: str) → str

Maps image name to bundle directory path.

Parameters:

image_name – The image name to map (e.g., “N1234567890”).

Returns:

Bundle directory path relative to bundle root (e.g., “1234xxxxxx/123456xxxx”).

pds4_bundle_template_dir() → str

Returns absolute path to template directory for PDS4 bundle generation.

Returns:

Absolute path to template directory.

pds4_image_name_to_browse_lid(image_name: str) → str

Returns the browse LID for the given image name.

Parameters:

image_name – The image name to convert to a browse LID.

Returns:

The browse LID.

pds4_image_name_to_browse_lidvid(image_name: str) → str

Returns the browse LIDVID for the given image name.

Parameters:

image_name – The image name to convert to a browse LID.

Returns:

The browse LIDVID.

pds4_image_name_to_data_lid(image_name: str) → str

Returns the data LID for the given image name.

Parameters:

image_name – The image name to convert to a data LID.

Returns:

The data LID.

pds4_image_name_to_data_lidvid(image_name: str) → str

Returns the data LIDVID for the given image name.

Parameters:

image_name – The image name to convert to a data LID.

Returns:

The data LIDVID.

pds4_path_stub(image_file: ImageFile) → str

Returns PDS4 path stub for bundle directory structure.

Parameters:

image_file – The image file to generate path stub for.

Returns:

Path stub relative to bundle root (e.g., “1234xxxxxx/123456xxxx/1234567890w”).

pds4_template_variables(*, image_file: ImageFile, nav_metadata: dict[str, Any], backplane_metadata: dict[str, Any]) → dict[str, Any]

Returns template variables for PDS4 label generation.

Parameters:

• image_file – The image file being processed.

• nav_metadata – Navigation metadata dictionary.

• backplane_metadata – Backplane metadata dictionary.

Returns:

Dictionary mapping variable names to values for template substitution.

static supported_grouping() → list[str]

Returns the list of supported grouping types.

Returns:

The list of supported grouping types. For Cassini ISS, only ‘botsim’ is supported.

yield_image_files_index(**kwargs: Any) → Iterator[ImageFiles]

Yield filenames given search criteria using index files.

Parameters:

• group – How to group the results. Only ‘botsim’ is supported.

• **kwargs – Arbitrary keyword arguments, usually used to restrict the search.

Yields:

ImageFiles objects containing information about groups of selected image files.

class DataSetPDS3CassiniISSCruise(pds3_holdings_root: str | Path | FCPath | None = None, *, index_filecache: FileCache | None = None, pds3_holdings_filecache: FileCache | None = None, config: Config | None = None)

Bases: DataSetPDS3CassiniISS

Implements dataset access for PDS3 Cassini ISS Cruise data (volumes 1001-1009).

class DataSetPDS3CassiniISSSaturn(pds3_holdings_root: str | Path | FCPath | None = None, *, index_filecache: FileCache | None = None, pds3_holdings_filecache: FileCache | None = None, config: Config | None = None)

Bases: DataSetPDS3CassiniISS

Implements dataset access for PDS3 Cassini ISS Saturn data (volumes 2001-2116).

class DataSetPDS3VoyagerISS(pds3_holdings_root: str | Path | FCPath | None = None, *, index_filecache: FileCache | None = None, pds3_holdings_filecache: FileCache | None = None, config: Config | None = None)

Bases: DataSetPDS3

Implements dataset access for PDS3 Voyager ISS (Imaging Science Subsystem) data.

This class provides specialized functionality for accessing and parsing Voyager ISS image data stored in PDS3 format.

pds4_bundle_name() → str

Returns bundle name for PDS4 bundle generation.

static pds4_bundle_path_for_image(image_name: str) → str

Maps image name to bundle directory path.

pds4_bundle_template_dir() → str

Returns absolute path to template directory for PDS4 bundle generation.

pds4_image_name_to_browse_lid(image_name: str) → str

Returns the browse LID for the given image name.

Parameters:

image_name – The image name to convert to a browse LID.

Returns:

The browse LID.

pds4_image_name_to_browse_lidvid(image_name: str) → str

Returns the browse LIDVID for the given image name.

Parameters:

image_name – The image name to convert to a browse LIDVID.

Returns:

The browse LIDVID.

pds4_image_name_to_data_lid(image_name: str) → str

Returns the data LID for the given image name.

Parameters:

image_name – The image name to convert to a data LID.

Returns:

The data LID.

pds4_image_name_to_data_lidvid(image_name: str) → str

Returns the data LIDVID for the given image name.

Parameters:

image_name – The image name to convert to a data LIDVID.

Returns:

The data LIDVID.

pds4_path_stub(image_file: ImageFile) → str

Returns PDS4 path stub for bundle directory structure.

pds4_template_variables(*, image_file: ImageFile, nav_metadata: dict[str, Any], backplane_metadata: dict[str, Any]) → dict[str, Any]

Returns template variables for PDS4 label generation.

class DataSetPDS3GalileoSSI(pds3_holdings_root: str | Path | FCPath | None = None, *, index_filecache: FileCache | None = None, pds3_holdings_filecache: FileCache | None = None, config: Config | None = None)

Bases: DataSetPDS3

Implements dataset access for PDS3 Galileo SSI (Solid State Imager) data.

This class provides specialized functionality for accessing and parsing Galileo SSI image data stored in PDS3 format.

pds4_bundle_name() → str

Returns bundle name for PDS4 bundle generation.

static pds4_bundle_path_for_image(image_name: str) → str

Maps image name to bundle directory path.

pds4_bundle_template_dir() → str

Returns absolute path to template directory for PDS4 bundle generation.

pds4_image_name_to_browse_lid(image_name: str) → str

Returns the browse LID for the given image name.

Parameters:

image_name – The image name to convert to a browse LID.

Returns:

The browse LID.

pds4_image_name_to_browse_lidvid(image_name: str) → str

Returns the browse LIDVID for the given image name.

Parameters:

image_name – The image name to convert to a browse LIDVID.

Returns:

The browse LIDVID.

pds4_image_name_to_data_lid(image_name: str) → str

Returns the data LID for the given image name.

Parameters:

image_name – The image name to convert to a data LID.

Returns:

The data LID.

pds4_image_name_to_data_lidvid(image_name: str) → str

Returns the data LIDVID for the given image name.

Parameters:

image_name – The image name to convert to a data LIDVID.

Returns:

The data LIDVID.

pds4_path_stub(image_file: ImageFile) → str

Returns PDS4 path stub for bundle directory structure.

pds4_template_variables(*, image_file: ImageFile, nav_metadata: dict[str, Any], backplane_metadata: dict[str, Any]) → dict[str, Any]

Returns template variables for PDS4 label generation.

class DataSetPDS3NewHorizonsLORRI(pds3_holdings_root: str | Path | FCPath | None = None, *, index_filecache: FileCache | None = None, pds3_holdings_filecache: FileCache | None = None, config: Config | None = None)

Bases: DataSetPDS3

Implements dataset access for PDS3 New Horizons LORRI (Low-Resolution Imaging Experiment) data.

This class provides specialized functionality for accessing and parsing New Horizons LORRI image data stored in PDS3 format.

pds4_bundle_name() → str

Returns bundle name for PDS4 bundle generation.

static pds4_bundle_path_for_image(image_name: str) → str

Maps image name to bundle directory path.

pds4_bundle_template_dir() → str

Returns absolute path to template directory for PDS4 bundle generation.

pds4_image_name_to_browse_lid(image_name: str) → str

Returns the browse LID for the given image name.

Parameters:

image_name – The image name to convert to a browse LID.

Returns:

The browse LID.

pds4_image_name_to_browse_lidvid(image_name: str) → str

Returns the browse LIDVID for the given image name.

Parameters:

image_name – The image name to convert to a browse LIDVID.

Returns:

The browse LIDVID.

pds4_image_name_to_data_lid(image_name: str) → str

Returns the data LID for the given image name.

Parameters:

image_name – The image name to convert to a data LID.

Returns:

The data LID.

pds4_image_name_to_data_lidvid(image_name: str) → str

Returns the data LIDVID for the given image name.

Parameters:

image_name – The image name to convert to a data LIDVID.

Returns:

The data LIDVID.

pds4_path_stub(image_file: ImageFile) → str

Returns PDS4 path stub for bundle directory structure.

pds4_template_variables(*, image_file: ImageFile, nav_metadata: dict[str, Any], backplane_metadata: dict[str, Any]) → dict[str, Any]

Returns template variables for PDS4 label generation.