aws.osml.formats.sidd.models.sidd_v3_0_0 module

This file was generated by xsdata, v23.8, on 2023-10-05 09:59:45

Generator: DataclassGenerator See: https://xsdata.readthedocs.io/

class aws.osml.formats.sidd.models.sidd_v3_0_0.AccuracyType(horizontal: List[float] = <factory>, vertical: List[float] = <factory>)[source]

Bases: object

horizontal: List[float]
vertical: List[float]
class aws.osml.formats.sidd.models.sidd_v3_0_0.AcheivedResolutionType[source]

Bases: object

Finest achievable resolution parameters.

class aws.osml.formats.sidd.models.sidd_v3_0_0.ClassificationGuidanceType(authority: str | None = None, date: XmlDate | None = None)[source]

Bases: object

Classification guidance authority (only if file is classified).

Variables:

  • authority – Classifying authority.

  • date – Date that the authority was provided. Specified in YYYY-MM-DD.

authority: str | None = None
date: XmlDate | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.DRAHistogramOverridesType(clip_min: int | None = None, clip_max: int | None = None)[source]

Bases: object

Variables:

  • clip_min – Suggested override for the lower end-point of the display histogram in the ELT DRA application. Referred to as Pmin in SIPS documentation.

  • clip_max – Suggested override for the upper end-point of the display histogram in the ELT DRA application. Referred to as Pmax in SIPS documentation.

clip_min: int | None = None
clip_max: int | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.DRAOverrides(subtractor: float | None = None, multiplier: float | None = None)[source]

Bases: object

Variables:

  • subtractor – Subtractor value used to reduce haze in the image. Range: [0.0 to 2047.0]

  • multiplier – Multiplier value used to reduce haze in the image. Range: [0.0 to 2047.0]

subtractor: float | None = None
multiplier: float | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.DRAParameters(pmin: float | None = None, pmax: float | None = None, emin_modifier: float | None = None, emax_modifier: float | None = None)[source]

Bases: object

Variables:

  • pmin – DRA clip low point. This is the cumulative histogram percentage value that defines the lower end- point of the dynamic range to be displayed. Range: [0.0 to 1.0]

  • pmax – DRA clip high point. This is the cumulative histogram percentage value that defines the upper end-point of the dynamic range to be displayed. Range: [0.0 to 1.0]

  • emin_modifier – The pixel value corresponding to the Pmin percentage poitn in the image histogram. Range: [0.0 to 1.0]/

  • emax_modifier – The pixel value corresponding to the Pmax percentage poitn in the image histogram. Range: [0.0 to 1.0]/

pmin: float | None = None
pmax: float | None = None
emin_modifier: float | None = None
emax_modifier: float | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.DownsamplingMethodType(value)[source]

Bases: Enum

An enumeration.

DECIMATE = 'DECIMATE'
MAX_PIXEL = 'MAX PIXEL'
AVERAGE = 'AVERAGE'
NEAREST_NEIGHBOR = 'NEAREST NEIGHBOR'
BILINEAR = 'BILINEAR'
LAGRANGE = 'LAGRANGE'
class aws.osml.formats.sidd.models.sidd_v3_0_0.EarthModelType(value)[source]

Bases: Enum

Identifies the earth model used for latitude, longitude and height parameters.

All height values are Height Above The Ellipsoid (HAE).

WGS_84 = 'WGS_84'
class aws.osml.formats.sidd.models.sidd_v3_0_0.EqualizationAlgorithmType(value)[source]

Bases: Enum

An enumeration.

VALUE_1_DLUT = '1DLUT'
class aws.osml.formats.sidd.models.sidd_v3_0_0.FilterBankCoefType(coef: List[ForwardRef('FilterBankCoefType.Coef')] = <factory>, num_phasings: Optional[int] = None, num_points: Optional[int] = None)[source]

Bases: object

coef: List[Coef]
num_phasings: int | None = None
num_points: int | None = None
class Coef(value: float | None = None, phasing: int | None = None, point: int | None = None)[source]

Bases: object

value: float | None = None
phasing: int | None = None
point: int | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.FilterDatabaseNameType(value)[source]

Bases: Enum

An enumeration.

BILINEAR = 'BILINEAR'
CUBIC = 'CUBIC'
LAGRANGE = 'LAGRANGE'
NEAREST_NEIGHBOR = 'NEAREST NEIGHBOR'
class aws.osml.formats.sidd.models.sidd_v3_0_0.FilterKernelCoefType(coef: List[ForwardRef('FilterKernelCoefType.Coef')] = <factory>, num_rows: Optional[int] = None, num_cols: Optional[int] = None)[source]

Bases: object

coef: List[Coef]
num_rows: int | None = None
num_cols: int | None = None
class Coef(value: float | None = None, row: int | None = None, col: int | None = None)[source]

Bases: object

value: float | None = None
row: int | None = None
col: int | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.FilterOperationType(value)[source]

Bases: Enum

An enumeration.

CONVOLUTION = 'CONVOLUTION'
CORRELATION = 'CORRELATION'
class aws.osml.formats.sidd.models.sidd_v3_0_0.GeopositioningTypeCoordinateSystemType(value)[source]

Bases: Enum

An enumeration.

GCS = 'GCS'
UTM = 'UTM'
class aws.osml.formats.sidd.models.sidd_v3_0_0.GeopositioningTypeGeodeticDatum(value)[source]

Bases: Enum

An enumeration.

WORLD_GEODETIC_SYSTEM_1984 = 'World Geodetic System 1984'
class aws.osml.formats.sidd.models.sidd_v3_0_0.GeopositioningTypeReferenceEllipsoid(value)[source]

Bases: Enum

An enumeration.

WORLD_GEODETIC_SYSTEM_1984 = 'World Geodetic System 1984'
class aws.osml.formats.sidd.models.sidd_v3_0_0.GeopositioningTypeSoundingDatum(value)[source]

Bases: Enum

An enumeration.

MEAN_SEA_LEVEL = 'Mean Sea Level'
class aws.osml.formats.sidd.models.sidd_v3_0_0.GeopositioningTypeVerticalDatum(value)[source]

Bases: Enum

An enumeration.

MEAN_SEA_LEVEL = 'Mean Sea Level'
class aws.osml.formats.sidd.models.sidd_v3_0_0.LayerType(bitrate: float | None = None, index: int | None = None)[source]

Bases: object

Variables:

  • bitrate – The bit rate target associated with the layer. It may happen that the bit rate was not achieved due to data characteristics. Note: for JPEG 2000 numerically lossless quality, the bit rate for the final layer is an expected value, based on performance.

  • index

bitrate: float | None = None
index: int | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.Lookup3TableType(value: ~typing.List[str] = <factory>, size: int | None = None)[source]

Bases: object

Variables:

  • value

  • size – Size of LUT

value: List[str]
size: int | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.LookupTableType(value: ~typing.List[int] = <factory>, lut: int | None = None)[source]

Bases: object

Variables:

  • value

  • lut – Size of LUT.

value: List[int]
lut: int | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.MeasurementTypeARPFlag(value)[source]

Bases: Enum

Variables:

  • REALTIME – Based on ephemeries at time of collect

  • PREDICTED – Based on predicted ephemeries (i.e. pre-collect)

  • POST_PROCESSED – Ephemeris has been refined after data collection

REALTIME = 'REALTIME'
PREDICTED = 'PREDICTED'
POST_PROCESSED = 'POST PROCESSED'
class aws.osml.formats.sidd.models.sidd_v3_0_0.PixelType(value)[source]

Bases: Enum

An enumeration.

