Skip to content

content module

This is the content module.

This module contains geographic metadata structures regarding data content derived from the ISO 19115-1:2014 and ISO 19115-2:2019 international standards.

AttributeGroup

Bases: ABC

Information about the content_type for groups of attributes for a specific RangeDimension.

Source code in opengis/metadata/content.py
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
class AttributeGroup(ABC):
    """
    Information about the `content_type` for groups of attributes for a
    specific `RangeDimension`.
    """

    @property
    @abstractmethod
    def content_type(self) -> Sequence[CoverageContentTypeCode]:
        """Type of information represented by the value."""

    @property
    @abstractmethod
    def attribute(self) -> Optional[Sequence[RangeDimension]]:
        """Information on an attribute of the resource."""

attribute: Optional[Sequence[RangeDimension]] abstractmethod property

Information on an attribute of the resource.

content_type: Sequence[CoverageContentTypeCode] abstractmethod property

Type of information represented by the value.

Band

Bases: SampleDimension

Range of wavelengths in the electromagnetic spectrum.

Source code in opengis/metadata/content.py
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
class Band(SampleDimension):
    """Range of wavelengths in the electromagnetic spectrum."""

    @property
    @abstractmethod
    def bound_max(self) -> Optional[float]:
        """
        Bounding maximum. The longest wavelength that the sensor is capable of
        collecting within a designated band.
        """

    @property
    @abstractmethod
    def bound_min(self) -> Optional[float]:
        """
        Bounding minimum. The shortest wavelength that the sensor is capable of
        collecting within a designated band.
        """

    @property
    @abstractmethod
    def bound_unit(self) -> Optional[UomLength]:
        """
        Bounding units. The units in which the sensor wavelengths are
        expressed.

        MANDATORY if `bound_max` or `bound_min` is specified.
        """

    @property
    @abstractmethod
    def peak_response(self) -> Optional[float]:
        """Wavelength at which the response is the highest."""

    @property
    @abstractmethod
    def tone_gradation(self) -> Optional[int]:
        """Number of discrete numerical values in the data."""

    @property
    @abstractmethod
    def band_boundary_definition(self) -> Optional[BandDefinition]:
        """
        Designation of criterion for defining maximum and minimum wavelengths
        for a spectral band.
        """

    @property
    @abstractmethod
    def transmitted_polarisation(self) -> \
            Optional[PolarisationOrientationCode]:
        """Polarisation of the transmitter or detector."""

    @property
    @abstractmethod
    def detected_polarisation(self) -> Optional[PolarisationOrientationCode]:
        """Polarisation of the transmitter or detector."""

band_boundary_definition: Optional[BandDefinition] abstractmethod property

Designation of criterion for defining maximum and minimum wavelengths for a spectral band.

bound_max: Optional[float] abstractmethod property

Bounding maximum. The longest wavelength that the sensor is capable of collecting within a designated band.

bound_min: Optional[float] abstractmethod property

Bounding minimum. The shortest wavelength that the sensor is capable of collecting within a designated band.

bound_unit: Optional[UomLength] abstractmethod property

Bounding units. The units in which the sensor wavelengths are expressed.

MANDATORY if bound_max or bound_min is specified.

detected_polarisation: Optional[PolarisationOrientationCode] abstractmethod property

Polarisation of the transmitter or detector.

peak_response: Optional[float] abstractmethod property

Wavelength at which the response is the highest.

tone_gradation: Optional[int] abstractmethod property

Number of discrete numerical values in the data.

transmitted_polarisation: Optional[PolarisationOrientationCode] abstractmethod property

Polarisation of the transmitter or detector.

BandDefinition

Bases: Enum

Designation of the criterion for defining wavelengths of a spectral band.

Source code in opengis/metadata/content.py
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
class BandDefinition(Enum):
    """
    Designation of the criterion for defining wavelengths of a spectral band.
    """

    THREE_DB = "3dB"
    """
    Width of a distribution equal to the distance between the outer two points\
    on the distribution having power level half of that at the peak.
    """

    HALF_MAXIMUM = "halfMaximum"
    """
    Width of a distribution equal to the distance between the outer two points
    on the distribution having power level half of that at the peak.
    """

    FIFTY_PERCENT = "fiftyPercent"
    """
    Full spectral width of a spectral power density measured at 50 % of its
    peak height.
    """

    ONE_OVER_E = "oneOverE"
    """
    Width of a distribution equal to the distance between the outer two points
    on the distribution having power level 1/e that of the peak.
    """

    EQUIVALENT_WIDTH = "equivalentWidth"
    """
    Width of a band with full sensitivity or absorption at every wavelength
    that detects or absorbs the same amount of energy as the band described.
    """

