Older versions of S102

Version 2.1

s100py.s102.v2_1.utils Module

Functions to create S102 data from other sources

If the utils module is run as __main__ then it will run from_bag() or from_gdal() on the filename given in the command line arguments.

Functions

plot_depth_using_h5py(filename[, enc_color])

create_s102(output_file[, overwrite])

rtype:

S102File

from_arrays(depth_grid, uncert_grid, output_file)

Creates or updates an S102File object based on numpy array/h5py datasets.

from_arrays_with_metadata(depth_grid, ...[, ...])

Creates or updates an S102File object based on numpy array/h5py datasets.

from_gdal(input_raster, output_file[, ...])

Fills or creates an S102File from the given arguments.

from_bag(bagfile, output_file[, metadata])

Fills or creates an S102File from the given arguments.

get_valid_epsg()

Create and return the list of valid EPSG codes for S-102 version 2.0.

to_geotiff(input_path, output_path)

s100py.s102.v2_1.api Module

Classes

ABC()

Helper class that provides a standard way to create an ABC using inheritance.

BathymetryContainer(*args, **opts)

This is the BathymetryCoverage right off the root of the HDF5 which has possible attributes from S100 spec table 10c-10 This will hold child groups named BathymetryCoverage.NN

BathymetryCoverage([recursively_create_children])

BathymetryCoverageBase([...])

This is the Group.NNN object that contains the grid data in a values dataset and other metadata about the grids.

BathymetryCoverageDataset(*args, **opts)

BathymetryCoveragesList(*args, **opts)

4.2.1.1.2 and Figure 4.4 and Table 10.1 of v2.0.0 This is the set of BathymetryCoverage.NN that act like a list here.

BathymetryFeatureInstance([...])

This will be the BathymetryCoverage.001 element in HDF5.

BathymetryGroupList(*args, **opts)

This is the list of Group.NNN that are held as a list.

BathymetryValues([recursively_create_children])

CommonPointRule()

DirectPosition([recursively_create_children])

S102 4.2.1.1.4 of v2.0.0

FeatureCodes([recursively_create_children])

Table 10.1 and sect 10.2.1 of v2.0.0

FeatureContainerDCF2(*args, **opts)

Container for Data Coding Format 2

FeatureInformation([recursively_create_children])

In S100, table 10c-8.

FeatureInformationDataset(*args, **opts)

This class comes from S100 -- 10c-9.5 Feature information group.

FeatureInstanceDCF2([...])

Data Coding Format 2 is the grid format from table 10c-12 in S100 spec.

GeographicExtent([recursively_create_children])

4.2.1.1.12 of v2.0.0 The class EX_GeographicExtent is a metadata class from ISO 19115.

GridCoordinate([recursively_create_children])

4.2.1.1.6 of S102 v2.0.0, references ISO 19123

GridEnvelope([recursively_create_children])