MONO8_I = 'MONO8I'
MONO8_LU = 'MONO8LU'
MONO16_I = 'MONO16I'
RGB8_LU = 'RGB8LU'
RGB24_I = 'RGB24I'
class aws.osml.formats.sidd.models.sidd_v3_0_0.PredefinedLookupType(database_name: str | None = None, remap_family: int | None = None, remap_member: int | None = None)[source]

Bases: object

Variables:

  • database_name – Database name of LUT to use.

  • remap_family – Index specifying the remap family.

  • remap_member – Index specifying the member for the remap family.

database_name: str | None = None
remap_family: int | None = None
remap_member: int | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.ProcessorInformationType(application: str | None = None, processing_date_time: XmlDateTime | None = None, site: str | None = None, profile: str | None = None)[source]

Bases: object

Variables:

  • application – Software application name and version number.

  • processing_date_time – Date and time defined in Coordinated Universal Time (UTC). The seconds should be followed by a Z to indicate UTC.

  • site – Creation location of product.

  • profile – Product-specific profile applied during product processing.

application: str | None = None
processing_date_time: XmlDateTime | None = None
site: str | None = None
profile: str | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.RangeAdjustmentAlgorithmType(value)[source]

Bases: Enum

Algorithm used for dynamic range adjustment.

AUTO = 'AUTO'
MANUAL = 'MANUAL'
NONE = 'NONE'
class aws.osml.formats.sidd.models.sidd_v3_0_0.RenderingIntentType(value)[source]

Bases: Enum

An enumeration.

PERCEPTUAL = 'PERCEPTUAL'
SATURATION = 'SATURATION'
RELATIVE = 'RELATIVE'
ABSOLUTE = 'ABSOLUTE'
class aws.osml.formats.sidd.models.sidd_v3_0_0.ShadowDirectionType(value)[source]

Bases: Enum

Descirbes the shadow direciton relative to the pixels in the file.

UP = 'UP'
DOWN = 'DOWN'
LEFT = 'LEFT'
RIGHT = 'RIGHT'
ARBITRARY = 'ARBITRARY'
class aws.osml.formats.sidd.models.sidd_v3_0_0.AnnotationObjectType(point: PointType | None = None, line: LineType | None = None, linear_ring: LinearRingType | None = None, polygon: PolygonType | None = None, polyhedral_surface: PolyhedralSurfaceType | None = None, multi_polygon: MultiPolygonType | None = None, multi_line_string: MultiLineStringType | None = None, multi_point: MultiPointType | None = None)[source]

Bases: object

Geometrical representation of the annotation.

point: PointType | None = None
line: LineType | None = None
linear_ring: LinearRingType | None = None
polygon: PolygonType | None = None
polyhedral_surface: PolyhedralSurfaceType | None = None
multi_polygon: MultiPolygonType | None = None
multi_line_string: MultiLineStringType | None = None
multi_point: MultiPointType | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.BankCustomType(filter_coefficients: aws.osml.formats.sidd.models.sidd_v3_0_0.FilterBankCoefType | None = None)[source]

Bases: object

filter_coefficients: FilterBankCoefType | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.BaseProjectionType(reference_point: ReferencePointType | None = None)[source]

Bases: object

Variables:

reference_point – Reference point for the geometrical system.

reference_point: ReferencePointType | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.ColorDisplayRemapType(remap_lut: Lookup3TableType | None = None)[source]

Bases: object

Object representing that the data requires color display.

Variables:

remap_lut – LUT-base remap indicating that the color display is done through index-based color.

remap_lut: Lookup3TableType | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.ColorManagementModuleType(rendering_intent: RenderingIntentType | None = None, source_profile: str | None = None, display_profile: str | None = None, iccprofile_signature: str | None = None)[source]

Bases: object

Parameters describing the Color Management Module (CMM).

Variables:

  • rendering_intent

  • source_profile – Name of sensor profile in ICC Profile database.

  • display_profile – Name of display profile in ICC Profile database.

  • iccprofile_signature – Valid ICC profile signature.

rendering_intent: RenderingIntentType | None = None
source_profile: str | None = None
display_profile: str | None = None
iccprofile_signature: str | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.DynamicRangeAdjustmentType(algorithm_type: RangeAdjustmentAlgorithmType | None = None, band_stats_source: int | None = None, draparameters: DRAParameters | None = None, draoverrides: DRAOverrides | None = None)[source]

Bases: object

Parameter describing DRA.

Variables:

  • algorithm_type – Algorithm used for dynamic range adjustment.

  • band_stats_source – Indicates which band to use in computing statistics for DRA. Valid range = 1 to NumBands.

  • draparameters

  • draoverrides

algorithm_type: RangeAdjustmentAlgorithmType | None = None
band_stats_source: int | None = None
draparameters: DRAParameters | None = None
draoverrides: DRAOverrides | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.ExploitationFeaturesCollectionGeometryType(azimuth: float | None = None, slope: float | None = None, squint: float | None = None, graze: float | None = None, tilt: float | None = None, doppler_cone_angle: float | None = None, extension: ~typing.List[~aws.osml.formats.sidd.models.sicommon_types_v1_0.ParameterType] = <factory>)[source]

Bases: object

Key geometry parameters independent of product processing.

All values computed at the center time of the full collection.

Variables:

  • azimuth – Angle clockwise from north indicating the ETP line of sight vector.

  • slope – Angle between the ETP at scene center and the range vector perpendicular to the direction of motion.

  • squint – Angle from the ground track to platform velocity vector at nadir. Left-look is positive, right- look is negative.

  • graze – Angle between the ETP and the line of sight vector.

  • tilt – Angle between the ETP and the cross range vector. Also known as the twist angle.

  • doppler_cone_angle – The angle between the velocity vector and the radar line-of-sight vector. Also known as the slant plane squint angle.

  • extension – Exploitation feature extension related to geometry for a single input image

azimuth: float | None = None
slope: float | None = None
squint: float | None = None
graze: float | None = None
tilt: float | None = None
doppler_cone_angle: float | None = None
extension: List[ParameterType]
class aws.osml.formats.sidd.models.sidd_v3_0_0.ExploitationFeaturesCollectionPhenomenologyType(shadow: ~aws.osml.formats.sidd.models.sicommon_types_v1_0.AngleZeroToExclusive360MagnitudeType | None = None, layover: ~aws.osml.formats.sidd.models.sicommon_types_v1_0.AngleZeroToExclusive360MagnitudeType | None = None, multi_path: float | None = None, ground_track: float | None = None, extension: ~typing.List[~aws.osml.formats.sidd.models.sicommon_types_v1_0.ParameterType] = <factory>)[source]

Bases: object

Phenomenology related to both the geometry and the final product processing.

All values computed at the center time of the full collection.

Variables:

  • shadow – The phenomon where vertical objects occlude radar energy.

  • layover – The phenomenon where vertical objects appear as ground objects with the same range/range rate.

  • multi_path – This is a range dependent phenomenon which describes the energy from a single scatter returned to the radar via more than one path and results in a nominally constant direction in the ETP.

  • ground_track – Counter-clockwise angle from increasing row direction to ground track at the center of the image.

  • extension – Exploitation feature extension related to phenomenology for a single input image

shadow: AngleZeroToExclusive360MagnitudeType | None = None
layover: AngleZeroToExclusive360MagnitudeType | None = None
multi_path: float | None = None
ground_track: float | None = None
extension: List[ParameterType]
class aws.osml.formats.sidd.models.sidd_v3_0_0.GeographicCoordinatesType(longitude_density: float | None = None, latitude_density: float | None = None, reference_origin: LatLonType | None = None)[source]

Bases: object

Describes the Local Geographic Coordinate system linking row/column to the absolute geographic coordinate (lat/lon)