EQUIVALENT_WIDTH = 'equivalentWidth' class-attribute instance-attribute

Width of a band with full sensitivity or absorption at every wavelength that detects or absorbs the same amount of energy as the band described.

FIFTY_PERCENT = 'fiftyPercent' class-attribute instance-attribute

Full spectral width of a spectral power density measured at 50 % of its peak height.

HALF_MAXIMUM = 'halfMaximum' class-attribute instance-attribute

Width of a distribution equal to the distance between the outer two points on the distribution having power level half of that at the peak.

ONE_OVER_E = 'oneOverE' class-attribute instance-attribute

Width of a distribution equal to the distance between the outer two points on the distribution having power level 1/e that of the peak.

THREE_DB = '3dB' class-attribute instance-attribute

Width of a distribution equal to the distance between the outer two points on the distribution having power level half of that at the peak.

ContentInformation

Bases: ABC

Description of the content of a resource.

Source code in opengis/metadata/content.py
477
478
class ContentInformation(ABC):
    """Description of the content of a resource."""

CoverageContentTypeCode

Bases: Enum

Transformation function to be used when scaling a physical value of a given element.

Source code in opengis/metadata/content.py
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
class CoverageContentTypeCode(Enum):
    """
    Transformation function to be used when scaling a physical value of a
    given element.
    """

    IMAGE = "image"
    """
    Meaningful numerical representation of a physical parameter that is not
    the actual value of the physical parameter.
    """

    THEMATIC_CLASSIFICATION = "thematicClassification"
    """
    Code value with no quantitative meaning, used to represent a
    physical quantity.
    """

    PHYSICAL_MEASUREMENT = "physicalMeasurement"
    """Value in physical units of the quantity being measured."""

    AUXILLARY_INFORMATION = "auxillaryInformation"
    """
    Data, usually a physical measurement, used to support the calculation
    of the primary PHYSICAL_MEASUREMENT coverages in the dataset.

    EXAMPLE: Grid of aerosol optical thickness used in the calculation of a
    sea surface temperature product.
    """

    QUALITY_INFORMATION = "qualityInformation"
    """
    Data used to characterize the quality of the PHYSICAL_MEASUREMENT coverages
    in the dataset.

    NOTE: Typically included in a gmi:QE_CoverageResult.
    """

    REFERENCE_INFORMATION = "referenceInformation"
    """
    Reference information used to support the calculation or use of the
    PHYSICAL_MEASUREMENT coverages in the dataset.

    EXAMPLE: Grids of latitude/longitude used to geolocate
    the physical measurements.
    """

    MODEL_RESULT = "modelResult"
    """
    Resources with values that are calculated using a model rather than being
    observed or calculated from observations.
    """

    COORDINATE = "coordinate"
    """Data used to provide coordinate axis values."""

AUXILLARY_INFORMATION = 'auxillaryInformation' class-attribute instance-attribute

Data, usually a physical measurement, used to support the calculation of the primary PHYSICAL_MEASUREMENT coverages in the dataset.

EXAMPLE: Grid of aerosol optical thickness used in the calculation of a sea surface temperature product.

COORDINATE = 'coordinate' class-attribute instance-attribute

Data used to provide coordinate axis values.

IMAGE = 'image' class-attribute instance-attribute

Meaningful numerical representation of a physical parameter that is not the actual value of the physical parameter.

MODEL_RESULT = 'modelResult' class-attribute instance-attribute

Resources with values that are calculated using a model rather than being observed or calculated from observations.

PHYSICAL_MEASUREMENT = 'physicalMeasurement' class-attribute instance-attribute

Value in physical units of the quantity being measured.

QUALITY_INFORMATION = 'qualityInformation' class-attribute instance-attribute

Data used to characterize the quality of the PHYSICAL_MEASUREMENT coverages in the dataset.

NOTE: Typically included in a gmi:QE_CoverageResult.

