s100

s100py.s100 Package

S-100 Python Utilities

Tools for converting various datasets to S-100 compliant formats.

Functions

abstractmethod(funcobj)

A decorator indicating abstract methods.

h5py_string_comp(h5py_val, cmp_str)

is_sub_class(cls, clsinfo)

Python 3.7+ changed the behavior of issubclass to raise an exception if the cls object is not a class.

open(filename[, mode])

rtype:

S1XXFile

Classes

ABC()

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

COMMON_POINT_RULE(value[, names, module, ...])

S100 v4.0 Table 10c-19

CommonPointRule()

DATA_CODING_FORMAT(value[, names, module, ...])

Sphinx is not interpreting the enum names properly when there are spaces. The correct enum names with spaces are::.

DATA_OFFSET_CODE(value[, names, module, ...])

DataOffset()

Mixin class for Data Offset from S100 v5.0 Table 10c-10 Added dataOffsetCode and dataOffsetVector to the featureContainer for DataCodingFormats 2,5,6,9.

DirectPosition([recursively_create_children])

S102 4.2.1.1.4 of v2.0.0

Enum(value[, names, module, qualname, type, ...])

Create a collection of name/value pairs.

FeatureContainer(*args, **opts)

Feature Container from S100 v5.0 Table 10c-9 The feature attribute table was added, primarily for S102 to supply extended information about the origin of the data.

FeatureContainerDCF1(*args, **opts)

Container for Data Coding Format 1

FeatureContainerDCF2(*args, **opts)

Container for Data Coding Format 2

FeatureContainerDCF3(*args, **opts)

Container for Data Coding Format 3

FeatureContainerDCF4(*args, **opts)

Container for Data Coding Format 4

FeatureContainerDCF5(*args, **opts)

Container for Data Coding Format 5

FeatureContainerDCF6(*args, **opts)

Container for Data Coding Format 6

FeatureContainerDCF7(*args, **opts)

Container for Data Coding Format 7

FeatureContainerDCF8(*args, **opts)

Container for Data Coding Format 8

FeatureContainerDCF9(*args, **opts)

Feature Oriented Regular Grid from S100 v5.0 Table 10c-12 Container for Data Coding Format 9

FeatureInformation([recursively_create_children])

In S100, table 10c-8.

FeatureInformationDataset(*args, **opts)

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

FeatureInstanceBase([...])

The feature instance group attributes from table 10c-12 in S100 spec

FeatureInstanceDCF1([...])

Data Coding Format 1 is the Fixed Stations from table 10c-12 in S100 spec.

FeatureInstanceDCF2([...])

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

FeatureInstanceDCF3([...])

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

FeatureInstanceDCF4([...])

Data Coding Format 4 is the Moving Platform format from table 10c-12 in S100 spec.

FeatureInstanceDCF5([...])

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

FeatureInstanceDCF6

alias of FeatureInstanceDCF5

FeatureInstanceDCF7([...])

Data Coding Format 7 is the Triangulated Irregular Network (TIN) format from table 10c-12 in S100 spec.

FeatureInstanceDCF8([...])

Fixed stations - stationwise from S100 v5.0 Table 10c-12

FeatureInstanceDCF9([...])

GeographicBoundingBox([...])

S100 Tables 10C-6 and 10c-12 see also 4.2.1.1.13 of S102 v2.0.0 The class EX_GeographicBoundingBox is a metadata class from ISO 19115.

GeometryValuesDataset([...])

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.

GridOrigin()

Mixin class for gridOriginLatitude/Longitude/Vertical.

GridSpacing()

Mixin class for gridSpacingLongitudinal/Latitudinal/Vertical.

GroupFBase([recursively_create_children])

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

HORIZONTAL_CS(value[, names, module, ...])

INTERPOLATION_TYPE(value[, names, module, ...])

S100 v4.0 table 10c-21 Enumeration S100_CV_InterpolationMethod Codes for interpolation methods between known feature attribute values associated with geometric objects in the domain of the discrete coverage Extension of ISO 19123 CV_InterpolationMethod

InterpolationType()

Mixin class for Interpolation Type.

NumberOfNodes()

Mixin class for numberOfNodes.

NumberOfStations()

Mixin class for numberOfStations.

PROJECTION_METHOD

alias of PROJECTION_METHODS

Point([recursively_create_children])

4.2.1.1.11 of v2.0.0 The class GM_Point is taken from ISO 19107 and is the basic data type for a geometric object consisting of one and only one point.

PositioningGroup([recursively_create_children])

Positions()

S100Exception

S100File(*args, **kywrds)

S100Root([recursively_create_children])

From table 10c-6 in S100 v4.0 spec.

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

S1xxDatasetBase(*args, **opts)

The S102 spec stores some things as datasets that could (or should) be stored as attributes.

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.

SEQUENCING_RULE_TYPE(value[, names, module, ...])

S100 v4.0 Table 10c-20

SequenceRule([recursively_create_children])

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

SequencingRule()

Mixin class for Sequencing Rule.

StartSequence()

Mixin class for startSequence.

TYPE_OF_HORIZONTAL_CRS(value[, names, ...])

VERTICAL_COORDINATE_BASE(value[, names, ...])

VERTICAL_CS(value[, names, module, ...])

VERTICAL_DATUM(value[, names, module, ...])

Note: while a Vertical Datum can be created with the shorthand aliases, ex: MLWS, the string written and returned from the file/S100 object will be the official long name, e.g. "meanLowWaterSprings" etc.

VERTICAL_DATUM_REFERENCE(value[, names, ...])

VertexPoint([recursively_create_children])

From Figure 8-21 in S100 v4.0.0