Variables:

  • longitude_density – Pixel ground spacing in E/W direction that is the number of pixels or element intervals in 360 degrees.

  • latitude_density – Pixel ground spacing in N/S direction that is the number of pixels or element intervals in 360 degrees.

  • reference_origin – Northwest corner Latitude/Longitude - product NW corner

longitude_density: float | None = None
latitude_density: float | None = None
reference_origin: LatLonType | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.GeometricChipType(chip_size: RowColIntType | None = None, original_upper_left_coordinate: RowColDoubleType | None = None, original_upper_right_coordinate: RowColDoubleType | None = None, original_lower_left_coordinate: RowColDoubleType | None = None, original_lower_right_coordinate: RowColDoubleType | None = None)[source]

Bases: object

Contains information related to downstream chipping of the product.

There is only one instance, and the instance is updated with respect to the full image parameters. For example, if an image is chipped out of a smaller chip, the new chip needs to be updated to the original full image corners. Since this relationship is linear, bi-linear interpolation is sufficient to determine an arbitrary chip coordinate in terms of the original full image coordinates. Chipping is typically done using an exploitation tool, and should not be done in the initial product creation.

Variables:

  • chip_size – Size of the chipped product in pixels.

  • original_upper_left_coordinate – Upper-left corner with respect to the original product.

  • original_upper_right_coordinate – Upper-right corner with respect to the original product.

  • original_lower_left_coordinate – Lower-left corner with respect to the original product.

  • original_lower_right_coordinate – Lower-right corner with respect to the original product.

chip_size: RowColIntType | None = None
original_upper_left_coordinate: RowColDoubleType | None = None
original_upper_right_coordinate: RowColDoubleType | None = None
original_lower_left_coordinate: RowColDoubleType | None = None
original_lower_right_coordinate: RowColDoubleType | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.GeopositioningType(coordinate_system_type: GeopositioningTypeCoordinateSystemType | None = None, geodetic_datum: GeopositioningTypeGeodeticDatum | None = None, reference_ellipsoid: GeopositioningTypeReferenceEllipsoid | None = None, vertical_datum: GeopositioningTypeVerticalDatum | None = None, sounding_datum: GeopositioningTypeSoundingDatum | None = None, false_origin: int | None = None, utmgrid_zone_number: int | None = None)[source]

Bases: object

Describes the absolute coordinate system to which the data is referenced.

Variables:

  • coordinate_system_type

  • geodetic_datum

  • reference_ellipsoid

  • vertical_datum

  • sounding_datum

  • false_origin – Z values false origin

  • utmgrid_zone_number – Gride zone number, required for UTM, not include for GCS. (4 character field) Values: +001 to +060 (northern hemisphere) -001 to -060 (southern hemisphere)

coordinate_system_type: GeopositioningTypeCoordinateSystemType | None = None
geodetic_datum: GeopositioningTypeGeodeticDatum | None = None
reference_ellipsoid: GeopositioningTypeReferenceEllipsoid | None = None
vertical_datum: GeopositioningTypeVerticalDatum | None = None
sounding_datum: GeopositioningTypeSoundingDatum | None = None
false_origin: int | None = None
utmgrid_zone_number: int | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.ImageCornersType(icp: ~typing.List[~aws.osml.formats.sidd.models.sidd_v3_0_0.ImageCornersType.ICP] = <factory>)[source]

Bases: object

Parameters apply to image corners of the product projected to the same height as the SCP.

These corners are an approximate geographic location that is not intended for analytical use.

Variables:

icp – Image Corner Point (ICP) data for the 4 corners in product. ICPs indexed x = 1, 2, 3, 4, clockwise.

icp: List[ICP]
class ICP(lat: float | None = None, lon: float | None = None, index: aws.osml.formats.sidd.models.sicommon_types_v1_0.CornerStringType | None = None)[source]

Bases: LatLonType

index: CornerStringType | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.InputROIType(size: RowColIntType | None = None, upper_left: RowColIntType | None = None)[source]

Bases: object

ROI representing portion of input data used to make this product.

Variables:

  • size – Number of rows and columns extracted from the input.

  • upper_left – The upper-left pixel extracted from the input.

size: RowColIntType | None = None
upper_left: RowColIntType | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.KernelCustomType(filter_coefficients: aws.osml.formats.sidd.models.sidd_v3_0_0.FilterKernelCoefType | None = None)[source]

Bases: object

filter_coefficients: FilterKernelCoefType | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.LUTInfoType(lutvalues: List[aws.osml.formats.sidd.models.sidd_v3_0_0.LookupTableType] = <factory>, num_luts: Optional[int] = None, size: Optional[int] = None)[source]

Bases: object

lutvalues: List[LookupTableType]
num_luts: int | None = None
size: int | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.LayerInfoType(layer: ~typing.List[~aws.osml.formats.sidd.models.sidd_v3_0_0.LayerType] = <factory>, num_layers: int | None = None)[source]

Bases: object

Original Layer Information.

The following fileds repeat for all layers in (0, 1, …, numLayers - 1). The default number of layers per tile in original image out of the original processor.

Variables:

  • layer – Layer Index Number indicates the number of layers being described. Layers are numbered from 0 to (numLayers - 1).

  • num_layers

layer: List[LayerType]
num_layers: int | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.MonochromeDisplayRemapType(remap_type: str | None = None, remap_parameter: ~typing.List[~aws.osml.formats.sidd.models.sicommon_types_v1_0.ParameterType] = <factory>)[source]

Bases: object

This remap works by taking the input space and using the LUT to map it to a log space (for 8-bit only).

From the log space the C0 and Ch fields are applied to get to display-ready density space. The density should then be rendered by the TTC and monitor comp. This means that the default DRA should not apply anything besides the clip points. If a different contrast/brightness is applied it should be done through modification of the clip points via DRA. Examples: Remap LUT Clips ============================= PEDF PEDF-&gt;D 0,255 LLG LLG-&gt;A-&gt;LogA C0,Ch Log N/A C0,Ch NRL N/A 0,255 (Supposed to be display ready)

Variables:

  • remap_type – Name of remap applied (for informational purposes only).

  • remap_parameter – Textual remap parameter. Filled based upon remap type (for informational purposes only). For example, if the data is linlog encoded a RemapParameter could be used to describe any amplitude scaling that was performed prior to linlog encoding the data.

remap_type: str | None = None
remap_parameter: List[ParameterType]
class aws.osml.formats.sidd.models.sidd_v3_0_0.Orientation(shadow_direction: ShadowDirectionType | None = None)[source]

Bases: object

Parameters describing the default orientation of the product.

Variables:

shadow_direction – Descirbes the shadow direciton relative to the pixels in the file.

shadow_direction: ShadowDirectionType | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.PolygonType(vertex: ~typing.List[~aws.osml.formats.sidd.models.sicommon_types_v1_0.LatLonVertexType] = <factory>, size: int | None = None)[source]

Bases: object

Indicates the full image includes both valid data and some zero filled pixels.

Simple convex polygon enclosed the valid data (may include some zero filled pixels for simplification). Vertices in clockwise order.

Variables:

  • vertex – Vertices indexed n = 1, 2, …, NumVertices. NumVertices &gt;= 3. Vertex 1 is determined by (1) minimum row index, (2) minimum column index if 2 vertices with minimum row index, 1st and last vertices are connected to form the polygon.

  • size

vertex: List[LatLonVertexType]
size: int | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.PositionalAccuracyType(num_regions: int | None = None, absolute_accuracy: AccuracyType | None = None, point_to_point_accuracy: AccuracyType | None = None)[source]

Bases: object

Describes the horizontal and vertical point and regional information for the DED.

Variables:

  • num_regions – Number of positional accuracy regions.

  • absolute_accuracy

  • point_to_point_accuracy