REFERENCE_INFORMATION = 'referenceInformation' class-attribute instance-attribute

Reference information used to support the calculation or use of the PHYSICAL_MEASUREMENT coverages in the dataset.

EXAMPLE: Grids of latitude/longitude used to geolocate the physical measurements.

THEMATIC_CLASSIFICATION = 'thematicClassification' class-attribute instance-attribute

Code value with no quantitative meaning, used to represent a physical quantity.

CoverageDescription

Bases: ContentInformation

Details about the content of a resource.

Source code in opengis/metadata/content.py
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
class CoverageDescription(ContentInformation):
    """Details about the content of a resource."""

    @property
    @abstractmethod
    def attribute_description(self) -> RecordType:
        """Description of the attribute described by the measurement value."""

    @property
    @abstractmethod
    def processing_level_code(self) -> Optional[Identifier]:
        """
        Code and codespace that identifies the level of processing that has
        been applied to the resource.
        """

    @property
    @abstractmethod
    def attribute_group(self) -> Optional[Sequence[AttributeGroup]]:
        """
        Information on the group(s) of related attributes of the resource
        with the same type.
        """

    @property
    @abstractmethod
    def range_element_description(self) -> Optional[Sequence[
        RangeElementDescription
    ]]:
        """
        Provides the description of the specific range elements of a coverage.
        """

attribute_description: RecordType abstractmethod property

Description of the attribute described by the measurement value.

attribute_group: Optional[Sequence[AttributeGroup]] abstractmethod property

Information on the group(s) of related attributes of the resource with the same type.

processing_level_code: Optional[Identifier] abstractmethod property

Code and codespace that identifies the level of processing that has been applied to the resource.

range_element_description: Optional[Sequence[RangeElementDescription]] abstractmethod property

Provides the description of the specific range elements of a coverage.

FeatureCatalogueDescription

Bases: ContentInformation

Information identifying the feature catalogue or the conceptual schema.

Source code in opengis/metadata/content.py
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
class FeatureCatalogueDescription(ContentInformation):
    """
    Information identifying the feature catalogue or the conceptual schema.
    """

    @property
    @abstractmethod
    def compliance_code(self) -> Optional[bool]:
        """
        Indication of whether or not the cited feature catalogue complies with
        ISO 19110.
        """

    @property
    @abstractmethod
    def locale(self) -> Optional[Sequence[str]]:
        """
        Language(s) and character set(s) used within the catalogue. A string
        conforming to IETF BCP 47.
        """

    @property
    @abstractmethod
    def included_with_dataset(self) -> Optional[bool]:
        """
        Indication of whether or not the feature catalogue is included with
        the resource.
        """

    @property
    @abstractmethod
    def feature_types(self) -> Optional[Sequence[FeatureTypeInfo]]:
        """
        Subset of feature types from cited feature catalogue occurring in
        dataset.
        """

    @property
    @abstractmethod
    def feature_catalogue_citation(self) -> Optional[Sequence[Citation]]:
        """
        Complete bibliographic reference to one or more external feature
        catalogues.

        MANADTORY: if a Feature Catalogue is not provided with the resource
            and `FeatureCatalogue` is `None`.
        """

compliance_code: Optional[bool] abstractmethod property

Indication of whether or not the cited feature catalogue complies with ISO 19110.

feature_catalogue_citation: Optional[Sequence[Citation]] abstractmethod property

Complete bibliographic reference to one or more external feature catalogues.

if a Feature Catalogue is not provided with the resource

and FeatureCatalogue is None.

feature_types: Optional[Sequence[FeatureTypeInfo]] abstractmethod property

Subset of feature types from cited feature catalogue occurring in dataset.

included_with_dataset: Optional[bool] abstractmethod property

Indication of whether or not the feature catalogue is included with the resource.

locale: Optional[Sequence[str]] abstractmethod property

Language(s) and character set(s) used within the catalogue. A string conforming to IETF BCP 47.

FeatureTypeInfo

Bases: ABC

Information about the occurring feature type.

Source code in opengis/metadata/content.py
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
class FeatureTypeInfo(ABC):
    """Information about the occurring feature type."""

    @property
    @abstractmethod
    def feature_type_name(self) -> GenericName:
        """Name of the feature type."""

    @property
    @abstractmethod
    def feature_instance_count(self) -> Optional[int]:
        """
        Number of occurences of feature instances for this type.

        Domain: > 0
        """

