aws.osml.formats.sidd.models.sidd_v1_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_v1_0_0.AcheivedResolutionType[source]

Bases: object

Finest achievable resolution parameters.

class aws.osml.formats.sidd.models.sidd_v1_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_v1_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_v1_0_0.DecimationMethodType(value)[source]

Bases: Enum

Default ELT decimation method for this data.

Also used as default for reduced resolution dataset generation (if applicable).

NEAREST_NEIGHBOR = 'NEAREST_NEIGHBOR'
BILINEAR = 'BILINEAR'
BRIGHTEST_PIXEL = 'BRIGHTEST_PIXEL'
LAGRANGE = 'LAGRANGE'
class aws.osml.formats.sidd.models.sidd_v1_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_v1_0_0.LookupTableType(value: ~typing.List[int] = <factory>, size: int | None = None)[source]

Bases: object

Variables:

  • value

  • size – Size of LUT.

value: List[int]
size: int | None = None
class aws.osml.formats.sidd.models.sidd_v1_0_0.MagnificationMethodType(value)[source]

Bases: Enum

Default ELT magnification method for this data.

NEAREST_NEIGHBOR = 'NEAREST_NEIGHBOR'
BILINEAR = 'BILINEAR'
LAGRANGE = 'LAGRANGE'
class aws.osml.formats.sidd.models.sidd_v1_0_0.MonitorCompensationAppliedType(gamma: float | None = None, xmin: float | None = None)[source]

Bases: object

Describes monitor compensation that may have been applied to the product during processing.

Variables:

  • gamma – Gamma value for monitor compensation pre-applied to the image.

  • xmin – Xmin value for monitor compensation pre-applied to the image.

gamma: float | None = None
xmin: float | None = None
class aws.osml.formats.sidd.models.sidd_v1_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_v1_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_v1_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_v1_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_v1_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_v1_0_0.ExploitationFeaturesCollectionGeometryType(azimuth: float | None = None, slope: float | None = None, squint: float | None = None, graze: float | None = None, tilt: float | None = None, extension: ~typing.List[~aws.osml.formats.sidd.models.sicommon_types.ParameterType] = <factory>)[source]

Bases: object

Key geometry parameters independent of product processing.

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 negative, right- look is positive.

  • 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.

  • 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
extension: List[ParameterType]
class aws.osml.formats.sidd.models.sidd_v1_0_0.ExploitationFeaturesCollectionPhenomenologyType(shadow: ~aws.osml.formats.sidd.models.sicommon_types.AngleMagnitudeType | None = None, layover: ~aws.osml.formats.sidd.models.sicommon_types.AngleMagnitudeType | None = None, multi_path: float | None = None, ground_track: float | None = None, extension: ~typing.List[~aws.osml.formats.sidd.models.sicommon_types.ParameterType] = <factory>)[source]

Bases: object

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

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: AngleMagnitudeType | None = None
layover: AngleMagnitudeType | None = None
multi_path: float | None = None
ground_track: float | None = None
extension: List[ParameterType]
class aws.osml.formats.sidd.models.sidd_v1_0_0.ExploitationFeaturesProductType(resolution: ~aws.osml.formats.sidd.models.sicommon_types.RowColDoubleType | None = None, north: float | None = None, extension: ~typing.List[~aws.osml.formats.sidd.models.sicommon_types.ParameterType] = <factory>)[source]

Bases: object

Metadata regarding the product.

Variables:

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

  • 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
north: float | None = None
extension: List[ParameterType]
class aws.osml.formats.sidd.models.sidd_v1_0_0.FootprintType(vertex: List[aws.osml.formats.sidd.models.sicommon_types.LatLonVertexType] = <factory>, size: Optional[int] = None)[source]

Bases: object

vertex: List[LatLonVertexType]
size: int | None = None
class aws.osml.formats.sidd.models.sidd_v1_0_0.GeographicInformationType(country_code: ~typing.List[str] = <factory>, security_info: str | None = None, geographic_info_extension: ~typing.List[~aws.osml.formats.sidd.models.sicommon_types.ParameterType] = <factory>)[source]

Bases: object

Variables:

  • country_code – Country identifier for this geographic region.

  • security_info – Specifies classification level or special handling designators for this geographic region

  • geographic_info_extension – Implementation specific geographic information.