num_regions: int | None = None
absolute_accuracy: AccuracyType | None = None
point_to_point_accuracy: AccuracyType | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.PredefinedFilterType(database_name: aws.osml.formats.sidd.models.sidd_v3_0_0.FilterDatabaseNameType | None = None, filter_family: int | None = None, filter_member: int | None = None)[source]

Bases: object

database_name: FilterDatabaseNameType | None = None
filter_family: int | None = None
filter_member: int | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.ProcTxRcvPolarizationType(tx_polarization_proc: str | Polarization1Typevalue | None = None, rcv_polarization_proc: str | Polarization1Typevalue | None = None)[source]

Bases: object

Variables:

  • tx_polarization_proc – Polarization transmit type

  • rcv_polarization_proc – Receive polarization type

tx_polarization_proc: str | Polarization1Typevalue | None = None
rcv_polarization_proc: str | Polarization1Typevalue | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.ProcessingEventType(application_name: str | None = None, applied_date_time: ~xsdata.models.datatype.XmlDateTime | None = None, interpolation_method: str | None = None, descriptor: ~typing.List[~aws.osml.formats.sidd.models.sicommon_types_v1_0.ParameterType] = <factory>)[source]

Bases: object

Variables:

  • application_name – Application which applied a modification.

  • applied_date_time – Date and time defined in Coordinated Universal Time (UTC). The seconds should be followed by a Z to indicate UTC.

  • interpolation_method – Type of interpolation applied to the data.

  • descriptor – Descriptor for the processing event.

application_name: str | None = None
applied_date_time: XmlDateTime | None = None
interpolation_method: str | None = None
descriptor: List[ParameterType]
class aws.osml.formats.sidd.models.sidd_v3_0_0.ProcessingModuleType(module_name: ~aws.osml.formats.sidd.models.sicommon_types_v1_0.ParameterType | None = None, module_parameter: ~typing.List[~aws.osml.formats.sidd.models.sicommon_types_v1_0.ParameterType] = <factory>, processing_module: ~typing.List[~aws.osml.formats.sidd.models.sidd_v3_0_0.ProcessingModuleType] = <factory>)[source]

Bases: object

Variables:

  • module_name – The name of the algorithm used in processing the product.

  • module_parameter – Parameters associated with the algorithm used in processing the product.

  • processing_module – ProcessingModule is a repeatable structure within itself to create an algorithm as a subset of another algorithm.

module_name: ParameterType | None = None
module_parameter: List[ParameterType]
processing_module: List[ProcessingModuleType]
class aws.osml.formats.sidd.models.sidd_v3_0_0.ProductClassificationType(security_extension: ~typing.List[~aws.osml.formats.sidd.models.sicommon_types_v1_0.ParameterType] = <factory>, desversion: str | None = None, ismcatcesversion: str | None = None, resource_element: bool | None = None, complies_with: ~typing.List[~aws.osml.formats.sidd.models.external.ism_v13.schema.ism.cvegenerated.cvenum_ismcomplies_with.CVEnumISMCompliesWithValues] = <factory>, create_date: ~xsdata.models.datatype.XmlDate | None = None, exempt_from: ~typing.List[~aws.osml.formats.sidd.models.external.ism_v13.schema.ism.cvegenerated.cvenum_ismexempt_from.CVEnumISMExemptFromValues] = <factory>, classification: ~aws.osml.formats.sidd.models.external.ism_v13.schema.ism.cvegenerated.cvenum_ismclassification_all.CVEnumISMClassificationAll | None = None, owner_producer: ~typing.List[str | ~aws.osml.formats.sidd.models.external.ism_v13.schema.ismcat.cvegenerated.cvenum_ismcatowner_producer.CVEnumISMCATOwnerProducerValuesvalue] = <factory>, joint: bool | None = None, scicontrols: ~typing.List[str | ~aws.osml.formats.sidd.models.external.ism_v13.schema.ism.cvegenerated.cvenum_ismscicontrols.CVEnumISMSCIControlsValuesvalue] = <factory>, saridentifier: ~typing.List[str] = <factory>, atomic_energy_markings: ~typing.List[str | ~aws.osml.formats.sidd.models.external.ism_v13.schema.ism.cvegenerated.cvenum_ismatomic_energy_markings.CVEnumISMatomicEnergyMarkingsValuesvalue] = <factory>, dissemination_controls: ~typing.List[~aws.osml.formats.sidd.models.external.ism_v13.schema.ism.cvegenerated.cvenum_ismdissem.CVEnumISMDissemValues] = <factory>, display_only_to: ~typing.List[str | ~aws.osml.formats.sidd.models.external.ism_v13.schema.ismcat.cvegenerated.cvenum_ismcatrel_to.CVEnumISMCATRelToValuesvalue] = <factory>, fgisource_open: ~typing.List[str | ~aws.osml.formats.sidd.models.external.ism_v13.schema.ismcat.cvegenerated.cvenum_ismcatfgiopen.CVEnumISMCATFGIOpenValuesvalue] = <factory>, fgisource_protected: ~typing.List[str | ~aws.osml.formats.sidd.models.external.ism_v13.schema.ismcat.cvegenerated.cvenum_ismcatfgiprotected.CVEnumISMCATFGIProtectedValuesvalue] = <factory>, releasable_to: ~typing.List[str | ~aws.osml.formats.sidd.models.external.ism_v13.schema.ismcat.cvegenerated.cvenum_ismcatrel_to.CVEnumISMCATRelToValuesvalue] = <factory>, non_icmarkings: ~typing.List[str | ~aws.osml.formats.sidd.models.external.ism_v13.schema.ism.cvegenerated.cvenum_ismnon_ic.CVEnumISMNonICValuesvalue] = <factory>, classified_by: str | None = None, compilation_reason: str | None = None, derivatively_classified_by: str | None = None, classification_reason: str | None = None, non_uscontrols: ~typing.List[~aws.osml.formats.sidd.models.external.ism_v13.schema.ism.cvegenerated.cvenum_ismnon_uscontrols.CVEnumISMNonUSControlsValues] = <factory>, derived_from: str | None = None, declass_date: ~xsdata.models.datatype.XmlDate | None = None, declass_event: str | None = None, declass_exception: ~aws.osml.formats.sidd.models.external.ism_v13.schema.ism.cvegenerated.cvenum_ism25_x.CVEnumISM25X | None = None, notice_type: ~typing.List[~aws.osml.formats.sidd.models.external.ism_v13.schema.ism.cvegenerated.cvenum_ismnotice.CVEnumISMNoticeValues] = <factory>, notice_reason: str | None = None, notice_date: ~xsdata.models.datatype.XmlDate | None = None, unregistered_notice_type: str | None = None, external_notice: bool | None = None)[source]

Bases: object

The overall classification of the product.

Variables:

  • security_extension – Extensible parameters used to support profile-specific needs related to product security.

  • desversion

  • ismcatcesversion

  • resource_element

  • complies_with

  • create_date

  • exempt_from

  • classification

  • owner_producer

  • joint

  • scicontrols

  • saridentifier

  • atomic_energy_markings

  • dissemination_controls

  • display_only_to

  • fgisource_open

  • fgisource_protected

  • releasable_to

  • non_icmarkings

  • classified_by

  • compilation_reason

  • derivatively_classified_by

  • classification_reason

  • non_uscontrols

  • derived_from

  • declass_date

  • declass_event

  • declass_exception

  • notice_type

  • notice_reason

  • notice_date

  • unregistered_notice_type

  • external_notice