S102 4.2.1.1.5 of v2.0.0, , references ISO 19123 While I would think that the envelope would describe the real world extents of the grid, in the docs it describes the envelope as specifying the row/column offsets for the lower left and upper right coordinates using the integer indices (S100 and ISO 19123 sec.

GroupFBase([recursively_create_children])

From S100 Table 10c-8 – Components of feature information group

S100Exception

S100File(*args, **kywrds)

S100Root([recursively_create_children])

From table 10c-6 in S100 spec.

S102Exception

S102FeatureInformation(*args, **kwrds)

S102 specifc version of FeatureInformation.

S102FeatureInformationDataset(*args, **opts)

In S102, 10.2.1 and table 10.2 and Table 10.1 of v2.0.0

S102File(name, *args, **kywrds)

S102MetadataListBase(*args, **opts)

S102Root([recursively_create_children])

The root group contains a feature information group and N feature containers.

S1XXFile(name, *args, **kywrds)

hdf5 files have primary creation methods of create_dataset to insert array data attrs a dictionary-like to add/read metadata about the current group create_group to make a group containing datasets and/or metadata

S1xxCollection(*args, **opts)

This class represents arrays (noted in UML as , 1.., 0..* etc) which is not really part of HDF5.

S1xxGridsBase([recursively_create_children])

This base class is intended for use with "values" groups.

S1xxObject([recursively_create_children])

This class implements a general hdf5 group object that has attributes, datasets or sub-groups.

SequenceRule([recursively_create_children])

4.2.1.1.7 (and .8) of v2.0.0 CV_SequenceRule specified in ISO 19123

SurfaceCorrectionValues([...])

VertexPoint([recursively_create_children])

From Figure 8-21 in S100 v4.0.0

Version 2.0

s100py.s102.v2_0.utils Module

Functions to create S102 data from other sources

If the utils module is run as __main__ then it will run from_bag() or from_gdal() on the filename given in the command line arguments.

Functions

plot_depth_using_h5py(filename[, enc_color])

create_s102(output_file[, overwrite])

rtype:

S102File

from_arrays(depth_grid, uncert_grid, output_file)

Creates or updates an S102File object based on numpy array/h5py datasets.

from_arrays_with_metadata(depth_grid, ...[, ...])

Creates or updates an S102File object based on numpy array/h5py datasets.

from_gdal(input_raster, output_file[, ...])

Fills or creates an S102File from the given arguments.

from_bag(bagfile, output_file[, metadata])

Fills or creates an S102File from the given arguments.

get_valid_epsg()

Create and return the list of valid EPSG codes for S-102 version 2.0.

to_geotiff(input_path, output_path)

s100py.s102.v2_0.api Module

Classes

ABC()

Helper class that provides a standard way to create an ABC using inheritance.

BathymetryContainer(*args, **opts)

This is the BathymetryCoverage right off the root of the HDF5 which has possible attributes from S100 spec table 10c-10 This will hold child groups named BathymetryCoverage.NN

BathymetryCoverage([recursively_create_children])

BathymetryCoverageBase([...])

This is the Group.NNN object that contains the grid data in a values dataset and other metadata about the grids.

BathymetryCoverageDataset(*args, **opts)

BathymetryCoveragesList(*args, **opts)

4.2.1.1.2 and Figure 4.4 and Table 10.1 of v2.0.0 This is the set of BathymetryCoverage.NN that act like a list here.

BathymetryFeatureInstance([...])

This will be the BathymetryCoverage.001 element in HDF5.

BathymetryGroupList(*args, **opts)

This is the list of Group.NNN that are held as a list.

BathymetryValues([recursively_create_children])

CommonPointRule()

DirectPosition([recursively_create_children])

S102 4.2.1.1.4 of v2.0.0

DisplayScaleMixin()

FeatureCodes([recursively_create_children])

FeatureCodesBase([recursively_create_children])

Table 10.1 and sect 10.2.1 of v2.0.0

FeatureCodesTrackingMixin()

FeatureContainerDCF2(*args, **opts)

Container for Data Coding Format 2

FeatureInformation([recursively_create_children])

In S100, table 10c-8.

FeatureInformationDataset(*args, **opts)

This class comes from S100 -- 10c-9.5 Feature information group.

FeatureInstanceDCF2([...])

Data Coding Format 2 is the grid format from table 10c-12 in S100 spec.

GeographicExtent([recursively_create_children])

4.2.1.1.12 of v2.0.0 The class EX_GeographicExtent is a metadata class from ISO 19115.

GridCoordinate([recursively_create_children])

4.2.1.1.6 of S102 v2.0.0, references ISO 19123

GridEnvelope([recursively_create_children])

S102 4.2.1.1.5 of v2.0.0, , references ISO 19123 While I would think that the envelope would describe the real world extents of the grid, in the docs it describes the envelope as specifying the row/column offsets for the lower left and upper right coordinates using the integer indices (S100 and ISO 19123 sec.

GroupFBase([recursively_create_children])

From S100 Table 10c-8 – Components of feature information group

S100Exception

S100File(*args, **kywrds)

S100Root([recursively_create_children])

From table 10c-6 in S100 spec.

S102Exception

S102FeatureInformation(*args, **kwrds)

S102 specifc version of FeatureInformation.

S102FeatureInformationDataset(*args, **opts)

In S102, 10.2.1 and table 10.2 and Table 10.1 of v2.0.0

S102File(name, *args, **kywrds)

S102MetadataListBase(*args, **opts)

S102Root([recursively_create_children])

The root group contains a feature information group and N feature containers.

S1XXFile(name, *args, **kywrds)

hdf5 files have primary creation methods of create_dataset to insert array data attrs a dictionary-like to add/read metadata about the current group create_group to make a group containing datasets and/or metadata

S1xxCollection(*args, **opts)

This class represents arrays (noted in UML as , 1.., 0..* etc) which is not really part of HDF5.

S1xxGridsBase([recursively_create_children])

This base class is intended for use with "values" groups.

S1xxObject([recursively_create_children])

This class implements a general hdf5 group object that has attributes, datasets or sub-groups.

SequenceRule([recursively_create_children])

4.2.1.1.7 (and .8) of v2.0.0 CV_SequenceRule specified in ISO 19123

SurfaceCorrectionValues([...])

TrackingListContainer(*args, **opts)

Table 10.1 of v2.0.0

TrackingListCoverage([...])

4.2.1.1.9 and Figure 4.4 of v2.0.0 commonPointRule is defined to be an S100_PointCoverage with a value of default and it therefore optional.

TrackingListCoverageDataset(*args, **opts)

TrackingListCoveragesList(*args, **opts)

4.2.1.1.9 and Figure 4.4 and Table 10.1 of v2.0.0

TrackingListGroupList(*args, **opts)

TrackingListSetList(*args, **opts)

TrackingListValues([recursively_create_children])

From 4.2.1.1.10 of S102 v2.0.0

TrackingListValuesList(*args, **opts)

VertexPoint([recursively_create_children])

From Figure 8-21 in S100 v4.0.0