country_code: List[str]
security_info: str | None = None
geographic_info_extension: List[ParameterType]
class aws.osml.formats.sidd.models.sidd_v1_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

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_v1_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_v1_0_0.MonochromeDisplayRemapType(remap_type: str | None = None, remap_lut: ~aws.osml.formats.sidd.models.sidd_v1_0_0.LookupTableType | None = None, remap_parameter: ~typing.List[~aws.osml.formats.sidd.models.sicommon_types.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_lut – Lookup table for remap to log amplitude for display. Used during the “Product Generation Option” portion of the SIPS display chain. Required for 8-bit data. Not to be used for 16-bit data.

  • 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_lut: LookupTableType | None = None
remap_parameter: List[ParameterType]
class aws.osml.formats.sidd.models.sidd_v1_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.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_v1_0_0.ProcessingModuleType(module_name: ~aws.osml.formats.sidd.models.sicommon_types.ParameterType | None = None, module_parameter: ~typing.List[~aws.osml.formats.sidd.models.sicommon_types.ParameterType] = <factory>, processing_module: ~typing.List[~aws.osml.formats.sidd.models.sidd_v1_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_v1_0_0.ProductClassificationType(security_extension: ~typing.List[~aws.osml.formats.sidd.models.sicommon_types.ParameterType] = <factory>, create_date: ~xsdata.models.datatype.XmlDate | None = None, complies_with: ~typing.List[~aws.osml.formats.sidd.models.external.ism.schema.cvegenerated.cvenum_ismcomplies_with.CVEnumISMCompliesWithValues] = <factory>, classification: ~aws.osml.formats.sidd.models.external.ism.schema.cvegenerated.cvenum_ismclassification_all.CVEnumISMClassificationAll | None = None, owner_producer: ~typing.List[~aws.osml.formats.sidd.models.external.ism.schema.cvegenerated.cvenum_ismowner_producer.CVEnumISMOwnerProducerValues] = <factory>, scicontrols: ~typing.List[str | ~aws.osml.formats.sidd.models.external.ism.schema.cvegenerated.cvenum_ismscicontrols.CVEnumISMSCIControlsValuesvalue] = <factory>, saridentifier: ~typing.List[str] = <factory>, dissemination_controls: ~typing.List[str | ~aws.osml.formats.sidd.models.external.ism.schema.cvegenerated.cvenum_ismdissem.CVEnumISMDissemValuesvalue] = <factory>, fgisource_open: ~typing.List[~aws.osml.formats.sidd.models.external.ism.schema.cvegenerated.cvenum_ismfgiopen.CVEnumISMFGIOpenValues] = <factory>, fgisource_protected: ~typing.List[~aws.osml.formats.sidd.models.external.ism.schema.cvegenerated.cvenum_ismfgiprotected.CVEnumISMFGIProtectedValues] = <factory>, releasable_to: ~typing.List[~aws.osml.formats.sidd.models.external.ism.schema.cvegenerated.cvenum_ismrel_to.CVEnumISMRelToValues] = <factory>, non_icmarkings: ~typing.List[~aws.osml.formats.sidd.models.external.ism.schema.cvegenerated.cvenum_ismnon_ic.CVEnumISMNonICValues] = <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.schema.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.schema.cvegenerated.cvenum_ism25_x.CVEnumISM25X | None = None, type_of_exempted_source: ~aws.osml.formats.sidd.models.external.ism.schema.cvegenerated.cvenum_ismsource_marked.CVEnumISMSourceMarked | None = None, date_of_exempted_source: ~xsdata.models.datatype.XmlDate | 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 – The version number of the DES. Should there be multiple specified in an instance document the one at the root node is the one that will apply to the entire document.

  • resource_element

  • create_date

  • complies_with

  • classification

  • owner_producer

  • scicontrols

  • saridentifier

  • dissemination_controls

  • 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

  • type_of_exempted_source

  • date_of_exempted_source

security_extension: List[ParameterType]
desversion: int = 4
resource_element: bool = True
create_date: XmlDate | None = None
complies_with: List[CVEnumISMCompliesWithValues]
classification: CVEnumISMClassificationAll | None = None
owner_producer: List[CVEnumISMOwnerProducerValues]
scicontrols: List[str | CVEnumISMSCIControlsValuesvalue]
saridentifier: List[str]
dissemination_controls: List[str | CVEnumISMDissemValuesvalue]
fgisource_open: List[CVEnumISMFGIOpenValues]
fgisource_protected: List[CVEnumISMFGIProtectedValues]
releasable_to: List[CVEnumISMRelToValues]
non_icmarkings: List[CVEnumISMNonICValues]
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
type_of_exempted_source: CVEnumISMSourceMarked | None = None
date_of_exempted_source: XmlDate | None = None
class aws.osml.formats.sidd.models.sidd_v1_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_v1_0_0.TxRcvPolarizationType(tx_polarization: PolarizationType | None = None, rcv_polarization: PolarizationType | None = None, rcv_polarization_offset: float | None = None, processed: bool | 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.

  • processed – Optional flag to describe whether this input polarization was used in processing the product.

tx_polarization: PolarizationType | None = None
rcv_polarization: PolarizationType | None = None
rcv_polarization_offset: float | None = None
processed: bool | None = None
class aws.osml.formats.sidd.models.sidd_v1_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_v1_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_v1_0_0.DownstreamReprocessingType(geometric_chip: ~aws.osml.formats.sidd.models.sidd_v1_0_0.GeometricChipType | None = None, processing_event: ~typing.List[~aws.osml.formats.sidd.models.sidd_v1_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_v1_0_0.ExploitationFeaturesCollectionInformationType(sensor_name: str | None = None, radar_mode: ~aws.osml.formats.sidd.models.sicommon_types.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.RangeAzimuthType | None = None, input_roi: ~aws.osml.formats.sidd.models.sidd_v1_0_0.InputROIType | None = None, polarization: ~typing.List[~aws.osml.formats.sidd.models.sidd_v1_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_v1_0_0.GeographicCoverageType(georegion_identifier: ~typing.List[~aws.osml.formats.sidd.models.sicommon_types.ParameterType] = <factory>, footprint: ~aws.osml.formats.sidd.models.sidd_v1_0_0.FootprintType | None = None, sub_region: ~typing.List[~aws.osml.formats.sidd.models.sidd_v1_0_0.GeographicCoverageType] = <factory>, geographic_info: ~aws.osml.formats.sidd.models.sidd_v1_0_0.GeographicInformationType | None = None)[source]

Bases: object

Variables:

  • georegion_identifier – Identifier for the georegion.

  • footprint – Estimated ground footprint of the product.

  • sub_region – Used to represent hierarchical decomposition into sub-regions.

  • geographic_info – Specifics about the georegion.

georegion_identifier: List[ParameterType]
footprint: FootprintType | None = None
sub_region: List[GeographicCoverageType]
geographic_info: GeographicInformationType | None = None
class aws.osml.formats.sidd.models.sidd_v1_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_v1_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_v1_0_0.ProductCreationType(processor_information: ~aws.osml.formats.sidd.models.sidd_v1_0_0.ProcessorInformationType | None = None, classification: ~aws.osml.formats.sidd.models.sidd_v1_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.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_v1_0_0.ProductProcessingType(processing_module: ~typing.List[~aws.osml.formats.sidd.models.sidd_v1_0_0.ProcessingModuleType] = <factory>)[source]

Bases: object

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_v1_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_v1_0_0.TargetInformationType(identifier: ~typing.List[~aws.osml.formats.sidd.models.sicommon_types.ParameterType] = <factory>, footprint: ~aws.osml.formats.sidd.models.sidd_v1_0_0.FootprintType | None = None, target_information_extension: ~typing.List[~aws.osml.formats.sidd.models.sicommon_types.ParameterType] = <factory>)[source]

Bases: object

Variables:

  • identifier – Target may have one or more identifiers. Examples: names, BE numbers, etc. Use the “name” attribute to describe what this is.

  • footprint – Target footprint as defined by polygonal shape.

  • target_information_extension – Generic extension. Could be used to indicate type of target, terrain, etc.

identifier: List[ParameterType]
footprint: FootprintType | None = None
target_information_extension: List[ParameterType]
class aws.osml.formats.sidd.models.sidd_v1_0_0.AnnotationsType(annotation: ~typing.List[~aws.osml.formats.sidd.models.sidd_v1_0_0.AnnotationType] = <factory>)[source]

Bases: object

Variables:

annotation – Annotation Object.

annotation: List[AnnotationType]
class aws.osml.formats.sidd.models.sidd_v1_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_v1_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_v1_0_0.GeographicAndTargetType(geographic_coverage: ~aws.osml.formats.sidd.models.sidd_v1_0_0.GeographicCoverageType | None = None, target_information: ~typing.List[~aws.osml.formats.sidd.models.sidd_v1_0_0.TargetInformationType] = <factory>)[source]

Bases: object

Variables:

  • geographic_coverage – Provides geographic coverage information.

  • target_information – Provides target specific geographic information.

geographic_coverage: GeographicCoverageType | None = None
target_information: List[TargetInformationType]
class aws.osml.formats.sidd.models.sidd_v1_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_v1_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_v1_0_0.ProductDisplayType(pixel_type: ~aws.osml.formats.sidd.models.sidd_v1_0_0.PixelType | None = None, remap_information: ~aws.osml.formats.sidd.models.sidd_v1_0_0.RemapChoiceType | None = None, magnification_method: ~aws.osml.formats.sidd.models.sidd_v1_0_0.MagnificationMethodType | None = None, decimation_method: ~aws.osml.formats.sidd.models.sidd_v1_0_0.DecimationMethodType | None = None, drahistogram_overrides: ~aws.osml.formats.sidd.models.sidd_v1_0_0.DRAHistogramOverridesType | None = None, monitor_compensation_applied: ~aws.osml.formats.sidd.models.sidd_v1_0_0.MonitorCompensationAppliedType | None = None, display_extension: ~typing.List[~aws.osml.formats.sidd.models.sicommon_types.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.

  • remap_information – Information regarding the encoding of the pixel data. Used for 8-bit pixel types.

  • magnification_method – Recommended ELT magnification method for this data.

  • decimation_method – Recommended ELT decimation method for this data. Also used as default for reduced resolution dataset generation (if applicable).

  • drahistogram_overrides – Recommended ELT DRA overrides.

  • monitor_compensation_applied – Describes monitor compensation that may have been applied to the product during processing.

  • display_extension – Extensible parameters used to support profile-specific needs related to product display.

pixel_type: PixelType | None = None
remap_information: RemapChoiceType | None = None
magnification_method: MagnificationMethodType | None = None
decimation_method: DecimationMethodType | None = None
drahistogram_overrides: DRAHistogramOverridesType | None = None
monitor_compensation_applied: MonitorCompensationAppliedType | None = None
display_extension: List[ParameterType]
class aws.osml.formats.sidd.models.sidd_v1_0_0.ExploitationFeaturesType(collection: ~typing.List[~aws.osml.formats.sidd.models.sidd_v1_0_0.ExploitationFeaturesType.Collection] = <factory>, product: ~aws.osml.formats.sidd.models.sidd_v1_0_0.ExploitationFeaturesProductType | None = None)[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: ExploitationFeaturesProductType | None = None
class Collection(information: aws.osml.formats.sidd.models.sidd_v1_0_0.ExploitationFeaturesCollectionInformationType | None = None, geometry: aws.osml.formats.sidd.models.sidd_v1_0_0.ExploitationFeaturesCollectionGeometryType | None = None, phenomenology: aws.osml.formats.sidd.models.sidd_v1_0_0.ExploitationFeaturesCollectionPhenomenologyType | None = None, identifier: str | None = None)[source]

Bases: ExploitationFeaturesCollectionType

identifier: str | None = None
class aws.osml.formats.sidd.models.sidd_v1_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, arppoly: XYZPolyType | 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.

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

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
arppoly: XYZPolyType | None = None
class aws.osml.formats.sidd.models.sidd_v1_0_0.SIDD(product_creation: ProductCreationType | None = None, display: ProductDisplayType | None = None, geographic_and_target: GeographicAndTargetType | None = None, measurement: MeasurementType | None = None, exploitation_features: ExploitationFeaturesType | None = None, product_processing: ProductProcessingType | None = None, downstream_reprocessing: DownstreamReprocessingType | None = None, error_statistics: ErrorStatisticsType | None = None, radiometric: RadiometricType | 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.

  • geographic_and_target – Contains generic and extensible targeting and geographic region information.

  • measurement – Contains the metadata necessary for performing measurements.

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

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

  • 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.

  • annotations – List of annotations for the imagery.

class Meta[source]

Bases: object

namespace = 'urn:SIDD:1.0.0'
product_creation: ProductCreationType | None = None
display: ProductDisplayType | None = None
geographic_and_target: GeographicAndTargetType | None = None
measurement: MeasurementType | None = None
exploitation_features: ExploitationFeaturesType | None = None
product_processing: ProductProcessingType | None = None
downstream_reprocessing: DownstreamReprocessingType | None = None
error_statistics: ErrorStatisticsType | None = None
radiometric: RadiometricType | None = None
annotations: AnnotationsType | None = None