security_extension: List[ParameterType]
desversion: str | None = None
ismcatcesversion: str | None = None
resource_element: bool | None = None
complies_with: List[CVEnumISMCompliesWithValues]
create_date: XmlDate | None = None
exempt_from: List[CVEnumISMExemptFromValues]
classification: CVEnumISMClassificationAll | None = None
owner_producer: List[str | CVEnumISMCATOwnerProducerValuesvalue]
joint: bool | None = None
scicontrols: List[str | CVEnumISMSCIControlsValuesvalue]
saridentifier: List[str]
atomic_energy_markings: List[str | CVEnumISMatomicEnergyMarkingsValuesvalue]
dissemination_controls: List[CVEnumISMDissemValues]
display_only_to: List[str | CVEnumISMCATRelToValuesvalue]
fgisource_open: List[str | CVEnumISMCATFGIOpenValuesvalue]
fgisource_protected: List[str | CVEnumISMCATFGIProtectedValuesvalue]
releasable_to: List[str | CVEnumISMCATRelToValuesvalue]
non_icmarkings: List[str | CVEnumISMNonICValuesvalue]
classified_by: str | None = None
compilation_reason: str | None = None
derivatively_classified_by: str | None = None
classification_reason: str | None = None
non_uscontrols: List[CVEnumISMNonUSControlsValues]
derived_from: str | None = None
declass_date: XmlDate | None = None
declass_event: str | None = None
declass_exception: CVEnumISM25X | None = None
notice_type: List[CVEnumISMNoticeValues]
notice_reason: str | None = None
notice_date: XmlDate | None = None
unregistered_notice_type: str | None = None
external_notice: bool | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.ProductPlaneType(row_unit_vector: XYZType | None = None, col_unit_vector: XYZType | None = None)[source]

Bases: object

Plane definition for the product.

Variables:

  • row_unit_vector – Unit vector of the plane defined to be aligned in the increasing row direction of the product. (Defined as Rpgd in Design and Exploitation document)

  • col_unit_vector – Unit vector of the plane defined to be aligned in the increasing column direction of the product. (Defined as Cpgd in Design and Exploitation document)

row_unit_vector: XYZType | None = None
col_unit_vector: XYZType | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.TxRcvPolarizationType(tx_polarization: str | Polarization1Typevalue | None = None, rcv_polarization: str | Polarization1Typevalue | None = None, rcv_polarization_offset: float | None = None)[source]

Bases: object

Variables:

  • tx_polarization – Polarization transmit type

  • rcv_polarization – Receive polarization type

  • rcv_polarization_offset – Optional angle offset for the receive polarization defined at aperture center.

tx_polarization: str | Polarization1Typevalue | None = None
rcv_polarization: str | Polarization1Typevalue | None = None
rcv_polarization_offset: float | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.ValidDataType(vertex: ~typing.List[~aws.osml.formats.sidd.models.sicommon_types_v1_0.RowColVertexType] = <factory>, size: int | None = None)[source]

Bases: object

Indicates the full image includes both valid data and some zero filled pixels.

Simple convex polygon enclosed the valid data (may include some zero filled pixels for simplification). Vertices in clockwise order.

Variables:

  • vertex – Vertices indexed n = 1, 2, …, NumVertices. NumVertices &gt;= 3. Vertex 1 is determined by (1) minimum row index, (2) minimum column index if 2 vertices with minimum row index, 1st and last vertices are connected to form the polygon.

  • size

vertex: List[RowColVertexType]
size: int | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.AnnotationType(identifier: str | None = None, spatial_reference_system: ~aws.osml.formats.sidd.models.sfa.ReferenceSystemType | None = None, object_value: ~typing.List[~aws.osml.formats.sidd.models.sidd_v3_0_0.AnnotationObjectType] = <factory>)[source]

Bases: object

Single annotation.

Variables:

  • identifier – Identifier for the annotation which idicates the type of object represented by this annotation.

  • spatial_reference_system – Spatial reference system of the annotation. Assumed to be WGS-84 geographic coordinate system if not specified with (lat, lon, h) units in (arc-sec, arc-sec, meters above ellipsoid).

  • object_value – The geometrical representation of the annotation.

identifier: str | None = None
spatial_reference_system: ReferenceSystemType | None = None
object_value: List[AnnotationObjectType]
class aws.osml.formats.sidd.models.sidd_v3_0_0.ColorSpaceTransformType(color_management_module: ColorManagementModuleType | None = None)[source]

Bases: object

Variables:

color_management_module – Parameters describing the Color Management Module (CMM).

color_management_module: ColorManagementModuleType | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.CustomLookupType(lutinfo: aws.osml.formats.sidd.models.sidd_v3_0_0.LUTInfoType | None = None)[source]

Bases: object

lutinfo: LUTInfoType | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.DigitalElevationDataType(geographic_coordinates: GeographicCoordinatesType | None = None, geopositioning: GeopositioningType | None = None, positional_accuracy: PositionalAccuracyType | None = None, null_value: int | None = None)[source]

Bases: object

This block describes the Digital ElevatioNData when it is included with the SIDD product.

Variables:

  • geographic_coordinates – Describes the Local Geographic Coordinate system linking row/column to the absolute geographic coordinate (lat/lon)

  • geopositioning – Describes the absolute coordinate system to which the data is referenced.

  • positional_accuracy – Describes the horizontal and vertical point and regional information for the DED.

  • null_value

geographic_coordinates: GeographicCoordinatesType | None = None
geopositioning: GeopositioningType | None = None
positional_accuracy: PositionalAccuracyType | None = None
null_value: int | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.DownstreamReprocessingType(geometric_chip: ~aws.osml.formats.sidd.models.sidd_v3_0_0.GeometricChipType | None = None, processing_event: ~typing.List[~aws.osml.formats.sidd.models.sidd_v3_0_0.ProcessingEventType] = <factory>)[source]

Bases: object

Variables:

  • geometric_chip – Contains information related to downstream chipping of the product.

  • processing_event – Contains information related to downstream processing of the product.

geometric_chip: GeometricChipType | None = None
processing_event: List[ProcessingEventType]
class aws.osml.formats.sidd.models.sidd_v3_0_0.ExploitationFeaturesCollectionInformationType(sensor_name: str | None = None, radar_mode: ~aws.osml.formats.sidd.models.sicommon_types_v1_0.RadarModeType | None = None, collection_date_time: ~xsdata.models.datatype.XmlDateTime | None = None, local_date_time: ~xsdata.models.datatype.XmlDateTime | None = None, collection_duration: float | None = None, resolution: ~aws.osml.formats.sidd.models.sicommon_types_v1_0.RangeAzimuthType | None = None, input_roi: ~aws.osml.formats.sidd.models.sidd_v3_0_0.InputROIType | None = None, polarization: ~typing.List[~aws.osml.formats.sidd.models.sidd_v3_0_0.TxRcvPolarizationType] = <factory>)[source]

Bases: object

General collection information.

Variables:

  • sensor_name – The name of the sensor.

  • radar_mode – Radar collection mode. The ModeType refers to the collection type [SPOTLIGHT, STRIPMAP, DYNAMIC STRIPMAP]. The optional ModeID is used to represent system-specific mode identifiers.

  • collection_date_time – Collection date and time defined in Coordinated Universal Time (UTC). The seconds should be followed by a Z to indicate UTC.

  • local_date_time – Date and time defined in local time.

  • collection_duration – The duration of the collection (units = seconds).

  • resolution – Uniformly-weighted resolution (range and azimuth) processed in the slant plane.

  • input_roi – ROI representing portion of input data used to make this product.

  • polarization – Transmit and receive polarization.

