The classes in s102.api can be accessed by just importing s102. They are automatically imported but can be brought in separately if desired.:
from s100py import s102
s102.S102File(...)
# or
from s100py.s102 import api
api.S102File(...)
# or
from s100py import s102.api
s102.api.S102File(...)
s100py.s102.v2_2.api Module
Classes
|
Helper class that provides a standard way to create an ABC using inheritance. |
|
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. |
|
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 |
|
This is the "Values" Group.NNN object that contains the grid data in a values dataset and other metadata about the grids. |
|
|
|
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. |
|
This will be the BathymetryCoverage.001 element in HDF5. |
|
This is the list of Group.NNN that are held as a list. |
|
S100 v5.0 8-6.2.8 Grid cell structure S-100 utilizes the same view of grid cell structure as Section 8.2.2 of ISO 19123. |
|
|
|
S102 4.2.1.1.4 of v2.0.0 |
|
Create a collection of name/value pairs. |
|
This class comes from S102 -- 10.2.7 Feature information group. |
|
The records that the integer matrix refer to and the actual attribute values for the quality of coverage. |
|
Table 10.1 and sect 10.2.1 of v2.0.0 Add the QualityOfSurvey from S102 v2.2 section 10.2.2 and table 10.3 |
|
Container for Data Coding Format 2 |
|
Feature Oriented Regular Grid from S100 v5.0 Table 10c-12 Container for Data Coding Format 9 |
|
In S100, table 10c-8. |
|
This class comes from S100 -- 10c-9.5 Feature information group. |
|
Data Coding Format 2 is the grid format from table 10c-12 in S100 spec. |
|
|
|
4.2.1.1.6 of S102 v2.0.0, references ISO 19123 |
|
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. |
|
From S100 Table 10c-8 – Components of feature information group |
|
Mixin class for Interpolation Type. |
|
This is for the Group_F information group. |
|
This will be the QualityCoverage.001 element in HDF5. |
|
This is the list of Group.NNN that are held as a list. |
|
This is the QualityOfSurvey right off the root of the HDF5 which has possible attributes from S100 spec table 10c-10 This will hold child groups named QualityOfSurvey.NN |
|
This is the "Values" Group.NNN object that contains the grid data in a values dataset and other metadata about the grids. |
|
4.2.1.1.2 and Figure 4.4 and Table 10.1 of v2.0.0 This is the set of QualityOfSurvey.NN that act like a list here. |
|
|
|
|
|
From table 10c-6 in S100 v4.0 spec. |
|
S102 specifc version of FeatureInformation. |
|
In S102, 10.2.1 and table 10.2 and Table 10.1 of v2.0.0 |
|
|
|
|
|
The root group contains a feature information group and N feature containers. |
|
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 |
|
This class represents arrays (noted in UML as , 1.., 0..* etc) which is not really part of HDF5. |
|
The S102 spec stores some things as datasets that could (or should) be stored as attributes. |
|
This base class is intended for use with "values" groups. |
|
This class implements a general hdf5 group object that has attributes, datasets or sub-groups. |
|
4.2.1.1.7 (and .8) of v2.0.0 CV_SequenceRule specified in ISO 19123 |
|
|
|
|
|
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. |
|
|
|
From Figure 8-21 in S100 v4.0.0 |