feature_instance_count: Optional[int] abstractmethod property

Number of occurences of feature instances for this type.

Domain: > 0

feature_type_name: GenericName abstractmethod property

Name of the feature type.

ImageDescription

Bases: CoverageDescription

Information about an image's suitability for use.

Source code in opengis/metadata/content.py
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
class ImageDescription(CoverageDescription):
    """Information about an image's suitability for use."""

    @property
    @abstractmethod
    def illumination_elevation_angle(self) -> Optional[float]:
        """
        Illumination elevation measured in degrees clockwise from the target
        plane at intersection of the optical line of sight with the Earth's
        surface.

        NOTE: For images from a scanning device, refer to the centre pixel
        of the image.

        Domain: -90 - 90
        """

    @property
    @abstractmethod
    def illumination_azimuth_angle(self) -> Optional[float]:
        """
        Illumination azimuth measured in degrees clockwise from true north at
        the time the image is taken.

        NOTE: For images from a scanning device, refer to the centre pixel of
        the image.

        Domain: 0.00 - 360
        """

    @property
    @abstractmethod
    def imaging_condition(self) -> Optional[ImagingConditionCode]:
        """Conditions that affected the image."""

    @property
    @abstractmethod
    def image_quality_code(self) -> Optional[Identifier]:
        """Code in producer's code space that specifies the image quality."""

    @property
    @abstractmethod
    def cloud_cover_percentage(self) -> Optional[float]:
        """
        Area of the dataset obscured by clouds, expressed as a percentage of
        the spatial extent.

        Domain: 0.0 - 100.0
        """

    @property
    @abstractmethod
    def compression_generation_quantity(self) -> Optional[int]:
        """
        Count of the number of lossy compression cycles performed on the image.
        """

    @property
    @abstractmethod
    def triangulation_indicator(self) -> Optional[bool]:
        """
        Indication of whether or not triangulation has been performed upon the
        image.
        """

    @property
    @abstractmethod
    def radiometric_calibration_data_availability(self) -> Optional[bool]:
        """
        Indication of whether or not the radiometric calibration information
        for generating the radiometrically calibrated standard data product is
        available.
        """

    @property
    @abstractmethod
    def camera_calibration_information_availability(self) -> Optional[bool]:
        """
        Indication of whether or not constants are available which allow for
        camera calibration corrections.
        """

    @property
    @abstractmethod
    def film_distortion_information_availability(self) -> Optional[bool]:
        """
        Indication of whether or not Calibration Reseau information is
        available.
        """

    @property
    @abstractmethod
    def lens_distortion_information_availability(self) -> Optional[bool]:
        """
        Indication of whether or not lens aberration correction information is
        available.
        """

camera_calibration_information_availability: Optional[bool] abstractmethod property

Indication of whether or not constants are available which allow for camera calibration corrections.

cloud_cover_percentage: Optional[float] abstractmethod property

Area of the dataset obscured by clouds, expressed as a percentage of the spatial extent.

Domain: 0.0 - 100.0

compression_generation_quantity: Optional[int] abstractmethod property

Count of the number of lossy compression cycles performed on the image.

film_distortion_information_availability: Optional[bool] abstractmethod property

Indication of whether or not Calibration Reseau information is available.

illumination_azimuth_angle: Optional[float] abstractmethod property

Illumination azimuth measured in degrees clockwise from true north at the time the image is taken.

NOTE: For images from a scanning device, refer to the centre pixel of the image.

Domain: 0.00 - 360

illumination_elevation_angle: Optional[float] abstractmethod property

Illumination elevation measured in degrees clockwise from the target plane at intersection of the optical line of sight with the Earth's surface.

NOTE: For images from a scanning device, refer to the centre pixel of the image.

Domain: -90 - 90

image_quality_code: Optional[Identifier] abstractmethod property

Code in producer's code space that specifies the image quality.

imaging_condition: Optional[ImagingConditionCode] abstractmethod property

Conditions that affected the image.

lens_distortion_information_availability: Optional[bool] abstractmethod property

Indication of whether or not lens aberration correction information is available.

radiometric_calibration_data_availability: Optional[bool] abstractmethod property