sensor_name: str | None = None
radar_mode: RadarModeType | None = None
collection_date_time: XmlDateTime | None = None
local_date_time: XmlDateTime | None = None
collection_duration: float | None = None
resolution: RangeAzimuthType | None = None
input_roi: InputROIType | None = None
polarization: List[TxRcvPolarizationType]
class aws.osml.formats.sidd.models.sidd_v3_0_0.ExploitationFeaturesProductType(resolution: ~aws.osml.formats.sidd.models.sicommon_types_v1_0.RowColDoubleType | None = None, ellipticity: float | None = None, polarization: ~typing.List[~aws.osml.formats.sidd.models.sidd_v3_0_0.ProcTxRcvPolarizationType] = <factory>, north: float | None = None, extension: ~typing.List[~aws.osml.formats.sidd.models.sicommon_types_v1_0.ParameterType] = <factory>)[source]

Bases: object

Metadata regarding the product.

Variables:

  • resolution – Uniformly-weighted resolution projected into the Earth Tangent Plane (ETP).

  • ellipticity – Ellipticity of the 2D-IPR at the ORP, measured in the Earth Geodetic Tangent Plane (EGTP). Ellipticity is the ratio of the IPR ellipse’s major axis to minor axis.

  • polarization – Describes the processed transmit and receive polarizations for the product.

  • north – Counter-clockwise angle from increasing row direction to north at the center of the image.

  • extension – Exploitation feature extension for the end product

resolution: RowColDoubleType | None = None
ellipticity: float | None = None
polarization: List[ProcTxRcvPolarizationType]
north: float | None = None
extension: List[ParameterType]
class aws.osml.formats.sidd.models.sidd_v3_0_0.FilterBankType(predefined: aws.osml.formats.sidd.models.sidd_v3_0_0.PredefinedFilterType | None = None, custom: aws.osml.formats.sidd.models.sidd_v3_0_0.BankCustomType | None = None)[source]

Bases: object

predefined: PredefinedFilterType | None = None
custom: BankCustomType | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.FilterKernelType(predefined: aws.osml.formats.sidd.models.sidd_v3_0_0.PredefinedFilterType | None = None, custom: aws.osml.formats.sidd.models.sidd_v3_0_0.KernelCustomType | None = None)[source]

Bases: object

predefined: PredefinedFilterType | None = None
custom: KernelCustomType | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.GeoDataType(earth_model: Optional[aws.osml.formats.sidd.models.sidd_v3_0_0.EarthModelType] = None, image_corners: Optional[aws.osml.formats.sidd.models.sidd_v3_0_0.ImageCornersType] = None, valid_data: Optional[aws.osml.formats.sidd.models.sidd_v3_0_0.PolygonType] = None, geo_info: List[aws.osml.formats.sidd.models.sicommon_types_v1_0.GeoInfo] = <factory>)[source]

Bases: object

earth_model: EarthModelType | None = None
image_corners: ImageCornersType | None = None
valid_data: PolygonType | None = None
geo_info: List[GeoInfo]
class aws.osml.formats.sidd.models.sidd_v3_0_0.J2KSubtype(num_wavelet_levels: int | None = None, num_bands: int | None = None, layer_info: LayerInfoType | None = None)[source]

Bases: object

Variables:

  • num_wavelet_levels – The default number of wavelet decompositionlevels performed per tile in the original image out of the processors.

  • num_bands – The number of spectral bands in the original image out of the processors.

  • layer_info – Original Layer Information. The following fileds repeat for all layers in (0, 1, …, numLayers - 1). The default number of layers per tile in original image out of the original processor.

num_wavelet_levels: int | None = None
num_bands: int | None = None
layer_info: LayerInfoType | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.MeasurableProjectionType(reference_point: ReferencePointType | None = None, sample_spacing: RowColDoubleType | None = None, time_coapoly: Poly2DType | None = None)[source]

Bases: BaseProjectionType

Variables:

  • sample_spacing – Sample spacing in row and column.

  • time_coapoly – Time (units = seconds) at which center of aperture for a given pixel coordinate in the product occurs.

sample_spacing: RowColDoubleType | None = None
time_coapoly: Poly2DType | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.PolynomialProjectionType(reference_point: ReferencePointType | None = None, row_col_to_lat: Poly2DType | None = None, row_col_to_lon: Poly2DType | None = None, row_col_to_alt: Poly2DType | None = None, lat_lon_to_row: Poly2DType | None = None, lat_lon_to_col: Poly2DType | None = None)[source]

Bases: BaseProjectionType

Polynomial pixel to ground.

Only used for sensor systems where the radar geometry parameters are not recorded.

Variables:

  • row_col_to_lat – Polynomial that converts Row/Col to Latitude (degrees).

  • row_col_to_lon – Polynomial that converts Row/Col to Longitude (degrees).

  • row_col_to_alt – Polynomial that converts Row/Col to Altitude (meters above WGS-84 ellipsoid).

  • lat_lon_to_row – Polynomial that converts Latitude (degrees) and Longitude (degrees) to pixel row location.

  • lat_lon_to_col – Polynomial that converts Latitude (degrees) and Longitude (degrees) to pixel column location

row_col_to_lat: Poly2DType | None = None
row_col_to_lon: Poly2DType | None = None
row_col_to_alt: Poly2DType | None = None
lat_lon_to_row: Poly2DType | None = None
lat_lon_to_col: Poly2DType | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.ProductCreationType(processor_information: ~aws.osml.formats.sidd.models.sidd_v3_0_0.ProcessorInformationType | None = None, classification: ~aws.osml.formats.sidd.models.sidd_v3_0_0.ProductClassificationType | None = None, product_name: str | None = None, product_class: str | None = None, product_type: str | None = None, product_creation_extension: ~typing.List[~aws.osml.formats.sidd.models.sicommon_types_v1_0.ParameterType] = <factory>)[source]

Bases: object

Contains general information about product creation.