Indication of whether or not the radiometric calibration information for generating the radiometrically calibrated standard data product is available.

triangulation_indicator: Optional[bool] abstractmethod property

Indication of whether or not triangulation has been performed upon the image.

ImagingConditionCode

Bases: Enum

Code which indicates conditions which may affect the image.

Source code in opengis/metadata/content.py
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
class ImagingConditionCode(Enum):
    """
    Code which indicates conditions which may affect the image.
    """

    BLURRED_IMAGE = "blurredImage"
    """Portion of the image is blurred."""

    CLOUD = "cloud"
    """Portion of the image is partially obscured by cloud cover."""

    DEGRADING_OBLIQUITY = "degradingObliquity"
    """
    Acute angle between the plane of the ecliptic (the plane of the Earth's
    orbit) and the plane of the celestial equator.
    """

    FOG = "fog"
    """Portion of the image is partially obscured by fog."""

    HEAVY_SMOKE_OR_DUST = "heavySmokeOrDust"
    """Portion of the image is partially obscured by heavy smoke or dust."""

    NIGHT = "night"
    """Image was taken at night."""

    RAIN = "rain"
    """Image was taken during rainfall."""

    SEMI_DARKNESS = "semiDarkness"
    """
    Image was taken during semi-dark conditions - twilight conditions.
    """
    SHADOW = "shadow"
    """Portion of the image is obscured by shadow."""

    SNOW = "snow"
    """Portion of the image is obscured by snow."""

    TERRAIN_MASKING = "terrainMasking"
    """
    The absence of collection data of a given point or area caused by the
    relative location of topographic features which obstruct the collection
    path between the collector(s) and the subject(s) of interes.
    """

BLURRED_IMAGE = 'blurredImage' class-attribute instance-attribute

Portion of the image is blurred.

CLOUD = 'cloud' class-attribute instance-attribute

Portion of the image is partially obscured by cloud cover.

DEGRADING_OBLIQUITY = 'degradingObliquity' class-attribute instance-attribute