Variables:

  • processor_information – Details regarding processor.

  • classification – The overall classification of the product.

  • product_name – The output product name defined by the processor.

  • product_class – Class of product. (examples: Dynamic Image, Amplitude Change Detection, Coherent Change Detection, etc.).

  • product_type – Type of sub-product. (examples: Frame #, Reference, Match, etc.). This field is only needed if there is a suite of associated products.

  • product_creation_extension – Extensible parameters used to support profile-specific needs related to product creation.

processor_information: ProcessorInformationType | None = None
classification: ProductClassificationType | None = None
product_name: str | None = None
product_class: str | None = None
product_type: str | None = None
product_creation_extension: List[ParameterType]
class aws.osml.formats.sidd.models.sidd_v3_0_0.ProductProcessingType(processing_module: ~typing.List[~aws.osml.formats.sidd.models.sidd_v3_0_0.ProcessingModuleType] = <factory>)[source]

Bases: object

Computed metadata regarding one or more of the input collections and final product.

Variables:

processing_module – Processing module to keep track of the name and any parameters associated with the algorithms used to produce the SIDD.

processing_module: List[ProcessingModuleType]
class aws.osml.formats.sidd.models.sidd_v3_0_0.RemapChoiceType(color_display_remap: ColorDisplayRemapType | None = None, monochrome_display_remap: MonochromeDisplayRemapType | None = None)[source]

Bases: object

Variables:

  • color_display_remap – Information for proper color display of the data.

  • monochrome_display_remap – Information for proper monochrome display of the data.

color_display_remap: ColorDisplayRemapType | None = None
monochrome_display_remap: MonochromeDisplayRemapType | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.AnnotationsType(annotation: ~typing.List[~aws.osml.formats.sidd.models.sidd_v3_0_0.AnnotationType] = <factory>)[source]

Bases: object

Variables:

annotation – Annotation Object.

annotation: List[AnnotationType]
class aws.osml.formats.sidd.models.sidd_v3_0_0.CylindricalProjectionType(reference_point: ReferencePointType | None = None, sample_spacing: RowColDoubleType | None = None, time_coapoly: Poly2DType | None = None, stripmap_direction: XYZType | None = None, curvature_radius: float | None = None)[source]

Bases: MeasurableProjectionType

Cylindrical mapping of the pixel grid.

Variables:

  • stripmap_direction – Along stripmap direction

  • curvature_radius – Radius of Curvature defined at scene center. If not present, the radius of curvature will be derived based upon the equations provided in the Design and Exploitation Document

stripmap_direction: XYZType | None = None
curvature_radius: float | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.ExploitationFeaturesCollectionType(information: ExploitationFeaturesCollectionInformationType | None = None, geometry: ExploitationFeaturesCollectionGeometryType | None = None, phenomenology: ExploitationFeaturesCollectionPhenomenologyType | None = None)[source]

Bases: object

Variables:

  • information – General collection information.

  • geometry – Key geometry parameters independent of product processing.

  • phenomenology – Phenomenology related to both the geometry and the final product processing.

information: ExploitationFeaturesCollectionInformationType | None = None
geometry: ExploitationFeaturesCollectionGeometryType | None = None
phenomenology: ExploitationFeaturesCollectionPhenomenologyType | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.FilterType(filter_name: str | None = None, filter_kernel: aws.osml.formats.sidd.models.sidd_v3_0_0.FilterKernelType | None = None, filter_bank: aws.osml.formats.sidd.models.sidd_v3_0_0.FilterBankType | None = None, operation: aws.osml.formats.sidd.models.sidd_v3_0_0.FilterOperationType | None = None)[source]

Bases: object

filter_name: str | None = None
filter_kernel: FilterKernelType | None = None
filter_bank: FilterBankType | None = None
operation: FilterOperationType | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.GeographicProjectionType(reference_point: ReferencePointType | None = None, sample_spacing: RowColDoubleType | None = None, time_coapoly: Poly2DType | None = None)[source]

Bases: MeasurableProjectionType

Geographic mapping of the pixel grid.

class aws.osml.formats.sidd.models.sidd_v3_0_0.J2KType(original: J2KSubtype | None = None, parsed: J2KSubtype | None = None)[source]

Bases: object

Variables:

  • original

  • parsed – Conditional fields that exist only for parsed images.

original: J2KSubtype | None = None
parsed: J2KSubtype | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.NewLookupTableType(lutname: str | None = None, predefined: aws.osml.formats.sidd.models.sidd_v3_0_0.PredefinedLookupType | None = None, custom: aws.osml.formats.sidd.models.sidd_v3_0_0.CustomLookupType | None = None)[source]

Bases: object

lutname: str | None = None
predefined: PredefinedLookupType | None = None
custom: CustomLookupType | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.PlaneProjectionType(reference_point: ReferencePointType | None = None, sample_spacing: RowColDoubleType | None = None, time_coapoly: Poly2DType | None = None, product_plane: ProductPlaneType | None = None)[source]

Bases: MeasurableProjectionType

Planar representation of the pixel grid.

Variables:

product_plane – Plane definition for the product.

product_plane: ProductPlaneType | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.BandEqualizationType(algorithm: ~aws.osml.formats.sidd.models.sidd_v3_0_0.EqualizationAlgorithmType | None = None, band_lut: ~typing.List[~aws.osml.formats.sidd.models.sidd_v3_0_0.BandEqualizationType.BandLUT] = <factory>)[source]

Bases: object

Band equalization ensures that real-world neutral colors have equal digital count values (i.e. are represented as neutral colors) across the dynamic range of the imaged scene.

Variables:

  • algorithm – Allowed values: 1DLUT

  • band_lut

algorithm: EqualizationAlgorithmType | None = None
band_lut: List[BandLUT]
class BandLUT(lutname: str | None = None, predefined: aws.osml.formats.sidd.models.sidd_v3_0_0.PredefinedLookupType | None = None, custom: aws.osml.formats.sidd.models.sidd_v3_0_0.CustomLookupType | None = None, k: int | None = None)[source]

Bases: NewLookupTableType

k: int | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.CompressionType(j2_k: J2KType | None = None)[source]

Bases: object

Contains information regarding any compression that has occured to the image data.

Variables:

j2_k – Block describing details of JPEG 2000 compression.

j2_k: J2KType | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.ExploitationFeaturesType(collection: ~typing.List[~aws.osml.formats.sidd.models.sidd_v3_0_0.ExploitationFeaturesType.Collection] = <factory>, product: ~typing.List[~aws.osml.formats.sidd.models.sidd_v3_0_0.ExploitationFeaturesProductType] = <factory>)[source]

Bases: object

Computed metadata regarding the collect.

Variables:

  • collection – Metadata regarding one of the input collections.

  • product – Metadata regarding the product.

collection: List[Collection]
product: List[ExploitationFeaturesProductType]
class Collection(information: aws.osml.formats.sidd.models.sidd_v3_0_0.ExploitationFeaturesCollectionInformationType | None = None, geometry: aws.osml.formats.sidd.models.sidd_v3_0_0.ExploitationFeaturesCollectionGeometryType | None = None, phenomenology: aws.osml.formats.sidd.models.sidd_v3_0_0.ExploitationFeaturesCollectionPhenomenologyType | None = None, identifier: str | None = None)[source]

Bases: ExploitationFeaturesCollectionType

identifier: str | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.MeasurementType(polynomial_projection: PolynomialProjectionType | None = None, geographic_projection: GeographicProjectionType | None = None, plane_projection: PlaneProjectionType | None = None, cylindrical_projection: CylindricalProjectionType | None = None, pixel_footprint: RowColIntType | None = None, arpflag: MeasurementTypeARPFlag | None = None, arppoly: XYZPolyType | None = None, valid_data: ValidDataType | None = None)[source]

Bases: object

Geometric SAR information required for measurement/geolocation.

Variables:

  • polynomial_projection – Polynomial pixel to ground. Only used for sensor systems where the radar geometry parameters are not recorded.

  • geographic_projection – Geographic mapping of the pixel grid referred to as GGD in the Design and Exploitation document.

  • plane_projection – Planar representation of the pixel grid referred to as PGD in the Design and Exploitation document.

  • cylindrical_projection – Cylindrical mapping of the pixel grid referred to as CGD in the Design and Exploitation document.

  • pixel_footprint – Size of the image in pixels.

  • arpflag – Flag indicating whether ARP polynomial is based on the best available (“collect time” or “predicted”) ephemeris.

  • arppoly – Center of aperture polynomial (units = m) based upon time into the collect.

  • valid_data – Indicates the full image includes both valid data and some zero filled pixels. Simple convex polygon enclosed the valid data (may include some zero filled pixels for simplification). Vertices in clockwise order.

polynomial_projection: PolynomialProjectionType | None = None
geographic_projection: GeographicProjectionType | None = None
plane_projection: PlaneProjectionType | None = None
cylindrical_projection: CylindricalProjectionType | None = None
pixel_footprint: RowColIntType | None = None
arpflag: MeasurementTypeARPFlag | None = None
arppoly: XYZPolyType | None = None
valid_data: ValidDataType | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.RRDSType(downsampling_method: DownsamplingMethodType | None = None, anti_alias: FilterType | None = None, interpolation: FilterType | None = None)[source]

Bases: object

Variables:

  • downsampling_method – Algorithm used to perform RRDS downsampling

  • anti_alias – Only included if DownSamplingMethod=DECIMET

  • interpolation – Only included if DownSamplingMethod=DECIMET

downsampling_method: DownsamplingMethodType | None = None
anti_alias: FilterType | None = None
interpolation: FilterType | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.ScalingType(anti_alias: FilterType | None = None, interpolation: FilterType | None = None)[source]

Bases: object

Variables:

  • anti_alias – Anti-Alias Filter used for scaling. Refer to program-specific documentation for population guidance

  • interpolation – Interpolation Filter used for scaling. Refer to program-specific documentation for population guidance.

anti_alias: FilterType | None = None
interpolation: FilterType | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.SharpnessEnhancementType(modular_transfer_function_compensation: FilterType | None = None, modular_transfer_function_enhancement: FilterType | None = None)[source]

Bases: object

Variables:

  • modular_transfer_function_compensation – Note: If defining a custom Filter, it must be no larger than 5x5.

  • modular_transfer_function_enhancement – Note: If defining a custom Filter, it must be no larger than 5x5.

modular_transfer_function_compensation: FilterType | None = None
modular_transfer_function_enhancement: FilterType | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.GeometricTransformType(scaling: ScalingType | None = None, orientation: Orientation | None = None)[source]

Bases: object

Variables:

  • scaling

  • orientation – Parameters describing the default orientation of the product

scaling: ScalingType | None = None
orientation: Orientation | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.ProductGenerationOptionsType(band_equalization: BandEqualizationType | None = None, modular_transfer_function_restoration: FilterType | None = None, data_remapping: NewLookupTableType | None = None, asymmetric_pixel_correction: FilterType | None = None)[source]

Bases: object

Performs several key actions on an image to prepare it for necessary additional processing to achieve the desired output product.

Variables:

  • band_equalization – Band equalization ensures that real-world neutral colors have equal digital count values (i.e. are represented as neutral colors) across the dynamic range of the imaged scene.

  • modular_transfer_function_restoration – Filter must be no larger than 15x15.

  • data_remapping – Data remapping refers to the specific need to convert the data of incoming, expanded or uncompressed image band data to non-mapped image data.

  • asymmetric_pixel_correction

band_equalization: BandEqualizationType | None = None
modular_transfer_function_restoration: FilterType | None = None
data_remapping: NewLookupTableType | None = None
asymmetric_pixel_correction: FilterType | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.InteractiveProcessingType(geometric_transform: GeometricTransformType | None = None, sharpness_enhancement: SharpnessEnhancementType | None = None, color_space_transform: ColorSpaceTransformType | None = None, dynamic_range_adjustment: DynamicRangeAdjustmentType | None = None, tonal_transfer_curve: NewLookupTableType | None = None, band: int | None = None)[source]

Bases: object

Variables:

  • geometric_transform – The geometric transform element is used to perform various geometric distortions to each band of image data. These distortions include image chipping, scaling, rotation, shearing, etc.

  • sharpness_enhancement

  • color_space_transform

  • dynamic_range_adjustment – Specifies the recommended ELT DRA overrides

  • tonal_transfer_curve – The 1-D LUT element uses one or more 1-D LUTs to stretch or compress tome data in valorous regions within a digital image’s dynamic range. 1-D LUT can be implemented using a Tonal Transfer Curve (TTC). There are 12 families of TTCs: Range = [0,11]. There are 64 members for each family: Range=[0, 63].

  • band

geometric_transform: GeometricTransformType | None = None
sharpness_enhancement: SharpnessEnhancementType | None = None
color_space_transform: ColorSpaceTransformType | None = None
dynamic_range_adjustment: DynamicRangeAdjustmentType | None = None
tonal_transfer_curve: NewLookupTableType | None = None
band: int | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.NonInteractiveProcessingType(product_generation_options: ProductGenerationOptionsType | None = None, rrds: RRDSType | None = None, band: int | None = None)[source]

Bases: object

Variables:

  • product_generation_options – Performs several key actions on an image to prepare it for necessary additional processing to achieve the desired output product.

  • rrds – Creates a set of sub-sampled versions of an image to provide processing chains with quick access to lower mangification values for faster computation speeds and performance.

  • band

product_generation_options: ProductGenerationOptionsType | None = None
rrds: RRDSType | None = None
band: int | None = None
class aws.osml.formats.sidd.models.sidd_v3_0_0.ProductDisplayType(pixel_type: ~aws.osml.formats.sidd.models.sidd_v3_0_0.PixelType | None = None, num_bands: int | None = None, default_band_display: int | None = None, non_interactive_processing: ~typing.List[~aws.osml.formats.sidd.models.sidd_v3_0_0.NonInteractiveProcessingType] = <factory>, interactive_processing: ~typing.List[~aws.osml.formats.sidd.models.sidd_v3_0_0.InteractiveProcessingType] = <factory>, display_extension: ~typing.List[~aws.osml.formats.sidd.models.sicommon_types_v1_0.ParameterType] = <factory>)[source]

Bases: object

Type for describing proper display of the derived product.

Variables:

  • pixel_type – Defines the pixel type, based on enumeration and definition in Design and Exploitation document.

  • num_bands – Number of bands contained in the image. Populate with the number of bands present after remapping. For example an 8-bit RGB image (RGBLU) this should be populated with 3.

  • default_band_display – Indicates which band to display by default. Valid range = 1 to NumBands.

  • non_interactive_processing

  • interactive_processing

  • display_extension – Optional extensible parameters used to support profile-specific needs related to product display. Predefined filter types.

pixel_type: PixelType | None = None
num_bands: int | None = None
default_band_display: int | None = None
non_interactive_processing: List[NonInteractiveProcessingType]
interactive_processing: List[InteractiveProcessingType]
display_extension: List[ParameterType]
class aws.osml.formats.sidd.models.sidd_v3_0_0.SIDD(product_creation: ProductCreationType | None = None, display: ProductDisplayType | None = None, geo_data: GeoDataType | None = None, measurement: MeasurementType | None = None, exploitation_features: ExploitationFeaturesType | None = None, downstream_reprocessing: DownstreamReprocessingType | None = None, error_statistics: ErrorStatisticsType | None = None, radiometric: RadiometricType | None = None, match_info: MatchInfoType | None = None, compression: CompressionType | None = None, digital_elevation_data: DigitalElevationDataType | None = None, product_processing: ProductProcessingType | None = None, annotations: AnnotationsType | None = None)[source]

Bases: object

Root element of the SIDD document.

Variables:

  • product_creation – Information related to processor, classification, and product type.

  • display – Contains information on the parameters needed to display the product in an exploitation tool.

  • geo_data – Contains geographic data.

  • measurement – Contains the metadata necessary for performing measurements.

  • exploitation_features – Computed metadata regarding the input collections and final product.

  • downstream_reprocessing – Contains metadata related to downstream processing of the product.

  • error_statistics – See SICD documentation for metadata definitions.

  • radiometric – Radiometric information about the product.

  • match_info – Information about other collections that are matched to the current collection. The current collection is the collection from which this SIDD product was generated.

  • compression – Contains information regarding any compression that has occured to the image data.

  • digital_elevation_data – This block describes the Digital ElevatioNData when it is included with the SIDD product.

  • product_processing – Contains metadata related to algorithms used during product generation.

  • annotations – List of annotations for the imagery.

class Meta[source]

Bases: object

namespace = 'urn:SIDD:3.0.0'
product_creation: ProductCreationType | None = None
display: ProductDisplayType | None = None
geo_data: GeoDataType | None = None
measurement: MeasurementType | None = None
exploitation_features: ExploitationFeaturesType | None = None
downstream_reprocessing: DownstreamReprocessingType | None = None
error_statistics: ErrorStatisticsType | None = None
radiometric: RadiometricType | None = None
match_info: MatchInfoType | None = None
compression: CompressionType | None = None
digital_elevation_data: DigitalElevationDataType | None = None
product_processing: ProductProcessingType | None = None
annotations: AnnotationsType | None = None