Acute angle between the plane of the ecliptic (the plane of the Earth's orbit) and the plane of the celestial equator.

FOG = 'fog' class-attribute instance-attribute

Portion of the image is partially obscured by fog.

HEAVY_SMOKE_OR_DUST = 'heavySmokeOrDust' class-attribute instance-attribute

Portion of the image is partially obscured by heavy smoke or dust.

NIGHT = 'night' class-attribute instance-attribute

Image was taken at night.

RAIN = 'rain' class-attribute instance-attribute

Image was taken during rainfall.

SEMI_DARKNESS = 'semiDarkness' class-attribute instance-attribute

Image was taken during semi-dark conditions - twilight conditions.

SHADOW = 'shadow' class-attribute instance-attribute

Portion of the image is obscured by shadow.

SNOW = 'snow' class-attribute instance-attribute

Portion of the image is obscured by snow.

TERRAIN_MASKING = 'terrainMasking' class-attribute instance-attribute

The absence of collection data of a given point or area caused by the relative location of topographic features which obstruct the collection path between the collector(s) and the subject(s) of interes.

PolarisationOrientationCode

Bases: Enum

Polarization of the antenna in relation to the wave form.

Source code in opengis/metadata/content.py
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
class PolarisationOrientationCode(Enum):
    """Polarization of the antenna in relation to the wave form."""

    HORIZONTAL = "horizontal"
    """
    Polarization of the sensor oriented in the horizontal plane in relation to
    swathe direction.
    """

    VERTICAL = "vertical"
    """
    Polarization of the sensor oriented in the vertical plane in relation to
    swathe direction.
    """

    LEFT_CIRCULAR = "leftCircular"
    """
    Polarization of the sensor oriented in the left circular plane in relation
    to swathe direction.
    """

    RIGHT_CIRCULAR = "rightCircular"
    """
    Polarization of the sensor oriented in the right circular plane in relation
    to swathe direction.
    """

    THETA = "theta"
    """
    Polarization of the sensor oriented in the angle between +90° and 0°
    parallel to swathe direction.
    """

    PHI = "phi"
    """
    Polarization of the sensor oriented in the +90° and 0° perpendicular to
    swathe direction.
    """

HORIZONTAL = 'horizontal' class-attribute instance-attribute

Polarization of the sensor oriented in the horizontal plane in relation to swathe direction.

LEFT_CIRCULAR = 'leftCircular' class-attribute instance-attribute

Polarization of the sensor oriented in the left circular plane in relation to swathe direction.

PHI = 'phi' class-attribute instance-attribute

Polarization of the sensor oriented in the +90° and 0° perpendicular to swathe direction.

RIGHT_CIRCULAR = 'rightCircular' class-attribute instance-attribute

Polarization of the sensor oriented in the right circular plane in relation to swathe direction.

THETA = 'theta' class-attribute instance-attribute

Polarization of the sensor oriented in the angle between +90° and 0° parallel to swathe direction.

VERTICAL = 'vertical' class-attribute instance-attribute

Polarization of the sensor oriented in the vertical plane in relation to swathe direction.

RangeDimension

Bases: ABC

Information on the range of attribute values.

Source code in opengis/metadata/content.py
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
class RangeDimension(ABC):
    """Information on the range of attribute values."""

    @property
    @abstractmethod
    def sequence_identifier(self) -> Optional[MemberName]:
        """
        Number that uniquely identifies instances of bands of wavelengths on
        which a sensor operates.
        """

    @property
    @abstractmethod
    def description(self) -> Optional[str]:
        """Description of the range of a cell measurement value."""

    @property
    @abstractmethod
    def name(self) -> Optional[Sequence[Identifier]]:
        """
        Identifiers for each attribute included in the resource.

        NOTE: These identifiers can be used to provide names for the
        resource's attribute from a standard set of names.
        """

description: Optional[str] abstractmethod property

Description of the range of a cell measurement value.

name: Optional[Sequence[Identifier]] abstractmethod property

Identifiers for each attribute included in the resource.

NOTE: These identifiers can be used to provide names for the resource's attribute from a standard set of names.

sequence_identifier: Optional[MemberName] abstractmethod property

Number that uniquely identifies instances of bands of wavelengths on which a sensor operates.

RangeElementDescription

Bases: ABC

Description of specific range elements.

Source code in opengis/metadata/content.py
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
class RangeElementDescription(ABC):
    """Description of specific range elements."""

    @property
    @abstractmethod
    def name(self) -> str:
        """Designation associated with a set of range elements."""

    @property
    @abstractmethod
    def definition(self) -> str:
        """Description of a set of specific range elements."""

    @property
    @abstractmethod
    def range_element(self) -> Sequence[Record]:
        """
        Specific range elements, i.e. range elements associated with a name
        and their definition.
        """

definition: str abstractmethod property

Description of a set of specific range elements.

name: str abstractmethod property

Designation associated with a set of range elements.

range_element: Sequence[Record] abstractmethod property

Specific range elements, i.e. range elements associated with a name and their definition.

SampleDimension

Bases: RangeDimension

The characteristics of each dimension (layer) included in the resource.

Source code in opengis/metadata/content.py
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
class SampleDimension(RangeDimension):
    """
    The characteristics of each dimension (layer) included in the resource.
    """

    @property
    @abstractmethod
    def max_value(self) -> Optional[float]:
        """
        Maximum value of data values in each dimension included in the
        resource.

        NOTE: Restricted to UomLength in the `Band` class.
        """

    @property
    @abstractmethod
    def min_value(self) -> Optional[float]:
        """
        Minimum value of data values in each dimension included in the
        resource.

        Restricted to `UomLength` in the `Band` class.
        """

    @property
    @abstractmethod
    def units(self) -> Optional[UnitOfMeasure]:
        """
        Units of data in each dimension included in the resource.

        NOTE: that the type of this is `UnitOfMeasure` and that it is
        restricted further for the `Band` class to being of type `UomLength`.

        MANDATORY if `max_value` or `min_value` is specified.
        """

    @property
    @abstractmethod
    def scale_factor(self) -> Optional[float]:
        """Scale factor which has been applied to the cell value."""

    @property
    @abstractmethod
    def offset(self) -> Optional[float]:
        """The physical value corresponding to a cell value of zero."""

    @property
    @abstractmethod
    def mean_value(self) -> Optional[float]:
        """
        Mean value of data values in each dimension included in the resource.
        """

    @property
    @abstractmethod
    def number_of_values(self) -> Optional[int]:
        """
        This gives the number of values used in a thematicClassification
        resource, e.g., the number of classes in a Land Cover Type coverage or
        the number of cells with data in other types of coverages.
        """

    @property
    @abstractmethod
    def standard_deviation(self) -> Optional[float]:
        """
        Standard deviation of data values in each dimension included in the
        resource.
        """

    @property
    @abstractmethod
    def other_property_type(self) -> Optional[RecordType]:
        """
        Type of other attribute description (i.e. netcdf/variable in ncml.xsd).
        """

    @property
    @abstractmethod
    def other_property(self) -> Optional[Record]:
        """
        Instance of otherAttributeType that defines attributes not explicitly
        included in `CoverageType`.
        """

    @property
    @abstractmethod
    def bits_per_value(self) -> Optional[int]:
        """
        Maximum number of significant bits in the uncompressed representation
        for the value in each band of each pixel.
        """

    @property
    @abstractmethod
    def transfer_function_type(self) -> Optional[TransferFunctionTypeCode]:
        """
        Type of transfer function to be used when scaling a physical value for
        a given element.
        """

    @property
    @abstractmethod
    def range_element_description(self) -> Sequence[RangeElementDescription]:
        """
        Provides the description and values of the specific range elements of
        a sample dimension.
        """

    @property
    @abstractmethod
    def nominal_spatial_resolution(self) -> Optional[float]:
        """
        Smallest distance between which separate points can be distinguished,
        as specified in instrument design.
        """

bits_per_value: Optional[int] abstractmethod property

Maximum number of significant bits in the uncompressed representation for the value in each band of each pixel.

max_value: Optional[float] abstractmethod property

Maximum value of data values in each dimension included in the resource.

NOTE: Restricted to UomLength in the Band class.

mean_value: Optional[float] abstractmethod property

Mean value of data values in each dimension included in the resource.

min_value: Optional[float] abstractmethod property

Minimum value of data values in each dimension included in the resource.

Restricted to UomLength in the Band class.

nominal_spatial_resolution: Optional[float] abstractmethod property

Smallest distance between which separate points can be distinguished, as specified in instrument design.

number_of_values: Optional[int] abstractmethod property

This gives the number of values used in a thematicClassification resource, e.g., the number of classes in a Land Cover Type coverage or the number of cells with data in other types of coverages.

offset: Optional[float] abstractmethod property

The physical value corresponding to a cell value of zero.

other_property: Optional[Record] abstractmethod property

Instance of otherAttributeType that defines attributes not explicitly included in CoverageType.

other_property_type: Optional[RecordType] abstractmethod property

Type of other attribute description (i.e. netcdf/variable in ncml.xsd).

range_element_description: Sequence[RangeElementDescription] abstractmethod property

Provides the description and values of the specific range elements of a sample dimension.

scale_factor: Optional[float] abstractmethod property

Scale factor which has been applied to the cell value.

standard_deviation: Optional[float] abstractmethod property

Standard deviation of data values in each dimension included in the resource.

transfer_function_type: Optional[TransferFunctionTypeCode] abstractmethod property

Type of transfer function to be used when scaling a physical value for a given element.

units: Optional[UnitOfMeasure] abstractmethod property

Units of data in each dimension included in the resource.

NOTE: that the type of this is UnitOfMeasure and that it is restricted further for the Band class to being of type UomLength.

MANDATORY if max_value or min_value is specified.

TransferFunctionTypeCode

Bases: Enum

Transform function to be used when scaling a physical value for a given element.

Source code in opengis/metadata/content.py
217
218
219
220
221
222
223
224
225
226
227
228
229
230
class TransferFunctionTypeCode(Enum):
    """
    Transform function to be used when scaling a physical value for a given
    element.
    """

    LINEAR = "linear"
    """Function used when transformation is first order polynomial."""

    LOGARITHMIC = "logarithmic"
    """Function used when transformation is logartihmic."""

    EXPONENTIAL = "exponential"
    """Function used when transformation is exponential."""

EXPONENTIAL = 'exponential' class-attribute instance-attribute

Function used when transformation is exponential.

LINEAR = 'linear' class-attribute instance-attribute

Function used when transformation is first order polynomial.

LOGARITHMIC = 'logarithmic' class-attribute instance-attribute

Function used when transformation is logartihmic.